gudusoft.gsqlparser.parser

Class OceanBaseSqlParser

Object

gudusoft.gsqlparser.parser.OceanBaseSqlParser

All Implemented Interfaces:

SqlParser

public class OceanBaseSqlParser
extends Object
implements SqlParser

OceanBase SQL parser — Phase 1 delegation skeleton.

OceanBase is a multi-tenant database whose SQL surface depends on the tenant kind. Each tenant is permanently MySQL-compatible, Oracle-compatible, or the system (sys) tenant. This parser is a thin SqlParser adapter that selects a delegate based on the EOBTenantMode carried inside ParserContext (mirrored from TGSqlParser.setOBTenantMode).

Phase 1 scope

This class implements SqlParser directly rather than extending AbstractSqlParser. The reason is that AbstractSqlParser.parse(gudusoft.gsqlparser.parser.ParserContext) is final and the template method orchestrates state on the subclass instance (sourcetokenlist, sqlstatements, lexer, parserContext, etc.). Splitting that state across an OceanBase wrapper plus a wrapped MySQL/Oracle delegate would be a concurrency-unsafe nightmare and defeat the purpose of the abstract template. By implementing the small SqlParser interface directly, Phase 1 forwards the entire parse cycle to a single delegate as an atomic unit, which is both simpler and easier to reason about.

The delegate's lexer/parser/AST machinery is reused as-is. AST nodes built during delegation report dbvoceanbase as their vendor because TGSqlParser.doDelegatedRawParse re-binds the NodeFactory back-reference to the OceanBase-configured TGSqlParser after the vendor parser returns. This is the same fixup mechanism existing delegated vendors rely on.

What Phase 1 does NOT do

• Does NOT parse OceanBase-specific syntax such as CREATE TENANT, ALTER SYSTEM, OB hint payloads, OB partition syntax, tablegroups, outlines, or global indexes. OB-specific syntax is added incrementally in Phase 4 after the grammar forks land in Phases 2/3.
• Does NOT auto-detect tenant mode from SQL content. Mode is strictly explicit via TGSqlParser.setOBTenantMode(gudusoft.gsqlparser.EOBTenantMode). Boundary detection of admin prefixes is handled by TSqlCmdsOceanbase for statement splitting only.
• Does NOT switch modes per-statement. One mode per TGSqlParser instance — OceanBase tenants are immutable in mode at creation time on the server side.

Promotion status

Phase 2 — landed: EOBTenantMode.MYSQL and EOBTenantMode.SYSTEM route to OceanBaseMysqlSqlParser (the forked MySQL grammar).

Phase 3 — landed: EOBTenantMode.ORACLE routes to OceanBaseOracleSqlParser (the forked Oracle dual grammar with full PL/SQL support). The public contract of this class does not change across these promotions.

Since:

4.0.1.4

See Also:

SqlParser, EOBTenantMode, TGSqlParser.setOBTenantMode(gudusoft.gsqlparser.EOBTenantMode)

Constructor Summary

Constructors

Constructor and Description
OceanBaseSqlParser() Construct an OceanBase parser.

Method Summary

Modifier and Type	Method and Description
SqlParseResult	getrawsqlstatements(ParserContext context) Extract raw SQL statements without full parsing.
EDbVendor	getVendor() Get the database vendor this parser handles.
SqlParseResult	parse(ParserContext context) Parse SQL from the given context.
SqlParseResult	tokenize(ParserContext context) Tokenize SQL without parsing or statement extraction.

Methods inherited from class Object

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

Methods inherited from interface gudusoft.gsqlparser.parser.SqlParser

doExtractRawStatements

Constructor Detail

OceanBaseSqlParser

public OceanBaseSqlParser()

Construct an OceanBase parser. Delegates are created lazily on the first parse call so a parser configured for dbvoceanbase but never actually used does not pay any allocation cost.

Method Detail

getVendor

public EDbVendor getVendor()

Description copied from interface: SqlParser

Get the database vendor this parser handles.

Specified by:

getVendor in interface SqlParser

Returns:

the database vendor (e.g., dbvoracle, dbvmysql)

parse

public SqlParseResult parse(ParserContext context)

Description copied from interface: SqlParser

Parse SQL from the given context.

This method performs full parsing including:

• Tokenization (lexical analysis)
• Syntax analysis (building parse tree)
• Semantic analysis (resolving references)

All inputs come from the context parameter, all outputs go to the result. This ensures clean separation of concerns and thread-safety.

Specified by:

parse in interface SqlParser

Parameters:

context - immutable context containing all parser inputs (SQL text, options, callbacks, etc.)

Returns:

immutable result containing all parser outputs (statements, tokens, errors, etc.)

tokenize

public SqlParseResult tokenize(ParserContext context)

Description copied from interface: SqlParser

Tokenize SQL without parsing or statement extraction.

This method performs only tokenization (lexical analysis):

• Tokenization (lexical analysis)

The result contains tokens but NO statements. Use this when you only need the token stream (e.g., for syntax highlighting, token analysis).

For statement boundaries without full parsing, use SqlParser.getrawsqlstatements(ParserContext).

Specified by:

tokenize in interface SqlParser

Parameters:

context - immutable context containing all parser inputs

Returns:

immutable result containing tokens only (no statements)

getrawsqlstatements

public SqlParseResult getrawsqlstatements(ParserContext context)

Description copied from interface: SqlParser

Extract raw SQL statements without full parsing.

This method performs:

• Tokenization (lexical analysis)
• Raw statement extraction (statement boundary detection)

This is faster than SqlParser.parse(ParserContext) because it skips detailed syntax checking and semantic analysis. The statements returned have their tokens grouped correctly but no AST (parse tree) is built.

Use cases:

• Split a script into individual statements
• Determine statement types without full parsing
• Quick validation of statement boundaries
• Pre-processing before selective parsing

Equivalent to legacy API: TGSqlParser.getrawsqlstatements()

Default implementation: For parsers still in delegation phase, this default implementation falls back to SqlParser.tokenize(ParserContext). Parsers extending AbstractSqlParser override this with proper implementation.

Specified by:

getrawsqlstatements in interface SqlParser

Parameters:

context - immutable context containing all parser inputs

Returns:

immutable result containing tokens and raw statements (no AST)