Struct WriteOperation

pub struct WriteOperation {
    pub input: Option<Relation>,
    pub source: Option<String>,
    pub mode: i32,
    pub sort_column_names: Vec<String>,
    pub partitioning_columns: Vec<String>,
    pub bucket_by: Option<BucketBy>,
    pub options: HashMap<String, String>,
    pub save_type: Option<SaveType>,
}

As writes are not directly handled during analysis and planning, they are modeled as commands.

Fields

input: Option<Relation>

(Required) The output of the input relation will be persisted according to the options.

source: Option<String>

(Optional) Format value according to the Spark documentation. Examples are: text, parquet, delta.

mode: i32

(Required) the save mode.

sort_column_names: Vec<String>

(Optional) List of columns to sort the output by.

partitioning_columns: Vec<String>

(Optional) List of columns for partitioning.

bucket_by: Option<BucketBy>

(Optional) Bucketing specification. Bucketing must set the number of buckets and the columns to bucket by.

options: HashMap<String, String>

(Optional) A list of configuration options.

save_type: Option<SaveType>

(Optional)

The destination of the write operation can be either a path or a table. If the destination is neither a path nor a table, such as jdbc and noop, the save_type should not be set.

Implementations

impl WriteOperation

pub fn source(&self) -> &str

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

pub fn mode(&self) -> SaveMode

Returns the enum value of mode, or the default if the field is set to an invalid enum value.

pub fn set_mode(&mut self, value: SaveMode)

Sets mode to the provided enum value.

Trait Implementations

impl Clone for WriteOperation

fn clone(&self) -> WriteOperation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WriteOperation

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

Formats the value using the given formatter.

impl Default for WriteOperation

fn default() -> Self

Returns the “default value” for a type.

impl Message for WriteOperation

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for WriteOperation

fn eq(&self, other: &WriteOperation) -> 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 StructuralPartialEq for WriteOperation