Edit on GitHub

sqlglot.dialects.mysql

  1from __future__ import annotations
  2
  3import typing as t
  4
  5from sqlglot import exp, generator, parser, tokens, transforms
  6from sqlglot.dialects.dialect import (
  7    Dialect,
  8    arrow_json_extract_scalar_sql,
  9    datestrtodate_sql,
 10    format_time_lambda,
 11    locate_to_strposition,
 12    max_or_greatest,
 13    min_or_least,
 14    no_ilike_sql,
 15    no_paren_current_date_sql,
 16    no_pivot_sql,
 17    no_tablesample_sql,
 18    no_trycast_sql,
 19    parse_date_delta_with_interval,
 20    rename_func,
 21    strposition_to_locate_sql,
 22)
 23from sqlglot.helper import seq_get
 24from sqlglot.tokens import TokenType
 25
 26
 27def _show_parser(*args: t.Any, **kwargs: t.Any) -> t.Callable[[MySQL.Parser], exp.Show]:
 28    def _parse(self: MySQL.Parser) -> exp.Show:
 29        return self._parse_show_mysql(*args, **kwargs)
 30
 31    return _parse
 32
 33
 34def _date_trunc_sql(self: generator.Generator, expression: exp.DateTrunc) -> str:
 35    expr = self.sql(expression, "this")
 36    unit = expression.text("unit")
 37
 38    if unit == "day":
 39        return f"DATE({expr})"
 40
 41    if unit == "week":
 42        concat = f"CONCAT(YEAR({expr}), ' ', WEEK({expr}, 1), ' 1')"
 43        date_format = "%Y %u %w"
 44    elif unit == "month":
 45        concat = f"CONCAT(YEAR({expr}), ' ', MONTH({expr}), ' 1')"
 46        date_format = "%Y %c %e"
 47    elif unit == "quarter":
 48        concat = f"CONCAT(YEAR({expr}), ' ', QUARTER({expr}) * 3 - 2, ' 1')"
 49        date_format = "%Y %c %e"
 50    elif unit == "year":
 51        concat = f"CONCAT(YEAR({expr}), ' 1 1')"
 52        date_format = "%Y %c %e"
 53    else:
 54        self.unsupported(f"Unexpected interval unit: {unit}")
 55        return f"DATE({expr})"
 56
 57    return f"STR_TO_DATE({concat}, '{date_format}')"
 58
 59
 60def _str_to_date(args: t.List) -> exp.StrToDate:
 61    date_format = MySQL.format_time(seq_get(args, 1))
 62    return exp.StrToDate(this=seq_get(args, 0), format=date_format)
 63
 64
 65def _str_to_date_sql(self: generator.Generator, expression: exp.StrToDate | exp.StrToTime) -> str:
 66    date_format = self.format_time(expression)
 67    return f"STR_TO_DATE({self.sql(expression.this)}, {date_format})"
 68
 69
 70def _trim_sql(self: generator.Generator, expression: exp.Trim) -> str:
 71    target = self.sql(expression, "this")
 72    trim_type = self.sql(expression, "position")
 73    remove_chars = self.sql(expression, "expression")
 74
 75    # Use TRIM/LTRIM/RTRIM syntax if the expression isn't mysql-specific
 76    if not remove_chars:
 77        return self.trim_sql(expression)
 78
 79    trim_type = f"{trim_type} " if trim_type else ""
 80    remove_chars = f"{remove_chars} " if remove_chars else ""
 81    from_part = "FROM " if trim_type or remove_chars else ""
 82    return f"TRIM({trim_type}{remove_chars}{from_part}{target})"
 83
 84
 85def _date_add_sql(kind: str) -> t.Callable[[generator.Generator, exp.DateAdd | exp.DateSub], str]:
 86    def func(self: generator.Generator, expression: exp.DateAdd | exp.DateSub) -> str:
 87        this = self.sql(expression, "this")
 88        unit = expression.text("unit").upper() or "DAY"
 89        return (
 90            f"DATE_{kind}({this}, {self.sql(exp.Interval(this=expression.expression, unit=unit))})"
 91        )
 92
 93    return func
 94
 95
 96class MySQL(Dialect):
 97    TIME_FORMAT = "'%Y-%m-%d %T'"
 98
 99    # https://prestodb.io/docs/current/functions/datetime.html#mysql-date-functions
