Module org.apache.arrow.flight.core
Package 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.GeneratedMessage.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.GeneratedMessage.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. - ARROW:FLIGHT:SQL:REMARKS - A comment describing the column. 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 TypeMethodDescriptionbuild()clear()Opaque handle for the prepared statement on the server.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptorcom.google.protobuf.ByteStringOpaque handle for the prepared statement on the server.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) setPreparedStatementHandle(com.google.protobuf.ByteString value) Opaque handle for the prepared statement on the server.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandPreparedStatementQuery.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandPreparedStatementQuery.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandPreparedStatementQuery.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<FlightSql.CommandPreparedStatementQuery.Builder>
-
mergeFrom
public FlightSql.CommandPreparedStatementQuery.Builder mergeFrom(FlightSql.CommandPreparedStatementQuery other) -
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandPreparedStatementQuery.Builder>
-
mergeFrom
public FlightSql.CommandPreparedStatementQuery.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.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:
getPreparedStatementHandlein interfaceFlightSql.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
Opaque handle for the prepared statement on the server.
bytes prepared_statement_handle = 1;- Returns:
- This builder for chaining.
-