Struct SinkDesc

pub struct SinkDesc {

    pub id: SinkId,
    pub name: String,
    pub definition: String,
    pub columns: Vec<ColumnCatalog>,
    pub plan_pk: Vec<ColumnOrder>,
    pub downstream_pk: Vec<usize>,
    pub distribution_key: Vec<usize>,
    pub properties: BTreeMap<String, String>,
    pub secret_refs: BTreeMap<String, PbSecretRef>,
    pub sink_type: SinkType,
    pub format_desc: Option<SinkFormatDesc>,
    pub db_name: String,
    pub sink_from_name: String,
    pub target_table: Option<TableId>,
    pub extra_partition_col_idx: Option<usize>,
    pub create_type: CreateType,
}

Fields

id: SinkId

Id of the sink. For debug now.

name: String

Name of the sink. For debug now.

definition: String

Full SQL definition of the sink. For debug now.

columns: Vec<ColumnCatalog>

All columns of the sink. Note that this is NOT sorted by columnId in the vector.

plan_pk: Vec<ColumnOrder>

Primary keys of the sink. Derived by the frontend.

downstream_pk: Vec<usize>

User-defined primary key indices for upsert sink.

distribution_key: Vec<usize>

Distribution key indices of the sink. For example, if distribution_key = [1, 2], then the distribution keys will be columns[1] and columns[2].

properties: BTreeMap<String, String>

The properties of the sink.

secret_refs: BTreeMap<String, PbSecretRef>

Secret ref

sink_type: SinkType

format_desc: Option<SinkFormatDesc>

db_name: String

Name of the database

sink_from_name: String

Name of the “table” field for Debezium. If the sink is from table or mv, it is the name of table/mv. Otherwise, it is the name of the sink.

target_table: Option<TableId>

Id of the target table for sink into table.

extra_partition_col_idx: Option<usize>

See the same name field in SinkWriterParam.

create_type: CreateType

Whether the sink job should run in foreground or background.

Implementations

impl SinkDesc

pub fn into_catalog( self, schema_id: SchemaId, database_id: DatabaseId, owner: UserId, connection_id: Option<ConnectionId>, ) -> SinkCatalog

pub fn to_proto(&self) -> PbSinkDesc

pub fn is_file_sink(&self) -> bool

Trait Implementations

impl Clone for SinkDesc

fn clone(&self) -> SinkDesc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SinkDesc

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

Formats the value using the given formatter.

impl Hash for SinkDesc

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

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 SinkDesc

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

impl StructuralPartialEq for SinkDesc