Skip to content

Commit 1c43924

Browse files
github-actions[bot]daniil-quix
github-actions[bot]
and
daniil-quix
authored
Update documentation (#713)
Co-authored-by: daniil-quix <[email protected]>
1 parent 63272b9 commit 1c43924

File tree

3 files changed

+72
-72
lines changed

3 files changed

+72
-72
lines changed

‎docs/api-reference/application.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
class Application()
1111
```
1212

13-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L75)
13+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L78)
1414

1515
The main Application class.
1616

@@ -85,7 +85,7 @@ def __init__(broker_address: Optional[Union[str, ConnectionConfig]] = None,
8585
processing_guarantee: ProcessingGuarantee = "at-least-once")
8686
```
8787

88-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L113)
88+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L116)
8989

9090

9191
<br>
@@ -174,7 +174,7 @@ instead of the default one.
174174
def Quix(cls, *args, **kwargs)
175175
```
176176

177-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L352)
177+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L358)
178178

179179
RAISES EXCEPTION: DEPRECATED.
180180

@@ -197,7 +197,7 @@ def topic(name: str,
197197
timestamp_extractor: Optional[TimestampExtractor] = None) -> Topic
198198
```
199199

200-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L384)
200+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L390)
201201

202202
Create a topic definition.
203203

@@ -279,7 +279,7 @@ def dataframe(topic: Optional[Topic] = None,
279279
source: Optional[BaseSource] = None) -> StreamingDataFrame
280280
```
281281

282-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L464)
282+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L470)
283283

284284
A simple helper method that generates a `StreamingDataFrame`, which is used
285285

@@ -335,7 +335,7 @@ to be used as an input topic.
335335
def stop(fail: bool = False)
336336
```
337337

338-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L520)
338+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L526)
339339

340340
Stop the internal poll loop and the message processing.
341341

@@ -362,7 +362,7 @@ to unhandled exception, and it shouldn't commit the current checkpoint.
362362
def get_producer() -> Producer
363363
```
364364

365-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L565)
365+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L571)
366366

367367
Create and return a pre-configured Producer instance.
368368
The Producer is initialized with params passed to Application.
@@ -397,7 +397,7 @@ with app.get_producer() as producer:
397397
def get_consumer(auto_commit_enable: bool = True) -> Consumer
398398
```
399399

400-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L613)
400+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L626)
401401

402402
Create and return a pre-configured Consumer instance.
403403

@@ -454,7 +454,7 @@ with app.get_consumer() as consumer:
454454
def clear_state()
455455
```
456456

457-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L663)
457+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L676)
458458

459459
Clear the state of the application.
460460

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

471-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L669)
471+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L682)
472472

473473
Add a source to the application.
474474

@@ -495,7 +495,7 @@ Note: the names of default topics are prefixed with "source__".
495495
def run(dataframe: Optional[StreamingDataFrame] = None)
496496
```
497497

498-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L700)
498+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L715)
499499

500500
Start processing data from Kafka using provided `StreamingDataFrame`
501501

@@ -531,7 +531,7 @@ app.run()
531531
def setup_topics()
532532
```
533533

534-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L824)
534+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L839)
535535

536536
Validate and create the topics
537537

@@ -543,7 +543,7 @@ Validate and create the topics
543543
class ApplicationConfig(BaseSettings)
544544
```
545545

546-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1016)
546+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1027)
547547

548548
Immutable object holding the application configuration
549549

@@ -566,7 +566,7 @@ def settings_customise_sources(
566566
) -> Tuple[PydanticBaseSettingsSource, ...]
567567
```
568568

569-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1051)
569+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1062)
570570

571571
Included to ignore reading/setting values from the environment
572572

@@ -580,7 +580,7 @@ Included to ignore reading/setting values from the environment
580580
def copy(**kwargs) -> Self
581581
```
582582

583-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1064)
583+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1075)
584584

585585
Update the application config and return a copy
586586

‎docs/api-reference/kafka.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ def poll(
229229
) -> Optional[RawConfluentKafkaMessageProto]
230230
```
231231

232-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L146)
232+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L145)
233233

234234
Consumes a single message, calls callbacks and returns events.
235235

@@ -267,7 +267,7 @@ event or callback. None or -1 is infinite. Default: None.
267267
def unsubscribe()
268268
```
269269

270-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L251)
270+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L250)
271271

272272
Remove current subscription.
273273

@@ -287,7 +287,7 @@ def store_offsets(message: Optional[Message] = None,
287287
offsets: Optional[List[TopicPartition]] = None)
288288
```
289289

290-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L260)
290+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L259)
291291

292292
Store offsets for a message or a list of offsets.
293293

@@ -320,7 +320,7 @@ def commit(message: Optional[Message] = None,
320320
asynchronous: bool = True) -> Optional[List[TopicPartition]]
321321
```
322322

