feat(catalog): enrich catalog interface with more methods by ChaomingZhangCN · Pull Request #102 · alibaba/paimon-cpp

ChaomingZhangCN · 2026-02-02T08:42:04Z

Purpose

Close #84

API and Format

virtual Status DropDatabase(const std::string& name, bool ignore_if_not_exists, bool cascade);
virtual Status AlterDatabase(const std::string& name, const std::map<std::string, std::string>& changes, bool ignore_if_not_exists);
virtual Result<std::shared_ptr<Database>> GetDatabase(const std::string& name) const;
virtual Result<std::shared_ptr<Table>> GetTable(const Identifier& identifier) const;
virtual Result<std::shared_ptr<Table>> GetTableById(const std::string& table_id) const;
virtual Status DropTable(const Identifier& identifier, bool ignore_if_not_exists);
virtual Status RenameTable(const Identifier& from_table, const Identifier& to_table, bool ignore_if_not_exists);
virtual Status MarkDonePartitions(const Identifier& identifier, const std::vector<std::map<std::string, std::string>>& partitions);
virtual Result<std::vector<std::map<std::string, std::string>>> ListPartitions(const Identifier& identifier) const;
virtual Status CreatePartitions(const Identifier& identifier, const std::vector<std::map<std::string, std::string>>& partitions);
virtual Status DropPartitions(const Identifier& identifier, const std::vector<std::map<std::string, std::string>>& partitions);
virtual Status AlterPartitions(const Identifier& identifier, const std::vector<PartitionStatistics>& partitions);
virtual Result<std::shared_ptr<View>> GetView(const Identifier& identifier) const;
virtual Status DropView(const Identifier& identifier, bool ignore_if_not_exists);
virtual Status CreateView(const Identifier& identifier, const View& view, bool ignore_if_exists);
virtual Result<std::vector<std::string>> ListViews(const std::string& database_name) const;
virtual Status RenameView(const Identifier& from_view, const Identifier& to_view, bool ignore_if_not_exists);
virtual Status RepairCatalog();
virtual Status RepairDatabase(const std::string& database_name);
virtual Status RepairTable(const Identifier& identifier);
virtual Status RegisterTable(const Identifier& identifier, const std::string& path);
virtual bool SupportsListObjectsPaged() const;
virtual bool SupportsListByPattern() const;
virtual bool SupportsListTableByType() const;
virtual bool SupportsVersionManagement() const;
virtual Result<bool> CommitSnapshot(const Identifier& identifier, const std::string& table_uuid, const std::shared_ptr<Snapshot>& snapshot, const std::vector<PartitionStatistics>& statistics);
virtual Result<std::shared_ptr<Snapshot>> LoadSnapshot(const Identifier& identifier, const std::string& version) const;
virtual Status RollbackTo(const Identifier& identifier, const std::chrono::system_clock::time_point& instant);
virtual Status RollbackTo(const Identifier& identifier, const std::chrono::system_clock::time_point& instant, const std::optional<int64_t>& from_snapshot);
virtual Status CreateBranch(const Identifier& identifier, const std::string& branch, const std::optional<std::string>& from_tag = std::nullopt);
virtual Status DropBranch(const Identifier& identifier, const std::string& branch);
virtual Status FastForward(const Identifier& identifier, const std::string& branch);
virtual Result<std::vector<std::string>> ListBranches(const Identifier& identifier) const;
virtual Result<TagInfo> GetTag(const Identifier& identifier, const std::string& tag_name) const;
virtual Status CreateTag(const Identifier& identifier, const std::string& tag_name, const std::optional<int64_t>& snapshot_id, const std::optional<std::string>& time_retained, bool ignore_if_exists);
virtual Status DeleteTag(const Identifier& identifier, const std::string& tag_name);

Documentation

src/paimon/core/table/table.h

src/paimon/core/view/view.h

include/paimon/core/tag_info.h

include/paimon/catalog/catalog.h

ChaomingZhangCN · 2026-02-05T11:10:23Z

@lxy-9602 @lszskye PTAL~

lxy-9602 · 2026-02-05T12:37:59Z

include/paimon/catalog/catalog.h

+    /// Invalidates cached table metadata.
+    ///
+    /// @param identifier Identifier of the table to invalidate.
+    virtual void InvalidateTable(const Identifier& identifier) {}


