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

Class FlightSql.CommandStatementQuery.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandStatementQuery.Builder>
org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementQuery.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, FlightSql.CommandStatementQueryOrBuilder
Enclosing class:
FlightSql.CommandStatementQuery
public static final class FlightSql.CommandStatementQuery.Builder extends com.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandStatementQuery.Builder> implements FlightSql.CommandStatementQueryOrBuilder

 Represents a SQL query. 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.
 - GetFlightInfo: execute the query.
Protobuf type arrow.flight.protocol.sql.CommandStatementQuery

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public FlightSql.CommandStatementQuery.Builder mergeFrom(FlightSql.CommandStatementQuery 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.CommandStatementQuery.Builder>

    • mergeFrom

      public FlightSql.CommandStatementQuery.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.CommandStatementQuery.Builder>
      Throws:
      IOException

    • getQuery

      public String getQuery()
       The SQL syntax.
      string query = 1;
      Specified by:
      getQuery in interface FlightSql.CommandStatementQueryOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       The SQL syntax.
      string query = 1;
      Specified by:
      getQueryBytes in interface FlightSql.CommandStatementQueryOrBuilder
      Returns:
      The bytes for query.

    • setQuery

      public FlightSql.CommandStatementQuery.Builder setQuery(String value)
       The SQL syntax.
      string query = 1;
      Parameters:
      value - The query to set.
      Returns:
      This builder for chaining.

    • clearQuery

      public FlightSql.CommandStatementQuery.Builder clearQuery()
       The SQL syntax.
      string query = 1;
      Returns:
      This builder for chaining.

    • setQueryBytes

      public FlightSql.CommandStatementQuery.Builder setQueryBytes(com.google.protobuf.ByteString value)
       The SQL syntax.
      string query = 1;
      Parameters:
      value - The bytes for query to set.
      Returns:
      This builder for chaining.

    • hasTransactionId

      public boolean hasTransactionId()
       Include the query as part of this transaction (if unset, the query is auto-committed).
      optional bytes transaction_id = 2;
      Specified by:
      hasTransactionId in interface FlightSql.CommandStatementQueryOrBuilder
      Returns:
      Whether the transactionId field is set.

    • getTransactionId

      public com.google.protobuf.ByteString getTransactionId()
       Include the query as part of this transaction (if unset, the query is auto-committed).
      optional bytes transaction_id = 2;
      Specified by:
      getTransactionId in interface FlightSql.CommandStatementQueryOrBuilder
      Returns:
      The transactionId.

    • setTransactionId

      public FlightSql.CommandStatementQuery.Builder setTransactionId(com.google.protobuf.ByteString value)
       Include the query as part of this transaction (if unset, the query is auto-committed).
      optional bytes transaction_id = 2;
      Parameters:
      value - The transactionId to set.
      Returns:
      This builder for chaining.

    • clearTransactionId

      public FlightSql.CommandStatementQuery.Builder clearTransactionId()
       Include the query as part of this transaction (if unset, the query is auto-committed).
      optional bytes transaction_id = 2;
      Returns:
      This builder for chaining.