323-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L291)
323+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L290)
324324

325325
Commit a message or a list of offsets.
326326

@@ -358,7 +358,7 @@ def committed(partitions: List[TopicPartition],
358358
timeout: Optional[float] = None) -> List[TopicPartition]
359359
```
360360

361-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L332)
361+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L331)
362362

363363
Retrieve committed offsets for the specified partitions.
364364

@@ -393,7 +393,7 @@ def get_watermark_offsets(partition: TopicPartition,
393393
cached: bool = False) -> Tuple[int, int]
394394
```
395395

396-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L350)
396+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L349)
397397

398398
Retrieve low and high offsets for the specified partition.
399399

@@ -432,7 +432,7 @@ def list_topics(topic: Optional[str] = None,
432432
timeout: Optional[float] = None) -> ClusterMetadata
433433
```
434434

435-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L376)
435+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L375)
436436

437437
Request metadata from the cluster.
438438

@@ -464,7 +464,7 @@ None or -1 is infinite. Default: None
464464
def memberid() -> Optional[str]
465465
```
466466

467-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L397)
467+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L396)
468468

469469
Return this client's broker-assigned group member id.
470470

@@ -492,7 +492,7 @@ def offsets_for_times(partitions: List[TopicPartition],
492492
timeout: Optional[float] = None) -> List[TopicPartition]
493493
```
494494

495-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L410)
495+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L409)
496496

497497
Look up offsets by timestamp for the specified partitions.
498498

@@ -531,7 +531,7 @@ None or -1 is infinite. Default: None
531531
def pause(partitions: List[TopicPartition])
532532
```
533533

534-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L436)
534+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L435)
535535

536536
Pause consumption for the provided list of partitions.
537537

@@ -559,7 +559,7 @@ Does NOT affect the result of `Consumer.assignment()`.
559559
def resume(partitions: List[TopicPartition])
560560
```
561561

562-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L449)
562+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L448)
563563

564564
Resume consumption for the provided list of partitions.
565565

@@ -583,7 +583,7 @@ Resume consumption for the provided list of partitions.
583583
def position(partitions: List[TopicPartition]) -> List[TopicPartition]
584584
```
585585

586-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L459)
586+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L458)
587587

588588
Retrieve current positions (offsets) for the specified partitions.
589589

@@ -616,7 +616,7 @@ the last consumed message + 1.
616616
def seek(partition: TopicPartition)
617617
```
618618

619-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L473)
619+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L472)
620620

621621
Set consume position for partition to offset.
622622

@@ -648,7 +648,7 @@ pass the offset in an `assign()` call.
648648
def assignment() -> List[TopicPartition]
649649
```
650650

651-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L490)
651+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L489)
652652

653653
Returns the current partition assignment.
654654

@@ -673,7 +673,7 @@ Returns the current partition assignment.
673673
def set_sasl_credentials(username: str, password: str)
674674
```
675675

676-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L503)
676+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L502)
677677

678678
Sets the SASL credentials used for this client.
679679

@@ -700,7 +700,7 @@ This method is applicable only to SASL PLAIN and SCRAM mechanisms.
700700
def incremental_assign(partitions: List[TopicPartition])
701701
```
702702

703-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L517)
703+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L516)
704704

705705
Assign new partitions.
706706

@@ -726,7 +726,7 @@ Any additional partitions besides the ones passed during the `Consumer`
726726
def assign(partitions: List[TopicPartition])
727727
```
728728

729-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L531)
729+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L530)
730730

731731
Set the consumer partition assignment to the provided list of `TopicPartition` and start consuming.
732732

@@ -751,7 +751,7 @@ Set the consumer partition assignment to the provided list of `TopicPartition` a
751751
def incremental_unassign(partitions: List[TopicPartition])
752752
```
753753

754-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L541)
754+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L540)
755755

756756
Revoke partitions.
757757

@@ -773,7 +773,7 @@ Can be called outside an on_revoke callback.
773773
def unassign()
774774
```
775775

776-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L551)
776+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L550)
777777

778778
Removes the current partition assignment and stops consuming.
779779

@@ -792,7 +792,7 @@ Removes the current partition assignment and stops consuming.
792792
def close()
793793
```
794794

795-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L560)
795+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L559)
796796

797797
Close down and terminate the Kafka Consumer.
798798

@@ -815,7 +815,7 @@ see `poll()` for more info.
815815
def consumer_group_metadata() -> GroupMetadata
816816
```
817817

818-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L577)
818+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/kafka/consumer.py#L576)
819819

820820
Used by the producer during consumer offset sending for an EOS transaction.
821821

0 commit comments

Comments
 (0)