Skip to content

Commit a83a792

Browse files
Update documentation (#573)
Co-authored-by: daniil-quix <133032822+daniil-quix@users.noreply.github.com>
1 parent f255256 commit a83a792

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

docs/api-reference/quixstreams.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6343,7 +6343,7 @@ Flush the recovery update to the storage.
63436343
class StateStoreManager()
63446344
```
63456345

6346-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L24)
6346+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L27)
63476347

63486348
Class for managing state stores and partitions.
63496349

@@ -6361,7 +6361,7 @@ StateStoreManager is responsible for:
63616361
def stores() -> Dict[str, Dict[str, Store]]
63626362
```
63636363

6364-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L62)
6364+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L67)
63656365

63666366
Map of registered state stores
63676367

@@ -6378,7 +6378,7 @@ dict in format {topic: {store_name: store}}
63786378
def recovery_required() -> bool
63796379
```
63806380

6381-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L70)
6381+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L75)
63826382

63836383
Whether recovery needs to be done.
63846384

@@ -6391,7 +6391,7 @@ Whether recovery needs to be done.
63916391
def using_changelogs() -> bool
63926392
```
63936393

6394-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L79)
6394+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L84)
63956395

63966396
Whether the StateStoreManager is using changelog topics
63976397

@@ -6407,7 +6407,7 @@ using changelogs, as bool
64076407
def do_recovery()
64086408
```
64096409

6410-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L87)
6410+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L96)
64116411

64126412
Perform a state recovery, if necessary.
64136413

@@ -6419,7 +6419,7 @@ Perform a state recovery, if necessary.
64196419
def stop_recovery()
64206420
```
64216421

6422-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L93)
6422+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L102)
64236423

64246424
Stop recovery (called during app shutdown).
64256425

@@ -6431,7 +6431,7 @@ Stop recovery (called during app shutdown).
64316431
def get_store(topic: str, store_name: str = DEFAULT_STATE_STORE_NAME) -> Store
64326432
```
64336433

6434-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L99)
6434+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L108)
64356435

64366436
Get a store for given name and topic
64376437

@@ -6450,10 +6450,11 @@ instance of `Store`
64506450

64516451
```python
64526452
def register_store(topic_name: str,
6453-
store_name: str = DEFAULT_STATE_STORE_NAME)
6453+
store_name: str = DEFAULT_STATE_STORE_NAME,
6454+
store_type: Optional[StoreTypes] = None)
64546455
```
64556456

6456-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L132)
6457+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L141)
64576458

64586459
Register a state store to be managed by StateStoreManager.
64596460

@@ -6466,6 +6467,8 @@ Each store can be registered only once for each topic.
64666467

64676468
- `topic_name`: topic name
64686469
- `store_name`: store name
6470+
- `store_type`: the storage type used for this store.
6471+
Default to StateStoreManager `default_store_type`
64696472

64706473
<a id="quixstreams.state.manager.StateStoreManager.register_windowed_store"></a>
64716474

@@ -6475,7 +6478,7 @@ Each store can be registered only once for each topic.
64756478
def register_windowed_store(topic_name: str, store_name: str)
64766479
```
64776480

6478-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L157)
6481+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L177)
64796482

64806483
Register a windowed state store to be managed by StateStoreManager.
64816484

@@ -6497,7 +6500,7 @@ Each window store can be registered only once for each topic.
64976500
def clear_stores()
64986501
```
64996502

6500-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L183)
6503+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L203)
65016504

65026505
Delete all state stores managed by StateStoreManager.
65036506

@@ -6510,7 +6513,7 @@ def on_partition_assign(topic: str, partition: int,
65106513
committed_offset: int) -> List[StorePartition]
65116514
```
65126515

6513-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L198)
6516+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L218)
65146517

65156518
Assign store partitions for each registered store for the given `TopicPartition`
65166519

@@ -6534,7 +6537,7 @@ list of assigned `StorePartition`
65346537
def on_partition_revoke(topic: str, partition: int)
65356538
```
65366539

6537-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L224)
6540+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L244)
65386541

65396542
Revoke store partitions for each registered store for the given `TopicPartition`
65406543

@@ -6551,7 +6554,7 @@ Revoke store partitions for each registered store for the given `TopicPartition`
65516554
def init()
65526555
```
65536556

6554-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L237)
6557+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L257)
65556558

65566559
Initialize `StateStoreManager` and create a store directory
65576560

@@ -6564,7 +6567,7 @@ Initialize `StateStoreManager` and create a store directory
65646567
def close()
65656568
```
65666569

6567-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L244)
6570+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/manager.py#L264)
65686571

65696572
Close all registered stores
65706573

0 commit comments

Comments
 (0)