Skip to content

Commit 84a8719

Browse files
Update documentation (#846)
Co-authored-by: daniil-quix <133032822+daniil-quix@users.noreply.github.com>
1 parent f838575 commit 84a8719

File tree

2 files changed

+28
-26
lines changed

2 files changed

+28
-26
lines changed

docs/api-reference/application.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Default: None (if not run on Quix Cloud)
106106
>***NOTE:*** the environment variable is set for you in the Quix Cloud
107107
- `consumer_group`: Kafka consumer group.
108108
Passed as `group.id` to `confluent_kafka.Consumer`.
109-
Linked Environment Variable: `Quix__Consumer__Group`.
109+
Linked Environment Variable: `Quix__Consumer_Group`.
110110
Default - "quixstreams-default" (set during init)
111111
>***NOTE:*** Quix Applications will prefix it with the Quix workspace id.
112112
- `commit_interval`: How often to commit the processed messages in seconds.
@@ -126,6 +126,7 @@ will be passed to `confluent_kafka.Consumer` as is.
126126
- `producer_extra_config`: A dictionary with additional options that
127127
will be passed to `confluent_kafka.Producer` as is.
128128
- `state_dir`: path to the application state directory.
129+
Linked Environment Variable: `Quix__State__Dir`.
129130
Default - `"state"`.
130131
- `rocksdb_options`: RocksDB options.
131132
If `None`, the default options will be used.
@@ -174,7 +175,7 @@ instead of the default one.
174175
def Quix(cls, *args, **kwargs)
175176
```
176177

177-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L375)
178+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L378)
178179

179180
RAISES EXCEPTION: DEPRECATED.
180181

@@ -197,7 +198,7 @@ def topic(name: str,
197198
timestamp_extractor: Optional[TimestampExtractor] = None) -> Topic
198199
```
199200

200-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L407)
201+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L410)
201202

202203
Create a topic definition.
203204

@@ -279,7 +280,7 @@ def dataframe(topic: Optional[Topic] = None,
279280
source: Optional[BaseSource] = None) -> StreamingDataFrame
280281
```
281282

282-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L487)
283+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L490)
283284

284285
A simple helper method that generates a `StreamingDataFrame`, which is used
285286

@@ -335,7 +336,7 @@ to be used as an input topic.
335336
def stop(fail: bool = False)
336337
```
337338

338-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L543)
339+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L546)
339340

340341
Stop the internal poll loop and the message processing.
341342

@@ -362,7 +363,7 @@ to unhandled exception, and it shouldn't commit the current checkpoint.
362363
def get_producer() -> Producer
363364
```
364365

365-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L588)
366+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L591)
366367

367368
Create and return a pre-configured Producer instance.
368369
The Producer is initialized with params passed to Application.
@@ -397,7 +398,7 @@ with app.get_producer() as producer:
397398
def get_consumer(auto_commit_enable: bool = True) -> Consumer
398399
```
399400

400-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L642)
401+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L645)
401402

402403
Create and return a pre-configured Consumer instance.
403404

@@ -454,7 +455,7 @@ with app.get_consumer() as consumer:
454455
def clear_state()
455456
```
456457

457-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L691)
458+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L694)
458459

459460
Clear the state of the application.
460461

@@ -468,7 +469,7 @@ Clear the state of the application.
468469
def add_source(source: BaseSource, topic: Optional[Topic] = None) -> Topic
469470
```
470471

471-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L697)
472+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L700)
472473

473474
Add a source to the application.
474475

@@ -497,7 +498,7 @@ def run(dataframe: Optional[StreamingDataFrame] = None,
497498
count: int = 0)
498499
```
499500

500-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L730)
501+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L733)
501502

502503
Start processing data from Kafka using provided `StreamingDataFrame`
503504

@@ -564,7 +565,7 @@ Default = 0 (infinite)
564565
class ApplicationConfig(BaseSettings)
565566
```
566567

567-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1071)
568+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1074)
568569

569570
Immutable object holding the application configuration
570571

@@ -587,7 +588,7 @@ def settings_customise_sources(
587588
) -> Tuple[PydanticBaseSettingsSource, ...]
588589
```
589590

590-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1106)
591+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1109)
591592

592593
Included to ignore reading/setting values from the environment
593594

@@ -601,7 +602,7 @@ Included to ignore reading/setting values from the environment
601602
def copy(**kwargs) -> "ApplicationConfig"
602603
```
603604

604-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1119)
605+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1122)
605606

