Skip to content

Commit c4dbf7f

Browse files
committed
[doc] Minor fix for the rest-catalog documentation
1 parent 1d128b7 commit c4dbf7f

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

docs/content/concepts/rest-catalog.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "RESTCatalog"
2+
title: "REST Catalog"
33
weight: 5
44
type: docs
55
aliases:
@@ -25,29 +25,33 @@ under the License.
2525
-->
2626

2727
# RESTCatalog
28+
2829
## Overview
2930

30-
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).
31+
Paimon REST Catalog provides a lightweight implementation to access the catalog service. Paimon could access the
32+
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).
3133

3234
{{< img src="/img/rest-catalog.svg">}}
3335

3436
## Key Features
3537

3638
1. User Defined Technology-Specific Logic Implementation
37-
- All technology-specific logic within the catalog server.
38-
- This ensures that the user can define logic that could be owned by the user.
39+
- All technology-specific logic within the catalog server.
40+
- This ensures that the user can define logic that could be owned by the user.
3941
2. Decoupled Architecture
40-
- The REST Catalog interacts with the catalog server through a well-defined REST API.
41-
- This decoupling allows for independent evolution and scaling of the catalog server and clients.
42+
- The REST Catalog interacts with the catalog server through a well-defined REST API.
43+
- This decoupling allows for independent evolution and scaling of the catalog server and clients.
4244
3. Language Agnostic
43-
- Developers can implement the catalog server in any programming language, provided that it adheres to the specified REST API.
44-
- This flexibility enables teams to utilize their existing tech stacks and expertise.
45+
- Developers can implement the catalog server in any programming language, provided that it adheres to the specified REST API.
46+
- This flexibility enables teams to utilize their existing tech stacks and expertise.
4547
4. Support for Any Catalog Backend
46-
- Paimon REST Catalog is designed to work with any catalog backend.
47-
- As long as they implement the relevant APIs, they can seamlessly integrate with Paimon REST Catalog.
48+
- REST Catalog is designed to work with any catalog backend.
49+
- As long as they implement the relevant APIs, they can seamlessly integrate with REST Catalog.
4850

4951
## Usage
52+
5053
- Bear token
54+
5155
```sql
5256
CREATE CATALOG `paimon-rest-catalog`
5357
WITH (
@@ -59,7 +63,9 @@ WITH (
5963
'token' = '<token>'
6064
);
6165
```
66+
6267
- DLF ak
68+
6369
```sql
6470
CREATE CATALOG `paimon-rest-catalog`
6571
WITH (
@@ -74,6 +80,7 @@ WITH (
7480
```
7581

7682
- DLF sts token
83+
7784
```sql
7885
CREATE CATALOG `paimon-rest-catalog`
7986
WITH (
@@ -89,6 +96,7 @@ WITH (
8996
```
9097

9198
- DLF sts token path
99+
92100
```sql
93101
CREATE CATALOG `paimon-rest-catalog`
94102
WITH (
@@ -101,7 +109,14 @@ WITH (
101109
);
102110
```
103111

112+
{{< hint info >}}
113+
The `'warehouse'` is your catalog instance name on the server, not the path.
114+
{{< /hint >}}
115+
104116
## Conclusion
105117

106-
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.
107-
Technology-specific Logic is encapsulated on the catalog server. At the same time, the catalog server supports any backend and languages.
118+
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
119+
from the catalog service.
120+
121+
Technology-specific Logic is encapsulated on the catalog server. At the same time, the catalog server supports any
122+
backend and languages.

0 commit comments

Comments
 (0)