Struct CommandStatementIngest

pub struct CommandStatementIngest {
    pub table_definition_options: Option<TableDefinitionOptions>,
    pub table: String,
    pub schema: Option<String>,
    pub catalog: Option<String>,
    pub temporary: bool,
    pub transaction_id: Option<Bytes>,
    pub options: HashMap<String, String>,
}

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.

Fields

table_definition_options: Option<TableDefinitionOptions>

The behavior for handling the table definition.

table: String

The table to load data into.

schema: Option<String>

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

catalog: Option<String>

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

temporary: bool

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.

transaction_id: Option<Bytes>

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

options: HashMap<String, String>

Backend-specific options.

Implementations

impl CommandStatementIngest

pub fn schema(&self) -> &str

Returns the value of schema, or the default value if schema is unset.

pub fn catalog(&self) -> &str

Returns the value of catalog, or the default value if catalog is unset.

pub fn transaction_id(&self) -> &[u8]

Returns the value of transaction_id, or the default value if transaction_id is unset.

Trait Implementations

impl Clone for CommandStatementIngest

fn clone(&self) -> CommandStatementIngest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandStatementIngest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CommandStatementIngest

fn default() -> Self

Returns the “default value” for a type.

impl Message for CommandStatementIngest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CommandStatementIngest

fn eq(&self, other: &CommandStatementIngest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ProstMessageExt for CommandStatementIngest

fn type_url() -> &'static str

type_url for this Message

fn as_any(&self) -> Any

Convert this Message to Any

impl StructuralPartialEq for CommandStatementIngest