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 Attach(Expression):
135    arg_types = {"this": True, "exists": False, "expressions": False}
136
137
138class Detach(Expression):
139    arg_types = {
140        "this": True,
141        "kind": False,
142        "exists": False,
143        "cluster": False,
144        "permanent": False,
145        "sync": False,
146    }
147
148
149class Install(Expression):
150    arg_types = {"this": True, "from_": False, "force": False}
151
152
153class Summarize(Expression):
154    arg_types = {"this": True, "table": False}
155
156
157class Kill(Expression):
158    arg_types = {"this": True, "kind": False}
159
160
161class Pragma(Expression):
162    pass
163
164
165class Declare(Expression):
166    arg_types = {"expressions": True, "replace": False}
167
168
169class DeclareItem(Expression):
170    arg_types = {"this": True, "kind": False, "default": False}
171
172
173class Set(Expression):
174    arg_types = {"expressions": False, "unset": False, "tag": False}
175
176
177class Heredoc(Expression):
178    arg_types = {"this": True, "tag": False}
179    _hash_raw_args = True
180
181
182class SetItem(Expression):
183    arg_types = {
184        "this": False,
185        "expressions": False,
186        "kind": False,
187        "collate": False,  # MySQL SET NAMES statement
188        "global_": False,
189    }
190
191
192class Show(Expression):
193    arg_types = {
194        "this": True,
195        "history": False,
196        "terse": False,
197        "target": False,
198        "offset": False,
199        "starts_with": False,
200        "limit": False,
201        "from_": False,
202        "like": False,
203        "where": False,
204        "db": False,
205        "scope": False,
206        "scope_kind": False,
207        "full": False,
208        "mutex": False,
209        "query": False,
210        "channel": False,
211        "global_": False,
212        "log": False,
213        "position": False,
214        "types": False,
215        "privileges": False,
216        "for_table": False,
217        "for_group": False,
218        "for_user": False,
219        "for_role": False,
220        "into_outfile": False,
221        "json": False,
222        "iceberg": False,
223    }
224
225
226class UserDefinedFunction(Expression):
227    arg_types = {"this": True, "expressions": False, "wrapped": False}
228
229
230class MacroOverloads(Expression):
231    arg_types = {"expressions": True}
232
233
234class MacroOverload(Expression):
235    arg_types = {"this": True, "expressions": False, "is_table": False}
236
237
238class CharacterSet(Expression):
239    arg_types = {"this": True, "default": False}
240
241
242class AlterColumn(Expression):
243    arg_types = {
244        "this": True,
245        "dtype": False,
246        "collate": False,
247        "using": False,
248        "default": False,
249        "drop": False,
250        "comment": False,
251        "allow_null": False,
252        "visible": False,
253        "rename_to": False,
254        "exists": False,
255    }
256
257
258class ModifyColumn(Expression):
259    arg_types = {"this": True, "rename_from": False}
260
261
262class AlterIndex(Expression):
263    arg_types = {"this": True, "visible": True}
264
265
266class AlterDistStyle(Expression):
267    pass
268
269
270class AlterSortKey(Expression):
271    arg_types = {"this": False, "expressions": False, "compound": False}
272
273
274class AlterSet(Expression):
275    arg_types = {
276        "expressions": False,
277        "option": False,
278        "tablespace": False,
279        "access_method": False,
280        "file_format": False,
281        "copy_options": False,
282        "tag": False,
283        "location": False,
284        "serde": False,
285    }
286
287
288class RenameColumn(Expression):
289    arg_types = {"this": True, "to": True, "exists": False}
290
291
292class AlterRename(Expression):
293    pass
294
295
296class RenameIndex(Expression):
297    arg_types = {"this": True, "to": True}
298
299
300class AlterModifySqlSecurity(Expression):
301    arg_types = {"expressions": True}
302
303
304class SwapTable(Expression):
305    pass
306
307
308class Comment(Expression):
309    arg_types = {
310        "this": True,
311        "kind": True,
312        "expression": True,
313        "exists": False,
314        "materialized": False,
315    }
316
317
318class Comprehension(Expression):
319    arg_types = {
320        "this": True,
321        "expression": True,
322        "position": False,
323        "iterator": True,
324        "condition": False,
325    }
326
327
328class MergeTreeTTLAction(Expression):
329    arg_types = {
330        "this": True,
331        "delete": False,
332        "recompress": False,
333        "to_disk": False,
334        "to_volume": False,
335    }
336
337
338class MergeTreeTTL(Expression):
339    arg_types = {
340        "expressions": True,
341        "where": False,
342        "group": False,
343        "aggregates": False,
344    }
345
346
347class Drop(Expression):
348    arg_types = {
349        "kind": False,
350        "tables": False,
351        "expressions": False,
352        "exists": False,
353        "temporary": False,
354        "materialized": False,
355        "cascade": False,
356        "restrict": False,
357        "constraints": False,
358        "purge": False,
359        "cluster": False,
360        "concurrently": False,
361        "sync": False,
362        "iceberg": False,
363        "force": False,
364    }
365
366    @property
367    def kind(self) -> str | None:
368        kind = self.args.get("kind")
369        return kind and kind.upper()
370
371
372class DropPrimaryKey(Expression):
373    arg_types = {}
374
375
376class Undrop(Expression):
377    arg_types = {"this": True, "kind": True, "rename": False}
378
379    @property
380    def kind(self) -> str:
381        return self.args["kind"].upper()
382
383
384class Command(Expression):
385    arg_types = {"this": True, "expression": False}
386    _hash_raw_args = True
387
388
389class Transaction(Expression):
390    arg_types = {"this": False, "modes": False, "mark": False}
391
392
393class Commit(Expression):
394    arg_types = {"chain": False, "this": False, "durability": False}
395
396
397class Rollback(Expression):
398    arg_types = {"savepoint": False, "this": False}
399
400
401class Alter(Expression):
402    arg_types = {
403        "this": False,
404        "kind": True,
405        "actions": False,
406        "exists": False,
407        "only": False,
408        "options": False,
409        "cluster": False,
410        "not_valid": False,
411        "check": False,
412        "cascade": False,
413        "iceberg": False,
414    }
415
416    @property
417    def kind(self) -> str | None:
418        kind = self.args.get("kind")
419        return kind and kind.upper()
420
421    @property
422    def actions(self) -> list[Expr]:
423        return self.args.get("actions") or []
424
425
426class AlterSession(Expression):
427    arg_types = {"expressions": True, "unset": False}
428
429
430class Use(Expression):
431    arg_types = {"this": False, "expressions": False, "kind": False}
432
433
434class NextValueFor(Expression, Func):
435    arg_types = {"this": True, "order": False}
436
437
438class Execute(Expression):
439    arg_types = {"this": True, "expressions": False, "return_status": False}
440
441    @property
442    def name(self) -> str:
443        return self.this.name
444
445
446class ExecuteSql(Execute):
447    pass