Struct Source

pub struct Source {

    pub id: u32,
    pub schema_id: u32,
    pub database_id: u32,
    pub name: String,
    pub row_id_index: Option<u32>,
    pub columns: Vec<ColumnCatalog>,
    pub pk_column_ids: Vec<i32>,
    pub with_properties: BTreeMap<String, String>,
    pub owner: u32,
    pub info: Option<StreamSourceInfo>,
    pub watermark_descs: Vec<WatermarkDesc>,
    pub definition: String,
    pub connection_id: Option<u32>,
    pub initialized_at_epoch: Option<u64>,
    pub created_at_epoch: Option<u64>,
    pub initialized_at_cluster_version: Option<String>,
    pub created_at_cluster_version: Option<String>,
    pub secret_refs: BTreeMap<String, SecretRef>,
    pub version: u64,
    pub rate_limit: Option<u32>,
    pub optional_associated_table_id: Option<OptionalAssociatedTableId>,
}

Fields

id: u32

For shared source, this is the same as the job id. For non-shared source and table with connector, this is a different oid.

schema_id: u32

database_id: u32

name: String

row_id_index: Option<u32>

The column index of row ID. If the primary key is specified by the user, this will be None.

columns: Vec<ColumnCatalog>

Columns of the source.

pk_column_ids: Vec<i32>

Column id of the primary key specified by the user. If the user does not specify a primary key, the vector will be empty.

with_properties: BTreeMap<String, String>

Properties specified by the user in WITH clause.

owner: u32

info: Option<StreamSourceInfo>

watermark_descs: Vec<WatermarkDesc>

Define watermarks on the source. The repeated is just for forward compatibility, currently, only one watermark on the source

definition: String

connection_id: Option<u32>

ref connection for connector

initialized_at_epoch: Option<u64>

created_at_epoch: Option<u64>

initialized_at_cluster_version: Option<String>

Cluster version (tracked by git commit) when initialized/created

created_at_cluster_version: Option<String>

secret_refs: BTreeMap<String, SecretRef>

Handle the source relies on any sceret. The key is the propertity name and the value is the secret id. Used for secret connect options.

version: u64

Per-source catalog version, used by schema change.

rate_limit: Option<u32>

optional_associated_table_id: Option<OptionalAssociatedTableId>

Indicate whether this source is created by table.

Implementations

impl Source

pub fn row_id_index(&self) -> u32

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

pub fn connection_id(&self) -> u32

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

pub fn initialized_at_epoch(&self) -> u64

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

pub fn created_at_epoch(&self) -> u64

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

pub fn initialized_at_cluster_version(&self) -> &str

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

pub fn created_at_cluster_version(&self) -> &str

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

pub fn rate_limit(&self) -> u32

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

impl Source

pub fn get_id(&self) -> u32

pub fn get_schema_id(&self) -> u32

pub fn get_database_id(&self) -> u32

pub fn get_name(&self) -> &String

pub fn get_row_id_index(&self) -> Result<&u32, PbFieldNotFound>

pub fn get_columns(&self) -> &Vec<ColumnCatalog>

pub fn get_pk_column_ids(&self) -> &Vec<i32>

pub fn get_with_properties(&self) -> &BTreeMap<String, String>

pub fn get_owner(&self) -> u32

pub fn get_info(&self) -> Result<&StreamSourceInfo, PbFieldNotFound>

pub fn get_watermark_descs(&self) -> &Vec<WatermarkDesc>

pub fn get_definition(&self) -> &String

pub fn get_connection_id(&self) -> Result<&u32, PbFieldNotFound>

pub fn get_initialized_at_epoch(&self) -> Result<&u64, PbFieldNotFound>

pub fn get_created_at_epoch(&self) -> Result<&u64, PbFieldNotFound>

pub fn get_initialized_at_cluster_version( &self, ) -> Result<&String, PbFieldNotFound>

pub fn get_created_at_cluster_version(&self) -> Result<&String, PbFieldNotFound>

pub fn get_secret_refs(&self) -> &BTreeMap<String, SecretRef>

pub fn get_version(&self) -> u64

pub fn get_rate_limit(&self) -> Result<&u32, PbFieldNotFound>

pub fn get_optional_associated_table_id( &self, ) -> Result<&OptionalAssociatedTableId, PbFieldNotFound>

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl Default for Source

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Source

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

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

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

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for Source

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Source