Does InvalidateTable need a return status?

lxy-9602 · 2026-02-05T12:40:38Z

include/paimon/catalog/catalog.h

+    /// @param instant Like snapshotId or tagName
+    /// @return A status indicating success or failure.
+    virtual Status RollbackTo(const Identifier& identifier,
+                              const std::chrono::system_clock::time_point& instant) {


instant is a time point or a snapshot id or tag name? It seems param mismatches comments.

+1, usingstd::variant is better than std::chrono::system_clock::time_point.

lucasfang · 2026-02-06T02:59:52Z

include/paimon/catalog/catalog.h

    /// status.
    virtual Result<std::vector<std::string>> ListTables(const std::string& db_name) const = 0;

+    /// Drops a database.


This PR includes too many unimplemented APIs at once, which may make the API documentation confusing. Would it be better to submit only a few APIs with their implementations in each PR?

Thank you for your suggestion. I will implement some of them in the filesystem catalog.

lszskye · 2026-02-06T07:16:00Z

include/paimon/catalog/database.h

+    /// ================== Table Metadata =====================
+
+    /// A name to identify this database.
+    virtual std::string Name() = 0;


virtual std::string Name() const = 0;

lszskye · 2026-02-06T07:38:28Z

src/paimon/core/view/view.h

+    virtual ~View() = default;
+
+    /// A name to identify this view.
+    virtual std::string Name() = 0;


For all GetXXX() api, please add const,
like virtual std::string Name() const = 0;

ChaomingZhangCN added 2 commits February 2, 2026 14:46

[feature] Enrich catalog interface with more methods

b705bca

add impl

b201f4a

ChaomingZhangCN changed the title ~~[feature] Enrich catalog interface with more methods~~ feat: Enrich catalog interface with more methods Feb 2, 2026

ChaomingZhangCN changed the title ~~feat: Enrich catalog interface with more methods~~ feat(catalog): Enrich catalog interface with more methods Feb 2, 2026

ChaomingZhangCN changed the title ~~feat(catalog): Enrich catalog interface with more methods~~ feat(catalog): enrich catalog interface with more methods Feb 2, 2026

ChaomingZhangCN and others added 3 commits February 2, 2026 18:13

address

e41494b

snapshot and tag api

65f968c

Merge branch 'main' into catalog-api

c947284

lxy-9602 reviewed Feb 3, 2026

View reviewed changes

lszskye reviewed Feb 4, 2026

View reviewed changes

include/paimon/catalog/catalog.h Outdated Show resolved Hide resolved

ChaomingZhangCN and others added 5 commits February 5, 2026 13:48

refactor

819a299

address

9f9ea7b

address

a2a22e4

fix

2c0762d

Merge branch 'main' into catalog-api

ad87149

lxy-9602 reviewed Feb 5, 2026

View reviewed changes

lucasfang reviewed Feb 6, 2026

View reviewed changes

lszskye reviewed Feb 6, 2026

View reviewed changes

alibaba deleted a comment from lszskye Feb 6, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(catalog): enrich catalog interface with more methods#102

feat(catalog): enrich catalog interface with more methods#102
ChaomingZhangCN wants to merge 10 commits intoalibaba:mainfrom
ChaomingZhangCN:catalog-api

ChaomingZhangCN commented Feb 2, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ChaomingZhangCN commented Feb 5, 2026

Uh oh!

lxy-9602 Feb 5, 2026

Uh oh!

lxy-9602 Feb 5, 2026

Uh oh!

ChaomingZhangCN Feb 6, 2026

Uh oh!

lucasfang Feb 6, 2026

Uh oh!

ChaomingZhangCN Feb 6, 2026

Uh oh!

lszskye Feb 6, 2026

Uh oh!

lszskye Feb 6, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

ChaomingZhangCN commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

API and Format

Documentation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ChaomingZhangCN commented Feb 5, 2026

Uh oh!

lxy-9602 Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

lxy-9602 Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

ChaomingZhangCN Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

lucasfang Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

ChaomingZhangCN Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

lszskye Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

lszskye Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ChaomingZhangCN commented Feb 2, 2026 •

edited

Loading

lszskye Feb 6, 2026 •

edited

Loading