1"""sqlglot expressions DDL."""
  2
  3from __future__ import annotations
  4
  5import typing as t
  6
  7from sqlglot.helper import trait
  8from sqlglot.expressions.core import Expression, Expr, Func
  9from sqlglot.expressions.query import Query, Selectable
 10
 11if t.TYPE_CHECKING:
 12    from sqlglot.expressions.query import CTE
 13
 14
 15@trait
 16class DDL(Selectable):
 17    @property
 18    def ctes(self) -> list[CTE]:
 19        """Returns a list of all the CTEs attached to this statement."""
 20        with_ = self.args.get("with_")
 21        return with_.expressions if with_ else []
 22
 23    @property
 24    def selects(self) -> list[Expr]:
 25        """If this statement contains a query (e.g. a CTAS), this returns the query's projections."""
 26        expression = self.expression
 27        return expression.selects if isinstance(expression, Query) else []
 28
 29    @property
 30    def named_selects(self) -> list[str]:
 31        """
 32        If this statement contains a query (e.g. a CTAS), this returns the output
 33        names of the query's projections.
 34        """
 35        expression = self.expression
 36        return expression.named_selects if isinstance(expression, Query) else []
 37
 38
 39class Create(Expression, DDL):
 40    arg_types = {
 41        "with_": False,
 42        "this": True,
 43        "kind": True,
 44        "expression": False,
 45        "exists": False,
 46        "properties": False,
 47        "replace": False,
 48        "refresh": False,
 49        "unique": False,
 50        "indexes": False,
 51        "no_schema_binding": False,
 52        "begin": False,
 53        "clone": False,
 54        "concurrently": False,
 55        "clustered": False,
 56    }
 57
 58    @property
 59    def kind(self) -> str | None:
 60        kind = self.args.get("kind")
 61        return kind and kind.upper()
 62
 63
 64class SequenceProperties(Expression):
 65    arg_types = {
 66        "increment": False,
 67        "minvalue": False,
 68        "maxvalue": False,
 69        "cache": False,
 70        "start": False,
 71        "owned": False,
 72        "options": False,
 73    }
 74
 75
 76class TriggerProperties(Expression):
 77    arg_types = {
 78        "table": True,
 79        "timing": True,
 80        "events": True,
 81        "execute": True,
 82        "constraint": False,
 83        "referenced_table": False,
 84        "deferrable": False,
 85        "initially": False,
 86        "referencing": False,
 87        "for_each": False,
 88        "when": False,
 89    }
 90
 91
 92class TriggerExecute(Expression):
 93    pass
 94
 95
 96class TriggerEvent(Expression):
 97    arg_types = {"this": True, "columns": False}
 98
 99
