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