Struct DesiredTable 

pub struct DesiredTable {
    pub table: TableRef,
    pub columns: Vec<ColumnSpec>,
    pub comment: Option<String>,
    pub properties: BTreeMap<String, String>,
}

The target state the engine wants a table to be in, derived from an incoming Arrow RecordBatch schema plus contract/engine metadata.

Fields

table: TableRef

The table this describes.

columns: Vec<ColumnSpec>

Columns in declaration order.

comment: Option<String>

Table-level description, if any.

properties: BTreeMap<String, String>

Table properties/tags (owner, contract URI + version, source topic, …), stored sorted so a plan is deterministic.

Implementations

impl DesiredTable

pub fn new(table: TableRef, columns: Vec<ColumnSpec>) -> Self

Start a desired-table spec with columns; comment and properties default empty and are added with the builder methods.

pub fn with_comment(self, comment: impl Into<String>) -> Self

Builder: set the table-level comment.

pub fn with_property( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Builder: set a table property/tag.

pub fn column(&self, name: &str) -> Option<&ColumnSpec>

Look up a desired column by name.

pub fn from_arrow_schema(table: TableRef, schema: &Schema) -> Self

Derive the desired columns directly from an incoming Arrow RecordBatch schema — the create/evolve driver described in the Zerobus sink plan §5.1.

Each Arrow field maps to the coarse sink type via [ProtoFieldType::from_arrow_type], carrying the field’s nullability. Comments and properties are attached afterwards with the builder methods (they come from the contract / engine, not the Arrow schema).

Trait Implementations

impl Clone for DesiredTable

fn clone(&self) -> DesiredTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DesiredTable

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

Formats the value using the given formatter.

impl PartialEq for DesiredTable

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

impl StructuralPartialEq for DesiredTable