606607
Update the application config and return a copy
607608

docs/api-reference/quixstreams.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12294,7 +12294,7 @@ Default: None (if not run on Quix Cloud)
1229412294
>***NOTE:*** the environment variable is set for you in the Quix Cloud
1229512295
- `consumer_group`: Kafka consumer group.
1229612296
Passed as `group.id` to `confluent_kafka.Consumer`.
12297-
Linked Environment Variable: `Quix__Consumer__Group`.
12297+
Linked Environment Variable: `Quix__Consumer_Group`.
1229812298
Default - "quixstreams-default" (set during init)
1229912299
>***NOTE:*** Quix Applications will prefix it with the Quix workspace id.
1230012300
- `commit_interval`: How often to commit the processed messages in seconds.
@@ -12314,6 +12314,7 @@ will be passed to `confluent_kafka.Consumer` as is.
1231412314
- `producer_extra_config`: A dictionary with additional options that
1231512315
will be passed to `confluent_kafka.Producer` as is.
1231612316
- `state_dir`: path to the application state directory.
12317+
Linked Environment Variable: `Quix__State__Dir`.
1231712318
Default - `"state"`.
1231812319
- `rocksdb_options`: RocksDB options.
1231912320
If `None`, the default options will be used.
@@ -12360,7 +12361,7 @@ instead of the default one.
1236012361
def Quix(cls, *args, **kwargs)
1236112362
```
1236212363

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)
1236412365

1236512366
RAISES EXCEPTION: DEPRECATED.
1236612367

@@ -12381,7 +12382,7 @@ def topic(name: str,
1238112382
timestamp_extractor: Optional[TimestampExtractor] = None) -> Topic
1238212383
```
1238312384

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)
1238512386

1238612387
Create a topic definition.
1238712388

@@ -12453,7 +12454,7 @@ def dataframe(topic: Optional[Topic] = None,
1245312454
source: Optional[BaseSource] = None) -> StreamingDataFrame
1245412455
```
1245512456

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)
1245712458

1245812459
A simple helper method that generates a `StreamingDataFrame`, which is used
1245912460

@@ -12501,7 +12502,7 @@ to be used as an input topic.
1250112502
def stop(fail: bool = False)
1250212503
```
1250312504

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)
1250512506

1250612507
Stop the internal poll loop and the message processing.
1250712508

@@ -12524,7 +12525,7 @@ to unhandled exception, and it shouldn't commit the current checkpoint.
1252412525
def get_producer() -> Producer
1252512526
```
1252612527

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)
1252812529

1252912530
Create and return a pre-configured Producer instance.
1253012531
The Producer is initialized with params passed to Application.
@@ -12555,7 +12556,7 @@ with app.get_producer() as producer:
1255512556
def get_consumer(auto_commit_enable: bool = True) -> Consumer
1255612557
```
1255712558

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)
1255912560

1256012561
Create and return a pre-configured Consumer instance.
1256112562

@@ -12606,7 +12607,7 @@ Default - True
1260612607
def clear_state()
1260712608
```
1260812609

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)
1261012611

1261112612
Clear the state of the application.
1261212613

@@ -12618,7 +12619,7 @@ Clear the state of the application.
1261812619
def add_source(source: BaseSource, topic: Optional[Topic] = None) -> Topic
1261912620
```
1262012621

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)
1262212623

1262312624
Add a source to the application.
1262412625

@@ -12643,7 +12644,7 @@ def run(dataframe: Optional[StreamingDataFrame] = None,
1264312644
count: int = 0)
1264412645
```
1264512646

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)
1264712648

1264812649
Start processing data from Kafka using provided `StreamingDataFrame`
1264912650

@@ -12706,7 +12707,7 @@ Default = 0 (infinite)
1270612707
class ApplicationConfig(BaseSettings)
1270712708
```
1270812709

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)
1271012711

1271112712
Immutable object holding the application configuration
1271212713

@@ -12727,7 +12728,7 @@ def settings_customise_sources(
1272712728
) -> Tuple[PydanticBaseSettingsSource, ...]
1272812729
```
1272912730

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)
1273112732

1273212733
Included to ignore reading/setting values from the environment
1273312734

@@ -12739,7 +12740,7 @@ Included to ignore reading/setting values from the environment
1273912740
def copy(**kwargs) -> "ApplicationConfig"
1274012741
```
1274112742

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)
1274312744

1274412745
Update the application config and return a copy
1274512746

0 commit comments

Comments
 (0)