Skip to content

Commit 4898a91

Browse files
Update documentation (#908)
Co-authored-by: daniil-quix <[email protected]>
1 parent 9416dd4 commit 4898a91

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

docs/api-reference/quixstreams.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8956,7 +8956,7 @@ if using changelogs
89568956
class WindowedRocksDBStorePartition(RocksDBStorePartition)
89578957
```
89588958

8959-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/windowed/partition.py#L18)
8959+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/windowed/partition.py#L10)
89608960

89618961
A base class to access windowed state in RocksDB.
89628962
It represents a single RocksDB database.
@@ -8972,7 +8972,7 @@ stores the expiration index to delete expired windows.
89728972
def iter_keys(cf_name: str = "default") -> Iterator[bytes]
89738973
```
89748974

8975-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/windowed/partition.py#L36)
8975+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/windowed/partition.py#L19)
89768976

89778977
Iterate over all keys in the DB.
89788978

@@ -8994,7 +8994,7 @@ An iterable of keys
89948994
def begin() -> WindowedRocksDBPartitionTransaction
89958995
```
89968996

8997-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/windowed/partition.py#L48)
8997+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/windowed/partition.py#L31)
89988998

89998999
Start a new `WindowedRocksDBPartitionTransaction`
90009000

@@ -9554,7 +9554,7 @@ if using changelogs
95549554
class RocksDBStorePartition(StorePartition)
95559555
```
95569556

9557-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L38)
9557+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L37)
95589558

95599559
A base class to access state in RocksDB.
95609560

@@ -9583,7 +9583,7 @@ def write(cache: PartitionTransactionCache,
95839583
batch: Optional[WriteBatch] = None)
95849584
```
95859585

9586-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L92)
9586+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L87)
95879587

95889588
Write data to RocksDB
95899589

@@ -9602,7 +9602,7 @@ def get(key: bytes,
96029602
cf_name: str = "default") -> Union[bytes, Literal[Marker.UNDEFINED]]
96039603
```
96049604

9605-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L142)
9605+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L137)
96069606

96079607
Get a key from RocksDB.
96089608

@@ -9626,7 +9626,7 @@ def iter_items(lower_bound: bytes,
96269626
cf_name: str = "default") -> Iterator[tuple[bytes, bytes]]
96279627
```
96289628

9629-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L157)
9629+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L154)
96309630

96319631
Iterate over key-value pairs within a specified range in a column family.
96329632

@@ -9651,7 +9651,7 @@ An iterator yielding (key, value) tuples.
96519651
def exists(key: bytes, cf_name: str = "default") -> bool
96529652
```
96539653

9654-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L214)
9654+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L211)
96559655

96569656
Check if a key is present in the DB.
96579657

@@ -9672,7 +9672,7 @@ Check if a key is present in the DB.
96729672
def get_changelog_offset() -> Optional[int]
96739673
```
96749674

9675-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L225)
9675+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L222)
96769676

96779677
Get offset that the changelog is up-to-date with.
96789678

@@ -9688,7 +9688,7 @@ offset or `None` if there's no processed offset yet
96889688
def write_changelog_offset(offset: int)
96899689
```
96909690

9691-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L237)
9691+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L234)
96929692

96939693
Write a new changelog offset to the db.
96949694

@@ -9707,7 +9707,7 @@ the actual data.
97079707
def close()
97089708
```
97099709

9710-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L250)
9710+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L247)
97119711

97129712
Close the underlying RocksDB
97139713

@@ -9720,7 +9720,7 @@ Close the underlying RocksDB
97209720
def path() -> str
97219721
```
97229722

9723-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L263)
9723+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L260)
97249724

97259725
Absolute path to RocksDB database folder
97269726

@@ -9737,7 +9737,7 @@ file path
97379737
def destroy(cls, path: str)
97389738
```
97399739

9740-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L271)
9740+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L268)
97419741

97429742
Delete underlying RocksDB database
97439743

@@ -9755,7 +9755,7 @@ The database must be closed first.
97559755
def get_column_family_handle(cf_name: str) -> ColumnFamily
97569756
```
97579757

9758-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L281)
9758+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L278)
97599759

97609760
Get a column family handle to pass to it WriteBatch.
97619761

@@ -9770,15 +9770,15 @@ repeatedly.
97709770

97719771
instance of `rocksdict.ColumnFamily`
97729772

9773-
<a id="quixstreams.state.rocksdb.partition.RocksDBStorePartition.get_column_family"></a>
9773+
<a id="quixstreams.state.rocksdb.partition.RocksDBStorePartition.get_or_create_column_family"></a>
97749774

9775-
#### RocksDBStorePartition.get\_column\_family
9775+
#### RocksDBStorePartition.get\_or\_create\_column\_family
97769776

97779777
```python
9778-
def get_column_family(cf_name: str) -> Rdict
9778+
def get_or_create_column_family(cf_name: str) -> Rdict
97799779
```
97809780

9781-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L302)
9781+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/partition.py#L293)
97829782

97839783
Get a column family instance.
97849784

@@ -9960,7 +9960,7 @@ This class is responsible for managing the state of one partition and creating
99609960
class TimestampedStore(RocksDBStore)
99619961
```
99629962

9963-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/timestamped.py#L277)
9963+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/rocksdb/timestamped.py#L275)
99649964

99659965
A RocksDB-backed state store implementation that manages key-value pairs
99669966
associated with timestamps.
@@ -10025,7 +10025,7 @@ if using changelogs topics.
1002510025
class MemoryStorePartition(StorePartition)
1002610026
```
1002710027

10028-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/memory/partition.py#L36)
10028+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/memory/partition.py#L35)
1002910029

1003010030
Class to access in-memory state.
1003110031

@@ -10044,7 +10044,7 @@ def write(cache: PartitionTransactionCache,
1004410044
changelog_offset: Optional[int]) -> None
1004510045
```
1004610046

10047-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/memory/partition.py#L75)
10047+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/memory/partition.py#L74)
1004810048

1004910049
Write data to the state
1005010050

@@ -10061,7 +10061,7 @@ Write data to the state
1006110061
def get_changelog_offset() -> Optional[int]
1006210062
```
1006310063

10064-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/memory/partition.py#L112)
10064+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/memory/partition.py#L108)
1006510065

1006610066
Get offset that the changelog is up-to-date with.
1006710067

@@ -10077,7 +10077,7 @@ offset or `None` if there's no processed offset yet
1007710077
def write_changelog_offset(offset: int)
1007810078
```
1007910079

10080-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/memory/partition.py#L119)
10080+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/memory/partition.py#L115)
1008110081

1008210082
Write a new changelog offset to the db.
1008310083

@@ -10098,7 +10098,7 @@ def get(key: bytes,
1009810098
cf_name: str = "default") -> Union[bytes, Literal[Marker.UNDEFINED]]
1009910099
```
1010010100

10101-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/memory/partition.py#L131)
10101+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/memory/partition.py#L127)
1010210102

1010310103
Get a key from the store
1010410104

@@ -10120,7 +10120,7 @@ a value if the key is present in the store. Otherwise, `default`
1012010120
def exists(key: bytes, cf_name: str = "default") -> bool
1012110121
```
1012210122

10123-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/memory/partition.py#L144)
10123+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/state/memory/partition.py#L140)
1012410124

1012510125
Check if a key is present in the store.
1012610126

0 commit comments

Comments
 (0)