Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addSessionConfig(Map<String, String>) - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment.Builder
B
- build() - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment.Builder
- Builder() - Constructor for class org.apache.flink.table.gateway.api.session.SessionEnvironment.Builder
C
- CANCELED - Enum constant in enum org.apache.flink.table.gateway.api.operation.OperationStatus
-
Operation has been cancelled.
- cancelOperation(SessionHandle, OperationHandle) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Cancel the operation when it is not in terminal status.
- CLOSED - Enum constant in enum org.apache.flink.table.gateway.api.operation.OperationStatus
-
Operation has been closed and all related resources are collected.
- closeOperation(SessionHandle, OperationHandle) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Close the operation and release all used resource by the operation.
- closeSession(SessionHandle) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Close the
Session. - completeStatement(SessionHandle, String, int) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Returns a list of completion hints for the given statement at the given position.
- configureSession(SessionHandle, String, long) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Using the statement to initialize the Session.
- create() - Static method in class org.apache.flink.table.gateway.api.operation.OperationHandle
- create() - Static method in class org.apache.flink.table.gateway.api.session.SessionHandle
- create(ReadableConfig, ClassLoader) - Method in interface org.apache.flink.table.gateway.api.session.SessionEnvironment.CatalogCreator
- create(ReadableConfig, ClassLoader) - Method in interface org.apache.flink.table.gateway.api.session.SessionEnvironment.ModuleCreator
- createEndpointFactoryHelper(SqlGatewayEndpointFactory, SqlGatewayEndpointFactory.Context) - Static method in class org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactoryUtils
-
Creates a utility that helps to validate options for a
SqlGatewayEndpointFactory. - createSqlGatewayEndpoint(SqlGatewayEndpointFactory.Context) - Method in interface org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactory
-
Creates an endpoint from the given context and endpoint options.
- createSqlGatewayEndpoint(SqlGatewayService, Configuration) - Static method in class org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactoryUtils
-
Attempts to discover the appropriate endpoint factory and creates the instance of the endpoints.
D
- DefaultEndpointFactoryContext(SqlGatewayService, Configuration, Map<String, String>) - Constructor for class org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactoryUtils.DefaultEndpointFactoryContext
- deployScript(SessionHandle, URI, String, Configuration) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Deploy the script in application mode.
E
- EndpointVersion - Interface in org.apache.flink.table.gateway.api.endpoint
-
Version of the endpoint.
- EOS - Enum constant in enum org.apache.flink.table.gateway.api.results.ResultSet.ResultType
-
Indicate all results have been fetched.
- equals(Object) - Method in class org.apache.flink.table.gateway.api.operation.OperationHandle
- equals(Object) - Method in class org.apache.flink.table.gateway.api.results.FunctionInfo
- equals(Object) - Method in class org.apache.flink.table.gateway.api.results.OperationInfo
- equals(Object) - Method in class org.apache.flink.table.gateway.api.results.ResultSetImpl
- equals(Object) - Method in class org.apache.flink.table.gateway.api.results.TableInfo
- equals(Object) - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment
- equals(Object) - Method in class org.apache.flink.table.gateway.api.session.SessionHandle
- ERROR - Enum constant in enum org.apache.flink.table.gateway.api.operation.OperationStatus
-
Some error happens.
- executeStatement(SessionHandle, String, long, Configuration) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Execute the submitted statement.
F
- FETCH_NEXT - Enum constant in enum org.apache.flink.table.gateway.api.results.FetchOrientation
-
Fetch the next results.
- FETCH_PRIOR - Enum constant in enum org.apache.flink.table.gateway.api.results.FetchOrientation
-
Fetch the prior results.
- FetchOrientation - Enum in org.apache.flink.table.gateway.api.results
-
Orientation to fetch results.
- fetchResults(SessionHandle, OperationHandle, long, int) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Fetch the results from the operation.
- fetchResults(SessionHandle, OperationHandle, FetchOrientation, int) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Fetch the results from the operation.
- FINISHED - Enum constant in enum org.apache.flink.table.gateway.api.operation.OperationStatus
-
All the work is finished and ready for the client to fetch the results.
- FunctionInfo - Class in org.apache.flink.table.gateway.api.results
-
Info to describe the function.
- FunctionInfo(FunctionIdentifier) - Constructor for class org.apache.flink.table.gateway.api.results.FunctionInfo
- FunctionInfo(FunctionIdentifier, FunctionKind) - Constructor for class org.apache.flink.table.gateway.api.results.FunctionInfo
G
- GATEWAY_ENDPOINT_PREFIX - Static variable in class org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactoryUtils
- GatewayInfo - Class in org.apache.flink.table.gateway.api.results
-
Info to describe the
SqlGatewayService. - GatewayInfo() - Constructor for class org.apache.flink.table.gateway.api.results.GatewayInfo
- getConverter() - Method in class org.apache.flink.table.gateway.api.results.ResultSetImpl
- getCurrentCatalog(SessionHandle) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Return current catalog name.
- getData() - Method in interface org.apache.flink.table.gateway.api.results.ResultSet
-
All the data in the current results.
- getData() - Method in class org.apache.flink.table.gateway.api.results.ResultSetImpl
- getDefaultCatalog() - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment
- getEndpointConfig(Configuration, String) - Static method in class org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactoryUtils
- getEndpointOptions() - Method in interface org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactory.Context
-
Returns the options with which the endpoint is created.
- getEndpointOptions() - Method in class org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactoryUtils.DefaultEndpointFactoryContext
- getException() - Method in class org.apache.flink.table.gateway.api.results.OperationInfo
- getFlinkConfiguration() - Method in interface org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactory.Context
-
Gives read-only access to the configuration of the current session.
- getFlinkConfiguration() - Method in class org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactoryUtils.DefaultEndpointFactoryContext
- getFunctionDefinition(SessionHandle, UnresolvedIdentifier) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Get the specific definition of the function.
- getGatewayInfo() - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Get the info about the
SqlGatewayService. - getIdentifier() - Method in class org.apache.flink.table.gateway.api.operation.OperationHandle
- getIdentifier() - Method in class org.apache.flink.table.gateway.api.results.FunctionInfo
- getIdentifier() - Method in class org.apache.flink.table.gateway.api.results.TableInfo
- getIdentifier() - Method in class org.apache.flink.table.gateway.api.session.SessionHandle
- getJobID() - Method in interface org.apache.flink.table.gateway.api.results.ResultSet
-
If the statement was submitted to a client, returns the JobID which uniquely identifies the job.
- getJobID() - Method in class org.apache.flink.table.gateway.api.results.ResultSetImpl
- getKind() - Method in class org.apache.flink.table.gateway.api.results.FunctionInfo
- getNextToken() - Method in interface org.apache.flink.table.gateway.api.results.ResultSet
-
The token indicates the next batch of the data.
- getNextToken() - Method in class org.apache.flink.table.gateway.api.results.ResultSetImpl
- getOperationInfo(SessionHandle, OperationHandle) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Get the
OperationInfoof the operation. - getOperationResultSchema(SessionHandle, OperationHandle) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Get the result schema for the specified Operation.
- getProductName() - Method in class org.apache.flink.table.gateway.api.results.GatewayInfo
- getRegisteredCatalogCreators() - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment
- getRegisteredModuleCreators() - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment
- getResultKind() - Method in interface org.apache.flink.table.gateway.api.results.ResultSet
-
Gets the result kind of the result.
- getResultKind() - Method in class org.apache.flink.table.gateway.api.results.ResultSetImpl
- getResultSchema() - Method in interface org.apache.flink.table.gateway.api.results.ResultSet
-
The schema of the data.
- getResultSchema() - Method in class org.apache.flink.table.gateway.api.results.ResultSetImpl
- getResultType() - Method in interface org.apache.flink.table.gateway.api.results.ResultSet
-
Get the type of the results, which may indicate the result is EOS or has data.
- getResultType() - Method in class org.apache.flink.table.gateway.api.results.ResultSetImpl
- getSessionConfig() - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment
- getSessionConfig(SessionHandle) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Get the current configuration of the
Session. - getSessionEndpointVersion() - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment
- getSessionEndpointVersion(SessionHandle) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Get endpoint version that is negotiated in the openSession.
- getSessionName() - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment
- getSqlGatewayOptionPrefix(String) - Static method in class org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactoryUtils
- getSqlGatewayService() - Method in interface org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactory.Context
-
Get the service to execute the request.
- getSqlGatewayService() - Method in class org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactoryUtils.DefaultEndpointFactoryContext
- getStatus() - Method in class org.apache.flink.table.gateway.api.results.OperationInfo
- getTable(SessionHandle, ObjectIdentifier) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Return table of the given fully qualified name.
- getTableKind() - Method in class org.apache.flink.table.gateway.api.results.TableInfo
- getVersion() - Method in class org.apache.flink.table.gateway.api.results.GatewayInfo
H
- hashCode() - Method in class org.apache.flink.table.gateway.api.operation.OperationHandle
- hashCode() - Method in class org.apache.flink.table.gateway.api.results.FunctionInfo
- hashCode() - Method in class org.apache.flink.table.gateway.api.results.OperationInfo
- hashCode() - Method in class org.apache.flink.table.gateway.api.results.ResultSetImpl
- hashCode() - Method in class org.apache.flink.table.gateway.api.results.TableInfo
- hashCode() - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment
- hashCode() - Method in class org.apache.flink.table.gateway.api.session.SessionHandle
I
- INITIALIZED - Enum constant in enum org.apache.flink.table.gateway.api.operation.OperationStatus
-
The operation is newly created.
- INSTANCE - Static variable in class org.apache.flink.table.gateway.api.results.GatewayInfo
- isQueryResult() - Method in interface org.apache.flink.table.gateway.api.results.ResultSet
-
Indicates that whether the result is for a query.
- isQueryResult() - Method in class org.apache.flink.table.gateway.api.results.ResultSetImpl
- isTerminalStatus() - Method in enum org.apache.flink.table.gateway.api.operation.OperationStatus
- isValidStatusTransition(OperationStatus, OperationStatus) - Static method in enum org.apache.flink.table.gateway.api.operation.OperationStatus
L
- listCatalogs(SessionHandle) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Return all available catalogs in the current session.
- listDatabases(SessionHandle, String) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Return all available schemas in the given catalog.
- listSystemFunctions(SessionHandle) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
List all available system functions.
- listTables(SessionHandle, String, String, Set<CatalogBaseTable.TableKind>) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Return all available tables/views in the given catalog and database.
- listUserDefinedFunctions(SessionHandle, String, String) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
List all user defined functions.
N
- newBuilder() - Static method in class org.apache.flink.table.gateway.api.session.SessionEnvironment
- newThreadPool(int, int, long, String) - Static method in class org.apache.flink.table.gateway.api.utils.ThreadUtils
- NOT_READY - Enum constant in enum org.apache.flink.table.gateway.api.results.ResultSet.ResultType
-
Indicate the result is not ready.
O
- openSession(SessionEnvironment) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Open the
Session. - OperationHandle - Class in org.apache.flink.table.gateway.api.operation
-
OperationHandleto index theOperation. - OperationHandle(UUID) - Constructor for class org.apache.flink.table.gateway.api.operation.OperationHandle
- OperationInfo - Class in org.apache.flink.table.gateway.api.results
-
Information of the
Operation. - OperationInfo(OperationStatus) - Constructor for class org.apache.flink.table.gateway.api.results.OperationInfo
- OperationInfo(OperationStatus, Exception) - Constructor for class org.apache.flink.table.gateway.api.results.OperationInfo
- OperationStatus - Enum in org.apache.flink.table.gateway.api.operation
-
Status to describe the
Operation. - org.apache.flink.table.gateway.api - package org.apache.flink.table.gateway.api
- org.apache.flink.table.gateway.api.config - package org.apache.flink.table.gateway.api.config
- org.apache.flink.table.gateway.api.endpoint - package org.apache.flink.table.gateway.api.endpoint
- org.apache.flink.table.gateway.api.operation - package org.apache.flink.table.gateway.api.operation
- org.apache.flink.table.gateway.api.results - package org.apache.flink.table.gateway.api.results
- org.apache.flink.table.gateway.api.session - package org.apache.flink.table.gateway.api.session
- org.apache.flink.table.gateway.api.utils - package org.apache.flink.table.gateway.api.utils
P
- PAYLOAD - Enum constant in enum org.apache.flink.table.gateway.api.results.ResultSet.ResultType
-
Indicate the result has data.
- PENDING - Enum constant in enum org.apache.flink.table.gateway.api.operation.OperationStatus
-
Prepare the resources for the operation.
R
- refreshMaterializedTable(SessionHandle, String, boolean, String, Map<String, String>, Map<String, String>, Map<String, String>) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Trigger a refresh operation of specific materialized table.
- registerCatalog(String, Catalog) - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment.Builder
- registerCatalogCreator(String, SessionEnvironment.CatalogCreator) - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment.Builder
- registerModuleAtHead(String, Module) - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment.Builder
- registerModuleCreatorAtHead(String, SessionEnvironment.ModuleCreator) - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment.Builder
- ResultSet - Interface in org.apache.flink.table.gateway.api.results
-
A
ResultSetrepresents the collection of the results. - ResultSet.ResultType - Enum in org.apache.flink.table.gateway.api.results
-
Describe the kind of the result.
- ResultSetImpl - Class in org.apache.flink.table.gateway.api.results
-
An implementation of
ResultSet. - ResultSetImpl(ResultSet.ResultType, Long, ResolvedSchema, List<RowData>, RowDataToStringConverter, boolean, JobID, ResultKind) - Constructor for class org.apache.flink.table.gateway.api.results.ResultSetImpl
- RUNNING - Enum constant in enum org.apache.flink.table.gateway.api.operation.OperationStatus
-
The operation is running.
S
- SessionEnvironment - Class in org.apache.flink.table.gateway.api.session
-
Environment to initialize the
Session. - SessionEnvironment.Builder - Class in org.apache.flink.table.gateway.api.session
-
Builder to build the
SessionEnvironment. - SessionEnvironment.CatalogCreator - Interface in org.apache.flink.table.gateway.api.session
-
An interface used to create
Catalog. - SessionEnvironment.ModuleCreator - Interface in org.apache.flink.table.gateway.api.session
-
An interface used to create
Module. - SessionHandle - Class in org.apache.flink.table.gateway.api.session
-
Session Handle that used to identify the Session.
- SessionHandle(UUID) - Constructor for class org.apache.flink.table.gateway.api.session.SessionHandle
- setDefaultCatalog(String) - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment.Builder
- setSessionEndpointVersion(EndpointVersion) - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment.Builder
- setSessionName(String) - Method in class org.apache.flink.table.gateway.api.session.SessionEnvironment.Builder
- SQL_GATEWAY_SESSION_CHECK_INTERVAL - Static variable in class org.apache.flink.table.gateway.api.config.SqlGatewayServiceConfigOptions
- SQL_GATEWAY_SESSION_IDLE_TIMEOUT - Static variable in class org.apache.flink.table.gateway.api.config.SqlGatewayServiceConfigOptions
- SQL_GATEWAY_SESSION_MAX_NUM - Static variable in class org.apache.flink.table.gateway.api.config.SqlGatewayServiceConfigOptions
- SQL_GATEWAY_SESSION_PLAN_CACHE_ENABLED - Static variable in class org.apache.flink.table.gateway.api.config.SqlGatewayServiceConfigOptions
- SQL_GATEWAY_SESSION_PLAN_CACHE_SIZE - Static variable in class org.apache.flink.table.gateway.api.config.SqlGatewayServiceConfigOptions
- SQL_GATEWAY_SESSION_PLAN_CACHE_TTL - Static variable in class org.apache.flink.table.gateway.api.config.SqlGatewayServiceConfigOptions
- SQL_GATEWAY_WORKER_KEEPALIVE_TIME - Static variable in class org.apache.flink.table.gateway.api.config.SqlGatewayServiceConfigOptions
- SQL_GATEWAY_WORKER_THREADS_MAX - Static variable in class org.apache.flink.table.gateway.api.config.SqlGatewayServiceConfigOptions
- SQL_GATEWAY_WORKER_THREADS_MIN - Static variable in class org.apache.flink.table.gateway.api.config.SqlGatewayServiceConfigOptions
- SqlGatewayEndpoint - Interface in org.apache.flink.table.gateway.api.endpoint
-
Endpoint of the SqlGateway to allow users to communicate with.
- SqlGatewayEndpointFactory - Interface in org.apache.flink.table.gateway.api.endpoint
-
A factory for creating Endpoint from Configuration.
- SqlGatewayEndpointFactory.Context - Interface in org.apache.flink.table.gateway.api.endpoint
-
Provides information describing the endpoint to be accessed.
- SqlGatewayEndpointFactoryUtils - Class in org.apache.flink.table.gateway.api.endpoint
-
Util to discover the
SqlGatewayEndpoint. - SqlGatewayEndpointFactoryUtils() - Constructor for class org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactoryUtils
- SqlGatewayEndpointFactoryUtils.DefaultEndpointFactoryContext - Class in org.apache.flink.table.gateway.api.endpoint
-
The default context of
SqlGatewayEndpointFactory. - SqlGatewayEndpointFactoryUtils.EndpointFactoryHelper - Class in org.apache.flink.table.gateway.api.endpoint
-
Helper utility for validating all options for a
SqlGatewayEndpointFactory. - SqlGatewayException - Exception in org.apache.flink.table.gateway.api.utils
-
General exception for SQL gateway related errors.
- SqlGatewayException(String) - Constructor for exception org.apache.flink.table.gateway.api.utils.SqlGatewayException
- SqlGatewayException(String, Throwable) - Constructor for exception org.apache.flink.table.gateway.api.utils.SqlGatewayException
- SqlGatewayException(Throwable) - Constructor for exception org.apache.flink.table.gateway.api.utils.SqlGatewayException
- SqlGatewayService - Interface in org.apache.flink.table.gateway.api
-
A service of SQL gateway is responsible for handling requests from the endpoints.
- SqlGatewayServiceConfigOptions - Class in org.apache.flink.table.gateway.api.config
-
Config options of the
SqlGatewayService. - SqlGatewayServiceConfigOptions() - Constructor for class org.apache.flink.table.gateway.api.config.SqlGatewayServiceConfigOptions
- start() - Method in interface org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpoint
-
Start the endpoint.
- stop() - Method in interface org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpoint
-
Terminate the endpoint.
- submitOperation(SessionHandle, Callable<ResultSet>) - Method in interface org.apache.flink.table.gateway.api.SqlGatewayService
-
Submit an operation and execute.
T
- TableInfo - Class in org.apache.flink.table.gateway.api.results
-
Information of the table or view.
- TableInfo(ObjectIdentifier, CatalogBaseTable.TableKind) - Constructor for class org.apache.flink.table.gateway.api.results.TableInfo
- ThreadUtils - Class in org.apache.flink.table.gateway.api.utils
-
Utils for thread pool executor.
- ThreadUtils() - Constructor for class org.apache.flink.table.gateway.api.utils.ThreadUtils
- TIMEOUT - Enum constant in enum org.apache.flink.table.gateway.api.operation.OperationStatus
-
The execution of the operation timeout.
- toString() - Method in class org.apache.flink.table.gateway.api.operation.OperationHandle
- toString() - Method in class org.apache.flink.table.gateway.api.results.FunctionInfo
- toString() - Method in class org.apache.flink.table.gateway.api.results.OperationInfo
- toString() - Method in class org.apache.flink.table.gateway.api.results.ResultSetImpl
- toString() - Method in class org.apache.flink.table.gateway.api.results.TableInfo
- toString() - Method in class org.apache.flink.table.gateway.api.session.SessionHandle
V
- valueOf(String) - Static method in enum org.apache.flink.table.gateway.api.operation.OperationStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.flink.table.gateway.api.results.FetchOrientation
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.flink.table.gateway.api.results.ResultSet.ResultType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.apache.flink.table.gateway.api.operation.OperationStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.apache.flink.table.gateway.api.results.FetchOrientation
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.apache.flink.table.gateway.api.results.ResultSet.ResultType
-
Returns an array containing the constants of this enum type, in the order they are declared.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form