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

Class FlightSql.CommandGetXdbcTypeInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.apache.arrow.flight.sql.impl.FlightSql.CommandGetXdbcTypeInfo
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, FlightSql.CommandGetXdbcTypeInfoOrBuilder
Enclosing class:
FlightSql
public static final class FlightSql.CommandGetXdbcTypeInfo extends com.google.protobuf.GeneratedMessageV3 implements FlightSql.CommandGetXdbcTypeInfoOrBuilder

 Represents a request to retrieve information about data type supported on a Flight SQL enabled backend.
 Used in the command member of FlightDescriptor for the following RPC calls:
  - GetSchema: return the schema of the query.
  - GetFlightInfo: execute the catalog metadata request.

 The returned schema will be:
 <
   type_name: utf8 not null (The name of the data type, for example: VARCHAR, INTEGER, etc),
   data_type: int32 not null (The SQL data type),
   column_size: int32 (The maximum size supported by that column.
                       In case of exact numeric types, this represents the maximum precision.
                       In case of string types, this represents the character length.
                       In case of datetime data types, this represents the length in characters of the string representation.
                       NULL is returned for data types where column size is not applicable.),
   literal_prefix: utf8 (Character or characters used to prefix a literal, NULL is returned for
                         data types where a literal prefix is not applicable.),
   literal_suffix: utf8 (Character or characters used to terminate a literal,
                         NULL is returned for data types where a literal suffix is not applicable.),
   create_params: list<utf8 not null>
                        (A list of keywords corresponding to which parameters can be used when creating
                         a column for that specific type.
                         NULL is returned if there are no parameters for the data type definition.),
   nullable: int32 not null (Shows if the data type accepts a NULL value. The possible values can be seen in the
                             Nullable enum.),
   case_sensitive: bool not null (Shows if a character data type is case-sensitive in collations and comparisons),
   searchable: int32 not null (Shows how the data type is used in a WHERE clause. The possible values can be seen in the
                               Searchable enum.),
   unsigned_attribute: bool (Shows if the data type is unsigned. NULL is returned if the attribute is
                             not applicable to the data type or the data type is not numeric.),
   fixed_prec_scale: bool not null (Shows if the data type has predefined fixed precision and scale.),
   auto_increment: bool (Shows if the data type is auto incremental. NULL is returned if the attribute
                         is not applicable to the data type or the data type is not numeric.),
   local_type_name: utf8 (Localized version of the data source-dependent name of the data type. NULL
                          is returned if a localized name is not supported by the data source),
   minimum_scale: int32 (The minimum scale of the data type on the data source.
                         If a data type has a fixed scale, the MINIMUM_SCALE and MAXIMUM_SCALE
                         columns both contain this value. NULL is returned if scale is not applicable.),
   maximum_scale: int32 (The maximum scale of the data type on the data source.
                         NULL is returned if scale is not applicable.),
   sql_data_type: int32 not null (The value of the SQL DATA TYPE which has the same values
                                  as data_type value. Except for interval and datetime, which
                                  uses generic values. More info about those types can be
                                  obtained through datetime_subcode. The possible values can be seen
                                  in the XdbcDataType enum.),
   datetime_subcode: int32 (Only used when the SQL DATA TYPE is interval or datetime. It contains
                            its sub types. For type different from interval and datetime, this value
                            is NULL. The possible values can be seen in the XdbcDatetimeSubcode enum.),
   num_prec_radix: int32 (If the data type is an approximate numeric type, this column contains
                          the value 2 to indicate that COLUMN_SIZE specifies a number of bits. For
                          exact numeric types, this column contains the value 10 to indicate that
                          column size specifies a number of decimal digits. Otherwise, this column is NULL.),
   interval_precision: int32 (If the data type is an interval data type, then this column contains the value
                              of the interval leading precision. Otherwise, this column is NULL. This fields
                              is only relevant to be used by ODBC).
 >
 The returned data should be ordered by data_type and then by type_name.
Protobuf type arrow.flight.protocol.sql.CommandGetXdbcTypeInfo
See Also:

  • Field Details

    • DATA_TYPE_FIELD_NUMBER

      public static final int DATA_TYPE_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()

    • internalGetFieldAccessorTable

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

    • hasDataType

      public boolean hasDataType()
      
 Specifies the data type to search for the info.
      optional int32 data_type = 1;
      Specified by:
      hasDataType in interface FlightSql.CommandGetXdbcTypeInfoOrBuilder
      Returns:
      Whether the dataType field is set.

    • getDataType

      public int getDataType()
      
 Specifies the data type to search for the info.
      optional int32 data_type = 1;
      Specified by:
      getDataType in interface FlightSql.CommandGetXdbcTypeInfoOrBuilder
      Returns:
      The dataType.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FlightSql.CommandGetXdbcTypeInfo.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FlightSql.CommandGetXdbcTypeInfo getDefaultInstance()

    • parser

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

    • getParserForType

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