Package org.apache.arrow.flight.sql.impl

Class FlightSql.ActionCreatePreparedStatementResult

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.arrow.flight.sql.impl.FlightSql.ActionCreatePreparedStatementResult

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, FlightSql.ActionCreatePreparedStatementResultOrBuilder

Enclosing class:

FlightSql

public static final class FlightSql.ActionCreatePreparedStatementResult
extends com.google.protobuf.GeneratedMessageV3
implements FlightSql.ActionCreatePreparedStatementResultOrBuilder

 Wrap the result of a "CreatePreparedStatement" or "CreatePreparedSubstraitPlan" action.

 The resultant PreparedStatement can be closed either:
 - Manually, through the "ClosePreparedStatement" action;
 - Automatically, by a server timeout.

 The result should be wrapped in a google.protobuf.Any message.
 

Protobuf type arrow.flight.protocol.sql.ActionCreatePreparedStatementResult

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FlightSql.ActionCreatePreparedStatementResult.Builder	Wrap the result of a "CreatePreparedStatement" or "CreatePreparedSubstraitPlan" action.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DATASET_SCHEMA_FIELD_NUMBER
static final int	PARAMETER_SCHEMA_FIELD_NUMBER
static final int	PREPARED_STATEMENT_HANDLE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
com.google.protobuf.ByteString	getDatasetSchema()	If a result set generating query was provided, dataset_schema contains the schema of the result set.
static FlightSql.ActionCreatePreparedStatementResult	getDefaultInstance()
FlightSql.ActionCreatePreparedStatementResult	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.ByteString	getParameterSchema()	If the query provided contained parameters, parameter_schema contains the schema of the expected parameters.
com.google.protobuf.Parser<FlightSql.ActionCreatePreparedStatementResult>	getParserForType()
com.google.protobuf.ByteString	getPreparedStatementHandle()	Opaque handle for the prepared statement on the server.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static FlightSql.ActionCreatePreparedStatementResult.Builder	newBuilder()
static FlightSql.ActionCreatePreparedStatementResult.Builder	newBuilder(FlightSql.ActionCreatePreparedStatementResult prototype)
FlightSql.ActionCreatePreparedStatementResult.Builder	newBuilderForType()
protected FlightSql.ActionCreatePreparedStatementResult.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FlightSql.ActionCreatePreparedStatementResult	parseDelimitedFrom(InputStream input)
static FlightSql.ActionCreatePreparedStatementResult	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.ActionCreatePreparedStatementResult	parseFrom(byte[] data)
static FlightSql.ActionCreatePreparedStatementResult	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.ActionCreatePreparedStatementResult	parseFrom(com.google.protobuf.ByteString data)
static FlightSql.ActionCreatePreparedStatementResult	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.ActionCreatePreparedStatementResult	parseFrom(com.google.protobuf.CodedInputStream input)
static FlightSql.ActionCreatePreparedStatementResult	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.ActionCreatePreparedStatementResult	parseFrom(InputStream input)
static FlightSql.ActionCreatePreparedStatementResult	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.ActionCreatePreparedStatementResult	parseFrom(ByteBuffer data)
static FlightSql.ActionCreatePreparedStatementResult	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FlightSql.ActionCreatePreparedStatementResult>	parser()
FlightSql.ActionCreatePreparedStatementResult.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

PREPARED_STATEMENT_HANDLE_FIELD_NUMBER

public static final int PREPARED_STATEMENT_HANDLE_FIELD_NUMBER

See Also:

• Constant Field Values

DATASET_SCHEMA_FIELD_NUMBER

public static final int DATASET_SCHEMA_FIELD_NUMBER

See Also:

• Constant Field Values

PARAMETER_SCHEMA_FIELD_NUMBER

public static final int PARAMETER_SCHEMA_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getPreparedStatementHandle

public com.google.protobuf.ByteString getPreparedStatementHandle()

 Opaque handle for the prepared statement on the server.
 

bytes prepared_statement_handle = 1;

Specified by:

getPreparedStatementHandle in interface FlightSql.ActionCreatePreparedStatementResultOrBuilder

Returns:

The preparedStatementHandle.

getDatasetSchema

public com.google.protobuf.ByteString getDatasetSchema()

 If a result set generating query was provided, dataset_schema contains the
 schema of the result set.  It should be an IPC-encapsulated Schema, as described in Schema.fbs.
 For some queries, the schema of the results may depend on the schema of the parameters.  The server
 should provide its best guess as to the schema at this point.  Clients must not assume that this
 schema, if provided, will be accurate.
 

bytes dataset_schema = 2;

Specified by:

getDatasetSchema in interface FlightSql.ActionCreatePreparedStatementResultOrBuilder

Returns:

The datasetSchema.

getParameterSchema

public com.google.protobuf.ByteString getParameterSchema()

 If the query provided contained parameters, parameter_schema contains the
 schema of the expected parameters.  It should be an IPC-encapsulated Schema, as described in Schema.fbs.
 

bytes parameter_schema = 3;

Specified by:

getParameterSchema in interface FlightSql.ActionCreatePreparedStatementResultOrBuilder

Returns:

The parameterSchema.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static FlightSql.ActionCreatePreparedStatementResult parseFrom(ByteBuffer data)
                                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlightSql.ActionCreatePreparedStatementResult parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlightSql.ActionCreatePreparedStatementResult parseFrom(com.google.protobuf.ByteString data)
                                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlightSql.ActionCreatePreparedStatementResult parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlightSql.ActionCreatePreparedStatementResult parseFrom(byte[] data)
                                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlightSql.ActionCreatePreparedStatementResult parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlightSql.ActionCreatePreparedStatementResult parseFrom(InputStream input)
                                                               throws IOException

Throws:

IOException

parseFrom

public static FlightSql.ActionCreatePreparedStatementResult parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static FlightSql.ActionCreatePreparedStatementResult parseDelimitedFrom(InputStream input)
                                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static FlightSql.ActionCreatePreparedStatementResult parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                        throws IOException

Throws:

IOException

parseFrom

public static FlightSql.ActionCreatePreparedStatementResult parseFrom(com.google.protobuf.CodedInputStream input)
                                                               throws IOException

Throws:

IOException

parseFrom

public static FlightSql.ActionCreatePreparedStatementResult parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                               throws IOException

Throws:

IOException

newBuilderForType

public FlightSql.ActionCreatePreparedStatementResult.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FlightSql.ActionCreatePreparedStatementResult.Builder newBuilder()

newBuilder

public static FlightSql.ActionCreatePreparedStatementResult.Builder newBuilder(FlightSql.ActionCreatePreparedStatementResult prototype)

toBuilder

public FlightSql.ActionCreatePreparedStatementResult.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected FlightSql.ActionCreatePreparedStatementResult.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FlightSql.ActionCreatePreparedStatementResult getDefaultInstance()

parser

public static com.google.protobuf.Parser<FlightSql.ActionCreatePreparedStatementResult> parser()

getParserForType

public com.google.protobuf.Parser<FlightSql.ActionCreatePreparedStatementResult> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public FlightSql.ActionCreatePreparedStatementResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder