Struct mz_storage_types::connections::KafkaConnection

pub struct KafkaConnection<C: ConnectionAccess = InlinedConnection> {
    pub brokers: Vec<KafkaBroker<C>>,
    pub default_tunnel: Tunnel<C>,
    pub progress_topic: Option<String>,
    pub progress_topic_options: KafkaTopicOptions,
    pub options: BTreeMap<String, StringOrSecret>,
    pub tls: Option<KafkaTlsConfig>,
    pub sasl: Option<KafkaSaslConfig<C>>,
}

Fields

brokers: Vec<KafkaBroker<C>>

default_tunnel: Tunnel<C>

A tunnel through which to route traffic, that can be overridden for individual brokers in brokers.

progress_topic: Option<String>

progress_topic_options: KafkaTopicOptions

options: BTreeMap<String, StringOrSecret>

tls: Option<KafkaTlsConfig>

sasl: Option<KafkaSaslConfig<C>>

Implementations

impl<C: ConnectionAccess> KafkaConnection<C>

pub fn progress_topic( &self, connection_context: &ConnectionContext, connection_id: CatalogItemId, ) -> Cow<'_, str>

Returns the name of the progress topic to use for the connection.

The caller is responsible for providing the connection ID as it is not known to KafkaConnection.

fn validate_by_default(&self) -> bool

impl KafkaConnection

pub fn id_base( connection_context: &ConnectionContext, connection_id: CatalogItemId, object_id: GlobalId, ) -> String

Generates a string that can be used as the base for a configuration ID (e.g., client.id, group.id, transactional.id) for a Kafka source or sink.

pub fn enrich_client_id(&self, configs: &ConfigSet, client_id: &mut String)

Enriches the provided client_id according to any enrichment rules in the kafka_client_id_enrichment_rules configuration parameter.

pub async fn create_with_context<C, T>( &self, storage_configuration: &StorageConfiguration, context: C, extra_options: &BTreeMap<&str, String>, in_task: InTask, ) -> Result<T, ContextCreationError>

where C: ClientContext, T: FromClientConfigAndContext<TunnelingClientContext<C>>,

Creates a Kafka client for the connection.

async fn validate( &self, _id: CatalogItemId, storage_configuration: &StorageConfiguration, ) -> Result<(), Error>

Trait Implementations

impl<C: ConnectionAccess> AlterCompatible for KafkaConnection<C>

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

impl<C: ConnectionAccess + Arbitrary> Arbitrary for KafkaConnection<C>

type Parameters = (<Vec<KafkaBroker<C>> as Arbitrary>::Parameters, <Tunnel<C> as Arbitrary>::Parameters, <Option<String> as Arbitrary>::Parameters, <KafkaTopicOptions as Arbitrary>::Parameters, <BTreeMap<String, StringOrSecret> as Arbitrary>::Parameters, <Option<KafkaTlsConfig> as Arbitrary>::Parameters, <Option<KafkaSaslConfig<C>> as Arbitrary>::Parameters)

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

type Strategy = Map<(<Vec<KafkaBroker<C>> as Arbitrary>::Strategy, <Tunnel<C> as Arbitrary>::Strategy, <Option<String> as Arbitrary>::Strategy, <KafkaTopicOptions as Arbitrary>::Strategy, <BTreeMap<String, StringOrSecret> as Arbitrary>::Strategy, <Option<KafkaTlsConfig> as Arbitrary>::Strategy, <Option<KafkaSaslConfig<C>> as Arbitrary>::Strategy), fn(_: (Vec<KafkaBroker<C>>, Tunnel<C>, Option<String>, KafkaTopicOptions, BTreeMap<String, StringOrSecret>, Option<KafkaTlsConfig>, Option<KafkaSaslConfig<C>>)) -> KafkaConnection<C>>

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

fn arbitrary_with(_top: 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 KafkaConnection<C>

fn clone(&self) -> KafkaConnection<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 KafkaConnection<C>

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

Formats the value using the given formatter.

impl<'de, C> Deserialize<'de> for KafkaConnection<C>

where C: Deserialize<'de> + ConnectionAccess,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C: Hash + ConnectionAccess> Hash for KafkaConnection<C>

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<R: ConnectionResolver> IntoInlineConnection<KafkaConnection, R> for KafkaConnection<ReferencedConnection>

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

impl<C: PartialEq + ConnectionAccess> PartialEq for KafkaConnection<C>

fn eq(&self, other: &KafkaConnection<C>) -> 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 RustType<ProtoKafkaConnection> for KafkaConnection

fn into_proto(&self) -> ProtoKafkaConnection

Convert a Self into a Proto value.

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

Consume and convert a Proto back into a Self value.

fn into_proto_owned(self) -> Proto

A zero clone version of Self::into_proto that types can optionally implement, otherwise, the default implementation delegates to Self::into_proto.

impl<C> Serialize for KafkaConnection<C>

where C: Serialize + ConnectionAccess,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C: Eq + ConnectionAccess> Eq for KafkaConnection<C>

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