100    TIME_MAPPING = {
101        "%M": "%B",
102        "%c": "%-m",
103        "%e": "%-d",
104        "%h": "%I",
105        "%i": "%M",
106        "%s": "%S",
107        "%S": "%S",
108        "%u": "%W",
109        "%k": "%-H",
110        "%l": "%-I",
111        "%T": "%H:%M:%S",
112        "%W": "%a",
113    }
114
115    class Tokenizer(tokens.Tokenizer):
116        QUOTES = ["'", '"']
117        COMMENTS = ["--", "#", ("/*", "*/")]
118        IDENTIFIERS = ["`"]
119        STRING_ESCAPES = ["'", "\\"]
120        BIT_STRINGS = [("b'", "'"), ("B'", "'"), ("0b", "")]
121        HEX_STRINGS = [("x'", "'"), ("X'", "'"), ("0x", "")]
122
123        KEYWORDS = {
124            **tokens.Tokenizer.KEYWORDS,
125            "CHARSET": TokenType.CHARACTER_SET,
126            "LONGBLOB": TokenType.LONGBLOB,
127            "LONGTEXT": TokenType.LONGTEXT,
128            "MEDIUMBLOB": TokenType.MEDIUMBLOB,
129            "MEDIUMTEXT": TokenType.MEDIUMTEXT,
130            "SEPARATOR": TokenType.SEPARATOR,
131            "START": TokenType.BEGIN,
132            "_ARMSCII8": TokenType.INTRODUCER,
133            "_ASCII": TokenType.INTRODUCER,
134            "_BIG5": TokenType.INTRODUCER,
135            "_BINARY": TokenType.INTRODUCER,
136            "_CP1250": TokenType.INTRODUCER,
137            "_CP1251": TokenType.INTRODUCER,
138            "_CP1256": TokenType.INTRODUCER,
139            "_CP1257": TokenType.INTRODUCER,
140            "_CP850": TokenType.INTRODUCER,
141            "_CP852": TokenType.INTRODUCER,
142            "_CP866": TokenType.INTRODUCER,
143            "_CP932": TokenType.INTRODUCER,
144            "_DEC8": TokenType.INTRODUCER,
145            "_EUCJPMS": TokenType.INTRODUCER,
146            "_EUCKR": TokenType.INTRODUCER,
147            "_GB18030": TokenType.INTRODUCER,
148            "_GB2312": TokenType.INTRODUCER,
149            "_GBK": TokenType.INTRODUCER,
150            "_GEOSTD8": TokenType.INTRODUCER,
151            "_GREEK": TokenType.INTRODUCER,
152            "_HEBREW": TokenType.INTRODUCER,
153            "_HP8": TokenType.INTRODUCER,
154            "_KEYBCS2": TokenType.INTRODUCER,
155            "_KOI8R": TokenType.INTRODUCER,
156            "_KOI8U": TokenType.INTRODUCER,
157            "_LATIN1": TokenType.INTRODUCER,
158            "_LATIN2": TokenType.INTRODUCER,
159            "_LATIN5": TokenType.INTRODUCER,
160            "_LATIN7": TokenType.INTRODUCER,
161            "_MACCE": TokenType.INTRODUCER,
162            "_MACROMAN": TokenType.INTRODUCER,
163            "_SJIS": TokenType.INTRODUCER,
164            "_SWE7": TokenType.INTRODUCER,
165            "_TIS620": TokenType.INTRODUCER,
166            "_UCS2": TokenType.INTRODUCER,
167            "_UJIS": TokenType.INTRODUCER,
168            # https://dev.mysql.com/doc/refman/8.0/en/string-literals.html
169            "_UTF8": TokenType.INTRODUCER,
170            "_UTF16": TokenType.INTRODUCER,
171            "_UTF16LE": TokenType.INTRODUCER,
172            "_UTF32": TokenType.INTRODUCER,
173            "_UTF8MB3": TokenType.INTRODUCER,
174            "_UTF8MB4": TokenType.INTRODUCER,
175            "@@": TokenType.SESSION_PARAMETER,
176        }
177
178        COMMANDS = tokens.Tokenizer.COMMANDS - {TokenType.SHOW}
179
180    class Parser(parser.Parser):
181        FUNC_TOKENS = {*parser.Parser.FUNC_TOKENS, TokenType.SCHEMA, TokenType.DATABASE}
182
183        FUNCTIONS = {
184            **parser.Parser.FUNCTIONS,
185            "DATE_ADD": parse_date_delta_with_interval(exp.DateAdd),
186            "DATE_FORMAT": format_time_lambda(exp.TimeToStr, "mysql"),
187            "DATE_SUB": parse_date_delta_with_interval(exp.DateSub),
188            "INSTR": lambda args: exp.StrPosition(substr=seq_get(args, 1), this=seq_get(args, 0)),
189            "LOCATE": locate_to_strposition,
190            "STR_TO_DATE": _str_to_date,
191        }
192
193        FUNCTION_PARSERS = {
194            **parser.Parser.FUNCTION_PARSERS,
195            "GROUP_CONCAT": lambda self: self.expression(
196                exp.GroupConcat,
197                this=self._parse_lambda(),
198                separator=self._match(TokenType.SEPARATOR) and self._parse_field(),
199            ),
200        }
201
202        STATEMENT_PARSERS = {
203            **parser.Parser.STATEMENT_PARSERS,
204            TokenType.SHOW: lambda self: self._parse_show(),
205        }
206
207        SHOW_PARSERS = {
208            "BINARY LOGS": _show_parser("BINARY LOGS"),
209            "MASTER LOGS": _show_parser("BINARY LOGS"),
210            "BINLOG EVENTS": _show_parser("BINLOG EVENTS"),
211            "CHARACTER SET": _show_parser("CHARACTER SET"),
212            "CHARSET": _show_parser("CHARACTER SET"),
213            "COLLATION": _show_parser("COLLATION"),
214            "FULL COLUMNS": _show_parser("COLUMNS", target="FROM", full=True),
215            "COLUMNS": _show_parser("COLUMNS", target="FROM"),
216            "CREATE DATABASE": _show_parser("CREATE DATABASE", target=True),
217            "CREATE EVENT": _show_parser("CREATE EVENT", target=True),
218            "CREATE FUNCTION": _show_parser("CREATE FUNCTION", target=True),
219            "CREATE PROCEDURE": _show_parser("CREATE PROCEDURE", target=True),
220            "CREATE TABLE": _show_parser("CREATE TABLE", target=True),
221            "CREATE TRIGGER": _show_parser("CREATE TRIGGER", target=True),
222            "CREATE VIEW": _show_parser("CREATE VIEW", target=True),
223            "DATABASES": _show_parser("DATABASES"),
224            "ENGINE": _show_parser("ENGINE", target=True),
225            "STORAGE ENGINES": _show_parser("ENGINES"),
226            "ENGINES": _show_parser("ENGINES"),
227            "ERRORS": _show_parser("ERRORS"),
228            "EVENTS": _show_parser("EVENTS"),
229            "FUNCTION CODE": _show_parser("FUNCTION CODE", target=True),
230            "FUNCTION STATUS": _show_parser("FUNCTION STATUS"),
231            "GRANTS": _show_parser("GRANTS", target="FOR"),
232            "INDEX": _show_parser("INDEX", target="FROM"),
233            "MASTER STATUS": _show_parser("MASTER STATUS"),
234            "OPEN TABLES": _show_parser("OPEN TABLES"),
235            "PLUGINS": _show_parser("PLUGINS"),
236            "PROCEDURE CODE": _show_parser("PROCEDURE CODE", target=True),
237            "PROCEDURE STATUS": _show_parser("PROCEDURE STATUS"),
238            "PRIVILEGES": _show_parser("PRIVILEGES"),
239            "FULL PROCESSLIST": _show_parser("PROCESSLIST", full=True),
240            "PROCESSLIST": _show_parser("PROCESSLIST"),
241            "PROFILE": _show_parser("PROFILE"),
242            "PROFILES": _show_parser("PROFILES"),
243            "RELAYLOG EVENTS": _show_parser("RELAYLOG EVENTS"),
244            "REPLICAS": _show_parser("REPLICAS"),
245            "SLAVE HOSTS": _show_parser("REPLICAS"),
246            "REPLICA STATUS": _show_parser("REPLICA STATUS"),
247            "SLAVE STATUS": _show_parser("REPLICA STATUS"),
248            "GLOBAL STATUS": _show_parser("STATUS", global_=True),
249            "SESSION STATUS": _show_parser("STATUS"),
250            "STATUS": _show_parser("STATUS"),
251            "TABLE STATUS": _show_parser("TABLE STATUS"),
252            "FULL TABLES": _show_parser("TABLES", full=True),
253            "TABLES": _show_parser("TABLES"),
254            "TRIGGERS": _show_parser("TRIGGERS"),
255            "GLOBAL VARIABLES": _show_parser("VARIABLES", global_=True),
256            "SESSION VARIABLES": _show_parser("VARIABLES"),
257            "VARIABLES": _show_parser("VARIABLES"),
258            "WARNINGS": _show_parser("WARNINGS"),
259        }
260
261        SET_PARSERS = {
262            **parser.Parser.SET_PARSERS,
263            "PERSIST": lambda self: self._parse_set_item_assignment("PERSIST"),
264            "PERSIST_ONLY": lambda self: self._parse_set_item_assignment("PERSIST_ONLY"),
265            "CHARACTER SET": lambda self: self._parse_set_item_charset("CHARACTER SET"),
266            "CHARSET": lambda self: self._parse_set_item_charset("CHARACTER SET"),
267            "NAMES": lambda self: self._parse_set_item_names(),
268        }
269
270        PROFILE_TYPES = {
271            "ALL",
272            "BLOCK IO",
273            "CONTEXT SWITCHES",
274            "CPU",
275            "IPC",
276            "MEMORY",
277            "PAGE FAULTS",
278            "SOURCE",
279            "SWAPS",
280        }
281
282        LOG_DEFAULTS_TO_LN = True
283
284        def _parse_show_mysql(
285            self,
286            this: str,
287            target: bool | str = False,
288            full: t.Optional[bool] = None,
289            global_: t.Optional[bool] = None,
290        ) -> exp.Show:
291            if target:
292                if isinstance(target, str):
293                    self._match_text_seq(target)
294                target_id = self._parse_id_var()
295            else:
296                target_id = None
297
298            log = self._parse_string() if self._match_text_seq("IN") else None
299
300            if this in {"BINLOG EVENTS", "RELAYLOG EVENTS"}:
301                position = self._parse_number() if self._match_text_seq("FROM") else None
302                db = None
303            else:
304                position = None
305                db = None
306
307                if self._match(TokenType.FROM):
308                    db = self._parse_id_var()
309                elif self._match(TokenType.DOT):
310                    db = target_id
311                    target_id = self._parse_id_var()
312
313            channel = self._parse_id_var() if self._match_text_seq("FOR", "CHANNEL") else None
314
315            like = self._parse_string() if self._match_text_seq("LIKE") else None
316            where = self._parse_where()
317
318            if this == "PROFILE":
319                types = self._parse_csv(lambda: self._parse_var_from_options(self.PROFILE_TYPES))
320                query = self._parse_number() if self._match_text_seq("FOR", "QUERY") else None
321                offset = self._parse_number() if self._match_text_seq("OFFSET") else None
322                limit = self._parse_number() if self._match_text_seq("LIMIT") else None
323            else:
324                types, query = None, None
325                offset, limit = self._parse_oldstyle_limit()
326
327            mutex = True if self._match_text_seq("MUTEX") else None
328            mutex = False if self._match_text_seq("STATUS") else mutex
329
330            return self.expression(
331                exp.Show,
332                this=this,
333                target=target_id,
334                full=full,
335                log=log,
336                position=position,
337                db=db,
338                channel=channel,
339                like=like,
340                where=where,
341                types=types,
342                query=query,
343                offset=offset,
344                limit=limit,
345                mutex=mutex,
346                **{"global": global_},  # type: ignore
347            )
348
349        def _parse_oldstyle_limit(
350            self,
351        ) -> t.Tuple[t.Optional[exp.Expression], t.Optional[exp.Expression]]:
352            limit = None
353            offset = None
354            if self._match_text_seq("LIMIT"):
355                parts = self._parse_csv(self._parse_number)
356                if len(parts) == 1:
357                    limit = parts[0]
358                elif len(parts) == 2:
359                    limit = parts[1]
360                    offset = parts[0]
361
362            return offset, limit
363
364        def _parse_set_item_charset(self, kind: str) -> exp.Expression:
365            this = self._parse_string() or self._parse_id_var()
366            return self.expression(exp.SetItem, this=this, kind=kind)
367
368        def _parse_set_item_names(self) -> exp.Expression:
369            charset = self._parse_string() or self._parse_id_var()
370            if self._match_text_seq("COLLATE"):
371                collate = self._parse_string() or self._parse_id_var()
372            else:
373                collate = None
374
375            return self.expression(exp.SetItem, this=charset, collate=collate, kind="NAMES")
376
377    class Generator(generator.Generator):
378        LOCKING_READS_SUPPORTED = True
379        NULL_ORDERING_SUPPORTED = False
380        JOIN_HINTS = False
381        TABLE_HINTS = False
382
383        TRANSFORMS = {
384            **generator.Generator.TRANSFORMS,
385            exp.CurrentDate: no_paren_current_date_sql,
386            exp.DateDiff: lambda self, e: self.func("DATEDIFF", e.this, e.expression),
387            exp.DateAdd: _date_add_sql("ADD"),
388            exp.DateStrToDate: datestrtodate_sql,
389            exp.DateSub: _date_add_sql("SUB"),
390            exp.DateTrunc: _date_trunc_sql,
391            exp.DayOfMonth: rename_func("DAYOFMONTH"),
392            exp.DayOfWeek: rename_func("DAYOFWEEK"),
393            exp.DayOfYear: rename_func("DAYOFYEAR"),
394            exp.GroupConcat: lambda self, e: f"""GROUP_CONCAT({self.sql(e, "this")} SEPARATOR {self.sql(e, "separator") or "','"})""",
395            exp.ILike: no_ilike_sql,
396            exp.JSONExtractScalar: arrow_json_extract_scalar_sql,
397            exp.Max: max_or_greatest,
398            exp.Min: min_or_least,
399            exp.NullSafeEQ: lambda self, e: self.binary(e, "<=>"),
400            exp.NullSafeNEQ: lambda self, e: self.not_sql(self.binary(e, "<=>")),
401            exp.Pivot: no_pivot_sql,
402            exp.Select: transforms.preprocess([transforms.eliminate_distinct_on]),
403            exp.StrPosition: strposition_to_locate_sql,
404            exp.StrToDate: _str_to_date_sql,
405            exp.StrToTime: _str_to_date_sql,
406            exp.TableSample: no_tablesample_sql,
407            exp.TimeStrToUnix: rename_func("UNIX_TIMESTAMP"),
408            exp.TimeToStr: lambda self, e: self.func("DATE_FORMAT", e.this, self.format_time(e)),
409            exp.Trim: _trim_sql,
410            exp.TryCast: no_trycast_sql,
411            exp.WeekOfYear: rename_func("WEEKOFYEAR"),
412        }
413
414        TYPE_MAPPING = generator.Generator.TYPE_MAPPING.copy()
415        TYPE_MAPPING.pop(exp.DataType.Type.MEDIUMTEXT)
416        TYPE_MAPPING.pop(exp.DataType.Type.LONGTEXT)
417        TYPE_MAPPING.pop(exp.DataType.Type.MEDIUMBLOB)
418        TYPE_MAPPING.pop(exp.DataType.Type.LONGBLOB)
419
420        PROPERTIES_LOCATION = {
421            **generator.Generator.PROPERTIES_LOCATION,
422            exp.TransientProperty: exp.Properties.Location.UNSUPPORTED,
423            exp.VolatileProperty: exp.Properties.Location.UNSUPPORTED,
424        }
425
426        LIMIT_FETCH = "LIMIT"
427
428        def show_sql(self, expression: exp.Show) -> str:
429            this = f" {expression.name}"
430            full = " FULL" if expression.args.get("full") else ""
431            global_ = " GLOBAL" if expression.args.get("global") else ""
432
433            target = self.sql(expression, "target")
434            target = f" {target}" if target else ""
435            if expression.name in {"COLUMNS", "INDEX"}:
436                target = f" FROM{target}"
437            elif expression.name == "GRANTS":
438                target = f" FOR{target}"
439
440            db = self._prefixed_sql("FROM", expression, "db")
441
442            like = self._prefixed_sql("LIKE", expression, "like")
443            where = self.sql(expression, "where")
444
445            types = self.expressions(expression, key="types")
446            types = f" {types}" if types else types
447            query = self._prefixed_sql("FOR QUERY", expression, "query")
448
449            if expression.name == "PROFILE":
450                offset = self._prefixed_sql("OFFSET", expression, "offset")
451                limit = self._prefixed_sql("LIMIT", expression, "limit")
452            else:
453                offset = ""
454                limit = self._oldstyle_limit_sql(expression)
455
456            log = self._prefixed_sql("IN", expression, "log")
457            position = self._prefixed_sql("FROM", expression, "position")
458
459            channel = self._prefixed_sql("FOR CHANNEL", expression, "channel")
460
461            if expression.name == "ENGINE":
462                mutex_or_status = " MUTEX" if expression.args.get("mutex") else " STATUS"
463            else:
464                mutex_or_status = ""
465
466            return f"SHOW{full}{global_}{this}{target}{types}{db}{query}{log}{position}{channel}{mutex_or_status}{like}{where}{offset}{limit}"
467
468        def _prefixed_sql(self, prefix: str, expression: exp.Expression, arg: str) -> str:
469            sql = self.sql(expression, arg)
470            return f" {prefix} {sql}" if sql else ""
471
472        def _oldstyle_limit_sql(self, expression: exp.Show) -> str:
473            limit = self.sql(expression, "limit")
474            offset = self.sql(expression, "offset")
475            if limit:
476                limit_offset = f"{offset}, {limit}" if offset else limit
477                return f" LIMIT {limit_offset}"
478            return ""
class MySQL(sqlglot.dialects.dialect.Dialect):
 97class MySQL(Dialect):
 98    TIME_FORMAT = "'%Y-%m-%d %T'"
 99
