1"""sqlglot expressions properties."""
  2
  3from __future__ import annotations
  4
  5import typing as t
  6from enum import auto
  7
  8from sqlglot.expressions.core import ColumnConstraintKind, Expression, Literal, convert
  9from sqlglot.helper import AutoName
 10
 11
 12class Property(Expression):
 13    arg_types = {"this": True, "value": True}
 14
 15
 16class GrantPrivilege(Expression):
 17    arg_types = {"this": True, "expressions": False}
 18
 19
 20class GrantPrincipal(Expression):
 21    arg_types = {"this": True, "kind": False}
 22
 23
 24class AllowedValuesProperty(Expression):
 25    arg_types = {"expressions": True}
 26
 27
 28class AggregateKeyProperty(Property):
 29    arg_types = {"expressions": True}
 30
 31
 32class AlgorithmProperty(Property):
 33    arg_types = {"this": True}
 34
 35
 36class ApiProperty(Property):
 37    arg_types = {}
 38
 39
 40class ApplicationProperty(Property):
 41    arg_types = {}
 42
 43
 44class AutoIncrementProperty(Property):
 45    arg_types = {"this": True}
 46
 47
 48class AutoRefreshProperty(Property):
 49    arg_types = {
 50        "this": False,
 51        "cadence": False,
 52        "offset": False,
 53        "randomize": False,
 54        "expressions": False,
 55        "settings": False,
 56        "append": False,
 57    }
 58
 59
 60class BackupProperty(Property):
 61    arg_types = {"this": True}
 62
 63
 64class BuildProperty(Property):
 65    arg_types = {"this": True}
 66
 67
 68class BlockCompressionProperty(Property):
 69    arg_types = {
 70        "autotemp": False,
 71        "always": False,
 72        "default": False,
 73        "manual": False,
 74        "never": False,
 75    }
 76
 77
 78class CalledOnNullInputProperty(Property):
 79    arg_types = {}
 80
 81
 82class CatalogProperty(Property):
 83    arg_types = {}
 84
 85
 86class CharacterSetProperty(Property):
 87    arg_types = {"this": True, "default": True}
 88
 89
 90class ChecksumProperty(Property):
 91    arg_types = {"on": False, "default": False}
 92
 93
 94class ClusterProperty(Property):
 95    arg_types = {"this": False, "expressions": False}
 96
 97
 98class CollateProperty(Property):
 99    arg_types = {"this": True, "default": False}
100
101
102class ComputeProperty(Property):
103    arg_types = {}
104
105
106class CopyGrantsProperty(Property):
107    arg_types = {}
108
109
110class CopyTagsProperty(Property):
111    arg_types = {}
112
113
114class DataBlocksizeProperty(Property):
115    arg_types = {
116        "size": False,
117        "units": False,
118        "minimum": False,
119        "maximum": False,
120        "default": False,
121    }
122
123
124class DataDeletionProperty(Property):
125    arg_types = {"on": True, "filter_column": False, "retention_period": False}
126
127
128class DatabaseProperty(Property):
129    arg_types = {}
130
131
132class DefinerProperty(Property):
133    arg_types = {"this": True}
134    _hash_raw_args = True
135
136
137class DistKeyProperty(Property):
138    arg_types = {"this": True}
139
140
141class DistributedByProperty(Property):
142    arg_types = {"expressions": False, "kind": True, "buckets": False, "order": False}
143
144
145class DistStyleProperty(Property):
146    arg_types = {"this": True}
147
148
149class DuplicateKeyProperty(Property):
150    arg_types = {"expressions": True}
151
152
153class EngineProperty(Property):
154    arg_types = {"this": True}
155
156
157class UuidProperty(Property):
158    arg_types = {"this": True}
159
160
161class HeapProperty(Property):
162    arg_types = {}
163
164
165class HybridProperty(Property):
166    arg_types = {}
167
168
169class HandlerProperty(Property):
170    arg_types = {"this": True}
171
172
173class ParameterStyleProperty(Property):
174    arg_types = {"this": True}
175
176
177class ToTableProperty(Property):
178    arg_types = {"this": True}
179
180
181class ExecuteAsProperty(Property):
182    arg_types = {"this": True}
183
184
185class ExternalProperty(Property):
186    arg_types = {"this": False}
187
188
189class FallbackProperty(Property):
190    arg_types = {"no": True, "protection": False}
191
192
193class FileFormatProperty(Property):
194    arg_types = {"this": False, "expressions": False, "hive_format": False}
195
196
197class CredentialsProperty(Property):
198    arg_types = {"expressions": True}
199
200
201class FreespaceProperty(Property):
202    arg_types = {"this": True, "percent": False}
203
204
205class GlobalProperty(Property):
206    arg_types = {}
207
208
209class IcebergProperty(Property):
210    arg_types = {}
211
212
213class IgnoreGrantsProperty(Property):
214    arg_types = {}
215
216
217class InheritsProperty(Property):
218    arg_types = {"expressions": True}
219
220
221class InputModelProperty(Property):
222    arg_types = {"this": True}
223
224
225class OutputModelProperty(Property):
226    arg_types = {"this": True}
227
228
229class InteractiveProperty(Property):
230    arg_types = {}
231
232
233class IsolatedLoadingProperty(Property):
234    arg_types = {"no": False, "concurrent": False, "target": False}
235
236
237class JournalProperty(Property):
238    arg_types = {
239        "no": False,
240        "dual": False,
241        "before": False,
242        "local": False,
243        "after": False,
244    }
245
246
247class LanguageProperty(Property):
248    arg_types = {"this": True}
249
250
251class EnviromentProperty(Property):
252    arg_types = {"expressions": True}
253
254
255class ClusteredByProperty(Property):
256    arg_types = {"expressions": True, "sorted_by": False, "buckets": True}
257
258
259class DictProperty(Property):
260    arg_types = {"this": True, "kind": True, "settings": False}
261
262
263class DictSubProperty(Property):
264    pass
265
266
267class DictRange(Property):
268    arg_types = {"this": True, "min": True, "max": True}
269
270
271class DynamicProperty(Property):
272    arg_types = {}
273
274
275class OnCluster(Property):
276    arg_types = {"this": True}
277
278
279class EmptyProperty(Property):
280    arg_types = {}
281
282
283class LikeProperty(Property):
284    arg_types = {"this": True, "expressions": False}
285
286
287class LocationProperty(Property):
288    arg_types = {"this": True}
289
290
291class LockProperty(Property):
292    arg_types = {"this": True}
293
294
295class LockingProperty(Property):
296    arg_types = {
297        "this": False,
298        "kind": True,
299        "for_or_in": False,
300        "lock_type": True,
301        "override": False,
302    }
303
304
305class LogProperty(Property):
306    arg_types = {"no": True}
307
308
309class MaskingProperty(Property):
310    arg_types = {}
311
312
313class MaterializedProperty(Property):
314    arg_types = {"this": False}
315
316
317class MergeBlockRatioProperty(Property):
318    arg_types = {"this": False, "no": False, "default": False, "percent": False}
319
320
321class ModuleProperty(Property):
322    arg_types = {"this": True, "expressions": False}
323
324
325class NetworkProperty(Property):
326    arg_types = {}
327
328
329class NoPrimaryIndexProperty(Property):
330    arg_types = {}
331
332
333class OnProperty(Property):
334    arg_types = {"this": True}
335
336
337class OnCommitProperty(Property):
338    arg_types = {"delete": False}
339
340
341class OptionsProperty(Property):
342    arg_types = {"expressions": True}
343
344
345class PartitionedByProperty(Property):
346    arg_types = {"this": True}
347
348
349class PartitionedByBucket(Property):
350    arg_types = {"this": True, "expression": True}
351
352
353class PartitionByTruncate(Property):
354    arg_types = {"this": True, "expression": True}
355
356
357class PartitionByRangeProperty(Property):
358    arg_types = {"partition_expressions": True, "create_expressions": True}
359
360
361class PartitionByRangePropertyDynamic(Expression):
362    arg_types = {"this": False, "start": True, "end": True, "every": True}
363
364
365class RollupProperty(Property):
366    arg_types = {"expressions": True}
367
368
369class RollupIndex(Expression):
370    arg_types = {"this": True, "expressions": True, "from_index": False, "properties": False}
371
372
373class RowAccessProperty(Property):
374    arg_types = {"this": False, "expressions": False}
375
376
377class PartitionByListProperty(Property):
378    arg_types = {"partition_expressions": True, "create_expressions": True}
379
380
381class PartitionList(Expression):
382    arg_types = {"this": True, "expressions": True}
383
384
385class RefreshTriggerProperty(Property):
386    arg_types = {
387        "method": False,
388        "kind": False,
389        "every": False,
390        "unit": False,
391        "starts": False,
392    }
393
394
395class UniqueKeyProperty(Property):
396    arg_types = {"expressions": True}
397
398
399class PartitionBoundSpec(Expression):
400    # this -> IN / MODULUS, expression -> REMAINDER, from_expressions -> FROM (...), to_expressions -> TO (...)
401    arg_types = {
402        "this": False,
403        "expression": False,
404        "from_expressions": False,
405        "to_expressions": False,
406    }
407
408
409class PartitionedOfProperty(Property):
410    # this -> parent_table (schema), expression -> FOR VALUES ... / DEFAULT
411    arg_types = {"this": True, "expression": True}
412
413
414class PhysicalProperty(Property):
415    arg_types = {"this": True, "value": False}
416
417
418class StreamingTableProperty(Property):
419    arg_types = {}
420
421
422class RemoteWithConnectionModelProperty(Property):
423    arg_types = {"this": True}
424
425
426class ReturnsProperty(Property):
427    arg_types = {"this": False, "is_table": False, "table": False, "null": False}
428
429
430class StrictProperty(Property):
431    arg_types = {}
432
433
434class WithoutRowidProperty(Property):
435    arg_types = {}
436
437
438class RowFormatProperty(Property):
439    arg_types = {"this": True}
440
441
442class RowFormatDelimitedProperty(Property):
443    # https://cwiki.apache.org/confluence/display/hive/languagemanual+dml
444    arg_types = {
445        "fields": False,
446        "escaped": False,
447        "collection_items": False,
448        "map_keys": False,
449        "lines": False,
450        "null": False,
451        "serde": False,
452    }
453
454
455class RowFormatSerdeProperty(Property):
456    arg_types = {"this": True, "serde_properties": False}
457
458
459class QueryTransform(Expression):
460    arg_types = {
461        "expressions": True,
462        "command_script": True,
463        "schema": False,
464        "row_format_before": False,
465        "record_writer": False,
466        "row_format_after": False,
467        "record_reader": False,
468    }
469
470
471class SampleProperty(Property):
472    arg_types = {"this": True}
473
474
475class SchemaCommentProperty(Property):
476    arg_types = {"this": True}
477
478
479class SemanticView(Expression):
480    arg_types = {
481        "this": True,
482        "metrics": False,
483        "dimensions": False,
484        "facts": False,
485        "where": False,
486    }
487
488
489class SerdeProperties(Property):
490    arg_types = {"expressions": True, "with_": False}
491
492
493class SetProperty(Property):
494    arg_types = {"multi": True}
495
496
497class SharingProperty(Property):
498    arg_types = {"this": False}
499
500
501class SetConfigProperty(Property):
502    arg_types = {"this": True}
503
504
505class SettingsProperty(Property):
506    arg_types = {"expressions": True}
507
508
509class SortKeyProperty(Property):
510    arg_types = {"this": True, "compound": False}
511
512
513class SqlReadWriteProperty(Property):
514    arg_types = {"this": True}
515
516
517class SqlSecurityProperty(Property):
518    arg_types = {"this": True}
519
520
521class StabilityProperty(Property):
522    arg_types = {"this": True}
523
524
525class StorageHandlerProperty(Property):
526    arg_types = {"this": True}
527
528
529class StorageProperty(Property):
530    arg_types = {"expressions": True}
531
532
533class UsingProperty(Property):
534    # kind: JAR, FILE, or ARCHIVE; this: the resource path (string literal)
535    arg_types = {"this": True, "kind": True}
536
537
538class TemporaryProperty(Property):
539    arg_types = {"this": False, "scoped": False}
540
541
542class VirtualProperty(Property):
543    arg_types = {}
544
545
546class SecureProperty(Property):
547    arg_types = {}
548
549
550class SecurityIntegrationProperty(Property):
551    arg_types = {}
552
553
554class Tags(Property, ColumnConstraintKind):
555    arg_types = {"expressions": True}
556
557
558class TableSpaceProperty(Property):
559    arg_types = {"this": True}
560
561
562class PropertiesLocation(AutoName):
563    POST_CREATE = auto()
564    POST_NAME = auto()
565    POST_SCHEMA = auto()
566    POST_WITH = auto()
567    POST_ALIAS = auto()
568    POST_EXPRESSION = auto()
569    POST_INDEX = auto()
570    UNSUPPORTED = auto()
571
572
573class TransformModelProperty(Property):
574    arg_types = {"expressions": True}
575
576
577class TransientProperty(Property):
578    arg_types = {"this": False}
579
580
581class UnloggedProperty(Property):
582    arg_types = {}
583
584
585class UsingTemplateProperty(Property):
586    arg_types = {"this": True}
587
588
589class ViewAttributeProperty(Property):
590    arg_types = {"this": True}
591
592
593class VolatileProperty(Property):
594    arg_types = {"this": False}
595
596
597class WithDataProperty(Property):
598    arg_types = {"no": True, "statistics": False}
599
600
601class WithJournalTableProperty(Property):
602    arg_types = {"this": True}
603
604
605class WithSchemaBindingProperty(Property):
606    arg_types = {"this": True}
607
608
609class WithSystemVersioningProperty(Property):
610    arg_types = {
611        "on": False,
612        "this": False,
613        "data_consistency": False,
614        "retention_period": False,
615        "with_": True,
616    }
617
618
619class WithProcedureOptions(Property):
620    arg_types = {"expressions": True}
621
622
623class EncodeProperty(Property):
624    arg_types = {"this": True, "properties": False, "key": False}
625
626
627class IncludeProperty(Property):
628    arg_types = {"this": True, "alias": False, "column_def": False}
629
630
631class ForceProperty(Property):
632    arg_types = {}
633
634
635class Properties(Expression):
636    arg_types = {"expressions": True}
637
638    NAME_TO_PROPERTY: t.ClassVar[dict[str, type[Property]]] = {
639        "ALGORITHM": AlgorithmProperty,
640        "AUTO_INCREMENT": AutoIncrementProperty,
641        "CHARACTER SET": CharacterSetProperty,
642        "CLUSTERED_BY": ClusteredByProperty,
643        "COLLATE": CollateProperty,
644        "COMMENT": SchemaCommentProperty,
645        "CREDENTIALS": CredentialsProperty,
646        "DEFINER": DefinerProperty,
647        "DISTKEY": DistKeyProperty,
648        "DISTRIBUTED_BY": DistributedByProperty,
649        "DISTSTYLE": DistStyleProperty,
650        "ENGINE": EngineProperty,
651        "EXECUTE AS": ExecuteAsProperty,
652        "FORMAT": FileFormatProperty,
653        "LANGUAGE": LanguageProperty,
654        "LOCATION": LocationProperty,
655        "LOCK": LockProperty,
656        "PARTITIONED_BY": PartitionedByProperty,
657        "RETURNS": ReturnsProperty,
658        "ROW_FORMAT": RowFormatProperty,
659        "SORTKEY": SortKeyProperty,
660        "ENCODE": EncodeProperty,
661        "INCLUDE": IncludeProperty,
662    }
663
664    PROPERTY_TO_NAME: t.ClassVar[dict[type[Property], str]] = {
665        v: k for k, v in NAME_TO_PROPERTY.items()
666    }
667
668    # CREATE property locations
669    # Form: schema specified
670    #   create [POST_CREATE]
671    #     table a [POST_NAME]
672    #     (b int) [POST_SCHEMA]
673    #     with ([POST_WITH])
674    #     index (b) [POST_INDEX]
675    #
676    # Form: alias selection
677    #   create [POST_CREATE]
678    #     table a [POST_NAME]
679    #     as [POST_ALIAS] (select * from b) [POST_EXPRESSION]
680    #     index (c) [POST_INDEX]
681    Location: t.ClassVar[type[PropertiesLocation]] = PropertiesLocation
682
683    @classmethod
684    def from_dict(cls, properties_dict: dict) -> Properties:
685        expressions = []
686        for key, value in properties_dict.items():
687            property_cls = cls.NAME_TO_PROPERTY.get(key.upper())
688            if property_cls:
689                expressions.append(property_cls(this=convert(value)))
690            else:
691                expressions.append(Property(this=Literal.string(key), value=convert(value)))
692
693        return cls(expressions=expressions)