gudusoft.gsqlparser.parser

Class DatabricksSqlParser

Object

gudusoft.gsqlparser.parser.AbstractSqlParser

gudusoft.gsqlparser.parser.DatabricksSqlParser

All Implemented Interfaces:

SqlParser

public class DatabricksSqlParser
extends AbstractSqlParser

Databricks SQL parser implementation.

This parser handles Databricks-specific SQL syntax including:

• Databricks SQL dialect and extensions
• Databricks PL/SQL blocks
• Special handling for VALUES keyword in INSERT statements
• Datatype casting with literals (e.g., DATE '2021-2-1')

Implementation Status: MIGRATED

• Phase: Complete migration from delegation to full AbstractSqlParser implementation
• Current: Self-contained Databricks parser using AbstractSqlParser template
• Goal: No delegation to legacy TGSqlParser

Since:

3.2.0.0

See Also:

SqlParser, AbstractSqlParser, TLexerDatabricks, TParserDatabricks

Nested Class Summary

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

AbstractSqlParser.PreparedSqlReader

Field Summary

Fields

Modifier and Type	Field and Description
TLexerDatabricks	flexer The Databricks lexer used for tokenization

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
DatabricksSqlParser() Construct Databricks SQL parser.

Method Summary

Modifier and Type	Method and Description
protected void	afterStatementParsed(TCustomSqlStatement stmt) Post-processing hook after each statement is parsed.
protected void	extractVendorRawStatements(SqlParseResult.Builder builder) Hook method: Extract raw Databricks SQL statements.
protected TCustomLexer	getLexer(ParserContext context) Return the Databricks lexer instance.
protected TCustomParser	getParser(ParserContext context, TSourceTokenList tokens) Return the Databricks SQL parser instance with updated token list.
protected TCustomParser	getSecondaryParser(ParserContext context, TSourceTokenList tokens) Databricks uses a single parser, no secondary parser needed.
protected void	handleCreateTableErrorRecovery(TCustomSqlStatement stmt) Handle error recovery for CREATE TABLE statements.
protected void	performInterpreter(ParserContext context, TStatementList statements) Perform interpretation (execute SQL in interpreter mode).
protected TStatementList	performParsing(ParserContext context, TCustomParser parser, TCustomParser secondaryParser, TSourceTokenList tokens, TStatementList rawStatements) Parse all raw statements to build AST.
protected void	performSemanticAnalysis(ParserContext context, TStatementList statements) Perform semantic analysis (resolve column-table relationships, etc.).
protected void	setupVendorParsersForExtraction() Hook method: Setup parsers for raw statement extraction.
protected void	tokenizeVendorSql() Hook method: Tokenize Databricks SQL by calling vendor-specific tokenization.
String	toString()

Methods inherited from class gudusoft.gsqlparser.parser.AbstractSqlParser

attemptErrorRecovery, copyErrorsFromStatement, doAfterTokenize, doExtractRawStatements, extractRawStatements, getanewsourcetoken, getDefaultDelimiterStr, getDelimiterChar, getErrorCount, getrawsqlstatements, getSyntaxErrors, getVendor, handleStatementParsingException, initializeGlobalContext, isDollarFunctionDelimiter, onRawStatementComplete, onRawStatementCompleteVendorSpecific, parse, 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 TLexerDatabricks flexer

The Databricks lexer used for tokenization

Constructor Detail

DatabricksSqlParser

public DatabricksSqlParser()

Construct Databricks SQL parser.

Configures the parser for Databricks 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 Databricks lexer instance.

The lexer is created once in the constructor and reused for all parsing operations.

Specified by:

getLexer in class AbstractSqlParser

Parameters:

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

Returns:

the Databricks lexer instance created in constructor

getParser

protected TCustomParser getParser(ParserContext context,
                                  TSourceTokenList tokens)

Return the Databricks SQL parser instance with updated token list.

The parser is created once in the constructor and reused for all parsing operations.

Specified by:

getParser in class AbstractSqlParser

Parameters:

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

tokens - source token list to parse

Returns:

the Databricks SQL parser instance created in constructor

getSecondaryParser

protected TCustomParser getSecondaryParser(ParserContext context,
                                           TSourceTokenList tokens)

Databricks uses a single parser, no secondary parser needed.

Overrides:

getSecondaryParser in class AbstractSqlParser

Parameters:

context - parser context

tokens - source token list

Returns:

null (no secondary parser)

tokenizeVendorSql

protected void tokenizeVendorSql()

Hook method: Tokenize Databricks SQL by calling vendor-specific tokenization.

Specified by:

tokenizeVendorSql in class AbstractSqlParser

setupVendorParsersForExtraction

protected void setupVendorParsersForExtraction()

Hook method: Setup parsers for raw statement extraction. Inject sqlcmds and sourcetokenlist into parser.

Specified by:

setupVendorParsersForExtraction in class AbstractSqlParser

extractVendorRawStatements

protected void extractVendorRawStatements(SqlParseResult.Builder builder)

Hook method: Extract raw Databricks SQL statements.

Specified by:

extractVendorRawStatements in class AbstractSqlParser

Parameters:

builder - the result builder to populate

performParsing

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

Parse all raw statements to build AST.

This method iterates through all raw statements and calls parsestatement() on each one to build the Abstract Syntax Tree. It handles error recovery for CREATE TABLE statements and collects syntax errors.

Specified by:

performParsing in class AbstractSqlParser

Parameters:

context - parser context with configuration

parser - primary parser instance

secondaryParser - secondary parser (null for Databricks)

tokens - source token list

rawStatements - raw statements from extraction phase

Returns:

statement list with parsed AST

afterStatementParsed

protected void afterStatementParsed(TCustomSqlStatement stmt)

Post-processing hook after each statement is parsed.

Default implementation does nothing. Override if needed for vendor-specific post-processing.

Overrides:

afterStatementParsed in class AbstractSqlParser

Parameters:

stmt - the statement that was just parsed

handleCreateTableErrorRecovery

protected void handleCreateTableErrorRecovery(TCustomSqlStatement stmt)

Handle error recovery for CREATE TABLE statements.

This method attempts to recover from parse errors in CREATE TABLE statements by marking unparseable table properties (like ROW FORMAT, STORED AS, etc.) as sqlpluscmd and retrying.

Databricks/Hive DDL allows complex table properties after the column definition that may not be fully supported in the grammar. This error recovery allows partial parsing of the main table structure.

Extracted from TGSqlParser.doparse() lines 16916-16971

Parameters:

stmt - the statement with errors

performSemanticAnalysis

protected void performSemanticAnalysis(ParserContext context,
                                       TStatementList statements)

Perform semantic analysis (resolve column-table relationships, etc.).

This method runs the TSQLResolver to build semantic relationships between columns and tables, among other analysis.

Overrides:

performSemanticAnalysis in class AbstractSqlParser

Parameters:

context - parser context

statements - statement list to analyze

performInterpreter

protected void performInterpreter(ParserContext context,
                                  TStatementList statements)

Perform interpretation (execute SQL in interpreter mode).

This method runs the TASTEvaluator to interpret/execute the SQL.

Overrides:

performInterpreter in class AbstractSqlParser

Parameters:

context - parser context

statements - statement list to interpret

toString

public String toString()

Overrides:

toString in class AbstractSqlParser