Struct mz_catalog::memory::objects::Sink

pub struct Sink {
    pub create_sql: String,
    pub global_id: GlobalId,
    pub from: GlobalId,
    pub connection: StorageSinkConnection<ReferencedConnection>,
    pub envelope: SinkEnvelope,
    pub partition_strategy: SinkPartitionStrategy,
    pub with_snapshot: bool,
    pub version: u64,
    pub resolved_ids: ResolvedIds,
    pub cluster_id: ClusterId,
}

Fields

create_sql: String

Parse-able SQL that defines this sink.

global_id: GlobalId

GlobalId used to reference this sink from outside the catalog, e.g storage.

from: GlobalId

Collection we read into this sink.

connection: StorageSinkConnection<ReferencedConnection>

Connection to the external service we’re sinking into, e.g. Kafka.

envelope: SinkEnvelope

Envelope we use to sink into the external system.

TODO(guswynn): this probably should just be in the connection.

partition_strategy: SinkPartitionStrategy

Strategy used to partition rows.

with_snapshot: bool

Emit an initial snapshot into the sink.

version: u64

Used to fence other writes into this sink as we evolve the upstream materialized view.

resolved_ids: ResolvedIds

Other catalog objects this sink references.

cluster_id: ClusterId

Cluster this sink runs on.

Implementations

impl Sink

pub fn sink_type(&self) -> &str

pub fn envelope(&self) -> Option<&str>

Envelope of the sink.

pub fn combined_format(&self) -> Cow<'_, str>

Output a combined format string of the sink. For legacy reasons if the key-format is none or the key & value formats are both the same (either avro or json), we return the value format name, otherwise we return a composite name.

pub fn formats(&self) -> (Option<&str>, &str)

Output distinct key_format and value_format of the sink.

pub fn connection_id(&self) -> Option<CatalogItemId>

pub fn global_id(&self) -> GlobalId

The single GlobalId that this Sink can be referenced by.

Trait Implementations

impl Clone for Sink

fn clone(&self) -> Sink

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sink

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

Formats the value using the given formatter.

impl Serialize for Sink

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.