100    # https://prestodb.io/docs/current/functions/datetime.html#mysql-date-functions
101    TIME_MAPPING = {
102        "%M": "%B",
103        "%c": "%-m",
104        "%e": "%-d",
105        "%h": "%I",
106        "%i": "%M",
107        "%s": "%S",
108        "%S": "%S",
109        "%u": "%W",
110        "%k": "%-H",
111        "%l": "%-I",
112        "%T": "%H:%M:%S",
113        "%W": "%a",
114    }
115
116    class Tokenizer(tokens.Tokenizer):
117        QUOTES = ["'", '"']
118        COMMENTS = ["--", "#", ("/*", "*/")]
119        IDENTIFIERS = ["`"]
120        STRING_ESCAPES = ["'", "\\"]
121        BIT_STRINGS = [("b'", "'"), ("B'", "'"), ("0b", "")]
122        HEX_STRINGS = [("x'", "'"), ("X'", "'"), ("0x", "")]
123
124        KEYWORDS = {
125            **tokens.Tokenizer.KEYWORDS,
126            "CHARSET": TokenType.CHARACTER_SET,
127            "LONGBLOB": TokenType.LONGBLOB,
128            "LONGTEXT": TokenType.LONGTEXT,
129            "MEDIUMBLOB": TokenType.MEDIUMBLOB,
130            "MEDIUMTEXT": TokenType.MEDIUMTEXT,
131            "SEPARATOR": TokenType.SEPARATOR,
132            "START": TokenType.BEGIN,
133            "_ARMSCII8": TokenType.INTRODUCER,
134            "_ASCII": TokenType.INTRODUCER,
135            "_BIG5": TokenType.INTRODUCER,
136            "_BINARY": TokenType.INTRODUCER,
137            "_CP1250": TokenType.INTRODUCER,
138            "_CP1251": TokenType.INTRODUCER,
139            "_CP1256": TokenType.INTRODUCER,
140            "_CP1257": TokenType.INTRODUCER,
141            "_CP850": TokenType.INTRODUCER,
142            "_CP852": TokenType.INTRODUCER,
143            "_CP866": TokenType.INTRODUCER,
144            "_CP932": TokenType.INTRODUCER,
145            "_DEC8": TokenType.INTRODUCER,
146            "_EUCJPMS": TokenType.INTRODUCER,
147            "_EUCKR": TokenType.INTRODUCER,
148            "_GB18030": TokenType.INTRODUCER,
149            "_GB2312": TokenType.INTRODUCER,
150            "_GBK": TokenType.INTRODUCER,
151            "_GEOSTD8": TokenType.INTRODUCER,
152            "_GREEK": TokenType.INTRODUCER,
153            "_HEBREW": TokenType.INTRODUCER,
154            "_HP8": TokenType.INTRODUCER,
155            "_KEYBCS2": TokenType.INTRODUCER,
156            "_KOI8R": TokenType.INTRODUCER,
157            "_KOI8U": TokenType.INTRODUCER,
158            "_LATIN1": TokenType.INTRODUCER,
159            "_LATIN2": TokenType.INTRODUCER,
160            "_LATIN5": TokenType.INTRODUCER,
161            "_LATIN7": TokenType.INTRODUCER,
162            "_MACCE": TokenType.INTRODUCER,
163            "_MACROMAN": TokenType.INTRODUCER,
164            "_SJIS": TokenType.INTRODUCER,
165            "_SWE7": TokenType.INTRODUCER,
166            "_TIS620": TokenType.INTRODUCER,
167            "_UCS2": TokenType.INTRODUCER,
168            "_UJIS": TokenType.INTRODUCER,
169            # https://dev.mysql.com/doc/refman/8.0/en/string-literals.html
170            "_UTF8": TokenType.INTRODUCER,
171            "_UTF16": TokenType.INTRODUCER,
172            "_UTF16LE": TokenType.INTRODUCER,
173            "_UTF32": TokenType.INTRODUCER,
174            "_UTF8MB3": TokenType.INTRODUCER,
175            "_UTF8MB4": TokenType.INTRODUCER,
176            "@@": TokenType.SESSION_PARAMETER,
177        }
178
179        COMMANDS = tokens.Tokenizer.COMMANDS - {TokenType.SHOW}
180
181    class Parser(parser.Parser):
182        FUNC_TOKENS = {*parser.Parser.FUNC_TOKENS, TokenType.SCHEMA, TokenType.DATABASE}
183
184        FUNCTIONS = {
185            **parser.Parser.FUNCTIONS,
186            "DATE_ADD": parse_date_delta_with_interval(exp.DateAdd),
187            "DATE_FORMAT": format_time_lambda(exp.TimeToStr, "mysql"),
188            "DATE_SUB": parse_date_delta_with_interval(exp.DateSub),
189            "INSTR": lambda args: exp.StrPosition(substr=seq_get(args, 1), this=seq_get(args, 0)),
190            "LOCATE": locate_to_strposition,
191            "STR_TO_DATE": _str_to_date,
192        }
193
194        FUNCTION_PARSERS = {
195            **parser.Parser.FUNCTION_PARSERS,
196            "GROUP_CONCAT": lambda self: self.expression(
197                exp.GroupConcat,
198                this=self._parse_lambda(),
199                separator=self._match(TokenType.SEPARATOR) and self._parse_field(),
200            ),
201        }
202
203        STATEMENT_PARSERS = {
204            **parser.Parser.STATEMENT_PARSERS,
205            TokenType.SHOW: lambda self: self._parse_show(),
206        }
207
208        SHOW_PARSERS = {
209            "BINARY LOGS": _show_parser("BINARY LOGS"),
210            "MASTER LOGS": _show_parser("BINARY LOGS"),
211            "BINLOG EVENTS": _show_parser("BINLOG EVENTS"),
212            "CHARACTER SET": _show_parser("CHARACTER SET"),
213            "CHARSET": _show_parser("CHARACTER SET"),
214            "COLLATION": _show_parser("COLLATION"),
215            "FULL COLUMNS": _show_parser("COLUMNS", target="FROM", full=True),
216            "COLUMNS": _show_parser("COLUMNS", target="FROM"),
217            "CREATE DATABASE": _show_parser("CREATE DATABASE", target=True),
218            "CREATE EVENT": _show_parser("CREATE EVENT", target=True),
219            "CREATE FUNCTION": _show_parser("CREATE FUNCTION", target=True),
220            "CREATE PROCEDURE": _show_parser("CREATE PROCEDURE", target=True),
221            "CREATE TABLE": _show_parser("CREATE TABLE", target=True),
222            "CREATE TRIGGER": _show_parser("CREATE TRIGGER", target=True),
223            "CREATE VIEW": _show_parser("CREATE VIEW", target=True),
224            "DATABASES": _show_parser("DATABASES"),
225            "ENGINE": _show_parser("ENGINE", target=True),
226            "STORAGE ENGINES": _show_parser("ENGINES"),
227            "ENGINES": _show_parser("ENGINES"),
228            "ERRORS": _show_parser("ERRORS"),
229            "EVENTS": _show_parser("EVENTS"),
230            "FUNCTION CODE": _show_parser("FUNCTION CODE", target=True),
231            "FUNCTION STATUS": _show_parser("FUNCTION STATUS"),
232            "GRANTS": _show_parser("GRANTS", target="FOR"),
233            "INDEX": _show_parser("INDEX", target="FROM"),
234            "MASTER STATUS": _show_parser("MASTER STATUS"),
235            "OPEN TABLES": _show_parser("OPEN TABLES"),
236            "PLUGINS": _show_parser("PLUGINS"),
237            "PROCEDURE CODE": _show_parser("PROCEDURE CODE", target=True),
238            "PROCEDURE STATUS": _show_parser("PROCEDURE STATUS"),
239            "PRIVILEGES": _show_parser("PRIVILEGES"),
240            "FULL PROCESSLIST": _show_parser("PROCESSLIST", full=True),
241            "PROCESSLIST": _show_parser("PROCESSLIST"),
242            "PROFILE": _show_parser("PROFILE"),
243            "PROFILES": _show_parser("PROFILES"),
244            "RELAYLOG EVENTS": _show_parser("RELAYLOG EVENTS"),
245            "REPLICAS": _show_parser("REPLICAS"),
246            "SLAVE HOSTS": _show_parser("REPLICAS"),
247            "REPLICA STATUS": _show_parser("REPLICA STATUS"),
248            "SLAVE STATUS": _show_parser("REPLICA STATUS"),
249            "GLOBAL STATUS": _show_parser("STATUS", global_=True),
250            "SESSION STATUS": _show_parser("STATUS"),
251            "STATUS": _show_parser("STATUS"),
252            "TABLE STATUS": _show_parser("TABLE STATUS"),
253            "FULL TABLES": _show_parser("TABLES", full=True),
254            "TABLES": _show_parser("TABLES"),
255            "TRIGGERS": _show_parser("TRIGGERS"),
256            "GLOBAL VARIABLES": _show_parser("VARIABLES", global_=True),
257            "SESSION VARIABLES": _show_parser("VARIABLES"),
258            "VARIABLES": _show_parser("VARIABLES"),
259            "WARNINGS": _show_parser("WARNINGS"),
260        }
261
262        SET_PARSERS = {
263            **parser.Parser.SET_PARSERS,
264            "PERSIST": lambda self: self._parse_set_item_assignment("PERSIST"),
265            "PERSIST_ONLY": lambda self: self._parse_set_item_assignment("PERSIST_ONLY"),
266            "CHARACTER SET": lambda self: self._parse_set_item_charset("CHARACTER SET"),
267            "CHARSET": lambda self: self._parse_set_item_charset("CHARACTER SET"),
268            "NAMES": lambda self: self._parse_set_item_names(),
269        }
270
271        PROFILE_TYPES = {
272            "ALL",
273            "BLOCK IO",
274            "CONTEXT SWITCHES",
275            "CPU",
276            "IPC",
277            "MEMORY",
278            "PAGE FAULTS",
279            "SOURCE",
280            "SWAPS",
281        }
282
283        LOG_DEFAULTS_TO_LN = True
284
285        def _parse_show_mysql(
286            self,
287            this: str,
288            target: bool | str = False,
289            full: t.Optional[bool] = None,
290            global_: t.Optional[bool] = None,
291        ) -> exp.Show:
292            if target:
293                if isinstance(target, str):
294                    self._match_text_seq(target)
295                target_id = self._parse_id_var()
296            else:
297                target_id = None
298
299            log = self._parse_string() if self._match_text_seq("IN") else None
300
301            if this in {"BINLOG EVENTS", "RELAYLOG EVENTS"}:
302                position = self._parse_number() if self._match_text_seq("FROM") else None
303                db = None
304            else:
305                position = None
306                db = None
307
308                if self._match(TokenType.FROM):
309                    db = self._parse_id_var()
310                elif self._match(TokenType.DOT):
311                    db = target_id
312                    target_id = self._parse_id_var()
313
314            channel = self._parse_id_var() if self._match_text_seq("FOR", "CHANNEL") else None
315
316            like = self._parse_string() if self._match_text_seq("LIKE") else None
317            where = self._parse_where()
318
319            if this == "PROFILE":
320                types = self._parse_csv(lambda: self._parse_var_from_options(self.PROFILE_TYPES))
321                query = self._parse_number() if self._match_text_seq("FOR", "QUERY") else None
322                offset = self._parse_number() if self._match_text_seq("OFFSET") else None
323                limit = self._parse_number() if self._match_text_seq("LIMIT") else None
324            else:
325                types, query = None, None
326                offset, limit = self._parse_oldstyle_limit()
327
328            mutex = True if self._match_text_seq("MUTEX") else None
329            mutex = False if self._match_text_seq("STATUS") else mutex
330
331            return self.expression(
332                exp.Show,
333                this=this,
334                target=target_id,
335                full=full,
336                log=log,
337                position=position,
338                db=db,
339                channel=channel,
340                like=like,
341                where=where,
342                types=types,
343                query=query,
344                offset=offset,
345                limit=limit,
346                mutex=mutex,
347                **{"global": global_},  # type: ignore
348            )
349
350        def _parse_oldstyle_limit(
351            self,
352        ) -> t.Tuple[t.Optional[exp.Expression], t.Optional[exp.Expression]]:
353            limit = None
354            offset = None
355            if self._match_text_seq("LIMIT"):
356                parts = self._parse_csv(self._parse_number)
357                if len(parts) == 1:
358                    limit = parts[0]
359                elif len(parts) == 2:
360                    limit = parts[1]
361                    offset = parts[0]
362
363            return offset, limit
364
365        def _parse_set_item_charset(self, kind: str) -> exp.Expression:
366            this = self._parse_string() or self._parse_id_var()
367            return self.expression(exp.SetItem, this=this, kind=kind)
368
369        def _parse_set_item_names(self) -> exp.Expression:
370            charset = self._parse_string() or self._parse_id_var()
371            if self._match_text_seq("COLLATE"):
372                collate = self._parse_string() or self._parse_id_var()
373            else:
374                collate = None
375
376            return self.expression(exp.SetItem, this=charset, collate=collate, kind="NAMES")
377
378    class Generator(generator.Generator):
379        LOCKING_READS_SUPPORTED = True
380        NULL_ORDERING_SUPPORTED = False
381        JOIN_HINTS = False
382        TABLE_HINTS = False
383
384        TRANSFORMS = {
385            **generator.Generator.TRANSFORMS,
386            exp.CurrentDate: no_paren_current_date_sql,
387            exp.DateDiff: lambda self, e: self.func("DATEDIFF", e.this, e.expression),
388            exp.DateAdd: _date_add_sql("ADD"),
389            exp.DateStrToDate: datestrtodate_sql,
390            exp.DateSub: _date_add_sql("SUB"),
391            exp.DateTrunc: _date_trunc_sql,
392            exp.DayOfMonth: rename_func("DAYOFMONTH"),
393            exp.DayOfWeek: rename_func("DAYOFWEEK"),
394            exp.DayOfYear: rename_func("DAYOFYEAR"),
395            exp.GroupConcat: lambda self, e: f"""GROUP_CONCAT({self.sql(e, "this")} SEPARATOR {self.sql(e, "separator") or "','"})""",
396            exp.ILike: no_ilike_sql,
397            exp.JSONExtractScalar: arrow_json_extract_scalar_sql,
398            exp.Max: max_or_greatest,
399            exp.Min: min_or_least,
400            exp.NullSafeEQ: lambda self, e: self.binary(e, "<=>"),
401            exp.NullSafeNEQ: lambda self, e: self.not_sql(self.binary(e, "<=>")),
402            exp.Pivot: no_pivot_sql,
403            exp.Select: transforms.preprocess([transforms.eliminate_distinct_on]),
404            exp.StrPosition: strposition_to_locate_sql,
405            exp.StrToDate: _str_to_date_sql,
406            exp.StrToTime: _str_to_date_sql,
407            exp.TableSample: no_tablesample_sql,
408            exp.TimeStrToUnix: rename_func("UNIX_TIMESTAMP"),
409            exp.TimeToStr: lambda self, e: self.func("DATE_FORMAT", e.this, self.format_time(e)),
410            exp.Trim: _trim_sql,
411            exp.TryCast: no_trycast_sql,
412            exp.WeekOfYear: rename_func("WEEKOFYEAR"),
413        }
414
415        TYPE_MAPPING = generator.Generator.TYPE_MAPPING.copy()
416        TYPE_MAPPING.pop(exp.DataType.Type.MEDIUMTEXT)
417        TYPE_MAPPING.pop(exp.DataType.Type.LONGTEXT)
418        TYPE_MAPPING.pop(exp.DataType.Type.MEDIUMBLOB)
419        TYPE_MAPPING.pop(exp.DataType.Type.LONGBLOB)
420
421        PROPERTIES_LOCATION = {
422            **generator.Generator.PROPERTIES_LOCATION,
423            exp.TransientProperty: exp.Properties.Location.UNSUPPORTED,
424            exp.VolatileProperty: exp.Properties.Location.UNSUPPORTED,
425        }
426
427        LIMIT_FETCH = "LIMIT"
428
429        def show_sql(self, expression: exp.Show) -> str:
430            this = f" {expression.name}"
431            full = " FULL" if expression.args.get("full") else ""
432            global_ = " GLOBAL" if expression.args.get("global") else ""
433
434            target = self.sql(expression, "target")
435            target = f" {target}" if target else ""
436            if expression.name in {"COLUMNS", "INDEX"}:
437                target = f" FROM{target}"
438            elif expression.name == "GRANTS":
439                target = f" FOR{target}"
440
441            db = self._prefixed_sql("FROM", expression, "db")
442
443            like = self._prefixed_sql("LIKE", expression, "like")
444            where = self.sql(expression, "where")
445
446            types = self.expressions(expression, key="types")
447            types = f" {types}" if types else types
448            query = self._prefixed_sql("FOR QUERY", expression, "query")
449
450            if expression.name == "PROFILE":
451                offset = self._prefixed_sql("OFFSET", expression, "offset")
452                limit = self._prefixed_sql("LIMIT", expression, "limit")
453            else:
454                offset = ""
455                limit = self._oldstyle_limit_sql(expression)
456
457            log = self._prefixed_sql("IN", expression, "log")
458            position = self._prefixed_sql("FROM", expression, "position")
459
460            channel = self._prefixed_sql("FOR CHANNEL", expression, "channel")
461
462            if expression.name == "ENGINE":
463                mutex_or_status = " MUTEX" if expression.args.get("mutex") else " STATUS"
464            else:
465                mutex_or_status = ""
466
467            return f"SHOW{full}{global_}{this}{target}{types}{db}{query}{log}{position}{channel}{mutex_or_status}{like}{where}{offset}{limit}"
468
469        def _prefixed_sql(self, prefix: str, expression: exp.Expression, arg: str) -> str:
470            sql = self.sql(expression, arg)
471            return f" {prefix} {sql}" if sql else ""
472
473        def _oldstyle_limit_sql(self, expression: exp.Show) -> str:
474            limit = self.sql(expression, "limit")
475            offset = self.sql(expression, "offset")
476            if limit:
477                limit_offset = f"{offset}, {limit}" if offset else limit
478                return f" LIMIT {limit_offset}"
479            return ""
class MySQL.Tokenizer(sqlglot.tokens.Tokenizer):
116    class Tokenizer(tokens.Tokenizer):
117        QUOTES = ["'", '"']
118        COMMENTS = ["--", "#", ("/*", "*/")]
119        IDENTIFIERS = ["`"]
120        STRING_ESCAPES = ["'", "\\"]
121        BIT_STRINGS = [("b'", "'"), ("B'", "'"), ("0b", "")]
122        HEX_STRINGS = [("x'", "'"), ("X'", "'"), ("0x", "")]
123
124        KEYWORDS = {
125            **tokens.Tokenizer.KEYWORDS,
126            "CHARSET": TokenType.CHARACTER_SET,
127            "LONGBLOB": TokenType.LONGBLOB,
128            "LONGTEXT": TokenType.LONGTEXT,
129            "MEDIUMBLOB": TokenType.MEDIUMBLOB,
130            "MEDIUMTEXT": TokenType.MEDIUMTEXT,
131            "SEPARATOR": TokenType.SEPARATOR,
132            "START": TokenType.BEGIN,
133            "_ARMSCII8": TokenType.INTRODUCER,
134            "_ASCII": TokenType.INTRODUCER,
135            "_BIG5": TokenType.INTRODUCER,
136            "_BINARY": TokenType.INTRODUCER,
137            "_CP1250": TokenType.INTRODUCER,
138            "_CP1251": TokenType.INTRODUCER,
139            "_CP1256": TokenType.INTRODUCER,
140            "_CP1257": TokenType.INTRODUCER,
141            "_CP850": TokenType.INTRODUCER,
142            "_CP852": TokenType.INTRODUCER,
143            "_CP866": TokenType.INTRODUCER,
144            "_CP932": TokenType.INTRODUCER,
145            "_DEC8": TokenType.INTRODUCER,
146            "_EUCJPMS": TokenType.INTRODUCER,
147            "_EUCKR": TokenType.INTRODUCER,
148            "_GB18030": TokenType.INTRODUCER,
149            "_GB2312": TokenType.INTRODUCER,
150            "_GBK": TokenType.INTRODUCER,
151            "_GEOSTD8": TokenType.INTRODUCER,
152            "_GREEK": TokenType.INTRODUCER,
153            "_HEBREW": TokenType.INTRODUCER,
154            "_HP8": TokenType.INTRODUCER,
155            "_KEYBCS2": TokenType.INTRODUCER,
156            "_KOI8R": TokenType.INTRODUCER,
157            "_KOI8U": TokenType.INTRODUCER,
158            "_LATIN1": TokenType.INTRODUCER,
159            "_LATIN2": TokenType.INTRODUCER,
160            "_LATIN5": TokenType.INTRODUCER,
161            "_LATIN7": TokenType.INTRODUCER,
162            "_MACCE": TokenType.INTRODUCER,
163            "_MACROMAN": TokenType.INTRODUCER,
164            "_SJIS": TokenType.INTRODUCER,
165            "_SWE7": TokenType.INTRODUCER,
166            "_TIS620": TokenType.INTRODUCER,
167            "_UCS2": TokenType.INTRODUCER,
168            "_UJIS": TokenType.INTRODUCER,
169            # https://dev.mysql.com/doc/refman/8.0/en/string-literals.html
170            "_UTF8": TokenType.INTRODUCER,
171            "_UTF16": TokenType.INTRODUCER,
172            "_UTF16LE": TokenType.INTRODUCER,
173            "_UTF32": TokenType.INTRODUCER,
174            "_UTF8MB3": TokenType.INTRODUCER,
175            "_UTF8MB4": TokenType.INTRODUCER,
176            "@@": TokenType.SESSION_PARAMETER,
177        }
178
179        COMMANDS = tokens.Tokenizer.COMMANDS - {TokenType.SHOW}
class MySQL.Parser(sqlglot.parser.Parser):
181    class Parser(parser.Parser):
182        FUNC_TOKENS = {*parser.Parser.FUNC_TOKENS, TokenType.SCHEMA, TokenType.DATABASE}
183
184        FUNCTIONS = {
185            **parser.Parser.FUNCTIONS,
186            "DATE_ADD": parse_date_delta_with_interval(exp.DateAdd),
187            "DATE_FORMAT": format_time_lambda(exp.TimeToStr, "mysql"),
188            "DATE_SUB": parse_date_delta_with_interval(exp.DateSub),
189            "INSTR": lambda args: exp.StrPosition(substr=seq_get(args, 1), this=seq_get(args, 0)),
190            "LOCATE": locate_to_strposition,
191            "STR_TO_DATE": _str_to_date,
192        }
193
194        FUNCTION_PARSERS = {
195            **parser.Parser.FUNCTION_PARSERS,
196            "GROUP_CONCAT": lambda self: self.expression(
197                exp.GroupConcat,
198                this=self._parse_lambda(),
199                separator=self._match(TokenType.SEPARATOR) and self._parse_field(),
200            ),
201        }
202
203        STATEMENT_PARSERS = {
204            **parser.Parser.STATEMENT_PARSERS,
205            TokenType.SHOW: lambda self: self._parse_show(),
206        }
207
208        SHOW_PARSERS = {
209            "BINARY LOGS": _show_parser("BINARY LOGS"),
210            "MASTER LOGS": _show_parser("BINARY LOGS"),
211            "BINLOG EVENTS": _show_parser("BINLOG EVENTS"),
212            "CHARACTER SET": _show_parser("CHARACTER SET"),
213            "CHARSET": _show_parser("CHARACTER SET"),
214            "COLLATION": _show_parser("COLLATION"),
215            "FULL COLUMNS": _show_parser("COLUMNS", target="FROM", full=True),
216            "COLUMNS": _show_parser("COLUMNS", target="FROM"),
217            "CREATE DATABASE": _show_parser("CREATE DATABASE", target=True),
218            "CREATE EVENT": _show_parser("CREATE EVENT", target=True),
219            "CREATE FUNCTION": _show_parser("CREATE FUNCTION", target=True),
220            "CREATE PROCEDURE": _show_parser("CREATE PROCEDURE", target=True),
221            "CREATE TABLE": _show_parser("CREATE TABLE", target=True),
222            "CREATE TRIGGER": _show_parser("CREATE TRIGGER", target=True),
223            "CREATE VIEW": _show_parser("CREATE VIEW", target=True),
224            "DATABASES": _show_parser("DATABASES"),
225            "ENGINE": _show_parser("ENGINE", target=True),
226            "STORAGE ENGINES": _show_parser("ENGINES"),
227            "ENGINES": _show_parser("ENGINES"),
228            "ERRORS": _show_parser("ERRORS"),
229            "EVENTS": _show_parser("EVENTS"),
230            "FUNCTION CODE": _show_parser("FUNCTION CODE", target=True),
231            "FUNCTION STATUS": _show_parser("FUNCTION STATUS"),
232            "GRANTS": _show_parser("GRANTS", target="FOR"),
233            "INDEX": _show_parser("INDEX", target="FROM"),
234            "MASTER STATUS": _show_parser("MASTER STATUS"),
235            "OPEN TABLES": _show_parser("OPEN TABLES"),
236            "PLUGINS": _show_parser("PLUGINS"),
237            "PROCEDURE CODE": _show_parser("PROCEDURE CODE", target=True),
238            "PROCEDURE STATUS": _show_parser("PROCEDURE STATUS"),
239            "PRIVILEGES": _show_parser("PRIVILEGES"),
240            "FULL PROCESSLIST": _show_parser("PROCESSLIST", full=True),
241            "PROCESSLIST": _show_parser("PROCESSLIST"),
242            "PROFILE": _show_parser("PROFILE"),
243            "PROFILES": _show_parser("PROFILES"),
244            "RELAYLOG EVENTS": _show_parser("RELAYLOG EVENTS"),
245            "REPLICAS": _show_parser("REPLICAS"),
246            "SLAVE HOSTS": _show_parser("REPLICAS"),
247            "REPLICA STATUS": _show_parser("REPLICA STATUS"),
248            "SLAVE STATUS": _show_parser("REPLICA STATUS"),
249            "GLOBAL STATUS": _show_parser("STATUS", global_=True),
250            "SESSION STATUS": _show_parser("STATUS"),
251            "STATUS": _show_parser("STATUS"),
252            "TABLE STATUS": _show_parser("TABLE STATUS"),
253            "FULL TABLES": _show_parser("TABLES", full=True),
254            "TABLES": _show_parser("TABLES"),
255            "TRIGGERS": _show_parser("TRIGGERS"),
256            "GLOBAL VARIABLES": _show_parser("VARIABLES", global_=True),
257            "SESSION VARIABLES": _show_parser("VARIABLES"),
258            "VARIABLES": _show_parser("VARIABLES"),
259            "WARNINGS": _show_parser("WARNINGS"),
260        }
261
262        SET_PARSERS = {
263            **parser.Parser.SET_PARSERS,
264            "PERSIST": lambda self: self._parse_set_item_assignment("PERSIST"),
265            "PERSIST_ONLY": lambda self: self._parse_set_item_assignment("PERSIST_ONLY"),
266            "CHARACTER SET": lambda self: self._parse_set_item_charset("CHARACTER SET"),
267            "CHARSET": lambda self: self._parse_set_item_charset("CHARACTER SET"),
268            "NAMES": lambda self: self._parse_set_item_names(),
269        }
270
271        PROFILE_TYPES = {
272            "ALL",
273            "BLOCK IO",
274            "CONTEXT SWITCHES",
275            "CPU",
276            "IPC",
277            "MEMORY",
278            "PAGE FAULTS",
279            "SOURCE",
280            "SWAPS",
281        }
282
283        LOG_DEFAULTS_TO_LN = True
284
285        def _parse_show_mysql(
286            self,
287            this: str,
288            target: bool | str = False,
289            full: t.Optional[bool] = None,
290            global_: t.Optional[bool] = None,
291        ) -> exp.Show:
292            if target:
293                if isinstance(target, str):
294                    self._match_text_seq(target)
295                target_id = self._parse_id_var()
296            else:
297                target_id = None
298
299            log = self._parse_string() if self._match_text_seq("IN") else None
300
301            if this in {"BINLOG EVENTS", "RELAYLOG EVENTS"}:
302                position = self._parse_number() if self._match_text_seq("FROM") else None
303                db = None
304            else:
305                position = None
306                db = None
307
308                if self._match(TokenType.FROM):
309                    db = self._parse_id_var()
310                elif self._match(TokenType.DOT):
311                    db = target_id
312                    target_id = self._parse_id_var()
313
314            channel = self._parse_id_var() if self._match_text_seq("FOR", "CHANNEL") else None
315
316            like = self._parse_string() if self._match_text_seq("LIKE") else None
317            where = self._parse_where()
318
319            if this == "PROFILE":
320                types = self._parse_csv(lambda: self._parse_var_from_options(self.PROFILE_TYPES))
321                query = self._parse_number() if self._match_text_seq("FOR", "QUERY") else None
322                offset = self._parse_number() if self._match_text_seq("OFFSET") else None
323                limit = self._parse_number() if self._match_text_seq("LIMIT") else None
324            else:
325                types, query = None, None
326                offset, limit = self._parse_oldstyle_limit()
327
328            mutex = True if self._match_text_seq("MUTEX") else None
329            mutex = False if self._match_text_seq("STATUS") else mutex
330
331            return self.expression(
332                exp.Show,
333                this=this,
334                target=target_id,
335                full=full,
336                log=log,
337                position=position,
338                db=db,
339                channel=channel,
340                like=like,
341                where=where,
342                types=types,
343                query=query,
344                offset=offset,
345                limit=limit,
346                mutex=mutex,
347                **{"global": global_},  # type: ignore
348            )
349
350        def _parse_oldstyle_limit(
351            self,
352        ) -> t.Tuple[t.Optional[exp.Expression], t.Optional[exp.Expression]]:
353            limit = None
354            offset = None
355            if self._match_text_seq("LIMIT"):
356                parts = self._parse_csv(self._parse_number)
357                if len(parts) == 1:
358                    limit = parts[0]
359                elif len(parts) == 2:
360                    limit = parts[1]
361                    offset = parts[0]
362
363            return offset, limit
364
365        def _parse_set_item_charset(self, kind: str) -> exp.Expression:
366            this = self._parse_string() or self._parse_id_var()
367            return self.expression(exp.SetItem, this=this, kind=kind)
368
369        def _parse_set_item_names(self) -> exp.Expression:
370            charset = self._parse_string() or self._parse_id_var()
371            if self._match_text_seq("COLLATE"):
372                collate = self._parse_string() or self._parse_id_var()
373            else:
374                collate = None
375
376            return self.expression(exp.SetItem, this=charset, collate=collate, kind="NAMES")

