org.apache.calcite.sql.parser

Class SqlParser

java.lang.Object

org.apache.calcite.sql.parser.SqlParser

@Value.Enclosing
public class SqlParser
extends Object

A SqlParser parses a SQL statement.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SqlParser.Config Interface to define the configuration for a SQL parser.
static class	SqlParser.ConfigBuilder Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ALLOW_BANG_EQUAL Deprecated.
static int	DEFAULT_IDENTIFIER_MAX_LENGTH
static com.google.common.collect.ImmutableMap<String,org.apache.calcite.avatica.util.TimeUnit>	DEFAULT_IDENTIFIER_TIMEUNIT_MAP Default value of SqlParser.Config.timeUnitCodes().

Method Summary

Modifier and Type	Method and Description
static SqlParser.Config	config() Returns a default SqlParser.Config.
static SqlParser.ConfigBuilder	configBuilder() Deprecated. Use config()
static SqlParser.ConfigBuilder	configBuilder(SqlParser.Config config) Deprecated. Use config, and modify it using its mutator methods
static SqlParser	create(Reader reader, SqlParser.Config config) Creates a SqlParser to parse the given string using the parser implementation created from given SqlParserImplFactory with given quoting syntax and casing policies for identifiers.
static SqlParser	create(String s) Creates a SqlParser to parse the given string using Calcite's parser implementation.
static SqlParser	create(String sql, SqlParser.Config config) Creates a SqlParser to parse the given string using the parser implementation created from given SqlParserImplFactory with given quoting syntax and casing policies for identifiers.
org.apache.calcite.sql.parser.SqlAbstractParserImpl.Metadata	getMetadata() Get the parser metadata.
List<CalciteContextException>	getWarnings() Returns the warnings that were generated by the previous invocation of the parser.
SqlNode	parseExpression() Parses a SQL expression.
SqlNode	parseQuery() Parses a SELECT statement.
SqlNode	parseQuery(String sql) Parses a SELECT statement and reuses parser.
SqlNode	parseStmt() Parses an SQL statement.
SqlNodeList	parseStmtList() Parses a list of SQL statements separated by semicolon.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_IDENTIFIER_MAX_LENGTH

public static final int DEFAULT_IDENTIFIER_MAX_LENGTH

See Also:

Constant Field Values

DEFAULT_IDENTIFIER_TIMEUNIT_MAP

public static final com.google.common.collect.ImmutableMap<String,org.apache.calcite.avatica.util.TimeUnit> DEFAULT_IDENTIFIER_TIMEUNIT_MAP

Default value of SqlParser.Config.timeUnitCodes(). The map is empty, which means that there are no abbreviations other than the time unit names ("YEAR", "SECOND", etc.)

DEFAULT_ALLOW_BANG_EQUAL

@Deprecated
public static final boolean DEFAULT_ALLOW_BANG_EQUAL

Deprecated.

Method Detail

create

public static SqlParser create(String s)

Creates a SqlParser to parse the given string using Calcite's parser implementation.

The default lexical policy is similar to Oracle.

Parameters:

s - An SQL statement or expression to parse.

Returns:

A parser

See Also:

Lex.ORACLE

create

public static SqlParser create(String sql,
                               SqlParser.Config config)

Creates a SqlParser to parse the given string using the parser implementation created from given SqlParserImplFactory with given quoting syntax and casing policies for identifiers.

Parameters:

sql - A SQL statement or expression to parse

config - The parser configuration (identifier max length, etc.)

Returns:

A parser

create

public static SqlParser create(Reader reader,
                               SqlParser.Config config)

Creates a SqlParser to parse the given string using the parser implementation created from given SqlParserImplFactory with given quoting syntax and casing policies for identifiers.

Unlike create(java.lang.String, org.apache.calcite.sql.parser.SqlParser.Config), the parser is not able to return the original query string, but will instead return "?".

Parameters:

reader - The source for the SQL statement or expression to parse

config - The parser configuration (identifier max length, etc.)

Returns:

A parser

parseExpression

public SqlNode parseExpression()
                        throws SqlParseException

Parses a SQL expression.

Throws:

SqlParseException - if there is a parse error

parseQuery

public SqlNode parseQuery()
                   throws SqlParseException

Parses a SELECT statement.

Returns:

A SqlSelect for a regular SELECT statement; a SqlBinaryOperator for a UNION, INTERSECT, or EXCEPT.

Throws:

SqlParseException - if there is a parse error

parseQuery

public SqlNode parseQuery(String sql)
                   throws SqlParseException

Parses a SELECT statement and reuses parser.

Parameters:

sql - sql to parse

Returns:

A SqlSelect for a regular SELECT statement; a SqlBinaryOperator for a UNION, INTERSECT, or EXCEPT.

Throws:

SqlParseException - if there is a parse error

parseStmt

public SqlNode parseStmt()
                  throws SqlParseException

Parses an SQL statement.

Returns:

top-level SqlNode representing stmt

Throws:

SqlParseException - if there is a parse error

parseStmtList

public SqlNodeList parseStmtList()
                          throws SqlParseException

Parses a list of SQL statements separated by semicolon. The semicolon is required between statements, but is optional at the end.

Returns:

list of SqlNodeList representing the list of SQL statements

Throws:

SqlParseException - if there is a parse error

getMetadata

public org.apache.calcite.sql.parser.SqlAbstractParserImpl.Metadata getMetadata()

Get the parser metadata.

Returns:

SqlAbstractParserImpl.Metadata implementation of underlying parser.

getWarnings

public List<CalciteContextException> getWarnings()

Returns the warnings that were generated by the previous invocation of the parser.

config

public static SqlParser.Config config()

Returns a default SqlParser.Config.

configBuilder

@Deprecated
public static SqlParser.ConfigBuilder configBuilder()

Deprecated. Use config()

Builder for a SqlParser.Config.

configBuilder

@Deprecated
public static SqlParser.ConfigBuilder configBuilder(SqlParser.Config config)

Deprecated. Use config, and modify it using its mutator methods

Builder for a SqlParser.Config that starts with an existing Config.