1"""sqlglot expressions constraints."""
  2
  3from __future__ import annotations
  4
  5from sqlglot.expressions.core import Expression, ColumnConstraintKind
  6
  7
  8class IndexConstraintOption(Expression):
  9    arg_types = {
 10        "key_block_size": False,
 11        "using": False,
 12        "parser": False,
 13        "comment": False,
 14        "visible": False,
 15        "engine_attr": False,
 16        "secondary_engine_attr": False,
 17    }
 18
 19
 20class Reference(Expression):
 21    arg_types = {"this": True, "expressions": False, "options": False}
 22
 23
 24class ColumnConstraint(Expression):
 25    arg_types = {"this": False, "kind": True}
 26
 27    @property
 28    def kind(self) -> ColumnConstraintKind | Reference:
 29        return self.args["kind"]
 30
 31
 32class AutoIncrementColumnConstraint(Expression, ColumnConstraintKind):
 33    pass
 34
 35
 36class InvisibleColumnConstraint(Expression, ColumnConstraintKind):
 37    arg_types = {}
 38
 39
 40class ZeroFillColumnConstraint(ColumnConstraint):
 41    arg_types = {}
 42
 43
 44class BinaryColumnConstraint(ColumnConstraint):
 45    arg_types = {}
 46
 47
 48class PeriodForSystemTimeConstraint(Expression, ColumnConstraintKind):
 49    arg_types = {"this": True, "expression": True}
 50
 51
 52class CaseSpecificColumnConstraint(Expression, ColumnConstraintKind):
 53    arg_types = {"not_": True}
 54
 55
 56class CharacterSetColumnConstraint(Expression, ColumnConstraintKind):
 57    pass
 58
 59
 60class CheckColumnConstraint(Expression, ColumnConstraintKind):
 61    arg_types = {"this": True, "enforced": False}
 62
 63
 64class AssumeColumnConstraint(Expression, ColumnConstraintKind):
 65    pass
 66
 67
 68class ClusteredColumnConstraint(Expression, ColumnConstraintKind):
 69    pass
 70
 71
 72class CollateColumnConstraint(Expression, ColumnConstraintKind):
 73    pass
 74
 75
 76class CommentColumnConstraint(Expression, ColumnConstraintKind):
 77    pass
 78
 79
 80class CompressColumnConstraint(Expression, ColumnConstraintKind):
 81    arg_types = {"this": False}
 82
 83
 84class DateFormatColumnConstraint(Expression, ColumnConstraintKind):
 85    pass
 86
 87
 88class DefaultColumnConstraint(Expression, ColumnConstraintKind):
 89    pass
 90
 91
 92class EncodeColumnConstraint(Expression, ColumnConstraintKind):
 93    pass
 94
 95
 96class ExcludeColumnConstraint(Expression, ColumnConstraintKind):
 97    pass
 98
 99
100class EphemeralColumnConstraint(Expression, ColumnConstraintKind):
101    arg_types = {"this": False}
102
103
104class WithOperator(Expression):
105    arg_types = {"this": True, "op": True}
106
107
108class GeneratedAsIdentityColumnConstraint(Expression, ColumnConstraintKind):
109    # this: True -> ALWAYS, this: False -> BY DEFAULT
110    arg_types = {
111        "this": False,
112        "expression": False,
113        "on_null": False,
114        "start": False,
115        "increment": False,
116        "minvalue": False,
117        "maxvalue": False,
118        "cycle": False,
119        "order": False,
120    }
121
122
123class GeneratedAsRowColumnConstraint(Expression, ColumnConstraintKind):
124    arg_types = {"start": False, "hidden": False}
125
126
127class IndexColumnConstraint(Expression, ColumnConstraintKind):
128    arg_types = {
129        "this": False,
130        "expressions": False,
131        "kind": False,
132        "index_type": False,
133        "options": False,
134        "expression": False,  # Clickhouse
135        "granularity": False,
136    }
137
138
139class InlineLengthColumnConstraint(Expression, ColumnConstraintKind):
140    pass
141
142
143class NonClusteredColumnConstraint(Expression, ColumnConstraintKind):
144    pass
145
146
147class NotForReplicationColumnConstraint(Expression, ColumnConstraintKind):
148    arg_types = {}
149
150
151class MaskingPolicyColumnConstraint(Expression, ColumnConstraintKind):
152    arg_types = {"this": True, "expressions": False}
153
154
155class NotNullColumnConstraint(Expression, ColumnConstraintKind):
156    arg_types = {"allow_null": False}
157
158
159class OnUpdateColumnConstraint(Expression, ColumnConstraintKind):
160    pass
161
162
163class PrimaryKeyColumnConstraint(Expression, ColumnConstraintKind):
164    arg_types = {"desc": False, "options": False}
165
166
167class TitleColumnConstraint(Expression, ColumnConstraintKind):
168    pass
169
170
171class UniqueColumnConstraint(Expression, ColumnConstraintKind):
172    arg_types = {
173        "this": False,
174        "index_type": False,
175        "on_conflict": False,
176        "nulls": False,
177        "options": False,
178    }
179
180
181class UppercaseColumnConstraint(Expression, ColumnConstraintKind):
182    arg_types = {}
183
184
185class WatermarkColumnConstraint(Expression):
186    arg_types = {"this": True, "expression": True}
187
188
189class PathColumnConstraint(Expression, ColumnConstraintKind):
190    pass
191
192
193class ProjectionPolicyColumnConstraint(Expression, ColumnConstraintKind):
194    pass
195
196
197class ComputedColumnConstraint(Expression, ColumnConstraintKind):
198    arg_types = {"this": True, "persisted": False, "not_null": False, "data_type": False}
199
200
201class InOutColumnConstraint(Expression, ColumnConstraintKind):
202    arg_types = {"input_": False, "output": False, "variadic": False}
203
204
205class Constraint(Expression):
206    arg_types = {"this": True, "expressions": True}
207
208
209class ForeignKey(Expression):
210    arg_types = {
211        "expressions": False,
212        "reference": False,
213        "delete": False,
214        "update": False,
215        "options": False,
216    }
217
218
219class ColumnPrefix(Expression):
220    arg_types = {"this": True, "expression": True}
221
222
223class PrimaryKey(Expression):
224    arg_types = {"this": False, "expressions": True, "options": False, "include": False}
225
226
227# https://docs.databricks.com/aws/en/sql/language-manual/sql-ref-syntax-ddl-create-table-constraint
228class TimeseriesKey(Expression):
229    pass
230
231
232class IndexParameters(Expression):
233    arg_types = {
234        "using": False,
235        "include": False,
236        "columns": False,
237        "with_storage": False,
238        "partition_by": False,
239        "tablespace": False,
240        "where": False,
241        "on": False,
242    }
243
244
245class AddConstraint(Expression):
246    arg_types = {"expressions": True}