org.apache.arrow.flight.sql.impl

Class FlightSql.CommandPreparedStatementQuery.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandPreparedStatementQuery.Builder>

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

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, FlightSql.CommandPreparedStatementQueryOrBuilder

Enclosing class:

FlightSql.CommandPreparedStatementQuery

public static final class FlightSql.CommandPreparedStatementQuery.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandPreparedStatementQuery.Builder>
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

Method Summary

Modifier and Type	Method and Description
FlightSql.CommandPreparedStatementQuery	build()
FlightSql.CommandPreparedStatementQuery	buildPartial()
FlightSql.CommandPreparedStatementQuery.Builder	clear()
FlightSql.CommandPreparedStatementQuery.Builder	clearPreparedStatementHandle() Opaque handle for the prepared statement on the server.
FlightSql.CommandPreparedStatementQuery	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
com.google.protobuf.ByteString	getPreparedStatementHandle() Opaque handle for the prepared statement on the server.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
FlightSql.CommandPreparedStatementQuery.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
FlightSql.CommandPreparedStatementQuery.Builder	mergeFrom(FlightSql.CommandPreparedStatementQuery other)
FlightSql.CommandPreparedStatementQuery.Builder	mergeFrom(com.google.protobuf.Message other)
FlightSql.CommandPreparedStatementQuery.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FlightSql.CommandPreparedStatementQuery.Builder	setPreparedStatementHandle(com.google.protobuf.ByteString value) Opaque handle for the prepared statement on the server.
FlightSql.CommandPreparedStatementQuery.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<FlightSql.CommandPreparedStatementQuery.Builder>

clear

public FlightSql.CommandPreparedStatementQuery.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandPreparedStatementQuery.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandPreparedStatementQuery.Builder>

getDefaultInstanceForType

public FlightSql.CommandPreparedStatementQuery getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public FlightSql.CommandPreparedStatementQuery build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public FlightSql.CommandPreparedStatementQuery buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public FlightSql.CommandPreparedStatementQuery.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FlightSql.CommandPreparedStatementQuery.Builder>

mergeFrom

public FlightSql.CommandPreparedStatementQuery.Builder mergeFrom(FlightSql.CommandPreparedStatementQuery other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandPreparedStatementQuery.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FlightSql.CommandPreparedStatementQuery.Builder>

Throws:

IOException

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.

setPreparedStatementHandle

public FlightSql.CommandPreparedStatementQuery.Builder setPreparedStatementHandle(com.google.protobuf.ByteString value)

 Opaque handle for the prepared statement on the server.
 

bytes prepared_statement_handle = 1;

Parameters:

value - The preparedStatementHandle to set.

Returns:

This builder for chaining.

clearPreparedStatementHandle

public FlightSql.CommandPreparedStatementQuery.Builder clearPreparedStatementHandle()

 Opaque handle for the prepared statement on the server.
 

bytes prepared_statement_handle = 1;

Returns:

This builder for chaining.

setUnknownFields

public final FlightSql.CommandPreparedStatementQuery.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandPreparedStatementQuery.Builder>

mergeUnknownFields

public final FlightSql.CommandPreparedStatementQuery.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandPreparedStatementQuery.Builder>