Struct DmlStatement

pub struct DmlStatement {
    pub table_name: TableReference,
    pub target: Arc<dyn TableSource>,
    pub op: WriteOp,
    pub input: Arc<LogicalPlan>,
    pub output_schema: Arc<DFSchema>,
}

Modifies the content of a database

This operator is used to perform DML operations such as INSERT, DELETE, UPDATE, and CTAS (CREATE TABLE AS SELECT).

• INSERT - Appends new rows to the existing table. Calls TableProvider::insert_into

• DELETE - Removes rows from the table. Currently NOT supported by the TableProvider trait or builtin sources.

• UPDATE - Modifies existing rows in the table. Currently NOT supported by the TableProvider trait or builtin sources.

• CREATE TABLE AS SELECT - Creates a new table and populates it with data from a query. This is similar to the INSERT operation, but it creates a new table instead of modifying an existing one.

Note that the structure is adapted from substrait WriteRel)

Fields

table_name: TableReference

The table name

target: Arc<dyn TableSource>

this is target table to insert into

op: WriteOp

The type of operation to perform

input: Arc<LogicalPlan>

The relation that determines the tuples to add/remove/modify the schema must match with table_schema

output_schema: Arc<DFSchema>

The schema of the output relation

Implementations

impl DmlStatement

pub fn new( table_name: TableReference, target: Arc<dyn TableSource>, op: WriteOp, input: Arc<LogicalPlan>, ) -> DmlStatement

Creates a new DML statement with the output schema set to a single count column.

pub fn name(&self) -> &str

Return a descriptive name of this DmlStatement

Trait Implementations

impl Clone for DmlStatement

fn clone(&self) -> DmlStatement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DmlStatement

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

Formats the value using the given formatter.

impl Hash for DmlStatement

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DmlStatement

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

fn partial_cmp(&self, other: &DmlStatement) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for DmlStatement