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 c4dbf7f94b [doc] Minor fix for the rest-catalog documentation
c4dbf7f94b is described below
commit c4dbf7f94b529c6c873663eada27c8bd14ccc082
Author: JingsongLi <[email protected]>
AuthorDate: Fri Feb 28 10:19:36 2025 +0800
[doc] Minor fix for the rest-catalog documentation
---
docs/content/concepts/rest-catalog.md | 39 ++++++++++++++++++++++++-----------
1 file changed, 27 insertions(+), 12 deletions(-)
diff --git a/docs/content/concepts/rest-catalog.md
b/docs/content/concepts/rest-catalog.md
index 7b10757f5b..852d3cdf15 100644
--- a/docs/content/concepts/rest-catalog.md
+++ b/docs/content/concepts/rest-catalog.md
@@ -1,5 +1,5 @@
---
-title: "RESTCatalog"
+title: "REST Catalog"
weight: 5
type: docs
aliases:
@@ -25,29 +25,33 @@ under the License.
-->
# RESTCatalog
+
## Overview
-Paimon REST Catalog provides a lightweight implementation to access the
catalog service. Paimon could access the catalog service through a catalog
server which implements REST API.You can see all APIs in [REST
API](https://github.com/apache/paimon/blob/master/paimon-open-api/rest-catalog-open-api.yaml).
+Paimon REST Catalog provides a lightweight implementation to access the
catalog service. Paimon could access the
+catalog service through a catalog server which implements REST API. You can
see all APIs in [REST
API](https://github.com/apache/paimon/blob/master/paimon-open-api/rest-catalog-open-api.yaml).
{{< img src="/img/rest-catalog.svg">}}
## Key Features
1. User Defined Technology-Specific Logic Implementation
- - All technology-specific logic within the catalog server.
- - This ensures that the user can define logic that could be owned by the
user.
+ - All technology-specific logic within the catalog server.
+ - This ensures that the user can define logic that could be owned by the
user.
2. Decoupled Architecture
- - The REST Catalog interacts with the catalog server through a well-defined
REST API.
- - This decoupling allows for independent evolution and scaling of the
catalog server and clients.
+ - The REST Catalog interacts with the catalog server through a well-defined
REST API.
+ - This decoupling allows for independent evolution and scaling of the
catalog server and clients.
3. Language Agnostic
- - Developers can implement the catalog server in any programming language,
provided that it adheres to the specified REST API.
- - This flexibility enables teams to utilize their existing tech stacks and
expertise.
+ - Developers can implement the catalog server in any programming language,
provided that it adheres to the specified REST API.
+ - This flexibility enables teams to utilize their existing tech stacks and
expertise.
4. Support for Any Catalog Backend
- - Paimon REST Catalog is designed to work with any catalog backend.
- - As long as they implement the relevant APIs, they can seamlessly integrate
with Paimon REST Catalog.
+ - REST Catalog is designed to work with any catalog backend.
+ - As long as they implement the relevant APIs, they can seamlessly
integrate with REST Catalog.
## Usage
+
- Bear token
+
```sql
CREATE CATALOG `paimon-rest-catalog`
WITH (
@@ -59,7 +63,9 @@ WITH (
'token' = '<token>'
);
```
+
- DLF ak
+
```sql
CREATE CATALOG `paimon-rest-catalog`
WITH (
@@ -74,6 +80,7 @@ WITH (
```
- DLF sts token
+
```sql
CREATE CATALOG `paimon-rest-catalog`
WITH (
@@ -89,6 +96,7 @@ WITH (
```
- DLF sts token path
+
```sql
CREATE CATALOG `paimon-rest-catalog`
WITH (
@@ -101,7 +109,14 @@ WITH (
);
```
+{{< hint info >}}
+The `'warehouse'` is your catalog instance name on the server, not the path.
+{{< /hint >}}
+
## Conclusion
-Paimon REST Catalog offers adaptable solution for accessing the catalog
service. According to [REST
API](https://github.com/apache/paimon/blob/master/paimon-open-api/rest-catalog-open-api.yaml)
is decoupled from the catalog service.
-Technology-specific Logic is encapsulated on the catalog server. At the same
time, the catalog server supports any backend and languages.
\ No newline at end of file
+REST Catalog offers adaptable solution for accessing the catalog service.
According to [REST
API](https://github.com/apache/paimon/blob/master/paimon-open-api/rest-catalog-open-api.yaml)
is decoupled
+from the catalog service.
+
+Technology-specific Logic is encapsulated on the catalog server. At the same
time, the catalog server supports any
+backend and languages.
