10
10
class Application ()
11
11
```
12
12
13
- [[VIEW SOURCE ]](https :// github .com / quixio / quix - streams / blob / main / quixstreams / app .py # L57 )
13
+ [[VIEW SOURCE ]](https :// github .com / quixio / quix - streams / blob / main / quixstreams / app .py # L61 )
14
14
15
15
The main Application class .
16
16
@@ -84,7 +84,7 @@ def __init__(broker_address: Optional[Union[str, ConnectionConfig]] = None,
84
84
processing_guarantee: ProcessingGuarantee = " at-least-once" )
85
85
```
86
86
87
- [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L95 )
87
+ [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L99 )
88
88
89
89
90
90
< br>
@@ -125,7 +125,7 @@ will be passed to `confluent_kafka.Consumer` as is.
125
125
- `producer_extra_config` : A dictionary with additional options that
126
126
will be passed to `confluent_kafka.Producer` as is .
127
127
- `state_dir` : path to the application state directory.
128
- Default - `" . state" ` .
128
+ Default - `" state" ` .
129
129
- `rocksdb_options` : RocksDB options.
130
130
If `None ` , the default options will be used.
131
131
- `consumer_poll_timeout` : timeout for `RowConsumer.poll()` . Default - `1.0 ` s
@@ -196,7 +196,7 @@ def Quix(
196
196
) -> Self
197
197
```
198
198
199
- [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L347 )
199
+ [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L353 )
200
200
201
201
> *** NOTE :*** DEPRECATED : use Application with `quix_sdk_token` argument instead.
202
202
@@ -307,7 +307,7 @@ def topic(name: str,
307
307
timestamp_extractor: Optional[TimestampExtractor] = None ) -> Topic
308
308
```
309
309
310
- [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L488 )
310
+ [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L494 )
311
311
312
312
Create a topic definition.
313
313
@@ -388,7 +388,7 @@ topic = app.topic("input-topic", timestamp_extractor=custom_ts_extractor)
388
388
def dataframe(topic: Topic) -> StreamingDataFrame
389
389
```
390
390
391
- [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L568 )
391
+ [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L574 )
392
392
393
393
A simple helper method that generates a `StreamingDataFrame` , which is used
394
394
@@ -438,7 +438,7 @@ to be used as an input topic.
438
438
def stop(fail: bool = False )
439
439
```
440
440
441
- [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L607 )
441
+ [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L613 )
442
442
443
443
Stop the internal poll loop and the message processing.
444
444
@@ -465,7 +465,7 @@ to unhandled exception, and it shouldn't commit the current checkpoint.
465
465
def get_producer() -> Producer
466
466
```
467
467
468
- [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L630 )
468
+ [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L636 )
469
469
470
470
Create and return a pre- configured Producer instance.
471
471
The Producer is initialized with params passed to Application.
@@ -482,7 +482,7 @@ instance each time, which is not optimized for repeated use in a streaming pipel
482
482
```python
483
483
from quixstreams import Application
484
484
485
- app = Application.Quix (... )
485
+ app = Application(... )
486
486
topic = app.topic(" input" )
487
487
488
488
with app.get_producer() as producer:
@@ -500,7 +500,7 @@ with app.get_producer() as producer:
500
500
def get_consumer(auto_commit_enable: bool = True ) -> Consumer
501
501
```
502
502
503
- [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L660 )
503
+ [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L666 )
504
504
505
505
Create and return a pre- configured Consumer instance.
506
506
The Consumer is initialized with params passed to Application.
@@ -525,7 +525,7 @@ the consumer config when creating the app.
525
525
```python
526
526
from quixstreams import Application
527
527
528
- app = Application.Quix (... )
528
+ app = Application(... )
529
529
topic = app.topic(" input" )
530
530
531
531
with app.get_consumer() as consumer:
@@ -549,7 +549,7 @@ with app.get_consumer() as consumer:
549
549
def clear_state()
550
550
```
551
551
552
- [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L707 )
552
+ [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L713 )
553
553
554
554
Clear the state of the application.
555
555
@@ -563,7 +563,7 @@ Clear the state of the application.
563
563
def run(dataframe: StreamingDataFrame)
564
564
```
565
565
566
- [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L713 )
566
+ [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L719 )
567
567
568
568
Start processing data from Kafka using provided `StreamingDataFrame`
569
569
@@ -595,3 +595,52 @@ app.run(dataframe=df)
595
595
596
596
- `dataframe` : instance of `StreamingDataFrame`
597
597
598
+ < a id = " quixstreams.app.ApplicationConfig" >< / a>
599
+
600
+ # ## ApplicationConfig
601
+
602
+ ```python
603
+ class ApplicationConfig(BaseSettings)
604
+ ```
605
+
606
+ [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L975)
607
+
608
+ Immutable object holding the application configuration
609
+
610
+ For details see :class :`quixstreams.Application`
611
+
612
+ < a id = " quixstreams.app.ApplicationConfig.settings_customise_sources" >< / a>
613
+
614
+ < br>< br>
615
+
616
+ # ### ApplicationConfig.settings\_customise\_sources
617
+
618
+ ```python
619
+ @ classmethod
620
+ def settings_customise_sources(
621
+ cls , settings_cls: Type[BaseSettings],
622
+ init_settings: PydanticBaseSettingsSource,
623
+ env_settings: PydanticBaseSettingsSource,
624
+ dotenv_settings: PydanticBaseSettingsSource,
625
+ file_secret_settings: PydanticBaseSettingsSource
626
+ ) -> Tuple[PydanticBaseSettingsSource, ... ]
627
+ ```
628
+
629
+ [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L1009)
630
+
631
+ Included to ignore reading/ setting values from the environment
632
+
633
+ < a id = " quixstreams.app.ApplicationConfig.copy" >< / a>
634
+
635
+ < br>< br>
636
+
637
+ # ### ApplicationConfig.copy
638
+
639
+ ```python
640
+ def copy(** kwargs) -> Self
641
+ ```
642
+
643
+ [[VIEW SOURCE ]](https:// github.com/ quixio/ quix- streams/ blob/ main/ quixstreams/ app.py# L1022)
644
+
645
+ Update the application config and return a copy
646
+
0 commit comments