org.apache.flink.table.client.gateway

Interface Executor

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ExecutorImpl

public interface Executor
extends Closeable

A gateway for communicating with Flink and other external systems.

Method Summary

Modifier and Type	Method and Description
void	close() Close the Executor and process all exceptions.
List<String>	completeStatement(String statement, int position) Returns a list of completion hints for the given statement at the given position.
void	configureSession(String statement) Configures session with statement.
static Executor	create(org.apache.flink.table.gateway.service.context.DefaultContext defaultContext, InetSocketAddress address, String sessionId) Create an Executor to execute commands.
StatementResult	executeStatement(String statement) Execute statement.
org.apache.flink.configuration.ReadableConfig	getSessionConfig() Get the configuration of the session.

Method Detail

create

static Executor create(org.apache.flink.table.gateway.service.context.DefaultContext defaultContext,
                       InetSocketAddress address,
                       String sessionId)

Create an Executor to execute commands.

configureSession

void configureSession(String statement)

Configures session with statement.

Parameters:

statement - to initialize the session

getSessionConfig

org.apache.flink.configuration.ReadableConfig getSessionConfig()

Get the configuration of the session.

Returns:

the session configuration.

executeStatement

StatementResult executeStatement(String statement)

Execute statement.

Parameters:

statement - to execute

Returns:

Iterable results of the statement

completeStatement

List<String> completeStatement(String statement,
                               int position)

Returns a list of completion hints for the given statement at the given position.

Parameters:

statement - Partial or slightly incorrect SQL statement

position - cursor position

Returns:

completion hints that fit at the current cursor position

close

void close()

Close the Executor and process all exceptions.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable