org.apache.arrow.flight.sql.impl

Class FlightSql.CommandGetSqlInfo

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.arrow.flight.sql.impl.FlightSql.CommandGetSqlInfo

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, FlightSql.CommandGetSqlInfoOrBuilder

Enclosing class:

FlightSql

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlightSql.CommandGetSqlInfo.Builder Represents a metadata request.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	INFO_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static FlightSql.CommandGetSqlInfo	getDefaultInstance()
FlightSql.CommandGetSqlInfo	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getInfo(int index) Values are modelled after ODBC's SQLGetInfo() function.
int	getInfoCount() Values are modelled after ODBC's SQLGetInfo() function.
List<Integer>	getInfoList() Values are modelled after ODBC's SQLGetInfo() function.
com.google.protobuf.Parser<FlightSql.CommandGetSqlInfo>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static FlightSql.CommandGetSqlInfo.Builder	newBuilder()
static FlightSql.CommandGetSqlInfo.Builder	newBuilder(FlightSql.CommandGetSqlInfo prototype)
FlightSql.CommandGetSqlInfo.Builder	newBuilderForType()
protected FlightSql.CommandGetSqlInfo.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FlightSql.CommandGetSqlInfo	parseDelimitedFrom(InputStream input)
static FlightSql.CommandGetSqlInfo	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandGetSqlInfo	parseFrom(byte[] data)
static FlightSql.CommandGetSqlInfo	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandGetSqlInfo	parseFrom(ByteBuffer data)
static FlightSql.CommandGetSqlInfo	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandGetSqlInfo	parseFrom(com.google.protobuf.ByteString data)
static FlightSql.CommandGetSqlInfo	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandGetSqlInfo	parseFrom(com.google.protobuf.CodedInputStream input)
static FlightSql.CommandGetSqlInfo	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandGetSqlInfo	parseFrom(InputStream input)
static FlightSql.CommandGetSqlInfo	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FlightSql.CommandGetSqlInfo>	parser()
FlightSql.CommandGetSqlInfo.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INFO_FIELD_NUMBER

public static final int INFO_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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

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.

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.CommandGetSqlInfo parseFrom(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlightSql.CommandGetSqlInfo parseFrom(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlightSql.CommandGetSqlInfo parseFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static FlightSql.CommandGetSqlInfo parseDelimitedFrom(InputStream input)
                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static FlightSql.CommandGetSqlInfo parseFrom(com.google.protobuf.CodedInputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public FlightSql.CommandGetSqlInfo.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FlightSql.CommandGetSqlInfo.Builder newBuilder()

newBuilder

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

toBuilder

public FlightSql.CommandGetSqlInfo.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected FlightSql.CommandGetSqlInfo.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FlightSql.CommandGetSqlInfo getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<FlightSql.CommandGetSqlInfo> 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.CommandGetSqlInfo getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder