Module org.apache.arrow.flight.core
Package org.apache.arrow.flight.sql.impl
Class FlightSql.CommandStatementIngest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementIngest.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Cloneable
,FlightSql.CommandStatementIngestOrBuilder
- Enclosing class:
- FlightSql.CommandStatementIngest
public static final class FlightSql.CommandStatementIngest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
implements FlightSql.CommandStatementIngestOrBuilder
Represents a bulk ingestion request. Used in the command member of FlightDescriptor for the the RPC call DoPut to cause the server load the contents of the stream's FlightData into the target destination.Protobuf type
arrow.flight.protocol.sql.CommandStatementIngest
-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()
clear()
The catalog of the destination table to load data into.clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) The db_schema of the destination table to load data into.The table to load data into.The behavior for handling the table definition.Store ingested data in a temporary table.Perform the ingestion as part of this transaction.clone()
boolean
containsOptions
(String key) Backend-specific options.The catalog of the destination table to load data into.com.google.protobuf.ByteString
The catalog of the destination table to load data into.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
Deprecated.Deprecated.int
Backend-specific options.Backend-specific options.getOptionsOrDefault
(String key, String defaultValue) Backend-specific options.getOptionsOrThrow
(String key) Backend-specific options.The db_schema of the destination table to load data into.com.google.protobuf.ByteString
The db_schema of the destination table to load data into.getTable()
The table to load data into.com.google.protobuf.ByteString
The table to load data into.The behavior for handling the table definition.The behavior for handling the table definition.The behavior for handling the table definition.boolean
Store ingested data in a temporary table.com.google.protobuf.ByteString
Perform the ingestion as part of this transaction.boolean
The catalog of the destination table to load data into.boolean
The db_schema of the destination table to load data into.boolean
The behavior for handling the table definition.boolean
Perform the ingestion as part of this transaction.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
protected com.google.protobuf.MapFieldReflectionAccessor
internalGetMapFieldReflection
(int number) protected com.google.protobuf.MapFieldReflectionAccessor
internalGetMutableMapFieldReflection
(int number) final boolean
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) The behavior for handling the table definition.mergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) putAllOptions
(Map<String, String> values) Backend-specific options.putOptions
(String key, String value) Backend-specific options.removeOptions
(String key) Backend-specific options.setCatalog
(String value) The catalog of the destination table to load data into.setCatalogBytes
(com.google.protobuf.ByteString value) The catalog of the destination table to load data into.setRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) The db_schema of the destination table to load data into.setSchemaBytes
(com.google.protobuf.ByteString value) The db_schema of the destination table to load data into.The table to load data into.setTableBytes
(com.google.protobuf.ByteString value) The table to load data into.The behavior for handling the table definition.setTableDefinitionOptions
(FlightSql.CommandStatementIngest.TableDefinitionOptions.Builder builderForValue) The behavior for handling the table definition.setTemporary
(boolean value) Store ingested data in a temporary table.setTransactionId
(com.google.protobuf.ByteString value) Perform the ingestion as part of this transaction.setUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, 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.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods 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() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflection
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-
internalGetMutableMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number) - Overrides:
internalGetMutableMapFieldReflection
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-
setField
public FlightSql.CommandStatementIngest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-
clearField
public FlightSql.CommandStatementIngest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) - Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-
clearOneof
public FlightSql.CommandStatementIngest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) - Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-
setRepeatedField
public FlightSql.CommandStatementIngest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-
addRepeatedField
public FlightSql.CommandStatementIngest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<FlightSql.CommandStatementIngest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-
mergeFrom
public FlightSql.CommandStatementIngest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<FlightSql.CommandStatementIngest.Builder>
- Throws:
IOException
-
hasTableDefinitionOptions
public boolean hasTableDefinitionOptions()The behavior for handling the table definition.
.arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions table_definition_options = 1;
- Specified by:
hasTableDefinitionOptions
in interfaceFlightSql.CommandStatementIngestOrBuilder
- Returns:
- Whether the tableDefinitionOptions field is set.
-
getTableDefinitionOptions
The behavior for handling the table definition.
.arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions table_definition_options = 1;
- Specified by:
getTableDefinitionOptions
in interfaceFlightSql.CommandStatementIngestOrBuilder
- Returns:
- The tableDefinitionOptions.
-
setTableDefinitionOptions
public FlightSql.CommandStatementIngest.Builder setTableDefinitionOptions(FlightSql.CommandStatementIngest.TableDefinitionOptions value) The behavior for handling the table definition.
.arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions table_definition_options = 1;
-
setTableDefinitionOptions
public FlightSql.CommandStatementIngest.Builder setTableDefinitionOptions(FlightSql.CommandStatementIngest.TableDefinitionOptions.Builder builderForValue) The behavior for handling the table definition.
.arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions table_definition_options = 1;
-
mergeTableDefinitionOptions
public FlightSql.CommandStatementIngest.Builder mergeTableDefinitionOptions(FlightSql.CommandStatementIngest.TableDefinitionOptions value) The behavior for handling the table definition.
.arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions table_definition_options = 1;
-
clearTableDefinitionOptions
The behavior for handling the table definition.
.arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions table_definition_options = 1;
-
getTableDefinitionOptionsBuilder
public FlightSql.CommandStatementIngest.TableDefinitionOptions.Builder getTableDefinitionOptionsBuilder()The behavior for handling the table definition.
.arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions table_definition_options = 1;
-
getTableDefinitionOptionsOrBuilder
public FlightSql.CommandStatementIngest.TableDefinitionOptionsOrBuilder getTableDefinitionOptionsOrBuilder()The behavior for handling the table definition.
.arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions table_definition_options = 1;
- Specified by:
getTableDefinitionOptionsOrBuilder
in interfaceFlightSql.CommandStatementIngestOrBuilder
-
getTable
The table to load data into.
string table = 2;
- Specified by:
getTable
in interfaceFlightSql.CommandStatementIngestOrBuilder
- Returns:
- The table.
-
getTableBytes
public com.google.protobuf.ByteString getTableBytes()The table to load data into.
string table = 2;
- Specified by:
getTableBytes
in interfaceFlightSql.CommandStatementIngestOrBuilder
- Returns:
- The bytes for table.
-
setTable
The table to load data into.
string table = 2;
- Parameters:
value
- The table to set.- Returns:
- This builder for chaining.
-
clearTable
The table to load data into.
string table = 2;
- Returns:
- This builder for chaining.
-
setTableBytes
The table to load data into.
string table = 2;
- Parameters:
value
- The bytes for table to set.- Returns:
- This builder for chaining.
-
hasSchema
public boolean hasSchema()The db_schema of the destination table to load data into. If unset, a backend-specific default may be used.
optional string schema = 3;
- Specified by:
hasSchema
in interfaceFlightSql.CommandStatementIngestOrBuilder
- Returns:
- Whether the schema field is set.
-
getSchema
The db_schema of the destination table to load data into. If unset, a backend-specific default may be used.
optional string schema = 3;
- Specified by:
getSchema
in interfaceFlightSql.CommandStatementIngestOrBuilder
- Returns:
- The schema.
-
getSchemaBytes
public com.google.protobuf.ByteString getSchemaBytes()The db_schema of the destination table to load data into. If unset, a backend-specific default may be used.
optional string schema = 3;
- Specified by:
getSchemaBytes
in interfaceFlightSql.CommandStatementIngestOrBuilder
- Returns:
- The bytes for schema.
-
setSchema
The db_schema of the destination table to load data into. If unset, a backend-specific default may be used.
optional string schema = 3;
- Parameters:
value
- The schema to set.- Returns:
- This builder for chaining.
-
clearSchema
The db_schema of the destination table to load data into. If unset, a backend-specific default may be used.
optional string schema = 3;
- Returns:
- This builder for chaining.
-
setSchemaBytes
public FlightSql.CommandStatementIngest.Builder setSchemaBytes(com.google.protobuf.ByteString value) The db_schema of the destination table to load data into. If unset, a backend-specific default may be used.
optional string schema = 3;
- Parameters:
value
- The bytes for schema to set.- Returns:
- This builder for chaining.
-
hasCatalog
public boolean hasCatalog()The catalog of the destination table to load data into. If unset, a backend-specific default may be used.
optional string catalog = 4;
- Specified by:
hasCatalog
in interfaceFlightSql.CommandStatementIngestOrBuilder
- Returns:
- Whether the catalog field is set.
-
getCatalog
The catalog of the destination table to load data into. If unset, a backend-specific default may be used.
optional string catalog = 4;
- Specified by:
getCatalog
in interfaceFlightSql.CommandStatementIngestOrBuilder
- Returns:
- The catalog.
-
getCatalogBytes
public com.google.protobuf.ByteString getCatalogBytes()The catalog of the destination table to load data into. If unset, a backend-specific default may be used.
optional string catalog = 4;
- Specified by:
getCatalogBytes
in interfaceFlightSql.CommandStatementIngestOrBuilder
- Returns:
- The bytes for catalog.
-
setCatalog
The catalog of the destination table to load data into. If unset, a backend-specific default may be used.
optional string catalog = 4;
- Parameters:
value
- The catalog to set.- Returns:
- This builder for chaining.
-
clearCatalog
The catalog of the destination table to load data into. If unset, a backend-specific default may be used.
optional string catalog = 4;
- Returns:
- This builder for chaining.
-
setCatalogBytes
public FlightSql.CommandStatementIngest.Builder setCatalogBytes(com.google.protobuf.ByteString value) The catalog of the destination table to load data into. If unset, a backend-specific default may be used.
optional string catalog = 4;
- Parameters:
value
- The bytes for catalog to set.- Returns:
- This builder for chaining.
-
getTemporary
public boolean getTemporary()Store ingested data in a temporary table. The effect of setting temporary is to place the table in a backend-defined namespace, and to drop the table at the end of the session. The namespacing may make use of a backend-specific schema and/or catalog. The server should return an error if an explicit choice of schema or catalog is incompatible with the server's namespacing decision.
bool temporary = 5;
- Specified by:
getTemporary
in interfaceFlightSql.CommandStatementIngestOrBuilder
- Returns:
- The temporary.
-
setTemporary
Store ingested data in a temporary table. The effect of setting temporary is to place the table in a backend-defined namespace, and to drop the table at the end of the session. The namespacing may make use of a backend-specific schema and/or catalog. The server should return an error if an explicit choice of schema or catalog is incompatible with the server's namespacing decision.
bool temporary = 5;
- Parameters:
value
- The temporary to set.- Returns:
- This builder for chaining.
-
clearTemporary
Store ingested data in a temporary table. The effect of setting temporary is to place the table in a backend-defined namespace, and to drop the table at the end of the session. The namespacing may make use of a backend-specific schema and/or catalog. The server should return an error if an explicit choice of schema or catalog is incompatible with the server's namespacing decision.
bool temporary = 5;
- Returns:
- This builder for chaining.
-
hasTransactionId
public boolean hasTransactionId()Perform the ingestion as part of this transaction. If specified, results should not be committed in the event of an error/cancellation.
optional bytes transaction_id = 6;
- Specified by:
hasTransactionId
in interfaceFlightSql.CommandStatementIngestOrBuilder
- Returns:
- Whether the transactionId field is set.
-
getTransactionId
public com.google.protobuf.ByteString getTransactionId()Perform the ingestion as part of this transaction. If specified, results should not be committed in the event of an error/cancellation.
optional bytes transaction_id = 6;
- Specified by:
getTransactionId
in interfaceFlightSql.CommandStatementIngestOrBuilder
- Returns:
- The transactionId.
-
setTransactionId
public FlightSql.CommandStatementIngest.Builder setTransactionId(com.google.protobuf.ByteString value) Perform the ingestion as part of this transaction. If specified, results should not be committed in the event of an error/cancellation.
optional bytes transaction_id = 6;
- Parameters:
value
- The transactionId to set.- Returns:
- This builder for chaining.
-
clearTransactionId
Perform the ingestion as part of this transaction. If specified, results should not be committed in the event of an error/cancellation.
optional bytes transaction_id = 6;
- Returns:
- This builder for chaining.
-
getOptionsCount
public int getOptionsCount()Description copied from interface:FlightSql.CommandStatementIngestOrBuilder
Backend-specific options.
map<string, string> options = 1000;
- Specified by:
getOptionsCount
in interfaceFlightSql.CommandStatementIngestOrBuilder
-
containsOptions
Backend-specific options.
map<string, string> options = 1000;
- Specified by:
containsOptions
in interfaceFlightSql.CommandStatementIngestOrBuilder
-
getOptions
Deprecated.UsegetOptionsMap()
instead.- Specified by:
getOptions
in interfaceFlightSql.CommandStatementIngestOrBuilder
-
getOptionsMap
Backend-specific options.
map<string, string> options = 1000;
- Specified by:
getOptionsMap
in interfaceFlightSql.CommandStatementIngestOrBuilder
-
getOptionsOrDefault
Backend-specific options.
map<string, string> options = 1000;
- Specified by:
getOptionsOrDefault
in interfaceFlightSql.CommandStatementIngestOrBuilder
-
getOptionsOrThrow
Backend-specific options.
map<string, string> options = 1000;
- Specified by:
getOptionsOrThrow
in interfaceFlightSql.CommandStatementIngestOrBuilder
-
clearOptions
-
removeOptions
Backend-specific options.
map<string, string> options = 1000;
-
getMutableOptions
Deprecated.Use alternate mutation accessors instead. -
putOptions
Backend-specific options.
map<string, string> options = 1000;
-
putAllOptions
Backend-specific options.
map<string, string> options = 1000;
-
setUnknownFields
public final FlightSql.CommandStatementIngest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-
mergeUnknownFields
public final FlightSql.CommandStatementIngest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementIngest.Builder>
-