Module org.apache.arrow.flight.core

Package org.apache.arrow.flight.sql.impl

Class FlightSql.CommandStatementIngest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

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

All Implemented Interfaces:

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

Enclosing class:

FlightSql

public static final class FlightSql.CommandStatementIngest
extends com.google.protobuf.GeneratedMessage
implements FlightSql.CommandStatementIngestOrBuilder

 Represents a bulk ingestion request. Used in the command member of FlightDescriptor
 for the the RPC call DoPut to cause the server load the contents of the stream's
 FlightData into the target destination.
 

Protobuf type arrow.flight.protocol.sql.CommandStatementIngest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FlightSql.CommandStatementIngest.Builder	Represents a bulk ingestion request.
static final class	FlightSql.CommandStatementIngest.TableDefinitionOptions	Options for table definition behavior
static interface	FlightSql.CommandStatementIngest.TableDefinitionOptionsOrBuilder

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

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessage.BuilderParent

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CATALOG_FIELD_NUMBER
static final int	OPTIONS_FIELD_NUMBER
static final int	SCHEMA_FIELD_NUMBER
static final int	TABLE_DEFINITION_OPTIONS_FIELD_NUMBER
static final int	TABLE_FIELD_NUMBER
static final int	TEMPORARY_FIELD_NUMBER
static final int	TRANSACTION_ID_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, 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	Description
boolean	containsOptions(String key)	Backend-specific options.
boolean	equals(Object obj)
String	getCatalog()	The catalog of the destination table to load data into.
com.google.protobuf.ByteString	getCatalogBytes()	The catalog of the destination table to load data into.
static FlightSql.CommandStatementIngest	getDefaultInstance()
FlightSql.CommandStatementIngest	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Map<String,String>	getOptions()	Deprecated.
int	getOptionsCount()	Backend-specific options.
Map<String,String>	getOptionsMap()	Backend-specific options.
String	getOptionsOrDefault(String key, String defaultValue)	Backend-specific options.
String	getOptionsOrThrow(String key)	Backend-specific options.
com.google.protobuf.Parser<FlightSql.CommandStatementIngest>	getParserForType()
String	getSchema()	The db_schema of the destination table to load data into.
com.google.protobuf.ByteString	getSchemaBytes()	The db_schema of the destination table to load data into.
int	getSerializedSize()
String	getTable()	The table to load data into.
com.google.protobuf.ByteString	getTableBytes()	The table to load data into.
FlightSql.CommandStatementIngest.TableDefinitionOptions	getTableDefinitionOptions()	The behavior for handling the table definition.
FlightSql.CommandStatementIngest.TableDefinitionOptionsOrBuilder	getTableDefinitionOptionsOrBuilder()	The behavior for handling the table definition.
boolean	getTemporary()	Store ingested data in a temporary table.
com.google.protobuf.ByteString	getTransactionId()	Perform the ingestion as part of this transaction.
boolean	hasCatalog()	The catalog of the destination table to load data into.
int	hashCode()
boolean	hasSchema()	The db_schema of the destination table to load data into.
boolean	hasTableDefinitionOptions()	The behavior for handling the table definition.
boolean	hasTransactionId()	Perform the ingestion as part of this transaction.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
final boolean	isInitialized()
static FlightSql.CommandStatementIngest.Builder	newBuilder()
static FlightSql.CommandStatementIngest.Builder	newBuilder(FlightSql.CommandStatementIngest prototype)
FlightSql.CommandStatementIngest.Builder	newBuilderForType()
protected FlightSql.CommandStatementIngest.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static FlightSql.CommandStatementIngest	parseDelimitedFrom(InputStream input)
static FlightSql.CommandStatementIngest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandStatementIngest	parseFrom(byte[] data)
static FlightSql.CommandStatementIngest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandStatementIngest	parseFrom(com.google.protobuf.ByteString data)
static FlightSql.CommandStatementIngest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandStatementIngest	parseFrom(com.google.protobuf.CodedInputStream input)
static FlightSql.CommandStatementIngest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandStatementIngest	parseFrom(InputStream input)
static FlightSql.CommandStatementIngest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandStatementIngest	parseFrom(ByteBuffer data)
static FlightSql.CommandStatementIngest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FlightSql.CommandStatementIngest>	parser()
FlightSql.CommandStatementIngest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

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

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

TABLE_DEFINITION_OPTIONS_FIELD_NUMBER

public static final int TABLE_DEFINITION_OPTIONS_FIELD_NUMBER

See Also:

• Constant Field Values

TABLE_FIELD_NUMBER

public static final int TABLE_FIELD_NUMBER

See Also:

• Constant Field Values

SCHEMA_FIELD_NUMBER

public static final int SCHEMA_FIELD_NUMBER

See Also:

• Constant Field Values

CATALOG_FIELD_NUMBER

public static final int CATALOG_FIELD_NUMBER

See Also:

• Constant Field Values

TEMPORARY_FIELD_NUMBER

public static final int TEMPORARY_FIELD_NUMBER

See Also:

• Constant Field Values

TRANSACTION_ID_FIELD_NUMBER

public static final int TRANSACTION_ID_FIELD_NUMBER

See Also:

• Constant Field Values

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

hasTableDefinitionOptions

public boolean hasTableDefinitionOptions()

 The behavior for handling the table definition.
 

.arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions table_definition_options = 1;

Specified by:

hasTableDefinitionOptions in interface FlightSql.CommandStatementIngestOrBuilder

Returns:

Whether the tableDefinitionOptions field is set.

getTableDefinitionOptions

public FlightSql.CommandStatementIngest.TableDefinitionOptions getTableDefinitionOptions()

 The behavior for handling the table definition.
 

.arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions table_definition_options = 1;

Specified by:

getTableDefinitionOptions in interface FlightSql.CommandStatementIngestOrBuilder

Returns:

The tableDefinitionOptions.

getTableDefinitionOptionsOrBuilder

public FlightSql.CommandStatementIngest.TableDefinitionOptionsOrBuilder getTableDefinitionOptionsOrBuilder()

 The behavior for handling the table definition.
 

.arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions table_definition_options = 1;

Specified by:

getTableDefinitionOptionsOrBuilder in interface FlightSql.CommandStatementIngestOrBuilder

getTable

public String getTable()

 The table to load data into.
 

string table = 2;

Specified by:

getTable in interface FlightSql.CommandStatementIngestOrBuilder

Returns:

The table.

getTableBytes

public com.google.protobuf.ByteString getTableBytes()

 The table to load data into.
 

string table = 2;

Specified by:

getTableBytes in interface FlightSql.CommandStatementIngestOrBuilder

Returns:

The bytes for table.

hasSchema

public boolean hasSchema()

 The db_schema of the destination table to load data into. If unset, a backend-specific default may be used.
 

optional string schema = 3;

Specified by:

hasSchema in interface FlightSql.CommandStatementIngestOrBuilder

Returns:

Whether the schema field is set.

getSchema

public String getSchema()

 The db_schema of the destination table to load data into. If unset, a backend-specific default may be used.
 

optional string schema = 3;

Specified by:

getSchema in interface FlightSql.CommandStatementIngestOrBuilder

Returns:

The schema.

getSchemaBytes

public com.google.protobuf.ByteString getSchemaBytes()

 The db_schema of the destination table to load data into. If unset, a backend-specific default may be used.
 

optional string schema = 3;

Specified by:

getSchemaBytes in interface FlightSql.CommandStatementIngestOrBuilder

Returns:

The bytes for schema.

hasCatalog

public boolean hasCatalog()

 The catalog of the destination table to load data into. If unset, a backend-specific default may be used.
 

optional string catalog = 4;

Specified by:

hasCatalog in interface FlightSql.CommandStatementIngestOrBuilder

Returns:

Whether the catalog field is set.

getCatalog

public String getCatalog()

 The catalog of the destination table to load data into. If unset, a backend-specific default may be used.
 

optional string catalog = 4;

Specified by:

getCatalog in interface FlightSql.CommandStatementIngestOrBuilder

Returns:

The catalog.

getCatalogBytes

public com.google.protobuf.ByteString getCatalogBytes()

 The catalog of the destination table to load data into. If unset, a backend-specific default may be used.
 

optional string catalog = 4;

Specified by:

getCatalogBytes in interface FlightSql.CommandStatementIngestOrBuilder

Returns:

The bytes for catalog.

getTemporary

public boolean getTemporary()

 Store ingested data in a temporary table.
 The effect of setting temporary is to place the table in a backend-defined namespace, and to drop the table at the end of the session.
 The namespacing may make use of a backend-specific schema and/or catalog.
 The server should return an error if an explicit choice of schema or catalog is incompatible with the server's namespacing decision.
 

bool temporary = 5;

Specified by:

getTemporary in interface FlightSql.CommandStatementIngestOrBuilder

Returns:

The temporary.

hasTransactionId

public boolean hasTransactionId()

 Perform the ingestion as part of this transaction. If specified, results should not be committed in the event of an error/cancellation.
 

optional bytes transaction_id = 6;

Specified by:

hasTransactionId in interface FlightSql.CommandStatementIngestOrBuilder

Returns:

Whether the transactionId field is set.

getTransactionId

public com.google.protobuf.ByteString getTransactionId()

 Perform the ingestion as part of this transaction. If specified, results should not be committed in the event of an error/cancellation.
 

optional bytes transaction_id = 6;

Specified by:

getTransactionId in interface FlightSql.CommandStatementIngestOrBuilder

Returns:

The transactionId.

getOptionsCount

public int getOptionsCount()

Description copied from interface: FlightSql.CommandStatementIngestOrBuilder

 Backend-specific options.
 

map<string, string> options = 1000;

Specified by:

getOptionsCount in interface FlightSql.CommandStatementIngestOrBuilder

containsOptions

public boolean containsOptions(String key)

 Backend-specific options.
 

map<string, string> options = 1000;

Specified by:

containsOptions in interface FlightSql.CommandStatementIngestOrBuilder

getOptions

@Deprecated
public Map<String,String> getOptions()

Deprecated.

Use getOptionsMap() instead.

Specified by:

getOptions in interface FlightSql.CommandStatementIngestOrBuilder

getOptionsMap

public Map<String,String> getOptionsMap()

 Backend-specific options.
 

map<string, string> options = 1000;

Specified by:

getOptionsMap in interface FlightSql.CommandStatementIngestOrBuilder

getOptionsOrDefault

public String getOptionsOrDefault(String key,
 String defaultValue)

 Backend-specific options.
 

map<string, string> options = 1000;

Specified by:

getOptionsOrDefault in interface FlightSql.CommandStatementIngestOrBuilder

getOptionsOrThrow

public String getOptionsOrThrow(String key)

 Backend-specific options.
 

map<string, string> options = 1000;

Specified by:

getOptionsOrThrow in interface FlightSql.CommandStatementIngestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public FlightSql.CommandStatementIngest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FlightSql.CommandStatementIngest.Builder newBuilder()

newBuilder

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

toBuilder

public FlightSql.CommandStatementIngest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected FlightSql.CommandStatementIngest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static FlightSql.CommandStatementIngest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<FlightSql.CommandStatementIngest> 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.GeneratedMessage

getDefaultInstanceForType

public FlightSql.CommandStatementIngest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder