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.GeneratedMessage.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.GeneratedMessage.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 Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandStatementIngest.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandStatementIngest.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandStatementIngest.Builder>

    • clear

      public FlightSql.CommandStatementIngest.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.GeneratedMessage.Builder<FlightSql.CommandStatementIngest.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.GeneratedMessage.Builder<FlightSql.CommandStatementIngest.Builder>

    • getDefaultInstanceForType

      public FlightSql.CommandStatementIngest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public FlightSql.CommandStatementIngest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public FlightSql.CommandStatementIngest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public FlightSql.CommandStatementIngest.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.CommandStatementIngest.Builder>

    • mergeFrom

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.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 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.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 interface FlightSql.CommandStatementIngestOrBuilder
      Returns:
      Whether the tableDefinitionOptions field is set.

    • getTableDefinitionOptions

      public FlightSql.CommandStatementIngest.TableDefinitionOptions getTableDefinitionOptions()
       The behavior for handling the table definition.
      .arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions table_definition_options = 1;
      Specified by:
      getTableDefinitionOptions in interface FlightSql.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

      public FlightSql.CommandStatementIngest.Builder 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 interface FlightSql.CommandStatementIngestOrBuilder

    • getTable

      public String getTable()
       The table to load data into.
      string table = 2;
      Specified by:
      getTable in interface FlightSql.CommandStatementIngestOrBuilder
      Returns:
      The table.

    • getTableBytes

      public com.google.protobuf.ByteString getTableBytes()
       The table to load data into.
      string table = 2;
      Specified by:
      getTableBytes in interface FlightSql.CommandStatementIngestOrBuilder
      Returns:
      The bytes for table.

    • setTable

      public FlightSql.CommandStatementIngest.Builder setTable(String value)
       The table to load data into.
      string table = 2;
      Parameters:
      value - The table to set.
      Returns:
      This builder for chaining.

    • clearTable

      public FlightSql.CommandStatementIngest.Builder clearTable()
       The table to load data into.
      string table = 2;
      Returns:
      This builder for chaining.

    • setTableBytes

      public FlightSql.CommandStatementIngest.Builder setTableBytes(com.google.protobuf.ByteString value)
       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 interface FlightSql.CommandStatementIngestOrBuilder
      Returns:
      Whether the schema field is set.

    • getSchema

      public String 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 interface FlightSql.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 interface FlightSql.CommandStatementIngestOrBuilder
      Returns:
      The bytes for schema.

    • setSchema

      public FlightSql.CommandStatementIngest.Builder setSchema(String 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 schema to set.
      Returns:
      This builder for chaining.

    • clearSchema

      public FlightSql.CommandStatementIngest.Builder 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 interface FlightSql.CommandStatementIngestOrBuilder
      Returns:
      Whether the catalog field is set.

    • getCatalog

      public String 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 interface FlightSql.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 interface FlightSql.CommandStatementIngestOrBuilder
      Returns:
      The bytes for catalog.

    • setCatalog

      public FlightSql.CommandStatementIngest.Builder setCatalog(String 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 catalog to set.
      Returns:
      This builder for chaining.

    • clearCatalog

      public FlightSql.CommandStatementIngest.Builder 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 interface FlightSql.CommandStatementIngestOrBuilder
      Returns:
      The temporary.

    • setTemporary

      public FlightSql.CommandStatementIngest.Builder setTemporary(boolean value)
      
 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

      public FlightSql.CommandStatementIngest.Builder 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 interface FlightSql.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 interface FlightSql.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

      public FlightSql.CommandStatementIngest.Builder 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 interface FlightSql.CommandStatementIngestOrBuilder

    • containsOptions

      public boolean containsOptions(String key)
       Backend-specific options.
      map<string, string> options = 1000;
      Specified by:
      containsOptions in interface FlightSql.CommandStatementIngestOrBuilder

    • getOptions

      @Deprecated public Map<String,String> getOptions()
      Deprecated.
      Use getOptionsMap() instead.
      Specified by:
      getOptions in interface FlightSql.CommandStatementIngestOrBuilder

    • getOptionsMap

      public Map<String,String> getOptionsMap()
       Backend-specific options.
      map<string, string> options = 1000;
      Specified by:
      getOptionsMap in interface FlightSql.CommandStatementIngestOrBuilder

    • getOptionsOrDefault

      public String getOptionsOrDefault(String key, String defaultValue)
       Backend-specific options.
      map<string, string> options = 1000;
      Specified by:
      getOptionsOrDefault in interface FlightSql.CommandStatementIngestOrBuilder

    • getOptionsOrThrow

      public String getOptionsOrThrow(String key)
       Backend-specific options.
      map<string, string> options = 1000;
      Specified by:
      getOptionsOrThrow in interface FlightSql.CommandStatementIngestOrBuilder

    • clearOptions

      public FlightSql.CommandStatementIngest.Builder clearOptions()

    • removeOptions

      public FlightSql.CommandStatementIngest.Builder removeOptions(String key)
       Backend-specific options.
      map<string, string> options = 1000;

    • getMutableOptions

      @Deprecated public Map<String,String> getMutableOptions()
      Deprecated.
      Use alternate mutation accessors instead.

    • putOptions

      public FlightSql.CommandStatementIngest.Builder putOptions(String key, String value)
       Backend-specific options.
      map<string, string> options = 1000;

    • putAllOptions

      public FlightSql.CommandStatementIngest.Builder putAllOptions(Map<String,String> values)
       Backend-specific options.
      map<string, string> options = 1000;