gudusoft.gsqlparser.parser

Class OceanBaseMysqlSqlParser

Object

gudusoft.gsqlparser.parser.AbstractSqlParser

gudusoft.gsqlparser.parser.OceanBaseMysqlSqlParser

All Implemented Interfaces:

SqlParser

public class OceanBaseMysqlSqlParser
extends AbstractSqlParser

OceanBase user tenant — MySQL compatibility mode parser (Phase 2 fork).

This class is a verbatim fork of MySqlSqlParser with class names rewritten to point at the forked grammar artifacts under gsp_java_parser/.../parser/oceanbasemysql/. The structural intent is identical to the MySQL parser; what differs is:

• It uses TLexerOceanbasemysql and TParserOceanbasemysql (generated from the forked lzlexoceanbasemysql.l / lzyaccoceanbasemysql.y sources by parsetable's generic-vendor fallback path).
• It registers as EDbVendor.dbvoceanbase so downstream components (sqlcmds, IdentifierProfile, the various TSQLEnv EnumMaps) consult OceanBase rules rather than MySQL rules.
• It is selected by OceanBaseSqlParser when the active EOBTenantMode is EOBTenantMode.MYSQL or EOBTenantMode.SYSTEM.

Phase 2 ships this fork at zero divergence from the MySQL base grammar — same shift/reduce conflicts, same token positions, same statement coverage. OceanBase-specific extensions (hints, partition extensions, tenant DDL, outlines, tablegroups) arrive incrementally in Phase 4 via additive edits to the .y source. Each Phase 4 addition is tracked in oceanbasemysql/FORK_DIVERGENCE.md.

Backporting upstream MySQL grammar fixes is documented in the Phase 0 plan (gsp_java_core/doc/oceanbase/PHASE0_REPORT.md) and the per-fork oceanbasemysql/REGEN.md.

Since:

4.0.1.4

See Also:

the unmodified base parser this class was forked from, the mode-routing adapter that selects this parser, forked lexer, forked parser

Nested Class Summary

Nested classes/interfaces inherited from class gudusoft.gsqlparser.parser.AbstractSqlParser

AbstractSqlParser.PreparedSqlReader

Field Summary

Fields

Modifier and Type	Field and Description
TLexerOceanbasemysql	flexer The MySQL lexer used for tokenization (public for TGSqlParser.getFlexer())

Fields inherited from class gudusoft.gsqlparser.parser.AbstractSqlParser

defaultDelimiterStr, delimiterChar, frameStack, globalContext, globalFrame, lexer, parserContext, sourcetokenlist, sqlcmds, sqlEnv, sqlstatements, syntaxErrors, vendor

Constructor Summary

Constructors

Constructor and Description
OceanBaseMysqlSqlParser() Construct MySQL SQL parser.

Method Summary

Modifier and Type	Method and Description
protected void	extractVendorRawStatements(SqlParseResult.Builder builder) Call MySQL-specific raw statement extraction logic.
protected TCustomLexer	getLexer(ParserContext context) Return the MySQL lexer instance.
protected TCustomParser	getParser(ParserContext context, TSourceTokenList tokens) Return the MySQL SQL parser instance with updated token list.
protected TStatementList	performParsing(ParserContext context, TCustomParser parser, TCustomParser secondaryParser, TSourceTokenList tokens, TStatementList rawStatements) Perform full parsing of statements with syntax checking.
protected void	setupVendorParsersForExtraction() Setup MySQL parser for raw statement extraction.
protected void	tokenizeVendorSql() Call MySQL-specific tokenization logic.
String	toString()

Methods inherited from class gudusoft.gsqlparser.parser.AbstractSqlParser

afterStatementParsed, attemptErrorRecovery, copyErrorsFromStatement, doAfterTokenize, doExtractRawStatements, extractRawStatements, getanewsourcetoken, getDefaultDelimiterStr, getDelimiterChar, getErrorCount, getrawsqlstatements, getSecondaryParser, getSyntaxErrors, getVendor, handleStatementParsingException, initializeGlobalContext, isDollarFunctionDelimiter, onRawStatementComplete, onRawStatementCompleteVendorSpecific, parse, performInterpreter, performSemanticAnalysis, performTokenization, prepareSqlReader, processTokensBeforeParse, processTokensInTokenTable, setTokenHandle, tokenize, towinlinebreak

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

flexer

public TLexerOceanbasemysql flexer

The MySQL lexer used for tokenization (public for TGSqlParser.getFlexer())

Constructor Detail

OceanBaseMysqlSqlParser

public OceanBaseMysqlSqlParser()

Construct MySQL SQL parser.

Configures the parser for MySQL database with default delimiter: semicolon (;)

Following the original TGSqlParser pattern, the lexer and parser are created once in the constructor and reused for all parsing operations.

Method Detail

getLexer

protected TCustomLexer getLexer(ParserContext context)

Return the MySQL lexer instance.

The lexer is created once in the constructor and reused for all parsing operations. This method simply returns the existing instance, matching the original TGSqlParser pattern where the lexer is created once and reset before each use.

Specified by:

getLexer in class AbstractSqlParser

Parameters:

context - parser context (not used, lexer already created)

Returns:

the MySQL lexer instance created in constructor

getParser

protected TCustomParser getParser(ParserContext context,
                                  TSourceTokenList tokens)

Return the MySQL SQL parser instance with updated token list.

The parser is created once in the constructor and reused for all parsing operations. This method updates the token list and returns the existing instance, matching the original TGSqlParser pattern.

Specified by:

getParser in class AbstractSqlParser

Parameters:

context - parser context (not used, parser already created)

tokens - source token list to parse

Returns:

the MySQL SQL parser instance created in constructor

tokenizeVendorSql

protected void tokenizeVendorSql()

Call MySQL-specific tokenization logic.

Delegates to domysqltexttotokenlist which handles MySQL's specific keyword recognition, delimiter handling, and token generation.

Specified by:

tokenizeVendorSql in class AbstractSqlParser

setupVendorParsersForExtraction

protected void setupVendorParsersForExtraction()

Setup MySQL parser for raw statement extraction.

MySQL uses a single parser, so we inject sqlcmds and update the token list for the main parser only.

Specified by:

setupVendorParsersForExtraction in class AbstractSqlParser

extractVendorRawStatements

protected void extractVendorRawStatements(SqlParseResult.Builder builder)

Call MySQL-specific raw statement extraction logic.

Delegates to domysqlgetrawsqlstatements which handles MySQL's statement delimiters (semicolon by default, or custom delimiter via DELIMITER command).

Specified by:

extractVendorRawStatements in class AbstractSqlParser

Parameters:

builder - the result builder to populate with raw statements

performParsing

protected TStatementList performParsing(ParserContext context,
                                        TCustomParser parser,
                                        TCustomParser secondaryParser,
                                        TSourceTokenList tokens,
                                        TStatementList rawStatements)

Perform full parsing of statements with syntax checking.

This method orchestrates the parsing of all statements.

Important: This method does NOT extract raw statements - they are passed in as a parameter already extracted by AbstractSqlParser.extractRawStatements(gudusoft.gsqlparser.parser.ParserContext, gudusoft.gsqlparser.TSourceTokenList, gudusoft.gsqlparser.TCustomLexer, long).

Specified by:

performParsing in class AbstractSqlParser

Parameters:

context - parser context

parser - main SQL parser (TParserOceanbasemysql)

secondaryParser - not used for MySQL

tokens - source token list

rawStatements - raw statements already extracted (never null)

Returns:

list of fully parsed statements with AST built

toString

public String toString()

Overrides:

toString in class AbstractSqlParser