100class TriggerReferencing(Expression):
101    arg_types = {"old": False, "new": False}
102
103
104class TruncateTable(Expression):
105    arg_types = {
106        "expressions": True,
107        "is_database": False,
108        "exists": False,
109        "only": False,
110        "cluster": False,
111        "identity": False,
112        "option": False,
113        "partition": False,
114    }
115
116
117class Clone(Expression):
118    arg_types = {"this": True, "shallow": False, "copy": False}
119
120
121class Describe(Expression):
122    arg_types = {
123        "this": True,
124        "style": False,
125        "kind": False,
126        "properties": False,
127        "expressions": False,
128        "partition": False,
129        "format": False,
130        "as_json": False,
131    }
132
133
134class ConnectTo(Expression):
135    pass
136
137
138class Disconnect(Expression):
139    arg_types = {}
140
141
142class Attach(Expression):
143    arg_types = {"this": True, "exists": False, "expressions": False}
144
145
146class Detach(Expression):
147    arg_types = {
148        "this": True,
149        "kind": False,
150        "exists": False,
151        "cluster": False,
152        "permanent": False,
153        "sync": False,
154    }
155
156
157class Install(Expression):
158    arg_types = {"this": True, "from_": False, "force": False}
159
160
161class Summarize(Expression):
162    arg_types = {"this": True, "table": False}
163
164
165class Kill(Expression):
166    arg_types = {"this": True, "kind": False}
167
168
169class Pragma(Expression):
170    pass
171
172
173class Declare(Expression):
174    arg_types = {"expressions": True, "replace": False}
175
176
177class DeclareItem(Expression):
178    arg_types = {"this": True, "kind": False, "default": False}
179
180
181class Set(Expression):
182    arg_types = {"expressions": False, "unset": False, "tag": False}
183
184
185class Heredoc(Expression):
186    arg_types = {"this": True, "tag": False}
187    _hash_raw_args = True
188
189
190class SetItem(Expression):
191    arg_types = {
192        "this": False,
193        "expressions": False,
194        "kind": False,
195        "collate": False,  # MySQL SET NAMES statement
196        "global_": False,
197    }
198
199
200class Show(Expression):
201    arg_types = {
202        "this": True,
203        "history": False,
204        "terse": False,
205        "target": False,
206        "offset": False,
207        "starts_with": False,
208        "limit": False,
209        "from_": False,
210        "like": False,
211        "where": False,
212        "db": False,
213        "scope": False,
214        "scope_kind": False,
215        "full": False,
216        "mutex": False,
217        "query": False,
218        "channel": False,
219        "global_": False,
220        "log": False,
221        "position": False,
222        "types": False,
223        "privileges": False,
224        "for_table": False,
225        "for_group": False,
226        "for_user": False,
227        "for_role": False,
228        "into_outfile": False,
229        "json": False,
230        "iceberg": False,
231    }
232
233
234class UserDefinedFunction(Expression):
235    arg_types = {"this": True, "expressions": False, "wrapped": False}
236
237
238class MacroOverloads(Expression):
239    arg_types = {"expressions": True}
240
241
242class MacroOverload(Expression):
243    arg_types = {"this": True, "expressions": False, "is_table": False}
244
245
246class CharacterSet(Expression):
247    arg_types = {"this": True, "default": False}
248
249
250class AlterColumn(Expression):
251    arg_types = {
252        "this": True,
253        "dtype": False,
254        "collate": False,
255        "using": False,
256        "default": False,
257        "drop": False,
258        "comment": False,
259        "allow_null": False,
260        "visible": False,
261        "rename_to": False,
262        "exists": False,
263    }
264
265
266class ModifyColumn(Expression):
267    arg_types = {"this": True, "rename_from": False}
268
269
270class AlterIndex(Expression):
271    arg_types = {"this": True, "visible": True}
272
273
274class AlterDistStyle(Expression):
275    pass
276
277
278class AlterSortKey(Expression):
279    arg_types = {"this": False, "expressions": False, "compound": False}
280
281
282class AlterSet(Expression):
283    arg_types = {
284        "expressions": False,
285        "option": False,
286        "tablespace": False,
287        "access_method": False,
288        "file_format": False,
289        "copy_options": False,
290        "tag": False,
291        "location": False,
292        "serde": False,
293    }
294
295
296class RenameColumn(Expression):
297    arg_types = {"this": True, "to": True, "exists": False}
298
299
300class AlterRename(Expression):
301    pass
302
303
304class RenameIndex(Expression):
305    arg_types = {"this": True, "to": True}
306
307
308class AlterModifySqlSecurity(Expression):
309    arg_types = {"expressions": True}
310
311
312class SwapTable(Expression):
313    pass
314
315
316class Comment(Expression):
317    arg_types = {
318        "this": True,
319        "kind": True,
320        "expression": True,
321        "exists": False,
322        "materialized": False,
323    }
324
325
326class Comprehension(Expression):
327    arg_types = {
328        "this": True,
329        "expression": True,
330        "position": False,
331        "iterator": True,
332        "condition": False,
333    }
334
335
336class MergeTreeTTLAction(Expression):
337    arg_types = {
338        "this": True,
339        "delete": False,
340        "recompress": False,
341        "to_disk": False,
342        "to_volume": False,
343    }
344
345
346class MergeTreeTTL(Expression):
347    arg_types = {
348        "expressions": True,
349        "where": False,
350        "group": False,
351        "aggregates": False,
352    }
353
354
355class Drop(Expression):
356    arg_types = {
357        "kind": False,
358        "tables": False,
359        "expressions": False,
360        "exists": False,
361        "temporary": False,
362        "materialized": False,
363        "cascade": False,
364        "restrict": False,
365        "constraints": False,
366        "purge": False,
367        "cluster": False,
368        "concurrently": False,
369        "sync": False,
370        "iceberg": False,
371        "force": False,
372    }
373
374    @property
375    def kind(self) -> str | None:
376        kind = self.args.get("kind")
377        return kind and kind.upper()
378
379
380class DropPrimaryKey(Expression):
381    arg_types = {}
382
383
384class Undrop(Expression):
385    arg_types = {"this": True, "kind": True, "rename": False}
386
387    @property
388    def kind(self) -> str:
389        return self.args["kind"].upper()
390
391
392class Command(Expression):
393    arg_types = {"this": True, "expression": False}
394    _hash_raw_args = True
395
396
397class Transaction(Expression):
398    arg_types = {"this": False, "modes": False, "mark": False}
399
400
401class Commit(Expression):
402    arg_types = {"chain": False, "this": False, "durability": False}
403
404
405class Rollback(Expression):
406    arg_types = {"savepoint": False, "this": False}
407
408
409class Alter(Expression):
410    arg_types = {
411        "this": False,
412        "kind": True,
413        "actions": False,
414        "exists": False,
415        "only": False,
416        "options": False,
417        "cluster": False,
418        "not_valid": False,
419        "check": False,
420        "cascade": False,
421        "iceberg": False,
422    }
423
424    @property
425    def kind(self) -> str | None:
426        kind = self.args.get("kind")
427        return kind and kind.upper()
428
429    @property
430    def actions(self) -> list[Expr]:
431        return self.args.get("actions") or []
432
433
434class AlterSession(Expression):
435    arg_types = {"expressions": True, "unset": False}
436
437
438class Use(Expression):
439    arg_types = {"this": False, "expressions": False, "kind": False}
440
441
442class NextValueFor(Expression, Func):
443    arg_types = {"this": True, "order": False}
444
445
446class Execute(Expression):
447    arg_types = {"this": True, "expressions": False, "return_status": False}
448
449    @property
450    def name(self) -> str:
451        return self.this.name
452
453
454class ExecuteSql(Execute):
455    pass