org.apache.arrow.flight.sql.impl

Class FlightSql.CommandPreparedStatementQuery

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

FlightSql

public static final class FlightSql.CommandPreparedStatementQuery
extends com.google.protobuf.GeneratedMessageV3
implements FlightSql.CommandPreparedStatementQueryOrBuilder

 Represents an instance of executing a prepared statement. Used in the command member of FlightDescriptor for
 the following RPC calls:
  - GetSchema: return the Arrow schema of the query.
    Fields on this schema may contain the following metadata:
    - ARROW:FLIGHT:SQL:CATALOG_NAME      - Table's catalog name
    - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME    - Database schema name
    - ARROW:FLIGHT:SQL:TABLE_NAME        - Table name
    - ARROW:FLIGHT:SQL:TYPE_NAME         - The data source-specific name for the data type of the column.
    - ARROW:FLIGHT:SQL:PRECISION         - Column precision/size
    - ARROW:FLIGHT:SQL:SCALE             - Column scale/decimal digits if applicable
    - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
    - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.
    - ARROW:FLIGHT:SQL:IS_READ_ONLY      - "1" indicates if the column is read only, "0" otherwise.
    - ARROW:FLIGHT:SQL:IS_SEARCHABLE     - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.

    If the schema is retrieved after parameter values have been bound with DoPut, then the server should account
    for the parameters when determining the schema.
  - DoPut: bind parameter values. All of the bound parameter sets will be executed as a single atomic execution.
  - GetFlightInfo: execute the prepared statement instance.
 

Protobuf type arrow.flight.protocol.sql.CommandPreparedStatementQuery

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlightSql.CommandPreparedStatementQuery.Builder Represents an instance of executing a prepared statement.

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 and Description
static 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 and Description
boolean	equals(Object obj)
static FlightSql.CommandPreparedStatementQuery	getDefaultInstance()
FlightSql.CommandPreparedStatementQuery	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<FlightSql.CommandPreparedStatementQuery>	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()
boolean	isInitialized()
static FlightSql.CommandPreparedStatementQuery.Builder	newBuilder()
static FlightSql.CommandPreparedStatementQuery.Builder	newBuilder(FlightSql.CommandPreparedStatementQuery prototype)
FlightSql.CommandPreparedStatementQuery.Builder	newBuilderForType()
protected FlightSql.CommandPreparedStatementQuery.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FlightSql.CommandPreparedStatementQuery	parseDelimitedFrom(InputStream input)
static FlightSql.CommandPreparedStatementQuery	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandPreparedStatementQuery	parseFrom(byte[] data)
static FlightSql.CommandPreparedStatementQuery	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandPreparedStatementQuery	parseFrom(ByteBuffer data)
static FlightSql.CommandPreparedStatementQuery	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandPreparedStatementQuery	parseFrom(com.google.protobuf.ByteString data)
static FlightSql.CommandPreparedStatementQuery	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandPreparedStatementQuery	parseFrom(com.google.protobuf.CodedInputStream input)
static FlightSql.CommandPreparedStatementQuery	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandPreparedStatementQuery	parseFrom(InputStream input)
static FlightSql.CommandPreparedStatementQuery	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FlightSql.CommandPreparedStatementQuery>	parser()
FlightSql.CommandPreparedStatementQuery.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PREPARED_STATEMENT_HANDLE_FIELD_NUMBER

public static final int PREPARED_STATEMENT_HANDLE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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.CommandPreparedStatementQueryOrBuilder

Returns:

The preparedStatementHandle.

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.CommandPreparedStatementQuery parseFrom(ByteBuffer data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlightSql.CommandPreparedStatementQuery 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.CommandPreparedStatementQuery parseFrom(byte[] data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public FlightSql.CommandPreparedStatementQuery.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FlightSql.CommandPreparedStatementQuery.Builder newBuilder()

newBuilder

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

toBuilder

public FlightSql.CommandPreparedStatementQuery.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FlightSql.CommandPreparedStatementQuery getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<FlightSql.CommandPreparedStatementQuery> 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.CommandPreparedStatementQuery getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder