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