aligned.sources.kafka.KafkaTopicConfig

class documentation

class KafkaTopicConfig(StreamDataSource): (source)

View In Hierarchy

Undocumented

Method consumer Returns a consumer that actually can load data
Method kafka_consumer Undocumented
Class Variable env_key Undocumented
Class Variable name Undocumented
Class Variable topic_name Undocumented

Inherited from StreamDataSource:

Class Method _deserialize Undocumented
Method _serialize Undocumented
def consumer(self, from_timestamp: str | None = None) -> KafkaReadableStream: (source)
overrides aligned.data_source.stream_data_source.StreamDataSource.consumer

Returns a consumer that actually can load data

E.g: ```python redis_config = RedisConfig(env_var="REDIS_URL")

consumer = redis_config.consumer() ```

Returns:
ReadableStream: A stream you can read records from
def kafka_consumer(self) -> KafkaConsumer: (source)

Undocumented

env_key: str = (source)

Undocumented

name: str = (source)
overrides aligned.data_source.stream_data_source.StreamDataSource.name

Undocumented

topic_name: str = (source)
overrides aligned.data_source.stream_data_source.StreamDataSource.topic_name

Undocumented