PyRSA commented on PR #1364:
URL: https://github.com/apache/paimon-rust/pull/1364#issuecomment-6786438920
> Requirement fit: SUPPORTED. The missing binding documentation is useful,
but the new tag-management walkthrough is not executable as presented.
>
> **[P2] Separate filesystem tag operations from REST-only
pagination/rollback, and keep the rollback tag alive**
(`docs/src/python-binding.md:566-571`). The guide's filesystem `PaimonCatalog`
supports create/get/delete tags, but `list_tags_paged` and `rollback_to`
inherit the core defaults that return `Unsupported` (mapped to
`NotImplementedError` by the Python binding). A reader following this example
therefore stops at `list_tags_paged`. With a REST catalog that implements those
operations, the example deletes `release-1.0` before attempting
`Instant.tag("release-1.0")`, so that rollback has no tag to resolve. Please
state the REST/server support requirement, separate the optional REST example,
and move deletion after the rollback example (or recreate the tag).
>
> Validation: `mkdocs build --strict --config-file docs/mkdocs.yml` passed.
I cross-checked the added calls against the Python exports and
`Catalog`/`FileSystemCatalog` implementations; the documentation build does not
execute these Python snippets.
>
> Batch integration note: #1368 adds
`paimon_catalog_create_tag_with_retention`. A local `git merge-tree` of #1364
and #1368 merges cleanly but leaves this PR's new C-guide sentence, “Creating
tags with a retention duration is not exposed in the C API,” false. Please
coordinate the documentation with #1368 and describe the new
export/null-retention behavior when both are included.
Thanks for the review! I've updated the documentation to address both issues:
- Separated Filesystem Catalog and REST Catalog tag-management examples
based on their actual supported capabilities.
- Clarified that `list_tags_paged` and `rollback_to` require REST Catalog
and a running REST Server.
- Fixed the tag lifecycle order to ensure the tag remains available
throughout the rollback operations.
- Updated the C Binding documentation to reflect the new
`paimon_catalog_create_tag_with_retention` API introduced in #1368.
- Clarified that the original `paimon_catalog_create_tag` API preserves the
no-retention behavior, and that retention metadata is persisted but does not
automatically expire or delete tags.
- Documented the `tagTimeRetained` field in the tag JSON representation.
I've verified the documentation against the Python, C, and Go bindings and
the catalog implementations. The strict documentation build and `git diff
--check` both pass.
Thanks again for catching these issues and for pointing out the integration
with #1368!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]