Skip to content

Commit

Permalink
[MINOR] docs: polish Iceberg REST server document (#6444)
Browse files Browse the repository at this point in the history
### What changes were proposed in this pull request?

multi catalog and view operation should shown in document side bars.

### Why are the changes needed?
User could find multi catalog configuration easily

### Does this PR introduce _any_ user-facing change?
no

### How was this patch tested?
just document
  • Loading branch information
FANNG1 authored and web-flow committed Feb 13, 2025
1 parent c4b3285 commit 00ad8dd
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/iceberg-rest-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,23 +243,23 @@ You must download the corresponding JDBC driver to the `iceberg-rest-server/libs

If you want to use a custom Iceberg Catalog as `catalog-backend`, you can add a corresponding jar file to the classpath and load a custom Iceberg Catalog implementation by specifying the `catalog-backend-impl` property.

#### View support
### View support

You could access the view interface if using JDBC backend and enable `jdbc.schema-version` property.

| Configuration item | Description | Default value | Required | Since Version |
|----------------------------------------------|--------------------------------------------------------------------------------------------|---------------|----------|------------------|
| `gravitino.iceberg-rest.jdbc.schema-version` | The schema version of JDBC catalog backend, setting to `V1` if supporting view operations. | (none) | NO | 0.7.0-incubating |

#### Multi catalog support
### Multi catalog support

The Gravitino Iceberg REST server supports multiple catalogs, and you could manage the catalog by different ways.

| Configuration item | Description | Default value | Required | Since Version |
|--------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|----------|------------------|
| `gravitino.iceberg-rest.catalog-config-provider` | The className of catalog configuration provider, Gravitino provides build-in `static-config-provider` and `dynamic-config-provider`, you could also develop a custom class that implements `apache.gravitino.iceberg.service.provider.IcebergConfigProvider` and add the corresponding jar file to the Iceberg REST service classpath directory. | `static-config-provider` | No | 0.7.0-incubating |

##### Static catalog configuration provider
#### Static catalog configuration provider

The static catalog configuration provider retrieves the catalog configuration from the configuration file of the Gravitino Iceberg REST server. You could configure the default catalog with `gravitino.iceberg-rest.<param name>=<value>`. For specific catalogs, use the format `gravitino.iceberg-rest.catalog.<catalog name>.<param name>=<value>`.

Expand Down Expand Up @@ -298,7 +298,7 @@ You can access different catalogs by setting the `prefix` to the specific catalo
...
```

##### Dynamic catalog configuration provider
#### Dynamic catalog configuration provider

The dynamic catalog configuration provider retrieves the catalog configuration from the Gravitino server.

Expand Down

0 comments on commit 00ad8dd

Please sign in to comment.