Skip to content

Commit adcdb7b

Browse files
discivigourJingsongLi
authored andcommitted
[doc] Add options supported by the python API
This closes #6715
1 parent 82cac0e commit adcdb7b

File tree

3 files changed

+29
-1
lines changed

3 files changed

+29
-1
lines changed

docs/content/concepts/rest/overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,7 @@ See [REST API]({{< ref "concepts/rest/rest-api" >}}).
7070
## REST Java API
7171

7272
See [REST Java API]({{< ref "program-api/rest-api" >}}).
73+
74+
## REST Python API
75+
76+
See [REST Python API]({{< ref "program-api/python-api" >}}).

docs/content/program-api/python-api.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -634,3 +634,27 @@ Key points about shard read:
634634
| f is not in [l1, l2] | PredicateBuilder.is_not_in(f, [l1, l2]) |
635635
| lower <= f <= upper | PredicateBuilder.between(f, lower, upper) |
636636

637+
## Supported Features
638+
639+
The following shows the supported features of Python Paimon compared to Java Paimon:
640+
641+
**Catalog Level**
642+
- FileSystemCatalog
643+
- RestCatalog
644+
645+
**Table Level**
646+
- Append Tables
647+
- `bucket = -1` (unaware)
648+
- `bucket > 0` (fixed)
649+
- Primary Key Tables
650+
- only support deduplicate
651+
- `bucket = -2` (postpone)
652+
- `bucket > 0` (fixed)
653+
- read with deletion vectors enabled
654+
- Read/Write Operations
655+
- Batch read and write for append tables and primary key tables
656+
- Predicate filtering
657+
- Overwrite semantics
658+
- Incremental reading of Delta data
659+
- Reading and writing blob data
660+
- `with_shard` feature

paimon-python/pypaimon/tests/blob_table_test.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2167,7 +2167,7 @@ def test_blob_write_read_large_data_with_rolling_with_shard(self):
21672167
table = self.catalog.get_table('test_db.blob_rolling_with_shard')
21682168

21692169
# Create large blob data
2170-
large_blob_size = 3 * 1024 * 1024 #
2170+
large_blob_size = 3 * 1024 * 1024
21712171
blob_pattern = b'LARGE_BLOB_PATTERN_' + b'X' * 1024 # ~1KB pattern
21722172
pattern_size = len(blob_pattern)
21732173
repetitions = large_blob_size // pattern_size

0 commit comments

Comments
 (0)