Parser consumes a list of tokens produced by the Tokenizer and produces a parsed syntax tree.

Arguments:
  • error_level: The desired error level. Default: ErrorLevel.IMMEDIATE
  • error_message_context: Determines the amount of context to capture from a query string when displaying the error message (in number of characters). Default: 100
  • max_errors: Maximum number of error messages to include in a raised ParseError. This is only relevant if error_level is ErrorLevel.RAISE. Default: 3
class MySQL.Generator(sqlglot.generator.Generator):
378    class Generator(generator.Generator):
379        LOCKING_READS_SUPPORTED = True
380        NULL_ORDERING_SUPPORTED = False
381        JOIN_HINTS = False
382        TABLE_HINTS = False
383
384        TRANSFORMS = {
385            **generator.Generator.TRANSFORMS,
386            exp.CurrentDate: no_paren_current_date_sql,
387            exp.DateDiff: lambda self, e: self.func("DATEDIFF", e.this, e.expression),
388            exp.DateAdd: _date_add_sql("ADD"),
389            exp.DateStrToDate: datestrtodate_sql,
390            exp.DateSub: _date_add_sql("SUB"),
391            exp.DateTrunc: _date_trunc_sql,
392            exp.DayOfMonth: rename_func("DAYOFMONTH"),
393            exp.DayOfWeek: rename_func("DAYOFWEEK"),
394            exp.DayOfYear: rename_func("DAYOFYEAR"),
395            exp.GroupConcat: lambda self, e: f"""GROUP_CONCAT({self.sql(e, "this")} SEPARATOR {self.sql(e, "separator") or "','"})""",
396            exp.ILike: no_ilike_sql,
397            exp.JSONExtractScalar: arrow_json_extract_scalar_sql,
398            exp.Max: max_or_greatest,
399            exp.Min: min_or_least,
400            exp.NullSafeEQ: lambda self, e: self.binary(e, "<=>"),
401            exp.NullSafeNEQ: lambda self, e: self.not_sql(self.binary(e, "<=>")),
402            exp.Pivot: no_pivot_sql,
403            exp.Select: transforms.preprocess([transforms.eliminate_distinct_on]),
404            exp.StrPosition: strposition_to_locate_sql,
405            exp.StrToDate: _str_to_date_sql,
406            exp.StrToTime: _str_to_date_sql,
407            exp.TableSample: no_tablesample_sql,
408            exp.TimeStrToUnix: rename_func("UNIX_TIMESTAMP"),
409            exp.TimeToStr: lambda self, e: self.func("DATE_FORMAT", e.this, self.format_time(e)),
410            exp.Trim: _trim_sql,
411            exp.TryCast: no_trycast_sql,
412            exp.WeekOfYear: rename_func("WEEKOFYEAR"),
413        }
414
415        TYPE_MAPPING = generator.Generator.TYPE_MAPPING.copy()
416        TYPE_MAPPING.pop(exp.DataType.Type.MEDIUMTEXT)
417        TYPE_MAPPING.pop(exp.DataType.Type.LONGTEXT)
418        TYPE_MAPPING.pop(exp.DataType.Type.MEDIUMBLOB)
419        TYPE_MAPPING.pop(exp.DataType.Type.LONGBLOB)
420
421        PROPERTIES_LOCATION = {
422            **generator.Generator.PROPERTIES_LOCATION,
423            exp.TransientProperty: exp.Properties.Location.UNSUPPORTED,
424            exp.VolatileProperty: exp.Properties.Location.UNSUPPORTED,
425        }
426
427        LIMIT_FETCH = "LIMIT"
428
429        def show_sql(self, expression: exp.Show) -> str:
430            this = f" {expression.name}"
431            full = " FULL" if expression.args.get("full") else ""
432            global_ = " GLOBAL" if expression.args.get("global") else ""
433
434            target = self.sql(expression, "target")
435            target = f" {target}" if target else ""
436            if expression.name in {"COLUMNS", "INDEX"}:
437                target = f" FROM{target}"
438            elif expression.name == "GRANTS":
439                target = f" FOR{target}"
440
441            db = self._prefixed_sql("FROM", expression, "db")
442
443            like = self._prefixed_sql("LIKE", expression, "like")
444            where = self.sql(expression, "where")
445
446            types = self.expressions(expression, key="types")
447            types = f" {types}" if types else types
448            query = self._prefixed_sql("FOR QUERY", expression, "query")
449
450            if expression.name == "PROFILE":
451                offset = self._prefixed_sql("OFFSET", expression, "offset")
452                limit = self._prefixed_sql("LIMIT", expression, "limit")
453            else:
454                offset = ""
455                limit = self._oldstyle_limit_sql(expression)
456
457            log = self._prefixed_sql("IN", expression, "log")
458            position = self._prefixed_sql("FROM", expression, "position")
459
460            channel = self._prefixed_sql("FOR CHANNEL", expression, "channel")
461
462            if expression.name == "ENGINE":
463                mutex_or_status = " MUTEX" if expression.args.get("mutex") else " STATUS"
464            else:
465                mutex_or_status = ""
466
467            return f"SHOW{full}{global_}{this}{target}{types}{db}{query}{log}{position}{channel}{mutex_or_status}{like}{where}{offset}{limit}"
468
469        def _prefixed_sql(self, prefix: str, expression: exp.Expression, arg: str) -> str:
470            sql = self.sql(expression, arg)
471            return f" {prefix} {sql}" if sql else ""
472
473        def _oldstyle_limit_sql(self, expression: exp.Show) -> str:
474            limit = self.sql(expression, "limit")
475            offset = self.sql(expression, "offset")
476            if limit:
477                limit_offset = f"{offset}, {limit}" if offset else limit
478                return f" LIMIT {limit_offset}"
479            return ""

