org.apache.arrow.flight.sql.impl

Class FlightSql.CommandGetXdbcTypeInfo.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetXdbcTypeInfo.Builder>

org.apache.arrow.flight.sql.impl.FlightSql.CommandGetXdbcTypeInfo.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, FlightSql.CommandGetXdbcTypeInfoOrBuilder

Enclosing class:

FlightSql.CommandGetXdbcTypeInfo

public static final class FlightSql.CommandGetXdbcTypeInfo.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetXdbcTypeInfo.Builder>
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

Method Summary

Modifier and Type	Method and Description
FlightSql.CommandGetXdbcTypeInfo	build()
FlightSql.CommandGetXdbcTypeInfo	buildPartial()
FlightSql.CommandGetXdbcTypeInfo.Builder	clear()
FlightSql.CommandGetXdbcTypeInfo.Builder	clearDataType() Specifies the data type to search for the info.
int	getDataType() Specifies the data type to search for the info.
FlightSql.CommandGetXdbcTypeInfo	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	hasDataType() Specifies the data type to search for the info.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
FlightSql.CommandGetXdbcTypeInfo.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
FlightSql.CommandGetXdbcTypeInfo.Builder	mergeFrom(FlightSql.CommandGetXdbcTypeInfo other)
FlightSql.CommandGetXdbcTypeInfo.Builder	mergeFrom(com.google.protobuf.Message other)
FlightSql.CommandGetXdbcTypeInfo.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FlightSql.CommandGetXdbcTypeInfo.Builder	setDataType(int value) Specifies the data type to search for the info.
FlightSql.CommandGetXdbcTypeInfo.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<FlightSql.CommandGetXdbcTypeInfo.Builder>

clear

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

getDefaultInstanceForType

public FlightSql.CommandGetXdbcTypeInfo getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public FlightSql.CommandGetXdbcTypeInfo build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public FlightSql.CommandGetXdbcTypeInfo buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

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

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetXdbcTypeInfo.Builder>

mergeFrom

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

Throws:

IOException

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.

setDataType

public FlightSql.CommandGetXdbcTypeInfo.Builder setDataType(int value)

 Specifies the data type to search for the info.
 

optional int32 data_type = 1;

Parameters:

value - The dataType to set.

Returns:

This builder for chaining.

clearDataType

public FlightSql.CommandGetXdbcTypeInfo.Builder clearDataType()

 Specifies the data type to search for the info.
 

optional int32 data_type = 1;

Returns:

This builder for chaining.

setUnknownFields

public final FlightSql.CommandGetXdbcTypeInfo.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetXdbcTypeInfo.Builder>

mergeUnknownFields

public final FlightSql.CommandGetXdbcTypeInfo.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetXdbcTypeInfo.Builder>