Skip to content

Read me additions #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 27, 2024
Merged

Read me additions #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,24 @@

Official Python binding for TidesDB

### Install

Installing latest version from source using pip.

```py
pip install git+https://github.com/tidesdb/tidesdb-python.git

```

### Usage

#### Getting current TidesDB module version

```python
import tidesdb
print(tidesdb.__version__)
```

#### Basic operations

```py
Expand All @@ -18,7 +34,7 @@ db.create_column_family(
1024*1024*64, # Flush threshold (64MB)
12, # Max level skip list, if using hash table is irrelevant
0.24, # Probability skip list, if using hash table is irrelevant
True, # Enable compression
True, # Enable compression, is slower
TidesDBCompressionAlgo.COMPRESS_SNAPPY, # Compression algorithm can be NO_COMPRESSION, COMPRESS_SNAPPY, COMPRESS_LZ4, COMPRESS_ZSTD
True, # Enable bloom filter
TidesDBMemtableDS.SKIP_LIST # Use skip list for memtable
Expand Down Expand Up @@ -173,3 +189,12 @@ db.drop_column_family("my_column_family")
db.close()

```

#### Compacting Column Family SSTables
Compaction will cut the amount of SSTables for a column family in half by pairing, merging and removing expired and tombstoned keys for the specified column family, with a specified number of threads.

```python
db.compact_sstables("my_column_family", max_threads=4) # max threads is refering to amount of threads used for compaction process
# 4 threads means 2 sstables being paired per thread which is faster than a lone thread say.
```