Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ that you always have docs corresponding to your checked-out version.

Make sure you have installed Hugo on your system.
Note: An extended version of Hugo <= 0.124.1 is required. you can Find this at [Hugo](https://github.com/gohugoio/hugo/releases/tag/v0.124.1)
```sh
go install -tags extended,withdeploy github.com/gohugoio/hugo@v0.124.1
```

From this directory:

Expand Down
6 changes: 5 additions & 1 deletion docs/content/concepts/catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,12 @@ access the Paimon table.

## Catalogs

Paimon catalogs currently support three types of metastores:
Paimon catalogs currently support four types of metastores:

* `filesystem` metastore (default), which stores both metadata and table files in filesystems.
* `hive` metastore, which additionally stores metadata in Hive metastore. Users can directly access the tables from Hive.
* `jdbc` metastore, which additionally stores metadata in relational databases such as MySQL, Postgres, etc.
* `rest` metastore, which is designed to provide a lightweight way to access any catalog backend from a single client.

## Filesystem Catalog

Expand Down Expand Up @@ -88,3 +89,6 @@ 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-catalog" >}}).
2 changes: 1 addition & 1 deletion docs/content/concepts/data-types.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Data Types"
weight: 7
weight: 8
type: docs
aliases:
- /concepts/data-types.html
Expand Down
88 changes: 88 additions & 0 deletions docs/content/concepts/rest-catalog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
title: "RESTCatalog"
weight: 5
type: docs
aliases:
- /concepts/rest-catalog.html
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
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).

{{< 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.
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.
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.
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.

## Usage
- Bear token
```sql
CREATE CATALOG `paimon-rest-catalog`
WITH (
'type' = 'paimon',
'uri' = '<catalog server url>',
'metastore' = 'rest',
'token.provider' = 'bear'
'token' = '<token>'
);
```
- DLF ak
```sql
CREATE CATALOG `paimon-rest-catalog`
WITH (
'type' = 'paimon',
'uri' = '<catalog server url>',
'metastore' = 'rest',
'token.provider' = 'dlf',
'dlf.accessKeyId'='<accessKeyId>',
'dlf.accessKeySecret'='<accessKeySecret>',
);
```
- DLF token path
```sql
CREATE CATALOG `paimon-rest-catalog`
WITH (
'type' = 'paimon',
'uri' = '<catalog server url>',
'metastore' = 'rest',
'token.provider' = 'dlf',
'dlf.token-path' = '<token-path>'
);
```

## 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.
2 changes: 1 addition & 1 deletion docs/content/concepts/spec/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Specification
bookCollapseSection: true
weight: 8
weight: 9
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
Expand Down
2 changes: 1 addition & 1 deletion docs/content/concepts/system-tables.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "System Tables"
weight: 6
weight: 7
type: docs
aliases:
- /concepts/system-tables.html
Expand Down
2 changes: 1 addition & 1 deletion docs/content/concepts/table-types.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Table Types"
weight: 5
weight: 6
type: docs
aliases:
- /concepts/table-types.html
Expand Down
2 changes: 2 additions & 0 deletions docs/static/img/rest-catalog.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.