org.apache.calcite.sql (Calcite Core 1.2.0-incubating API)

Interface Summary
Interface	Description
SqlLiteral.SqlSymbol	A value must implement this interface if it is to be embedded as a SqlLiteral of type SYMBOL.
SqlOperandCountRange	A class that describes how many operands an operator can take.
SqlOperatorTable	SqlOperatorTable defines a directory interface for enumerating and looking up SQL operators and functions.
SqlWriter	A `SqlWriter` is the target to construct a SQL statement from a parse tree.
SqlWriter.Frame	A Frame is a piece of generated text which shares a common indentation level.
SqlWriter.FrameType	Frame type.

Class Summary
Class	Description
ExplicitOperatorBinding	`ExplicitOperatorBinding` implements `SqlOperatorBinding` via an underlying array of known operand types.
SqlAccessType	SqlAccessType is represented by a set of allowed access types
SqlAggFunction	Abstract base class for the definition of an aggregate function: an operator which aggregates sets of values into a result.
SqlAsOperator	The `AS` operator associates an expression with an alias.
SqlBasicCall	Implementation of `SqlCall` that keeps its operands in an array.
SqlBinaryOperator	`SqlBinaryOperator` is a binary operator.
SqlBinaryStringLiteral	A binary (or hexadecimal) string literal.
SqlCall	A `SqlCall` is a call to an `operator`.
SqlCallBinding	`SqlCallBinding` implements `SqlOperatorBinding` by analyzing to the operands of a `SqlCall` with a `SqlValidator`.
SqlCharStringLiteral	A character string literal.
SqlCollation	A `SqlCollation` is an object representing a `Collate` statement.
SqlDataTypeSpec	Represents a SQL data type specification in a parse tree.
SqlDateLiteral	A SQL literal representing a DATE value, such as `DATE '2004-10-22'`.
SqlDelete	A `SqlDelete` is a node of a parse tree which represents a DELETE statement.
SqlDialect	`SqlDialect` encapsulates the differences between dialects of SQL.
SqlDialect.FakeUtil	A few utility functions copied from org.apache.calcite.util.Util.
SqlDynamicParam	A `SqlDynamicParam` represents a dynamic parameter marker in an SQL statement.
SqlExplain	A `SqlExplain` is a node of a parse tree which represents an EXPLAIN PLAN statement.
SqlFunction	A `SqlFunction` is a type of operator which has conventional function-call syntax.
SqlFunctionalOperator	SqlFunctionalOperator is a base class for special operators which use functional syntax.
SqlIdentifier	A `SqlIdentifier` is an identifier, possibly compound.
SqlInfixOperator	A generalization of a binary operator to involve several (two or more) arguments, and keywords between each pair of arguments.
SqlInsert	A `SqlInsert` is a node of a parse tree which represents an INSERT statement.
SqlInternalOperator	Generic operator for nodes with internal syntax.
SqlIntervalLiteral	A SQL literal representing a time interval.
SqlIntervalLiteral.IntervalValue	A Interval value.
SqlIntervalQualifier	Represents an INTERVAL qualifier.
SqlJdbcFunctionCall	A `SqlJdbcFunctionCall` is a node of a parse tree which represents a JDBC function call.
SqlJoin	Parse tree node representing a `JOIN` clause.
SqlJoin.SqlJoinOperator	`SqlJoinOperator` describes the syntax of the SQL `JOIN` operator.
SqlLiteral	A `SqlLiteral` is a constant.
SqlMerge	A `SqlMerge` is a node of a parse tree which represents a MERGE statement.
SqlNode	A `SqlNode` is a SQL parse tree.
SqlNodeList	A `SqlNodeList` is a list of `SqlNode`s.
SqlNumericLiteral	A numeric SQL literal.
SqlOperator	A `SqlOperator` is a type of node in a SQL parse tree (it is NOT a node in a SQL parse tree).
SqlOperatorBinding	`SqlOperatorBinding` represents the binding of an `SqlOperator` to actual operands, along with any additional information required to validate those operands if needed.
SqlOrderBy	Parse tree node that represents an `ORDER BY` on a query other than a `SELECT` (e.g.
SqlOverOperator	An operator describing a window function specification.
SqlPostfixOperator	A postfix unary operator.
SqlPrefixOperator	A unary operator.
SqlProcedureCallOperator	SqlProcedureCallOperator represents the CALL statement.
SqlRankFunction	Operator which aggregates sets of values into a result.
SqlSampleSpec	Specification of a SQL sample.
SqlSampleSpec.SqlSubstitutionSampleSpec	Sample specification that orders substitution.
SqlSampleSpec.SqlTableSampleSpec	Sample specification.
SqlSelect	A `SqlSelect` is a node of a parse tree which represents a select statement.
SqlSelectOperator	An operator describing a query.
SqlSetOperator	SqlSetOperator represents a relational set theory operator (UNION, INTERSECT, MINUS).
SqlSetOption	SQL parse tree node to represent `ALTER scope SET option = value` statement.
SqlSpecialOperator	Generic operator for nodes with special syntax.
SqlTimeLiteral	A SQL literal representing a TIME value, for example `TIME '14:33:44.567'`.
SqlTimestampLiteral	A SQL literal representing a TIMESTAMP value, for example `TIMESTAMP '1969-07-21 03:15 GMT'`.
SqlUnnestOperator	The `UNNEST` operator.
SqlUnresolvedFunction	Placeholder for an unresolved function.
SqlUpdate	A `SqlUpdate` is a node of a parse tree which represents an UPDATE statement.
SqlUtil	Contains utility functions related to SQL parsing, all static.
SqlUtil.DatabaseMetaDataInvocationHandler	Handles particular `DatabaseMetaData` methods; invocations of other methods will fall through to the base class, `BarfingInvocationHandler`, which will throw an error.
SqlValuesOperator	The `VALUES` operator.
SqlWindow	SQL window specification.
SqlWith	The WITH clause of a query.
SqlWithItem	An item in a WITH clause of a query.

Enum Summary
Enum	Description
JoinConditionType	Enumerates the types of condition in a join expression.
JoinType	Enumerates the types of join.
SemiJoinType	Enumeration representing different join types used in correlation relations.
SqlAccessEnum	Enumeration representing different access types
SqlCollation.Coercibility	A <character value expression> consisting of a column reference has the coercibility characteristic Implicit, with collating sequence as defined when the column was created.
SqlDialect.DatabaseProduct	Rough list of flavors of database.
SqlExplain.Depth	The level of abstraction with which to display the plan.
SqlExplainLevel	SqlExplainLevel defines detail levels for EXPLAIN PLAN.
SqlFunctionCategory	Enumeration of the categories of SQL-invoked routines.
SqlInsertKeyword	Defines the keywords that can occur immediately after the "INSERT" keyword.
SqlKind	Enumerates the possible types of `SqlNode`.
SqlNullSemantics	SqlNullSemantics defines the possible comparison rules for values which might be null.
SqlSelectKeyword	Defines the keywords which can occur immediately after the "SELECT" keyword.
SqlStateCodes	Contains `Glossary.SQL2003` SQL state codes.
SqlSyntax	Enumeration of possible syntactic types of `operators`.
SqlWriter.FrameTypeEnum	Enumerates the types of frame.
SqlWriter.SubqueryStyle	Style of formatting subqueries.

Package org.apache.calcite.sql Description

Provides a SQL parser and object model.

This package, and the dependent org.apache.calcite.sql.parser package, are independent of the other Calcite packages, so may be used standalone.

Parser

SqlParser parses a SQL string to a parse tree. It only performs the most basic syntactic validation.

Object model

Every node in the parse tree is a SqlNode. Sub-types are:

SqlLiteral represents a boolean, numeric, string, or date constant, or the value NULL.
SqlIdentifier represents an identifier, such as EMPNO or emp.deptno.
SqlCall is a call to an operator or function. By means of special operators, we can use this construct to represent virtually every non-leaf node in the tree. For example, a select statement is a call to the 'select' operator.
SqlNodeList is a list of nodes.

A SqlOperator describes the behavior of a node in the tree, such as how to un-parse a SqlCall into a SQL string. It is important to note that operators are metadata, not data: there is only one SqlOperator instance representing the '=' operator, even though there may be many calls to it.

SqlOperator has several derived classes which make it easy to define new operators: SqlFunction, SqlBinaryOperator, SqlPrefixOperator, SqlPostfixOperator. And there are singleton classes for special syntactic constructs SqlSelectOperator and SqlJoin.SqlJoinOperator. (These special operators even have their own sub-types of SqlCall: SqlSelect and SqlJoin.)

A SqlOperatorTable is a collection of operators. By supplying your own operator table, you can customize the dialect of SQL without modifying the parser.

Validation

SqlValidator checks that a tree of SqlNodes is semantically valid. You supply a SqlOperatorTable to describe the available functions and operators, and a SqlValidatorCatalogReader for access to the database's catalog.

Generating SQL

A SqlWriter converts a tree of SqlNodes into a SQL string. A SqlDialect defines how this happens.