SQLGlot Converter¶
SQLGlotConverter
¶
Bases: BaseConverter[Any], AstConverter
Core converter that transforms yads specs into sqlglot AST expressions.
SQLGlotConverter is the foundational converter that handles the transformation from yads' high-level canonical spec to sqlglot's Abstract Syntax Tree representation. This AST serves as a dialect-agnostic intermediate representation that can then be serialized into SQL for specific database systems.
The converter uses single dispatch methods to handle different yads types, constraints, and spec elements, providing extensible type mapping and constraint conversion. It maintains the full expressiveness of the yads specification while producing valid sqlglot AST nodes.
The converter supports all yads type system features including primitive types, complex nested types, constraints, generated columns, partitioning transforms, and storage properties. It serves as the core engine for all SQL DDL generation in yads.
Source code in src/yads/converters/sql/ast_converter.py
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 | |
__init__(config=None)
¶
Initialize the SQLGlotConverter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
SQLGlotConverterConfig | None
|
Configuration object. If None, uses default SQLGlotConverterConfig. |
None
|
Source code in src/yads/converters/sql/ast_converter.py
138 139 140 141 142 143 144 145 | |
conversion_context(*, mode=None, field=None)
¶
Temporarily set conversion mode and field context.
This context manager centralizes handling of converter state used for warnings and coercions, ensuring that values are restored afterwards.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mode
|
Literal['raise', 'coerce'] | None
|
Optional override for the current conversion mode. |
None
|
field
|
str | None
|
Optional field name for contextual warnings. |
None
|
Source code in src/yads/converters/base.py
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 | |
convert(spec, *, mode=None)
¶
Convert a yads YadsSpec into a sqlglot exp.Create AST expression.
The resulting AST is dialect-agnostic and can be serialized to SQL for any database system supported by sqlglot. The conversion preserves all spec information and applies appropriate sqlglot expression types.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
spec
|
YadsSpec
|
The yads spec as a |
required |
mode
|
Literal['raise', 'coerce'] | None
|
Optional conversion mode override for this call. When not provided, the converter's configured mode is used. If provided: - "raise": Raise on any unsupported features. - "coerce": Apply adjustments to produce a valid AST and emit warnings. |
None
|
Returns:
| Type | Description |
|---|---|
Create
|
sqlglot |
Create
|
The AST includes table schema, constraints, properties, and metadata |
Create
|
from the yads spec. |
Source code in src/yads/converters/sql/ast_converter.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 | |
raise_or_coerce(yads_type=None, *, coerce_type=None, error_msg=None)
¶
Handle raise or coerce mode for unsupported type features.
This public method provides a consistent way to handle unsupported types based on the converter's mode. It can be used within converters and in custom column override functions.
The method uses the template method pattern with several hook methods that subclasses can override to customize behavior.
Hook that subclasses can override
_format_type_for_display: Customize how types appear in warnings_emit_warning: Customize warning emission_get_fallback_type: Customize fallback type resolution_generate_error_message: Customize error message generation
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
yads_type
|
Any | None
|
The yads type that is not supported. Can be None if error_msg is explicitly provided. |
None
|
coerce_type
|
Any | None
|
The type to coerce to in coerce mode. If None, uses the converter's configured fallback type. |
None
|
error_msg
|
str | None
|
Custom error message. If None, uses a default message based on the converter class name and yads_type. When providing a custom error_msg, yads_type can be None. |
None
|
Returns:
| Type | Description |
|---|---|
T
|
The coerced type in coerce mode. |
Raises:
| Type | Description |
|---|---|
UnsupportedFeatureError
|
In raise mode when the feature is not supported, or in coerce mode when fallback_type is None. |
ValueError
|
If both yads_type and error_msg are None. |
Source code in src/yads/converters/base.py
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 | |
SQLGlotConverterConfig
dataclass
¶
Bases: BaseConverterConfig[Any]
Configuration for SQLGlotConverter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mode
|
Literal['raise', 'coerce']
|
Conversion mode. One of "raise" or "coerce". Inherited from BaseConverterConfig. Defaults to "coerce". |
'coerce'
|
ignore_columns
|
frozenset[str]
|
Column names to exclude from conversion. Inherited from BaseConverterConfig. Defaults to empty. |
_empty_frozenset_str()
|
include_columns
|
frozenset[str] | None
|
If provided, only these columns are included. Inherited from BaseConverterConfig. Defaults to None. |
None
|
column_overrides
|
Mapping[str, Callable[[Field, SQLGlotConverter], ColumnDef]]
|
Mapping of column name to a callable that returns a
custom sqlglot |
(lambda: MappingProxyType({}))()
|
if_not_exists
|
bool
|
If True, sets the |
False
|
or_replace
|
bool
|
If True, sets the |
False
|
ignore_catalog
|
bool
|
If True, omits the catalog from the table name. Defaults to False. |
False
|
ignore_database
|
bool
|
If True, omits the database from the table name. Defaults to False. |
False
|
fallback_type
|
Type | None
|
SQL data type to use for unsupported types in coerce mode. Must be one of: exp.DataType.Type.TEXT, exp.DataType.Type.BINARY, exp.DataType.Type.BLOB, or None. Defaults to None. |
None
|
Source code in src/yads/converters/sql/ast_converter.py
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | |
__post_init__()
¶
Validate configuration parameters.
Source code in src/yads/converters/sql/ast_converter.py
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | |