Table of Contents

Class CommandStatementIngest

Namespace
Arrow.Flight.Protocol.Sql
Assembly
Apache.Arrow.Flight.Sql.dll

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.

public sealed class CommandStatementIngest : IMessage<CommandStatementIngest>, IEquatable<CommandStatementIngest>, IDeepCloneable<CommandStatementIngest>, IBufferMessage, IMessage
Inheritance
CommandStatementIngest
Implements
IDeepCloneable<CommandStatementIngest>
IBufferMessage
IMessage
Inherited Members
Extension Methods

Constructors

CommandStatementIngest() 

public CommandStatementIngest()

CommandStatementIngest(CommandStatementIngest) 

public CommandStatementIngest(CommandStatementIngest other)

Parameters

other CommandStatementIngest

Fields

CatalogFieldNumber

Field number for the "catalog" field.

public const int CatalogFieldNumber = 4

Field Value

int

OptionsFieldNumber

Field number for the "options" field.

public const int OptionsFieldNumber = 1000

Field Value

int

SchemaFieldNumber

Field number for the "schema" field.

public const int SchemaFieldNumber = 3

Field Value

int

TableDefinitionOptionsFieldNumber

Field number for the "table_definition_options" field.

public const int TableDefinitionOptionsFieldNumber = 1

Field Value

int

TableFieldNumber

Field number for the "table" field.

public const int TableFieldNumber = 2

Field Value

int

TemporaryFieldNumber

Field number for the "temporary" field.

public const int TemporaryFieldNumber = 5

Field Value

int

TransactionIdFieldNumber

Field number for the "transaction_id" field.

public const int TransactionIdFieldNumber = 6

Field Value

int

Properties

Catalog

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

public string Catalog { get; set; }

Property Value

string

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

HasCatalog

Gets whether the "catalog" field is set

public bool HasCatalog { get; }

Property Value

bool

HasSchema

Gets whether the "schema" field is set

public bool HasSchema { get; }

Property Value

bool

HasTransactionId

Gets whether the "transaction_id" field is set

public bool HasTransactionId { get; }

Property Value

bool

Options

Backend-specific options.

public MapField<string, string> Options { get; }

Property Value

MapField<string, string>

Parser 

public static MessageParser<CommandStatementIngest> Parser { get; }

Property Value

MessageParser<CommandStatementIngest>

Schema

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

public string Schema { get; set; }

Property Value

string

Table

The table to load data into.

public string Table { get; set; }

Property Value

string

TableDefinitionOptions

The behavior for handling the table definition.

public CommandStatementIngest.Types.TableDefinitionOptions TableDefinitionOptions { get; set; }

Property Value

CommandStatementIngest.Types.TableDefinitionOptions

Temporary

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.

public bool Temporary { get; set; }

Property Value

bool

TransactionId

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

public ByteString TransactionId { get; set; }

Property Value

ByteString

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

ClearCatalog()

Clears the value of the "catalog" field

public void ClearCatalog()

ClearSchema()

Clears the value of the "schema" field

public void ClearSchema()

ClearTransactionId()

Clears the value of the "transaction_id" field

public void ClearTransactionId()

Clone()

Creates a deep clone of this object.

public CommandStatementIngest Clone()

Returns

CommandStatementIngest

A deep clone of this object.

Equals(CommandStatementIngest)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(CommandStatementIngest other)

Parameters

other CommandStatementIngest

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CommandStatementIngest)

Merges the given message into this one.

public void MergeFrom(CommandStatementIngest other)

Parameters

other CommandStatementIngest

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.

Edit this page