Generator converts a given syntax tree to the corresponding SQL string.

Arguments:
  • pretty: Whether or not to format the produced SQL string. Default: False.
  • identify: Determines when an identifier should be quoted. Possible values are: False (default): Never quote, except in cases where it's mandatory by the dialect. True or 'always': Always quote. 'safe': Only quote identifiers that are case insensitive.
  • normalize: Whether or not to normalize identifiers to lowercase. Default: False.
  • pad: Determines the pad size in a formatted string. Default: 2.
  • indent: Determines the indentation size in a formatted string. Default: 2.
  • normalize_functions: Whether or not to normalize all function names. Possible values are: "upper" or True (default): Convert names to uppercase. "lower": Convert names to lowercase. False: Disables function name normalization.
  • unsupported_level: Determines the generator's behavior when it encounters unsupported expressions. Default ErrorLevel.WARN.
  • max_unsupported: Maximum number of unsupported messages to include in a raised UnsupportedError. This is only relevant if unsupported_level is ErrorLevel.RAISE. Default: 3
  • leading_comma: Determines whether or not the comma is leading or trailing in select expressions. This is only relevant when generating in pretty mode. Default: False
  • max_text_width: The max number of characters in a segment before creating new lines in pretty mode. The default is on the smaller end because the length only represents a segment and not the true line length. Default: 80
  • comments: Whether or not to preserve comments in the output SQL code. Default: True
