You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/concepts/rest-catalog.md
+27-12Lines changed: 27 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: "RESTCatalog"
2
+
title: "REST Catalog"
3
3
weight: 5
4
4
type: docs
5
5
aliases:
@@ -25,29 +25,33 @@ under the License.
25
25
-->
26
26
27
27
# RESTCatalog
28
+
28
29
## Overview
29
30
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).
31
33
32
34
{{< img src="/img/rest-catalog.svg">}}
33
35
34
36
## Key Features
35
37
36
38
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.
39
41
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.
42
44
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.
45
47
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.
48
50
49
51
## Usage
52
+
50
53
- Bear token
54
+
51
55
```sql
52
56
CREATE CATALOG `paimon-rest-catalog`
53
57
WITH (
@@ -59,7 +63,9 @@ WITH (
59
63
'token'='<token>'
60
64
);
61
65
```
66
+
62
67
- DLF ak
68
+
63
69
```sql
64
70
CREATE CATALOG `paimon-rest-catalog`
65
71
WITH (
@@ -74,6 +80,7 @@ WITH (
74
80
```
75
81
76
82
- DLF sts token
83
+
77
84
```sql
78
85
CREATE CATALOG `paimon-rest-catalog`
79
86
WITH (
@@ -89,6 +96,7 @@ WITH (
89
96
```
90
97
91
98
- DLF sts token path
99
+
92
100
```sql
93
101
CREATE CATALOG `paimon-rest-catalog`
94
102
WITH (
@@ -101,7 +109,14 @@ WITH (
101
109
);
102
110
```
103
111
112
+
{{< hint info >}}
113
+
The `'warehouse'` is your catalog instance name on the server, not the path.
114
+
{{< /hint >}}
115
+
104
116
## Conclusion
105
117
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
0 commit comments