Package org.apache.arrow.flight.sql.impl

Class FlightSql.CommandStatementIngest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementIngest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, FlightSql.CommandStatementIngestOrBuilder
Enclosing class:
FlightSql
public static final class FlightSql.CommandStatementIngest extends com.google.protobuf.GeneratedMessageV3 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
See Also:

  • Field Details

    • TABLE_DEFINITION_OPTIONS_FIELD_NUMBER

      public static final int TABLE_DEFINITION_OPTIONS_FIELD_NUMBER
      See Also:

    • TABLE_FIELD_NUMBER

      public static final int TABLE_FIELD_NUMBER
      See Also:

    • SCHEMA_FIELD_NUMBER

      public static final int SCHEMA_FIELD_NUMBER
      See Also:

    • CATALOG_FIELD_NUMBER

      public static final int CATALOG_FIELD_NUMBER
      See Also:

    • TEMPORARY_FIELD_NUMBER

      public static final int TEMPORARY_FIELD_NUMBER
      See Also:

    • TRANSACTION_ID_FIELD_NUMBER

      public static final int TRANSACTION_ID_FIELD_NUMBER
      See Also:

    • OPTIONS_FIELD_NUMBER

      public static final int OPTIONS_FIELD_NUMBER
      See Also:

  • Method Details

    • 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()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

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

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

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

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

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

    • 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

    • 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.CommandStatementIngest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static FlightSql.CommandStatementIngest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static FlightSql.CommandStatementIngest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static FlightSql.CommandStatementIngest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static FlightSql.CommandStatementIngest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FlightSql.CommandStatementIngest.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

      protected FlightSql.CommandStatementIngest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static FlightSql.CommandStatementIngest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FlightSql.CommandStatementIngest> 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.CommandStatementIngest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder