Edit on GitHub

sqlglot.dialects.mysql

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

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

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

Generator interprets the given syntax tree and produces a SQL string as an output.

Arguments:
  • time_mapping (dict): the dictionary of custom time mappings in which the key represents a python time format and the output the target time format
  • time_trie (trie): a trie of the time_mapping keys
  • pretty (bool): if set to True the returned string will be formatted. Default: False.
  • quote_start (str): specifies which starting character to use to delimit quotes. Default: '.
  • quote_end (str): specifies which ending character to use to delimit quotes. Default: '.
  • identifier_start (str): specifies which starting character to use to delimit identifiers. Default: ".
  • identifier_end (str): specifies which ending character to use to delimit identifiers. Default: ".
  • bit_start (str): specifies which starting character to use to delimit bit literals. Default: None.
  • bit_end (str): specifies which ending character to use to delimit bit literals. Default: None.
  • hex_start (str): specifies which starting character to use to delimit hex literals. Default: None.
  • hex_end (str): specifies which ending character to use to delimit hex literals. Default: None.
  • byte_start (str): specifies which starting character to use to delimit byte literals. Default: None.
  • byte_end (str): specifies which ending character to use to delimit byte literals. Default: None.
  • identify (bool | str): 'always': always quote, 'safe': quote identifiers if they don't contain an upcase, True defaults to always.
  • normalize (bool): if set to True all identifiers will lower cased
  • string_escape (str): specifies a string escape character. Default: '.
  • identifier_escape (str): specifies an identifier escape character. Default: ".
  • pad (int): determines padding in a formatted string. Default: 2.
  • indent (int): determines the size of indentation in a formatted string. Default: 4.
  • unnest_column_only (bool): if true unnest table aliases are considered only as column aliases
  • normalize_functions (str): normalize function names, "upper", "lower", or None Default: "upper"
  • alias_post_tablesample (bool): if the table alias comes after tablesample Default: False
  • unsupported_level (ErrorLevel): determines the generator's behavior when it encounters unsupported expressions. Default ErrorLevel.WARN.
  • null_ordering (str): Indicates the default null ordering method to use if not explicitly set. Options are "nulls_are_small", "nulls_are_large", "nulls_are_last". Default: "nulls_are_small"
  • max_unsupported (int): 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 (bool): if the the comma is leading or trailing in select statements 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:
430        def show_sql(self, expression: exp.Show) -> str:
431            this = f" {expression.name}"
432            full = " FULL" if expression.args.get("full") else ""
433            global_ = " GLOBAL" if expression.args.get("global") else ""
434
435            target = self.sql(expression, "target")
436            target = f" {target}" if target else ""
437            if expression.name in {"COLUMNS", "INDEX"}:
438                target = f" FROM{target}"
439            elif expression.name == "GRANTS":
440                target = f" FOR{target}"
441
442            db = self._prefixed_sql("FROM", expression, "db")
443
444            like = self._prefixed_sql("LIKE", expression, "like")
445            where = self.sql(expression, "where")
446
447            types = self.expressions(expression, key="types")
448            types = f" {types}" if types else types
449            query = self._prefixed_sql("FOR QUERY", expression, "query")
450
451            if expression.name == "PROFILE":
452                offset = self._prefixed_sql("OFFSET", expression, "offset")
453                limit = self._prefixed_sql("LIMIT", expression, "limit")
454            else:
455                offset = ""
456                limit = self._oldstyle_limit_sql(expression)
457
458            log = self._prefixed_sql("IN", expression, "log")
459            position = self._prefixed_sql("FROM", expression, "position")
460
461            channel = self._prefixed_sql("FOR CHANNEL", expression, "channel")
462
463            if expression.name == "ENGINE":
464                mutex_or_status = " MUTEX" if expression.args.get("mutex") else " STATUS"
465            else:
466                mutex_or_status = ""
467
468            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
create_sql
clone_sql
describe_sql
prepend_ctes
with_sql
cte_sql
tablealias_sql
bitstring_sql
hexstring_sql
bytestring_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
afterjournalproperty_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
after_having_modifiers
after_limit_modifiers
select_sql
schema_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
concat_sql
check_sql
foreignkey_sql
primarykey_sql
unique_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
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