Skip to content

[python] Introduce Paimon CLI in PyPaimon#7358

Merged
JingsongLi merged 4 commits intoapache:masterfrom
JingsongLi:paimon_cli
Mar 8, 2026
Merged

[python] Introduce Paimon CLI in PyPaimon#7358
JingsongLi merged 4 commits intoapache:masterfrom
JingsongLi:paimon_cli

Conversation

@JingsongLi
Copy link
Contributor

@JingsongLi JingsongLi commented Mar 7, 2026

Purpose

PyPaimon provides a command-line interface (CLI) for interacting with Paimon catalogs and tables.
The CLI allows you to read data from Paimon tables directly from the command line.

The CLI is installed automatically when you install PyPaimon.

This PR implements:

  1. table read.
  2. table get.
  3. table create.

Tests

API and Format

Documentation

Generative AI tooling

GLM-5


#### Limit Results

Use the `-l` or `--limit` option to limit the number of rows displayed:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add default value 100 here (ref to code in line of cli_table).

@plusplusjiajia
Copy link
Member

+1. Great addition to pypaimon! The cli makes it much easier to interact with paimon tables.

@JingsongLi JingsongLi merged commit 949cb4f into apache:master Mar 8, 2026
6 checks passed
jerry-024 added a commit to jerry-024/paimon that referenced this pull request Mar 10, 2026
* upstream/master: (31 commits)
  [python] Correct pyroaring version in requirements
  [test] Enrich table name in MergeIntoTableTestBase
  [test] Fix unstable test: FileStoreLookupFunctionTest.testLookupScanLeak
  [python] Remove useless parameters in blob_writer.py
  [rest] Introduce reset consumer api in rest (apache#7372)
  [python] Introduce Python CLI table snapshot (apache#7373)
  [python] Fix time mapping by always using time32 (apache#7371)
  [python] Introduce catalog list-dbs in Python CLI (apache#7366)
  [hotfix][docs] replace the documentation URL for data-types blob (apache#7370)
  [python] Add i short name to ignore-if-not-exists for database
  [python] Support dynamic bucket write (apache#7363)
  [python] Introduce database related commands to Python CLI (apache#7362)
  [python] Introduce table import, drop and alter to Python CLI (apache#7360)
  [python] Fix py version required in README (apache#7361)
  [test] Add missing LeafFunction coverage in PredicateJsonSerdeTest (apache#7359)
  [python] support predicate NotBetween, Like function (apache#7352)
  [python] Introduce Paimon CLI in PyPaimon (apache#7358)
  [doc] Document ignoreIfExists for create_branch
  [core] Add IF NOT EXISTS support for create_branch operation (apache#7353)
  [python] Remove oss and pylance from requirements deps
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants