Module org.apache.arrow.flight.core
Package org.apache.arrow.flight.sql.impl
Class FlightSql.CommandStatementSubstraitPlan.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementSubstraitPlan.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable,FlightSql.CommandStatementSubstraitPlanOrBuilder
- Enclosing class:
- FlightSql.CommandStatementSubstraitPlan
public static final class FlightSql.CommandStatementSubstraitPlan.Builder
extends com.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
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. - ARROW:FLIGHT:SQL:REMARKS - A comment describing the column. - GetFlightInfo: execute the query. - DoPut: execute the query.Protobuf type
arrow.flight.protocol.sql.CommandStatementSubstraitPlan-
Method Summary
Modifier and TypeMethodDescriptionbuild()clear()A serialized substrait.PlanInclude the query as part of this transaction (if unset, the query is auto-committed).static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorgetPlan()A serialized substrait.PlanA serialized substrait.PlanA serialized substrait.Plancom.google.protobuf.ByteStringInclude the query as part of this transaction (if unset, the query is auto-committed).booleanhasPlan()A serialized substrait.PlanbooleanInclude the query as part of this transaction (if unset, the query is auto-committed).protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergePlan(FlightSql.SubstraitPlan value) A serialized substrait.PlansetPlan(FlightSql.SubstraitPlan value) A serialized substrait.PlansetPlan(FlightSql.SubstraitPlan.Builder builderForValue) A serialized substrait.PlansetTransactionId(com.google.protobuf.ByteString value) Include the query as part of this transaction (if unset, the query is auto-committed).Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
mergeFrom
public FlightSql.CommandStatementSubstraitPlan.Builder mergeFrom(FlightSql.CommandStatementSubstraitPlan other) -
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
mergeFrom
public FlightSql.CommandStatementSubstraitPlan.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>- Throws:
IOException
-
hasPlan
public boolean hasPlan()A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;- Specified by:
hasPlanin interfaceFlightSql.CommandStatementSubstraitPlanOrBuilder- Returns:
- Whether the plan field is set.
-
getPlan
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;- Specified by:
getPlanin interfaceFlightSql.CommandStatementSubstraitPlanOrBuilder- Returns:
- The plan.
-
setPlan
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1; -
setPlan
public FlightSql.CommandStatementSubstraitPlan.Builder setPlan(FlightSql.SubstraitPlan.Builder builderForValue) A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1; -
mergePlan
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1; -
clearPlan
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1; -
getPlanBuilder
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1; -
getPlanOrBuilder
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;- Specified by:
getPlanOrBuilderin interfaceFlightSql.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:
hasTransactionIdin interfaceFlightSql.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:
getTransactionIdin interfaceFlightSql.CommandStatementSubstraitPlanOrBuilder- Returns:
- The transactionId.
-
setTransactionId
public FlightSql.CommandStatementSubstraitPlan.Builder setTransactionId(com.google.protobuf.ByteString value) Include the query as part of this transaction (if unset, the query is auto-committed).
optional bytes transaction_id = 2;- Parameters:
value- The transactionId to set.- Returns:
- This builder for chaining.
-
clearTransactionId
Include the query as part of this transaction (if unset, the query is auto-committed).
optional bytes transaction_id = 2;- Returns:
- This builder for chaining.
-