@@ -12294,7 +12294,7 @@ Default: None (if not run on Quix Cloud)
12294
12294
>***NOTE:*** the environment variable is set for you in the Quix Cloud
12295
12295
- `consumer_group`: Kafka consumer group.
12296
12296
Passed as `group.id` to `confluent_kafka.Consumer`.
12297
- Linked Environment Variable: `Quix__Consumer__Group `.
12297
+ Linked Environment Variable: `Quix__Consumer_Group `.
12298
12298
Default - "quixstreams-default" (set during init)
12299
12299
>***NOTE:*** Quix Applications will prefix it with the Quix workspace id.
12300
12300
- `commit_interval`: How often to commit the processed messages in seconds.
@@ -12314,6 +12314,7 @@ will be passed to `confluent_kafka.Consumer` as is.
12314
12314
- `producer_extra_config`: A dictionary with additional options that
12315
12315
will be passed to `confluent_kafka.Producer` as is.
12316
12316
- `state_dir`: path to the application state directory.
12317
+ Linked Environment Variable: `Quix__State__Dir`.
12317
12318
Default - `"state"`.
12318
12319
- `rocksdb_options`: RocksDB options.
12319
12320
If `None`, the default options will be used.
@@ -12360,7 +12361,7 @@ instead of the default one.
12360
12361
def Quix(cls, *args, **kwargs)
12361
12362
```
12362
12363
12363
- [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L375 )
12364
+ [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L378 )
12364
12365
12365
12366
RAISES EXCEPTION: DEPRECATED.
12366
12367
@@ -12381,7 +12382,7 @@ def topic(name: str,
12381
12382
timestamp_extractor: Optional[TimestampExtractor] = None) -> Topic
12382
12383
```
12383
12384
12384
- [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L407 )
12385
+ [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L410 )
12385
12386
12386
12387
Create a topic definition.
12387
12388
@@ -12453,7 +12454,7 @@ def dataframe(topic: Optional[Topic] = None,
12453
12454
source: Optional[BaseSource] = None) -> StreamingDataFrame
12454
12455
```
12455
12456
12456
- [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L487 )
12457
+ [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L490 )
12457
12458
12458
12459
A simple helper method that generates a `StreamingDataFrame`, which is used
12459
12460
@@ -12501,7 +12502,7 @@ to be used as an input topic.
12501
12502
def stop(fail: bool = False)
12502
12503
```
12503
12504
12504
- [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L543 )
12505
+ [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L546 )
12505
12506
12506
12507
Stop the internal poll loop and the message processing.
12507
12508
@@ -12524,7 +12525,7 @@ to unhandled exception, and it shouldn't commit the current checkpoint.
12524
12525
def get_producer() -> Producer
12525
12526
```
12526
12527
12527
- [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L588 )
12528
+ [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L591 )
12528
12529
12529
12530
Create and return a pre-configured Producer instance.
12530
12531
The Producer is initialized with params passed to Application.
@@ -12555,7 +12556,7 @@ with app.get_producer() as producer:
12555
12556
def get_consumer(auto_commit_enable: bool = True) -> Consumer
12556
12557
```
12557
12558
12558
- [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L642 )
12559
+ [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L645 )
12559
12560
12560
12561
Create and return a pre-configured Consumer instance.
12561
12562
@@ -12606,7 +12607,7 @@ Default - True
12606
12607
def clear_state()
12607
12608
```
12608
12609
12609
- [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L691 )
12610
+ [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L694 )
12610
12611
12611
12612
Clear the state of the application.
12612
12613
@@ -12618,7 +12619,7 @@ Clear the state of the application.
12618
12619
def add_source(source: BaseSource, topic: Optional[Topic] = None) -> Topic
12619
12620
```
12620
12621
12621
- [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L697 )
12622
+ [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L700 )
12622
12623
12623
12624
Add a source to the application.
12624
12625
@@ -12643,7 +12644,7 @@ def run(dataframe: Optional[StreamingDataFrame] = None,
12643
12644
count: int = 0)
12644
12645
```
12645
12646
12646
- [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L730 )
12647
+ [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L733 )
12647
12648
12648
12649
Start processing data from Kafka using provided `StreamingDataFrame`
12649
12650
@@ -12706,7 +12707,7 @@ Default = 0 (infinite)
12706
12707
class ApplicationConfig(BaseSettings)
12707
12708
```
12708
12709
12709
- [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1071 )
12710
+ [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1074 )
12710
12711
12711
12712
Immutable object holding the application configuration
12712
12713
@@ -12727,7 +12728,7 @@ def settings_customise_sources(
12727
12728
) -> Tuple[PydanticBaseSettingsSource, ...]
12728
12729
```
12729
12730
12730
- [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1106 )
12731
+ [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1109 )
12731
12732
12732
12733
Included to ignore reading/setting values from the environment
12733
12734
@@ -12739,7 +12740,7 @@ Included to ignore reading/setting values from the environment
12739
12740
def copy(**kwargs) -> "ApplicationConfig"
12740
12741
```
12741
12742
12742
- [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1119 )
12743
+ [[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1122 )
12743
12744
12744
12745
Update the application config and return a copy
12745
12746
0 commit comments