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
Modifier and Type | Class and Description |
---|---|
static class |
FlightSql.CommandStatementSubstraitPlan.Builder
Represents a Substrait plan.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
Modifier and Type | Field and Description |
---|---|
static int |
PLAN_FIELD_NUMBER |
static int |
TRANSACTION_ID_FIELD_NUMBER |
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).
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
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) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int PLAN_FIELD_NUMBER
public static final int TRANSACTION_ID_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public boolean hasPlan()
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;
hasPlan
in interface FlightSql.CommandStatementSubstraitPlanOrBuilder
public FlightSql.SubstraitPlan getPlan()
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;
getPlan
in interface FlightSql.CommandStatementSubstraitPlanOrBuilder
public FlightSql.SubstraitPlanOrBuilder getPlanOrBuilder()
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;
getPlanOrBuilder
in interface FlightSql.CommandStatementSubstraitPlanOrBuilder
public boolean hasTransactionId()
Include the query as part of this transaction (if unset, the query is auto-committed).
optional bytes transaction_id = 2;
hasTransactionId
in interface FlightSql.CommandStatementSubstraitPlanOrBuilder
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;
getTransactionId
in interface FlightSql.CommandStatementSubstraitPlanOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static FlightSql.CommandStatementSubstraitPlan parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandStatementSubstraitPlan parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandStatementSubstraitPlan parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandStatementSubstraitPlan parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandStatementSubstraitPlan parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandStatementSubstraitPlan parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandStatementSubstraitPlan parseFrom(InputStream input) throws IOException
IOException
public static FlightSql.CommandStatementSubstraitPlan parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static FlightSql.CommandStatementSubstraitPlan parseDelimitedFrom(InputStream input) throws IOException
IOException
public static FlightSql.CommandStatementSubstraitPlan parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static FlightSql.CommandStatementSubstraitPlan parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static FlightSql.CommandStatementSubstraitPlan parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public FlightSql.CommandStatementSubstraitPlan.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static FlightSql.CommandStatementSubstraitPlan.Builder newBuilder()
public static FlightSql.CommandStatementSubstraitPlan.Builder newBuilder(FlightSql.CommandStatementSubstraitPlan prototype)
public FlightSql.CommandStatementSubstraitPlan.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected FlightSql.CommandStatementSubstraitPlan.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static FlightSql.CommandStatementSubstraitPlan getDefaultInstance()
public static com.google.protobuf.Parser<FlightSql.CommandStatementSubstraitPlan> parser()
public com.google.protobuf.Parser<FlightSql.CommandStatementSubstraitPlan> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public FlightSql.CommandStatementSubstraitPlan getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2023 The Apache Software Foundation. All rights reserved.