org.apache.flink.table.gateway.service.result

Class NotReadyResult

java.lang.Object

org.apache.flink.table.gateway.service.result.NotReadyResult

All Implemented Interfaces:

ResultSet

public class NotReadyResult
extends Object
implements ResultSet

To represent that the execution result is not ready to fetch.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.table.gateway.api.results.ResultSet

ResultSet.ResultType

Field Summary

Fields

Modifier and Type	Field and Description
static NotReadyResult	INSTANCE

Method Summary

Modifier and Type	Method and Description
List<RowData>	getData() All the data in the current results.
JobID	getJobID() If the statement was submitted to a client, returns the JobID which uniquely identifies the job.
Long	getNextToken() The token indicates the next batch of the data.
ResultKind	getResultKind() Gets the result kind of the result.
ResolvedSchema	getResultSchema() The schema of the data.
ResultSet.ResultType	getResultType() Get the type of the results, which may indicate the result is EOS or has data.
boolean	isQueryResult() Indicates that whether the result is for a query.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final NotReadyResult INSTANCE

Method Detail

getResultType

public ResultSet.ResultType getResultType()

Description copied from interface: ResultSet

Get the type of the results, which may indicate the result is EOS or has data.

Specified by:

getResultType in interface ResultSet

getNextToken

public Long getNextToken()

Description copied from interface: ResultSet

The token indicates the next batch of the data.

When the token is null, it means all the data has been fetched.

Specified by:

getNextToken in interface ResultSet

getResultSchema

public ResolvedSchema getResultSchema()

Description copied from interface: ResultSet

The schema of the data.

The schema of the DDL, USE, EXPLAIN, SHOW and DESCRIBE align with the schema of the TableResult.getResolvedSchema(). The only differences is the schema of the `INSERT` statement.

The schema of INSERT:

 +-------------+-------------+----------+
 | column name | column type | comments |
 +-------------+-------------+----------+
 |   job id    |    string   |          |
 +- -----------+-------------+----------+
 

Specified by:

getResultSchema in interface ResultSet

getData

public List<RowData> getData()

Description copied from interface: ResultSet

All the data in the current results.

Specified by:

getData in interface ResultSet

isQueryResult

public boolean isQueryResult()

Description copied from interface: ResultSet

Indicates that whether the result is for a query.

Specified by:

isQueryResult in interface ResultSet

getJobID

public JobID getJobID()

Description copied from interface: ResultSet

If the statement was submitted to a client, returns the JobID which uniquely identifies the job. Otherwise, returns null.

Specified by:

getJobID in interface ResultSet

getResultKind

public ResultKind getResultKind()

Description copied from interface: ResultSet

Gets the result kind of the result.

Specified by:

getResultKind in interface ResultSet