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