Trait mz_storage_types::sources::SourceConnection

source · 
pub trait SourceConnection:
    Debug
    + Clone
    + PartialEq
    + AlterCompatible {
    // Required methods
    fn name(&self) -> &'static str;
    fn external_reference(&self) -> Option<&str>;
    fn default_key_desc(&self) -> RelationDesc;
    fn default_value_desc(&self) -> RelationDesc;
    fn timestamp_desc(&self) -> RelationDesc;
    fn connection_id(&self) -> Option<CatalogItemId>;
    fn primary_export_details(&self) -> SourceExportDetails;
    fn supports_read_only(&self) -> bool;
}
Expand description

A connection to an external system

Required Methods§

source

fn name(&self) -> &'static str

The name of the external system (e.g kafka, postgres, etc).

source

fn external_reference(&self) -> Option<&str>

The name of the resource in the external system (e.g kafka topic) if any

source

fn default_key_desc(&self) -> RelationDesc

Defines the key schema to use by default for this source connection type. This will be used for the primary export of the source and as the default pre-encoding key schema for the source.

source

fn default_value_desc(&self) -> RelationDesc

Defines the value schema to use by default for this source connection type. This will be used for the primary export of the source and as the default pre-encoding value schema for the source.

source

fn timestamp_desc(&self) -> RelationDesc

The schema of this connection’s timestamp type. This will also be the schema of the progress relation.

source

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

The id of the connection object (i.e the one obtained from running CREATE CONNECTION) in the catalog, if any.

source

fn primary_export_details(&self) -> SourceExportDetails

If this source connection can output to a primary collection, contains the source-specific details of that export, else is set to SourceExportDetails::None to indicate that this source should not export to the primary collection.

source

fn supports_read_only(&self) -> bool

Whether the source type supports read only mode.

Object Safety§

This trait is not object safe.

Implementors§