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