org.apache.arrow.flight.sql.impl

Class FlightSql.CommandStatementSubstraitPlan

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

FlightSql

public static final class FlightSql.CommandStatementSubstraitPlan
extends com.google.protobuf.GeneratedMessageV3
implements FlightSql.CommandStatementSubstraitPlanOrBuilder

 Represents a Substrait plan. 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.
  - GetFlightInfo: execute the query.
  - DoPut: execute the query.
 

Protobuf type arrow.flight.protocol.sql.CommandStatementSubstraitPlan

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlightSql.CommandStatementSubstraitPlan.Builder Represents a Substrait plan.

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	PLAN_FIELD_NUMBER
static int	TRANSACTION_ID_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.CommandStatementSubstraitPlan	getDefaultInstance()
FlightSql.CommandStatementSubstraitPlan	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<FlightSql.CommandStatementSubstraitPlan>	getParserForType()
FlightSql.SubstraitPlan	getPlan() A serialized substrait.Plan
FlightSql.SubstraitPlanOrBuilder	getPlanOrBuilder() A serialized substrait.Plan
int	getSerializedSize()
com.google.protobuf.ByteString	getTransactionId() Include the query as part of this transaction (if unset, the query is auto-committed).
int	hashCode()
boolean	hasPlan() A serialized substrait.Plan
boolean	hasTransactionId() Include the query as part of this transaction (if unset, the query is auto-committed).
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static FlightSql.CommandStatementSubstraitPlan.Builder	newBuilder()
static FlightSql.CommandStatementSubstraitPlan.Builder	newBuilder(FlightSql.CommandStatementSubstraitPlan prototype)
FlightSql.CommandStatementSubstraitPlan.Builder	newBuilderForType()
protected FlightSql.CommandStatementSubstraitPlan.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FlightSql.CommandStatementSubstraitPlan	parseDelimitedFrom(InputStream input)
static FlightSql.CommandStatementSubstraitPlan	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandStatementSubstraitPlan	parseFrom(byte[] data)
static FlightSql.CommandStatementSubstraitPlan	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandStatementSubstraitPlan	parseFrom(ByteBuffer data)
static FlightSql.CommandStatementSubstraitPlan	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandStatementSubstraitPlan	parseFrom(com.google.protobuf.ByteString data)
static FlightSql.CommandStatementSubstraitPlan	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandStatementSubstraitPlan	parseFrom(com.google.protobuf.CodedInputStream input)
static FlightSql.CommandStatementSubstraitPlan	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandStatementSubstraitPlan	parseFrom(InputStream input)
static FlightSql.CommandStatementSubstraitPlan	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FlightSql.CommandStatementSubstraitPlan>	parser()
FlightSql.CommandStatementSubstraitPlan.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

PLAN_FIELD_NUMBER

public static final int PLAN_FIELD_NUMBER

See Also:

Constant Field Values

TRANSACTION_ID_FIELD_NUMBER

public static final int TRANSACTION_ID_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

hasPlan

public boolean hasPlan()

 A serialized substrait.Plan
 

.arrow.flight.protocol.sql.SubstraitPlan plan = 1;

Specified by:

hasPlan in interface FlightSql.CommandStatementSubstraitPlanOrBuilder

Returns:

Whether the plan field is set.

getPlan

public FlightSql.SubstraitPlan getPlan()

 A serialized substrait.Plan
 

.arrow.flight.protocol.sql.SubstraitPlan plan = 1;

Specified by:

getPlan in interface FlightSql.CommandStatementSubstraitPlanOrBuilder

Returns:

The plan.

getPlanOrBuilder

public FlightSql.SubstraitPlanOrBuilder getPlanOrBuilder()

 A serialized substrait.Plan
 

.arrow.flight.protocol.sql.SubstraitPlan plan = 1;

Specified by:

getPlanOrBuilder in interface FlightSql.CommandStatementSubstraitPlanOrBuilder

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.CommandStatementSubstraitPlanOrBuilder

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.CommandStatementSubstraitPlanOrBuilder

Returns:

The transactionId.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public FlightSql.CommandStatementSubstraitPlan.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FlightSql.CommandStatementSubstraitPlan.Builder newBuilder()

newBuilder

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

toBuilder

public FlightSql.CommandStatementSubstraitPlan.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FlightSql.CommandStatementSubstraitPlan getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder