Skip to content

chore: update README and api docs #296

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
lxy-9602 merged 2 commits into from
May 21, 2026
+20 −3
Merged

chore: update README and api docs #296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1492b9
update examples in README.md
zjw1111 May 21, 2026
735a427
chore: update api docs
zjw1111 May 21, 2026
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ The writing is divided into two stages:
// ...
RecordBatchBuilder batch_builder(&arrow_array);
batch_builder.SetPartition({{"col1", "20240813"}, {"col2", "23"}}).SetBucket(1);
PAIMON_ASSIGN_OR_RAISE(std::shared_ptr<RecordBatch> batch, batch_builder.Finish());
PAIMON_RETURN_NOT_OK(file_store_write->Write(batch));
PAIMON_ASSIGN_OR_RAISE(std::unique_ptr<RecordBatch> batch, batch_builder.Finish());
PAIMON_RETURN_NOT_OK(file_store_write->Write(std::move(batch)));
Comment thread
zjw1111 marked this conversation as resolved.
PAIMON_ASSIGN_OR_RAISE(std::vector<std::shared_ptr<CommitMessage>> commit_messages,
file_store_write->PrepareCommit());

Expand Down Expand Up @@ -99,7 +99,7 @@ The reading is divided into two stages:
TableScan::Create(std::move(scan_context)));
PAIMON_ASSIGN_OR_RAISE(std::shared_ptr<Plan> plan, table_scan->CreatePlan());

ReadContextBuilder read_context_builder(table_path, /*schema_id=*/0);
ReadContextBuilder read_context_builder(table_path);
Comment thread
zjw1111 marked this conversation as resolved.
PAIMON_ASSIGN_OR_RAISE(std::unique_ptr<ReadContext> read_context,
read_context_builder.SetReadSchema({"f0", "f1"})
.SetPredicate(predicate)
Expand Down
4 changes: 4 additions & 0 deletions docs/source/api/commit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,7 @@ Interface
.. doxygenclass:: paimon::CommitContext
:members:
:undoc-members:

.. doxygenclass:: paimon::CommitMessage
:members:
:undoc-members:
4 changes: 4 additions & 0 deletions docs/source/api/read.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,7 @@ Interface
.. doxygenclass:: paimon::ReadContext
:members:
:undoc-members:

.. doxygenclass:: paimon::BatchReader
:members:
:undoc-members:
9 changes: 9 additions & 0 deletions docs/source/api/scan.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ Interface
.. doxygenclass:: paimon::Plan
:members:
:undoc-members:

.. doxygenclass:: paimon::Split
:members:
:undoc-members:

.. doxygenclass:: paimon::DataSplit
:members:
:undoc-members:

.. doxygenclass:: paimon::ScanFilter
:members:
:undoc-members:
Loading