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

Class FlightSql.CommandGetSqlInfo.Builder

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

 Represents a metadata request. Used in the command member of FlightDescriptor
 for the following RPC calls:
 - GetSchema: return the Arrow schema of the query.
 - GetFlightInfo: execute the metadata request.

 The returned Arrow schema will be:
 <
 info_name: uint32 not null,
 value: dense_union<
 string_value: utf8,
 bool_value: bool,
 bigint_value: int64,
 int32_bitmask: int32,
 string_list: list<string_data: utf8>
 int32_to_int32_list_map: map<key: int32, value: list<$data$: int32>>
 >
 where there is one row per requested piece of metadata information.
Protobuf type arrow.flight.protocol.sql.CommandGetSqlInfo

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

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

    • mergeFrom

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

    • getInfoList

      public List<Integer> getInfoList()
      
 Values are modelled after ODBC's SQLGetInfo() function. This information is intended to provide
 Flight SQL clients with basic, SQL syntax and SQL functions related information.
 More information types can be added in future releases.
 E.g. more SQL syntax support types, scalar functions support, type conversion support etc.

 Note that the set of metadata may expand.

 Initially, Flight SQL will support the following information types:
 - Server Information - Range [0-500)
 - Syntax Information - Range [500-1000)
 Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options).
 Custom options should start at 10,000.

 If omitted, then all metadata will be retrieved.
 Flight SQL Servers may choose to include additional metadata above and beyond the specified set, however they must
 at least return the specified set. IDs ranging from 0 to 10,000 (exclusive) are reserved for future use.
 If additional metadata is included, the metadata IDs should start from 10,000.
      repeated uint32 info = 1;
      Specified by:
      getInfoList in interface FlightSql.CommandGetSqlInfoOrBuilder
      Returns:
      A list containing the info.

    • getInfoCount

      public int getInfoCount()
      
 Values are modelled after ODBC's SQLGetInfo() function. This information is intended to provide
 Flight SQL clients with basic, SQL syntax and SQL functions related information.
 More information types can be added in future releases.
 E.g. more SQL syntax support types, scalar functions support, type conversion support etc.

 Note that the set of metadata may expand.

 Initially, Flight SQL will support the following information types:
 - Server Information - Range [0-500)
 - Syntax Information - Range [500-1000)
 Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options).
 Custom options should start at 10,000.

 If omitted, then all metadata will be retrieved.
 Flight SQL Servers may choose to include additional metadata above and beyond the specified set, however they must
 at least return the specified set. IDs ranging from 0 to 10,000 (exclusive) are reserved for future use.
 If additional metadata is included, the metadata IDs should start from 10,000.
      repeated uint32 info = 1;
      Specified by:
      getInfoCount in interface FlightSql.CommandGetSqlInfoOrBuilder
      Returns:
      The count of info.

    • getInfo

      public int getInfo(int index)
      
 Values are modelled after ODBC's SQLGetInfo() function. This information is intended to provide
 Flight SQL clients with basic, SQL syntax and SQL functions related information.
 More information types can be added in future releases.
 E.g. more SQL syntax support types, scalar functions support, type conversion support etc.

 Note that the set of metadata may expand.

 Initially, Flight SQL will support the following information types:
 - Server Information - Range [0-500)
 - Syntax Information - Range [500-1000)
 Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options).
 Custom options should start at 10,000.

 If omitted, then all metadata will be retrieved.
 Flight SQL Servers may choose to include additional metadata above and beyond the specified set, however they must
 at least return the specified set. IDs ranging from 0 to 10,000 (exclusive) are reserved for future use.
 If additional metadata is included, the metadata IDs should start from 10,000.
      repeated uint32 info = 1;
      Specified by:
      getInfo in interface FlightSql.CommandGetSqlInfoOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The info at the given index.

    • setInfo

      public FlightSql.CommandGetSqlInfo.Builder setInfo(int index, int value)
      
 Values are modelled after ODBC's SQLGetInfo() function. This information is intended to provide
 Flight SQL clients with basic, SQL syntax and SQL functions related information.
 More information types can be added in future releases.
 E.g. more SQL syntax support types, scalar functions support, type conversion support etc.

 Note that the set of metadata may expand.

 Initially, Flight SQL will support the following information types:
 - Server Information - Range [0-500)
 - Syntax Information - Range [500-1000)
 Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options).
 Custom options should start at 10,000.

 If omitted, then all metadata will be retrieved.
 Flight SQL Servers may choose to include additional metadata above and beyond the specified set, however they must
 at least return the specified set. IDs ranging from 0 to 10,000 (exclusive) are reserved for future use.
 If additional metadata is included, the metadata IDs should start from 10,000.
      repeated uint32 info = 1;
      Parameters:
      index - The index to set the value at.
      value - The info to set.
      Returns:
      This builder for chaining.

    • addInfo

      public FlightSql.CommandGetSqlInfo.Builder addInfo(int value)
      
 Values are modelled after ODBC's SQLGetInfo() function. This information is intended to provide
 Flight SQL clients with basic, SQL syntax and SQL functions related information.
 More information types can be added in future releases.
 E.g. more SQL syntax support types, scalar functions support, type conversion support etc.

 Note that the set of metadata may expand.

 Initially, Flight SQL will support the following information types:
 - Server Information - Range [0-500)
 - Syntax Information - Range [500-1000)
 Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options).
 Custom options should start at 10,000.

 If omitted, then all metadata will be retrieved.
 Flight SQL Servers may choose to include additional metadata above and beyond the specified set, however they must
 at least return the specified set. IDs ranging from 0 to 10,000 (exclusive) are reserved for future use.
 If additional metadata is included, the metadata IDs should start from 10,000.
      repeated uint32 info = 1;
      Parameters:
      value - The info to add.
      Returns:
      This builder for chaining.

    • addAllInfo

      public FlightSql.CommandGetSqlInfo.Builder addAllInfo(Iterable<? extends Integer> values)
      
 Values are modelled after ODBC's SQLGetInfo() function. This information is intended to provide
 Flight SQL clients with basic, SQL syntax and SQL functions related information.
 More information types can be added in future releases.
 E.g. more SQL syntax support types, scalar functions support, type conversion support etc.

 Note that the set of metadata may expand.

 Initially, Flight SQL will support the following information types:
 - Server Information - Range [0-500)
 - Syntax Information - Range [500-1000)
 Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options).
 Custom options should start at 10,000.

 If omitted, then all metadata will be retrieved.
 Flight SQL Servers may choose to include additional metadata above and beyond the specified set, however they must
 at least return the specified set. IDs ranging from 0 to 10,000 (exclusive) are reserved for future use.
 If additional metadata is included, the metadata IDs should start from 10,000.
      repeated uint32 info = 1;
      Parameters:
      values - The info to add.
      Returns:
      This builder for chaining.

    • clearInfo

      public FlightSql.CommandGetSqlInfo.Builder clearInfo()
      
 Values are modelled after ODBC's SQLGetInfo() function. This information is intended to provide
 Flight SQL clients with basic, SQL syntax and SQL functions related information.
 More information types can be added in future releases.
 E.g. more SQL syntax support types, scalar functions support, type conversion support etc.

 Note that the set of metadata may expand.

 Initially, Flight SQL will support the following information types:
 - Server Information - Range [0-500)
 - Syntax Information - Range [500-1000)
 Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options).
 Custom options should start at 10,000.

 If omitted, then all metadata will be retrieved.
 Flight SQL Servers may choose to include additional metadata above and beyond the specified set, however they must
 at least return the specified set. IDs ranging from 0 to 10,000 (exclusive) are reserved for future use.
 If additional metadata is included, the metadata IDs should start from 10,000.
      repeated uint32 info = 1;
      Returns:
      This builder for chaining.