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 PeriodForSystemTimeConstraint(Expression, ColumnConstraintKind):
 45    arg_types = {"this": True, "expression": True}
 46
 47
 48class CaseSpecificColumnConstraint(Expression, ColumnConstraintKind):
 49    arg_types = {"not_": True}
 50
 51
 52class CharacterSetColumnConstraint(Expression, ColumnConstraintKind):
 53    pass
 54
 55
 56class CheckColumnConstraint(Expression, ColumnConstraintKind):
 57    arg_types = {"this": True, "enforced": False}
 58
 59
 60class AssumeColumnConstraint(Expression, ColumnConstraintKind):
 61    pass
 62
 63
 64class ClusteredColumnConstraint(Expression, ColumnConstraintKind):
 65    pass
 66
 67
 68class CollateColumnConstraint(Expression, ColumnConstraintKind):
 69    pass
 70
 71
 72class CommentColumnConstraint(Expression, ColumnConstraintKind):
 73    pass
 74
 75
 76class CompressColumnConstraint(Expression, ColumnConstraintKind):
 77    arg_types = {"this": False}
 78
 79
 80class DateFormatColumnConstraint(Expression, ColumnConstraintKind):
 81    pass
 82
 83
 84class DefaultColumnConstraint(Expression, ColumnConstraintKind):
 85    pass
 86
 87
 88class EncodeColumnConstraint(Expression, ColumnConstraintKind):
 89    pass
 90
 91
 92class ExcludeColumnConstraint(Expression, ColumnConstraintKind):
 93    pass
 94
 95
 96class EphemeralColumnConstraint(Expression, ColumnConstraintKind):
 97    arg_types = {"this": False}
 98
 99
100class WithOperator(Expression):
101    arg_types = {"this": True, "op": True}
102
103
104class GeneratedAsIdentityColumnConstraint(Expression, ColumnConstraintKind):
105    # this: True -> ALWAYS, this: False -> BY DEFAULT
106    arg_types = {
107        "this": False,
108        "expression": False,
109        "on_null": False,
110        "start": False,
111        "increment": False,
112        "minvalue": False,
113        "maxvalue": False,
114        "cycle": False,
115        "order": False,
116    }
117
118
119class GeneratedAsRowColumnConstraint(Expression, ColumnConstraintKind):
120    arg_types = {"start": False, "hidden": False}
121
122
123class IndexColumnConstraint(Expression, ColumnConstraintKind):
124    arg_types = {
125        "this": False,
126        "expressions": False,
127        "kind": False,
128        "index_type": False,
129        "options": False,
130        "expression": False,  # Clickhouse
131        "granularity": False,
132    }
133
134
135class InlineLengthColumnConstraint(Expression, ColumnConstraintKind):
136    pass
137
138
139class NonClusteredColumnConstraint(Expression, ColumnConstraintKind):
140    pass
141
142
143class NotForReplicationColumnConstraint(Expression, ColumnConstraintKind):
144    arg_types = {}
145
146
147class MaskingPolicyColumnConstraint(Expression, ColumnConstraintKind):
148    arg_types = {"this": True, "expressions": False}
149
150
151class NotNullColumnConstraint(Expression, ColumnConstraintKind):
152    arg_types = {"allow_null": False}
153
154
155class OnUpdateColumnConstraint(Expression, ColumnConstraintKind):
156    pass
157
158
159class PrimaryKeyColumnConstraint(Expression, ColumnConstraintKind):
160    arg_types = {"desc": False, "options": False}
161
162
163class TitleColumnConstraint(Expression, ColumnConstraintKind):
164    pass
165
166
167class UniqueColumnConstraint(Expression, ColumnConstraintKind):
168    arg_types = {
169        "this": False,
170        "index_type": False,
171        "on_conflict": False,
172        "nulls": False,
173        "options": False,
174    }
175
176
177class UppercaseColumnConstraint(Expression, ColumnConstraintKind):
178    arg_types = {}
179
180
181class WatermarkColumnConstraint(Expression):
182    arg_types = {"this": True, "expression": True}
183
184
185class PathColumnConstraint(Expression, ColumnConstraintKind):
186    pass
187
188
189class ProjectionPolicyColumnConstraint(Expression, ColumnConstraintKind):
190    pass
191
192
193class ComputedColumnConstraint(Expression, ColumnConstraintKind):
194    arg_types = {"this": True, "persisted": False, "not_null": False, "data_type": False}
195
196
197class InOutColumnConstraint(Expression, ColumnConstraintKind):
198    arg_types = {"input_": False, "output": False, "variadic": False}
199
200
201class Constraint(Expression):
202    arg_types = {"this": True, "expressions": True}
203
204
205class ForeignKey(Expression):
206    arg_types = {
207        "expressions": False,
208        "reference": False,
209        "delete": False,
210        "update": False,
211        "options": False,
212    }
213
214
215class ColumnPrefix(Expression):
216    arg_types = {"this": True, "expression": True}
217
218
219class PrimaryKey(Expression):
220    arg_types = {"this": False, "expressions": True, "options": False, "include": False}
221
222
223class IndexParameters(Expression):
224    arg_types = {
225        "using": False,
226        "include": False,
227        "columns": False,
228        "with_storage": False,
229        "partition_by": False,
230        "tablespace": False,
231        "where": False,
232        "on": False,
233    }
234
235
236class AddConstraint(Expression):
237    arg_types = {"expressions": True}