Struct mz_storage_client::types::sources::KafkaSourceConnection

pub struct KafkaSourceConnection<C: ConnectionAccess = InlinedConnection> {
    pub connection: C::Kafka,
    pub connection_id: GlobalId,
    pub topic: String,
    pub start_offsets: BTreeMap<i32, i64>,
    pub group_id_prefix: Option<String>,
    pub environment_id: String,
    pub include_timestamp: Option<IncludedColumnPos>,
    pub include_partition: Option<IncludedColumnPos>,
    pub include_topic: Option<IncludedColumnPos>,
    pub include_offset: Option<IncludedColumnPos>,
    pub include_headers: Option<IncludedColumnPos>,
}

Fields

connection: C::Kafka

connection_id: GlobalId

topic: String

start_offsets: BTreeMap<i32, i64>

group_id_prefix: Option<String>

environment_id: String

include_timestamp: Option<IncludedColumnPos>

If present, include the timestamp as an output column of the source with the given name

include_partition: Option<IncludedColumnPos>

If present, include the partition as an output column of the source with the given name.

include_topic: Option<IncludedColumnPos>

If present, include the topic as an output column of the source with the given name.

include_offset: Option<IncludedColumnPos>

If present, include the offset as an output column of the source with the given name.

include_headers: Option<IncludedColumnPos>

Implementations

impl<C: ConnectionAccess> KafkaSourceConnection<C>

pub fn group_id(&self, source_id: GlobalId) -> String

Returns the id for the consumer group the configured source will use.

This has a weird API because KafkaSourceConnection’s are created before id allocation, so we can’t store the id in the object itself.

Trait Implementations

impl<C: ConnectionAccess> Arbitrary for KafkaSourceConnection<C>where <<C as ConnectionAccess>::Kafka as Arbitrary>::Strategy: 'static,

type Strategy = BoxedStrategy<KafkaSourceConnection<C>>

The type of Strategy used to generate values of type Self.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

fn arbitrary_with(_: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl<C: Clone + ConnectionAccess> Clone for KafkaSourceConnection<C>where C::Kafka: Clone,

fn clone(&self) -> KafkaSourceConnection<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + ConnectionAccess> Debug for KafkaSourceConnection<C>where C::Kafka: Debug,

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

Formats the value using the given formatter.

impl<'de, C: ConnectionAccess> Deserialize<'de> for KafkaSourceConnection<C>where C::Kafka: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C: ConnectionAccess> From<KafkaSourceConnection<C>> for GenericSourceConnection<C>

fn from(conn: KafkaSourceConnection<C>) -> Self

Converts to this type from the input type.

impl<R: ConnectionResolver> IntoInlineConnection<KafkaSourceConnection<InlinedConnection>, R> for KafkaSourceConnection<ReferencedConnection>

fn into_inline_connection(self, r: R) -> KafkaSourceConnection

impl<C: PartialEq + ConnectionAccess> PartialEq<KafkaSourceConnection<C>> for KafkaSourceConnection<C>where C::Kafka: PartialEq,

fn eq(&self, other: &KafkaSourceConnection<C>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RustType<ProtoKafkaSourceConnection> for KafkaSourceConnection<InlinedConnection>

fn into_proto(&self) -> ProtoKafkaSourceConnection

Convert a Self into a Proto value.

fn from_proto( proto: ProtoKafkaSourceConnection ) -> Result<Self, TryFromProtoError>

Consume and convert a Proto back into a Self value.

impl<C: ConnectionAccess> Serialize for KafkaSourceConnection<C>where C::Kafka: Serialize,

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

Serialize this value into the given Serde serializer.

impl<C: ConnectionAccess> SourceConnection for KafkaSourceConnection<C>

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

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

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

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

fn timestamp_desc(&self) -> RelationDesc

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

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

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

fn metadata_columns(&self) -> Vec<(&str, ColumnType)>

Returns available metadata columns that this connection offers in (name, type) pairs in the order specified by the user.

fn metadata_column_types(&self) -> Vec<IncludedColumnSource>

The available metadata columns in the order specified by the user. This only identifies the kinds of columns that this source offers without any further information.

fn alter_compatible( &self, id: GlobalId, other: &Self ) -> Result<(), StorageError>

Determines if self is compatible with another SourceConnection, in such a way that it is possible to turn self into other through a valid series of transformations (e.g. no transformation or ALTER SOURCE).

impl<C: Eq + ConnectionAccess> Eq for KafkaSourceConnection<C>where C::Kafka: Eq,

impl<C: ConnectionAccess> StructuralEq for KafkaSourceConnection<C>

impl<C: ConnectionAccess> StructuralPartialEq for KafkaSourceConnection<C>