Skip to content

Commit 3f2ba04

Browse files
authored
Chore/docs updates (#577)
* Update wording about multiple topics processing * Mention connectors APIs in README
1 parent 4084bf4 commit 3f2ba04

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@
1313
Quix Streams is a cloud-native library for processing data in Kafka using pure Python. It’s designed to give you the power of a distributed system in a lightweight library by combining Kafka's low-level scalability and resiliency features with an easy-to-use Python interface (to ease newcomers to stream processing).
1414

1515
It has the following benefits:
16+
1617
- Streaming DataFrame API (similar to pandas DataFrame) for tabular data transformations.
1718
- Custom stateful operations via a state object.
1819
- Custom reducing and aggregating over tumbling and hopping time windows.
1920
- Exactly-once processing semantics via Kafka transactions.
20-
- Pure Python with no need for a server-side engine.
21+
- Sources and Sinks APIs to connect external data to Kafka.
22+
- Pure Python with no need for a server-side engine.
2123

2224
Use Quix Streams to build simple Kafka producer/consumer applications or leverage stream processing to build complex event-driven systems, real-time data pipelines and AI/ML products.
2325

docs/consuming-multiple-topics.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,12 @@ As a reminder, state is ultimately tied to a given topic (and thus its `SDF`).
8484

8585
### Multiple Topics: NOT parallel
8686

87-
Though multiple `SDF`s are involved with multiple topics, they do not run in parallel:
88-
it simply subscribes the `Application`s underlying consumer to all the `SDF`'s topics.
87+
Though multiple `StreamingDataFrame`s are involved with multiple topics, they do not run _in parallel_:
8988

90-
So, more topics being processed will directly affect the processing time of each given
91-
topic.
89+
- The `Application` instance always has a single consumer, which reads messages one-by-one from multiple topics.
90+
- After the message is consumed from the topic, it is routed to the corresponding `StreamingDataFrame` responsible for the processing of this topic.
91+
92+
Processing multiple topics directly affects the throughput for each topic because more messages will be processed using the same resources.
9293

9394

9495
## Upcoming Features

0 commit comments

Comments
 (0)