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): improvement lakehouse iceberg document #1138

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
4 changes: 3 additions & 1 deletion docs/apache-hive-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The Hive catalog supports to create, update, and delete databases and tables in

### Catalog operations

see [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#catalogs-operations).
Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#catalogs-operations) for more details.

## Schema

Expand Down Expand Up @@ -136,6 +136,8 @@ Hive automatically adds and manages some reserved properties. Users aren't allow

### Table operations

Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#tables-operations) for more details.

#### Alter operations

Gravitino has already defined a unified set of [metadata operation interfaces](./manage-metadata-using-gravitino#alter-a-table), and almost all [Hive Alter operations](https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-AlterTable/Partition/Column) have corresponding table update request which enable you to change the struct of an existing table.
Expand Down
3 changes: 0 additions & 3 deletions docs/iceberg-rest-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ The Gravitino Iceberg REST Server follows the [Apache Iceberg REST API specifica

:::info
Builds with Apache Iceberg `1.3.1`. The Apache Iceberg table format version is `1` by default.
:::

:::info
Builds with Hadoop 2.10.x, there may compatibility issue when accessing Hadoop 3.x clusters.
:::

Expand Down
6 changes: 4 additions & 2 deletions docs/jdbc-mysql-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ You must download the corresponding JDBC driver to the `catalogs/jdbc-mysql/libs

### Catalog operations

see [Manage metadata using Gravitino](./manage-metadata-using-gravitino#catalogs-operations).
Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#catalogs-operations) for more details.

## Schema

Expand All @@ -61,7 +61,7 @@ see [Manage metadata using Gravitino](./manage-metadata-using-gravitino#catalogs

### Schema operations

see [Manage metadata using Gravitino](./manage-metadata-using-gravitino#schemas-operations).
Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#schemas-operations) for more details.

## Table

Expand Down Expand Up @@ -102,6 +102,8 @@ MySQL doesn't support Gravitino `Boolean` `Fixed` `Struct` `List` `Map` `Timesta

### Table operations

Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#tables-operations) for more details.

#### Alter table operations

Supports operations:
Expand Down
11 changes: 9 additions & 2 deletions docs/jdbc-postgresql-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ In PostgreSQL, the database corresponds to the Gravitino catalog, and the schema

### Catalog operations

see [Manage metadata using Gravitino](./manage-metadata-using-gravitino#catalogs-operations).
Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#catalogs-operations) for more details.

## Schema

Expand All @@ -62,20 +62,25 @@ see [Manage metadata using Gravitino](./manage-metadata-using-gravitino#catalogs
- Supports cascade drop schema.

### Schema properties

- Doesn't are schema property settings.

### Schema operations
see [Manage metadata using Gravitino](./manage-metadata-using-gravitino#schemas-operations).

Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#schemas-operations) for more details.

## Table

### Table capabilities

- Gravitino table corresponds to the PostgreSQL table.
- Supports DDL operation for PostgreSQL tables.
- Doesn't support setting certain column properties, such as default value and check constraints.
- Doesn't support index definition.
- Doesn't support table property settings.

#### Table column types

| Gravitino Type | PostgreSQL Type |
|----------------|-------------------------------|
| `Boolean` | `boolean` |
Expand Down Expand Up @@ -105,6 +110,8 @@ PostgreSQL doesn't support Gravitino `Fixed` `Struct` `List` `Map` `IntervalDay`

### Table operations

Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#tables-operations) for more details.

#### Alter table operations

Supports operations:
Expand Down
19 changes: 8 additions & 11 deletions docs/lakehouse-iceberg-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ Gravitino provides the ability to manage Apache Iceberg metadata.

:::info
Builds with Apache Iceberg `1.3.1`. The Apache Iceberg table format version is `1` by default.
:::

:::info
Builds with Hadoop 2.10.x, there may compatibility issue when accessing Hadoop 3.x clusters.
:::

Expand Down Expand Up @@ -58,7 +55,9 @@ You must download the corresponding JDBC driver to the `catalogs/lakehouse-icebe

### Catalog operations

## Schema
Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#catalogs-operations) for more details.

## Schema

### Schema capabilities

Expand All @@ -70,7 +69,9 @@ You could put properties except `comment`.

### Schema operations

## Table
Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#schemas-operations) for more details.

## Table

### Table capabilities

Expand All @@ -88,9 +89,6 @@ Supports transforms:

:::info
Iceberg doesn't support multi fields in `BucketTransform`.
:::

:::info
Iceberg doesn't support `ApplyTransform`, `RangeTransform` and `ListTransform`.
:::

Expand Down Expand Up @@ -163,6 +161,8 @@ The Gravitino server doesn't allow passing the following reserved fields.

### Table operations

Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#tables-operations) for more details.

#### Alter table operations

Supports operations:
Expand All @@ -181,9 +181,6 @@ Supports operations:

:::info
The default column position is `LAST` when you add a column. If you add a non nullability column, there may be compatibility issues.
:::

:::info
Iceberg just supports updating primitive types.
:::

Expand Down