Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MINOR] docs(lakehouse-iceberg): polish iceberg document #2040

Merged
merged 3 commits into from
Feb 4, 2024
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
10 changes: 3 additions & 7 deletions docs/iceberg-rest-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Gravitino Iceberg REST Server follows the [Apache Iceberg REST API specifica
### Capabilities

- Supports the Apache Iceberg REST API defined in Iceberg 1.3.1, and supports all namespace and table interfaces. `Token`, and `Config` interfaces aren't supported yet.
- Works as a catalog proxy, supporting `HiveCatalog` and `JDBCCatalog`.
- Works as a catalog proxy, supporting `Hive` and `JDBC` as catalog backend.
- Provides a pluggable metrics store interface to store and delete Iceberg metrics.
- When writing to HDFS, the Gravitino Iceberg REST catalog service can only operate as the specified HDFS user and
doesn't support proxying to other HDFS users. See [How to access Apache Hadoop](gravitino-server-config.md#how-to-access-apache-hadoop) for more details.
Expand All @@ -26,7 +26,7 @@ Builds with Hadoop 2.10.x, there may be compatibility issues when accessing Hado

## Gravitino Iceberg REST catalog service configuration

Assuming the Gravitino server is deployed in the `GRAVITINO_HOME` directory, you can locate the configuration options in [`$GRAVITINO_HOME/conf/gravitino.conf`](gravitino-server-config.md). There are three configuration properties for the Iceberg REST catalog service:
Assuming the Gravitino server is deployed in the `GRAVITINO_HOME` directory, you can locate the configuration options in [`$GRAVITINO_HOME/conf/gravitino.conf`](gravitino-server-config.md). There are four configuration properties for the Iceberg REST catalog service:

1. [**REST Catalog Server Configuration**](#rest-catalog-server-configuration): you can specify the HTTP server properties like host and port.

Expand Down Expand Up @@ -74,7 +74,7 @@ Gravitino provides a pluggable metrics store interface to store and delete Icebe
### Gravitino Iceberg catalog backend configuration

:::info
The Gravitino Iceberg REST catalog service uses the memory catalog by default. You can specify using a Hive or JDBC catalog in a production environment.
The Gravitino Iceberg REST catalog service uses the memory catalog backend by default. You can specify using a Hive or JDBC catalog backend in a production environment.
:::

#### Hive backend configuration
Expand All @@ -101,10 +101,6 @@ The Gravitino Iceberg REST catalog service uses the memory catalog by default. Y
You must download the corresponding JDBC driver to the `catalogs/lakehouse-iceberg/libs` directory.
:::

:::info
`gravitino.auxService.iceberg-rest.jdbc-driver` isn't required unless Gravitino manages multi JDBC drivers.
:::

### Other Apache Iceberg catalog properties

You can add other properties defined in [Iceberg catalog properties](https://iceberg.apache.org/docs/1.3.1/configuration/#catalog-properties).
Expand Down
3 changes: 1 addition & 2 deletions docs/lakehouse-iceberg-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,6 @@ Apache Iceberg doesn't support Gravitino `EvenDistribution` type.

| Gravitino Type | Apache Iceberg Type |
|-----------------------------|-----------------------------|
| `Struct` | `Struct` |
| `Map` | `Map` |
| `Array` | `Array` |
| `Boolean` | `Boolean` |
Expand All @@ -212,7 +211,7 @@ Apache Iceberg doesn't support Gravitino `EvenDistribution` type.
| `UUID` | `UUID` |

:::info
Apache Iceberg doesn't support Gravitino `Varchar` `Fixedchar` `Byte` `Short` `Union` type.
Apache Iceberg doesn't support Gravitino `Struct` `Varchar` `Fixedchar` `Byte` `Short` `Union` type.
:::

### Table properties
Expand Down
Loading