This is an automated email from the ASF dual-hosted git repository.
lzljs3620320 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/paimon.git
The following commit(s) were added to refs/heads/master by this push:
new e3e5b44806 [doc] Add description for python api doc
e3e5b44806 is described below
commit e3e5b4480631b1254cfd6cc23e7e012cc29821da
Author: JingsongLi <[email protected]>
AuthorDate: Mon Sep 15 13:47:01 2025 +0800
[doc] Add description for python api doc
---
docs/content/concepts/catalog.md | 10 +++++-----
docs/content/program-api/python-api.md | 6 +++++-
2 files changed, 10 insertions(+), 6 deletions(-)
diff --git a/docs/content/concepts/catalog.md b/docs/content/concepts/catalog.md
index 2a646b2cb4..3d57cbf129 100644
--- a/docs/content/concepts/catalog.md
+++ b/docs/content/concepts/catalog.md
@@ -51,6 +51,11 @@ CREATE CATALOG my_catalog WITH (
);
```
+## REST Catalog
+
+By using the Paimon REST catalog, changes to the catalog will be directly
stored in a remote catalog server which exposed through REST API.
+See [Paimon REST Catalog]({{< ref "concepts/rest/overview" >}}).
+
## Hive Catalog
By using Paimon Hive catalog, changes to the catalog will directly affect the
corresponding Hive metastore. Tables
@@ -89,8 +94,3 @@ CREATE CATALOG my_jdbc WITH (
'warehouse' = 'hdfs:///path/to/warehouse'
);
```
-
-## REST Catalog
-
-By using the Paimon REST catalog, changes to the catalog will be directly
stored in a remote catalog server which exposed through REST API.
-See [Paimon REST Catalog]({{< ref "concepts/rest/overview" >}}).
diff --git a/docs/content/program-api/python-api.md
b/docs/content/program-api/python-api.md
index a5ab249cc5..6f7d8bb697 100644
--- a/docs/content/program-api/python-api.md
+++ b/docs/content/program-api/python-api.md
@@ -27,6 +27,9 @@ under the License.
# Python API
+PyPaimon is a Python implementation for connecting Paimon catalog, reading &
writing tables. The complete Python
+implementation of the brand new PyPaimon does not require JDK installation.
+
## Environment Settings
### SDK Installing
@@ -46,12 +49,13 @@ from pypaimon import CatalogFactory
# Note that keys and values are all string
catalog_options = {
- 'metastore': 'filesystem',
'warehouse': 'file:///path/to/warehouse'
}
catalog = CatalogFactory.create(catalog_options)
```
+Currently, PyPaimon only support filesystem catalog and rest catalog. See
[Catalog]({{< ref "concepts/catalog" >}}).
+
## Create Database & Table
You can use the catalog to create table for writing data.
