Interface | Description |
---|---|
AggregatedTable |
A table that has been performed on the aggregate function.
|
Compilable |
Represents an artifact that can be compiled to a
CompiledPlan . |
CompiledPlan |
Represents an immutable, fully optimized, and executable entity that has been compiled from a
Table & SQL API pipeline definition.
|
Executable |
Represents an artifact that can be executed.
|
Explainable<SELF extends Explainable<SELF>> |
Represents an artifact that can be explained using a summary string.
|
FlatAggregateTable | |
GroupedTable |
A table that has been grouped on a set of grouping keys.
|
GroupWindowedTable |
A table that has been windowed for
GroupWindow s. |
OverWindowedTable |
A table that has been windowed for
OverWindow s. |
PlannerConfig |
The
PlannerConfig holds parameters to configure the behavior of queries. |
StatementSet |
A
StatementSet accepts pipelines defined by DML statements or Table objects. |
Table |
The
Table object is the core abstraction of the Table API. |
TableEnvironment |
A table environment is the base class, entry point, and central context for creating Table and
SQL API programs.
|
TablePipeline |
Describes a complete pipeline from one or more source tables to a sink table.
|
TableResult |
A TableResult is the representation of the statement execution result.
|
WindowGroupedTable |
A table that has been windowed and grouped for
GroupWindow s. |
Class | Description |
---|---|
ApiExpression |
Java API class that gives access to expression operations.
|
DataTypes |
A
DataType can be used to declare input and/or output types of operations. |
DataTypes.AbstractField |
Common helper class for resolved and unresolved fields of a row or structured type.
|
DataTypes.Field |
Helper class for defining the field of a row or structured type.
|
DataTypes.Resolution |
Helper class for defining the resolution of an interval.
|
DataTypes.UnresolvedField |
Helper class for defining the unresolved field of a row or structured type.
|
EnvironmentSettings |
Defines all parameters that initialize a table environment.
|
EnvironmentSettings.Builder |
A builder for
EnvironmentSettings . |
Expressions |
Entry point of the Table API Expression DSL such as:
$("myField").plus(10).abs() |
FormatDescriptor |
Describes a
format and its options for use with TableDescriptor . |
FormatDescriptor.Builder |
Builder for
FormatDescriptor . |
GroupWindow |
A group window specification.
|
Over |
Helper class for creating an over window.
|
OverWindow |
An over window specification.
|
OverWindowPartitioned |
Partially defined over window with partitioning.
|
OverWindowPartitionedOrdered |
Partially defined over window with (optional) partitioning and order.
|
OverWindowPartitionedOrderedPreceding |
Partially defined over window with (optional) partitioning, order, and preceding.
|
PlanReference |
Unresolved pointer to a persisted plan.
|
PlanReference.ContentPlanReference |
Plan reference to a string containing the serialized persisted plan in JSON.
|
PlanReference.FilePlanReference |
Plan reference to a file in the local filesystem.
|
PlanReference.ResourcePlanReference |
Plan reference to a file in the provided
ClassLoader . |
Schema |
Schema of a table or view.
|
Schema.Builder |
A builder for constructing an immutable but still unresolved
Schema . |
Schema.UnresolvedColumn |
Super class for all kinds of columns in an unresolved schema.
|
Schema.UnresolvedComputedColumn |
Declaration of a computed column that will be resolved to
Column.ComputedColumn during
schema resolution. |
Schema.UnresolvedConstraint |
Super class for all kinds of constraints in an unresolved schema.
|
Schema.UnresolvedMetadataColumn |
Declaration of a metadata column that will be resolved to
Column.MetadataColumn during
schema resolution. |
Schema.UnresolvedPhysicalColumn |
Declaration of a physical column that will be resolved to
Column.PhysicalColumn during
schema resolution. |
Schema.UnresolvedPrimaryKey |
Declaration of a primary key that will be resolved to
UniqueConstraint during schema
resolution. |
Schema.UnresolvedWatermarkSpec |
Declaration of a watermark strategy that will be resolved to
WatermarkSpec during
schema resolution. |
Session |
Helper class for creating a session window.
|
SessionWithGap |
Session window.
|
SessionWithGapOnTime |
Session window on time.
|
SessionWithGapOnTimeWithAlias |
Session window on time with alias.
|
Slide |
Helper class for creating a sliding window.
|
SlideWithSize |
Partially specified sliding window.
|
SlideWithSizeAndSlide |
Sliding window.
|
SlideWithSizeAndSlideOnTime |
Sliding window on time.
|
SlideWithSizeAndSlideOnTimeWithAlias |
Sliding window on time with alias.
|
TableColumn | Deprecated
See
ResolvedSchema and Column . |
TableColumn.ComputedColumn |
Representation of a computed column.
|
TableColumn.MetadataColumn |
Representation of a metadata column.
|
TableColumn.PhysicalColumn |
Representation of a physical column.
|
TableConfig |
Configuration for the current
TableEnvironment session to adjust Table & SQL API
programs. |
TableDescriptor |
Describes a
CatalogTable representing a source or sink. |
TableDescriptor.Builder |
Builder for
TableDescriptor . |
TableSchema | Deprecated
This class has been deprecated as part of FLIP-164.
|
TableSchema.Builder |
Builder for creating a
TableSchema . |
Tumble |
Helper class for creating a tumbling window.
|
TumbleWithSize |
Tumbling window.
|
TumbleWithSizeOnTime |
Tumbling window on time.
|
TumbleWithSizeOnTimeWithAlias |
Tumbling window on time with alias.
|
Types | Deprecated
This class will be removed in future versions as it uses the old type system.
|
WatermarkSpec | Deprecated
See
ResolvedSchema and WatermarkSpec . |
Enum | Description |
---|---|
ExplainDetail |
ExplainDetail defines the types of details for explain result.
|
JsonExistsOnError |
Behavior in case of errors for
BuiltInFunctionDefinitions.JSON_EXISTS . |
JsonOnNull |
Behavior for entries with a null value for
BuiltInFunctionDefinitions.JSON_OBJECT and
BuiltInFunctionDefinitions.JSON_ARRAY . |
JsonQueryOnEmptyOrError |
Behavior of
BuiltInFunctionDefinitions.JSON_QUERY in case a path expression is empty or
raises an error. |
JsonQueryWrapper |
Defines whether and when to wrap the result of
BuiltInFunctionDefinitions.JSON_QUERY into
an array. |
JsonType |
Supported JSON types for
BuiltInFunctionDefinitions.IS_JSON . |
JsonValueOnEmptyOrError |
Behavior for
BuiltInFunctionDefinitions.JSON_VALUE . |
ResultKind |
ResultKind defines the types of the result.
|
SqlDialect |
Enumeration of valid SQL compatibility modes.
|
Exception | Description |
---|---|
AmbiguousTableFactoryException | Deprecated
This exception is considered internal and has been erroneously placed in the *.api
package.
|
CatalogNotExistException |
Exception for an operation on a nonexistent catalog.
|
ExpressionParserException | Deprecated
This exception is considered internal and has been erroneously placed in the *.api
package.
|
NoMatchingTableFactoryException | Deprecated
This exception is considered internal and has been erroneously placed in the *.api
package.
|
SqlParserEOFException |
Exception for incomplete sql statement found while sql parsing.
|
SqlParserException |
Exception for all errors occurring during sql parsing.
|
TableException |
General Exception for all errors during table handling.
|
TableNotExistException |
Exception for an operation on a nonexistent table.
|
ValidationException |
Exception for all errors occurring during validation phase.
|
Copyright © 2014–2022 The Apache Software Foundation. All rights reserved.