Skip to content

[Doc] Reconsider "Paimon cluster" wording in catalog documentation #73369

@llphxd

Description

@llphxd

Enhancement

The Paimon catalog documentation currently uses the term "Paimon cluster" in several places.

For example:

To ensure successful SQL workloads on your Paimon cluster, your StarRocks cluster must be able to access the storage system and metastore of your Paimon cluster.

You cannot use Paimon catalogs to drop, delete, or insert data into your Paimon cluster.

My understanding is that Apache Paimon is a table format / lakehouse storage abstraction, and it is serverless by itself. It is usually backed by a storage system and a metastore, rather than being a standalone cluster service.

Therefore, the term "Paimon cluster" may be misleading in the documentation.

Would it be better to replace "Paimon cluster" with more accurate wording depending on the context, such as:

  • "Paimon data"
  • "Paimon tables"
  • "Paimon warehouse"
  • "Paimon's storage system and metastore"

I also noticed similar wording in other catalog documentation, for example the Iceberg catalog documentation also uses terms like "Iceberg cluster". If maintainers agree with this concern, the same terminology cleanup may be worth applying consistently across related catalog documentation.

Document location:

docs/en/data_source/catalog/paimon_catalog.md

If maintainers agree with this concern, I would be happy to submit a PR to improve the wording.

Metadata

Metadata

Assignees

No one assigned

    Labels

    type/enhancementMake an enhancement to StarRocks

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions