docs: describe REST catalog usage - #85
Merged
mrdrivingduck merged 1 commit intoAug 10, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the extension’s README to more clearly document how to query Apache Paimon tables via DuckDB, distinguishing local warehouse usage from remote access patterns (filesystem vs REST catalog) and clarifying REST catalog parameters and authentication.
Changes:
- Rename the local-warehouse section to “Query Local Paimon Tables” for clearer separation from remote usage.
- Restructure remote querying docs into two explicit paths: “Through a Filesystem Catalog” (OSS/S3) and “Through a REST Catalog”.
- Add a REST catalog ATTACH example and describe how
ATTACH’s first argument, the local DuckDB catalog alias, andbeartoken authentication are interpreted.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Document local and remote query paths, including filesystem and REST catalog access, warehouse identifiers, and bearer-token authentication. Co-authored-by: GPT-5.6 Terra <codex@users.noreply.github.com>
mrdrivingduck
force-pushed
the
codex/docs-rest-catalog-v1.4-andium
branch
from
August 10, 2026 10:40
c016dd8 to
589d9c3
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
README.md:226
- The REST catalog example uses
ATTACH 'my_warehouse' ..., but in the current implementation the firstATTACHargument is also used to infer the filesystem backend and to match scoped Paimon Secrets. Using a non-URI identifier here will default tofile_system=localand will not load S3/OSS credentials, which makes the example misleading for the surrounding “remote object storage” section.
Use a REST catalog when Paimon catalog metadata is served through the [Paimon REST Catalog API](https://paimon.apache.org/docs/master/concepts/rest/). The first `ATTACH` argument (`my_warehouse`) is sent to the REST server as its warehouse identifier; set it to the warehouse or instance your server expects. `rest_paimon` is only the local DuckDB catalog name.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document the local and remote Paimon query paths, including filesystem and REST catalog access.
Clarify the REST warehouse identifier, local DuckDB catalog alias, and supported bearer-token authentication.
Validation
Documentation-only change; checked the Markdown diff with
git diff --check.