def show_sql(self, expression: sqlglot.expressions.Show) -> str:
429        def show_sql(self, expression: exp.Show) -> str:
430            this = f" {expression.name}"
431            full = " FULL" if expression.args.get("full") else ""
432            global_ = " GLOBAL" if expression.args.get("global") else ""
433
434            target = self.sql(expression, "target")
435            target = f" {target}" if target else ""
436            if expression.name in {"COLUMNS", "INDEX"}:
437                target = f" FROM{target}"
438            elif expression.name == "GRANTS":
439                target = f" FOR{target}"
440
441            db = self._prefixed_sql("FROM", expression, "db")
442
443            like = self._prefixed_sql("LIKE", expression, "like")
444            where = self.sql(expression, "where")
445
446            types = self.expressions(expression, key="types")
447            types = f" {types}" if types else types
448            query = self._prefixed_sql("FOR QUERY", expression, "query")
449
450            if expression.name == "PROFILE":
451                offset = self._prefixed_sql("OFFSET", expression, "offset")
452                limit = self._prefixed_sql("LIMIT", expression, "limit")
453            else:
454                offset = ""
455                limit = self._oldstyle_limit_sql(expression)
456
457            log = self._prefixed_sql("IN", expression, "log")
458            position = self._prefixed_sql("FROM", expression, "position")
459
460            channel = self._prefixed_sql("FOR CHANNEL", expression, "channel")
461
462            if expression.name == "ENGINE":
463                mutex_or_status = " MUTEX" if expression.args.get("mutex") else " STATUS"
464            else:
465                mutex_or_status = ""
466
467            return f"SHOW{full}{global_}{this}{target}{types}{db}{query}{log}{position}{channel}{mutex_or_status}{like}{where}{offset}{limit}"
Inherited Members
sqlglot.generator.Generator
Generator
generate
unsupported
sep
seg
pad_comment
maybe_comment
wrap
no_identify
normalize_func
indent
sql
uncache_sql
cache_sql
characterset_sql
column_sql
columnposition_sql
columndef_sql
columnconstraint_sql
autoincrementcolumnconstraint_sql
compresscolumnconstraint_sql
generatedasidentitycolumnconstraint_sql
notnullcolumnconstraint_sql
primarykeycolumnconstraint_sql
uniquecolumnconstraint_sql
createable_sql
create_sql
clone_sql
describe_sql
prepend_ctes
with_sql
cte_sql
tablealias_sql
bitstring_sql
hexstring_sql
bytestring_sql
rawstring_sql
datatypesize_sql
datatype_sql
directory_sql
delete_sql
drop_sql
except_sql
except_op
fetch_sql
filter_sql
hint_sql
index_sql
identifier_sql
inputoutputformat_sql
national_sql
partition_sql
properties_sql
root_properties
properties
with_properties
locate_properties
property_sql
likeproperty_sql
fallbackproperty_sql
journalproperty_sql
freespaceproperty_sql
checksumproperty_sql
mergeblockratioproperty_sql
datablocksizeproperty_sql
blockcompressionproperty_sql
isolatedloadingproperty_sql
lockingproperty_sql
withdataproperty_sql
insert_sql
intersect_sql
intersect_op
introducer_sql
pseudotype_sql
onconflict_sql
returning_sql
rowformatdelimitedproperty_sql
table_sql
tablesample_sql
pivot_sql
tuple_sql
update_sql
values_sql
var_sql
into_sql
from_sql
group_sql
having_sql
join_sql
lambda_sql
lateral_sql
limit_sql
offset_sql
setitem_sql
set_sql
pragma_sql
lock_sql
literal_sql
loaddata_sql
null_sql
boolean_sql
order_sql
cluster_sql
distribute_sql
sort_sql
ordered_sql
matchrecognize_sql
query_modifiers
offset_limit_modifiers
after_having_modifiers
after_limit_modifiers
select_sql
schema_sql
schema_columns_sql
star_sql
parameter_sql
sessionparameter_sql
placeholder_sql
subquery_sql
qualify_sql
union_sql
union_op
unnest_sql
where_sql
window_sql
partition_by_sql
windowspec_sql
withingroup_sql
between_sql
bracket_sql
all_sql
any_sql
exists_sql
case_sql
constraint_sql
nextvaluefor_sql
extract_sql
trim_sql
safeconcat_sql
check_sql
foreignkey_sql
primarykey_sql
if_sql
matchagainst_sql
jsonkeyvalue_sql
jsonobject_sql
openjsoncolumndef_sql
openjson_sql
in_sql
in_unnest_op
interval_sql
return_sql
reference_sql
anonymous_sql
paren_sql
neg_sql
not_sql
alias_sql
aliases_sql
attimezone_sql
add_sql
and_sql
connector_sql
bitwiseand_sql
bitwiseleftshift_sql
bitwisenot_sql
bitwiseor_sql
bitwiserightshift_sql
bitwisexor_sql
cast_sql
currentdate_sql
collate_sql
command_sql
comment_sql
mergetreettlaction_sql
mergetreettl_sql
transaction_sql
commit_sql
rollback_sql
altercolumn_sql
renametable_sql
altertable_sql
droppartition_sql
addconstraint_sql
distinct_sql
ignorenulls_sql
respectnulls_sql
intdiv_sql
dpipe_sql
safedpipe_sql
div_sql
overlaps_sql
distance_sql
dot_sql
eq_sql
escape_sql
glob_sql
gt_sql
gte_sql
ilike_sql
ilikeany_sql
is_sql
like_sql
likeany_sql
similarto_sql
lt_sql
lte_sql
mod_sql
mul_sql
neq_sql
nullsafeeq_sql
nullsafeneq_sql
or_sql
slice_sql
sub_sql
trycast_sql
use_sql
binary
function_fallback_sql
func
format_args
text_width
format_time
expressions
op_expressions
naked_property
set_operation
tag_sql
token_sql
userdefinedfunction_sql
joinhint_sql
kwarg_sql
when_sql
merge_sql
tochar_sql
dictproperty_sql
dictrange_sql
dictsubproperty_sql
oncluster_sql