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] fix(docs): Correct document #5425

Merged
merged 1 commit into from
Nov 1, 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
6 changes: 3 additions & 3 deletions docs/apache-hive-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ see [Manage Relational Metadata Using Gravitino](./manage-relational-metadata-us
- The Hive catalog supports creating, updating, and deleting tables in the HMS.
- Doesn't support column default value.

#### Table partitions
### Table partitioning

The Hive catalog supports [partitioned tables](https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-PartitionedTables). Users can create partitioned tables in the Hive catalog with the specific partitioning attribute.
Although Gravitino supports several partitioning strategies, Apache Hive inherently only supports a single partitioning strategy (partitioned by column). Therefore, the Hive catalog only supports `Identity` partitioning.
Expand All @@ -87,7 +87,7 @@ Although Gravitino supports several partitioning strategies, Apache Hive inheren
The `fieldName` specified in the partitioning attribute must be the name of a column defined in the table.
:::

#### Table sort orders and distributions
### Table sort orders and distributions

The Hive catalog supports [bucketed sorted tables](https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-BucketedSortedTables). Users can create bucketed sorted tables in the Hive catalog with specific `distribution` and `sortOrders` attributes.
Although Gravitino supports several distribution strategies, Apache Hive inherently only supports a single distribution strategy (clustered by column). Therefore the Hive catalog only supports `Hash` distribution.
Expand All @@ -96,7 +96,7 @@ Although Gravitino supports several distribution strategies, Apache Hive inheren
The `fieldName` specified in the `distribution` and `sortOrders` attribute must be the name of a column defined in the table.
:::

#### Table column types
### Table column types

The Hive catalog supports all data types defined in the [Hive Language Manual](https://cwiki.apache.org/confluence/display/Hive/LanguageManual+Types).
The following table lists the data types mapped from the Hive catalog to Gravitino.
Expand Down
4 changes: 3 additions & 1 deletion docs/gravitino-server-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,10 +222,12 @@ The following table lists the catalog specific properties and their default path
|---------------------|-----------------------------------------------------------------------------------------|----------------------------------------------------------|
| `hive` | [Hive catalog properties](apache-hive-catalog.md#catalog-properties) | `catalogs/hive/conf/hive.conf` |
| `lakehouse-iceberg` | [Lakehouse Iceberg catalog properties](lakehouse-iceberg-catalog.md#catalog-properties) | `catalogs/lakehouse-iceberg/conf/lakehouse-iceberg.conf` |
| `lakehouse-paimon` | [Lakehouse Paimon catalog properties](lakehouse-paimon-catalog.md#catalog-properties) | `catalogs/lakehouse-paimon/conf/lakehouse-paimon.conf` |
| `lakehouse-hudi` | [Lakehouse Hudi catalog properties](lakehouse-hudi-catalog.md#catalog-properties) | `catalogs/lakehouse-hudi/conf/lakehouse-hudi.conf` |
| `jdbc-mysql` | [MySQL catalog properties](jdbc-mysql-catalog.md#catalog-properties) | `catalogs/jdbc-mysql/conf/jdbc-mysql.conf` |
| `jdbc-postgresql` | [PostgreSQL catalog properties](jdbc-postgresql-catalog.md#catalog-properties) | `catalogs/jdbc-postgresql/conf/jdbc-postgresql.conf` |
| `jdbc-doris` | [Doris catalog properties](jdbc-doris-catalog.md#catalog-properties) | `catalogs/jdbc-doris/conf/jdbc-doris.conf` |
| `lakehouse-paimon` | [Lakehouse Paimon catalog properties](lakehouse-paimon-catalog.md#catalog-properties) | `catalogs/lakehouse-paimon/conf/lakehouse-paimon.conf` |
| `jdbc-oceanbase` | [OceanBase catalog properties](jdbc-oceanbase-catalog.md#catalog-properties) | `catalogs/jdbc-oceanbase/conf/jdbc-oceanbase.conf` |
| `kafka` | [Kafka catalog properties](kafka-catalog.md#catalog-properties) | `catalogs/kafka/conf/kafka.conf` |

:::info
Expand Down
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,12 @@ Gravitino currently supports the following catalogs:

* [**Iceberg catalog**](./lakehouse-iceberg-catalog.md)
* [**Paimon catalog**](./lakehouse-paimon-catalog.md)
* [**Hudi catalog**](./lakehouse-hudi-catalog.md)
* [**Hive catalog**](./apache-hive-catalog.md)
* [**MySQL catalog**](./jdbc-mysql-catalog.md)
* [**PostgreSQL catalog**](./jdbc-postgresql-catalog.md)
* [**Doris catalog**](./jdbc-doris-catalog.md)
* [**OceanBase catalog**](./jdbc-oceanbase-catalog.md)

**Fileset catalogs:**

Expand Down Expand Up @@ -107,10 +109,12 @@ Gravitino supports different catalogs to manage the metadata in different source

* [Iceberg catalog](./lakehouse-iceberg-catalog.md): a complete guide to using Gravitino to manage Apache Iceberg data.
* [Paimon catalog](./lakehouse-paimon-catalog.md): a complete guide to using Gravitino to manage Apache Paimon data.
* [Hudi catalog](./lakehouse-hudi-catalog.md): a complete guide to using Gravitino to manage Apache Hudi data.
* [Hive catalog](./apache-hive-catalog.md): a complete guide to using Gravitino to manage Apache Hive data.
* [MySQL catalog](./jdbc-mysql-catalog.md): a complete guide to using Gravitino to manage MySQL data.
* [PostgreSQL catalog](./jdbc-postgresql-catalog.md): a complete guide to using Gravitino to manage PostgreSQL data.
* [Doris catalog](./jdbc-doris-catalog.md): a complete guide to using Gravitino to manage Doris data.
* [OceanBase catalog](./jdbc-oceanbase-catalog.md): a complete guide to using Gravitino to manage OceanBase data.
* [Hadoop catalog](./hadoop-catalog.md): a complete guide to using Gravitino to manage fileset
using Hadoop Compatible File System (HCFS).
* [Kafka catalog](./kafka-catalog.md): a complete guide to using Gravitino to manage Kafka topics metadata.
Expand Down
4 changes: 2 additions & 2 deletions docs/jdbc-doris-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ The data types other than those listed above are mapped to Gravitino's
**[Unparsed Type](./manage-relational-metadata-using-gravitino.md#unparsed-type)** that
represents an unresolvable data type since 0.5.0.

#### Table column auto-increment
### Table column auto-increment

Unsupported for now.

Expand Down Expand Up @@ -149,7 +149,7 @@ Unsupported for now.
</TabItem>
</Tabs>

### Table partitions
### Table partitioning

The Doris catalog supports partitioned tables.
Users can create partitioned tables in the Doris catalog with specific partitioning attributes. It is also supported to pre-assign partitions when creating Doris tables.
Expand Down
4 changes: 2 additions & 2 deletions docs/jdbc-mysql-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Refer to [Manage Relational Metadata Using Gravitino](./manage-relational-metada
- Supports [column default value](./manage-relational-metadata-using-gravitino.md#table-column-default-value) and [auto-increment](./manage-relational-metadata-using-gravitino.md#table-column-auto-increment)..
- Supports managing MySQL table features though table properties, like using `engine` to set MySQL storage engine.

#### Table column types
### Table column types

| Gravitino Type | MySQL Type |
|--------------------|---------------------|
Expand Down Expand Up @@ -113,7 +113,7 @@ MySQL doesn't support Gravitino `Boolean` `Fixed` `Struct` `List` `Map` `Timesta
Meanwhile, the data types other than listed above are mapped to Gravitino **[External Type](./manage-relational-metadata-using-gravitino.md#external-type)** that represents an unresolvable data type since 0.6.0-incubating.
:::

#### Table column auto-increment
### Table column auto-increment

:::note
MySQL setting an auto-increment column requires simultaneously setting a unique index; otherwise, an error will occur.
Expand Down
8 changes: 6 additions & 2 deletions docs/jdbc-oceanbase-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,11 @@ Refer to [Manage Relational Metadata Using Gravitino](./manage-relational-metada
- Supports index.
- Supports [column default value](./manage-relational-metadata-using-gravitino.md#table-column-default-value) and [auto-increment](./manage-relational-metadata-using-gravitino.md#table-column-auto-increment)..

#### Table column types
### Table properties

- Doesn't support table properties.

### Table column types

| Gravitino Type | OceanBase Type |
|-------------------|---------------------|
Expand Down Expand Up @@ -110,7 +114,7 @@ OceanBase doesn't support Gravitino `Boolean` `Fixed` `Struct` `List` `Map` `Tim
Meanwhile, the data types other than listed above are mapped to Gravitino **[External Type](./manage-relational-metadata-using-gravitino.md#external-type)** that represents an unresolvable data type since 0.6.0-incubating.
:::

#### Table column auto-increment
### Table column auto-increment

:::note
OceanBase setting an auto-increment column requires simultaneously setting a unique index; otherwise, an error will occur.
Expand Down
4 changes: 2 additions & 2 deletions docs/jdbc-postgresql-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Please refer to [Manage Relational Metadata Using Gravitino](./manage-relational
- Support [column default value](./manage-relational-metadata-using-gravitino.md#table-column-default-value) and [auto-increment](./manage-relational-metadata-using-gravitino.md#table-column-auto-increment).
- Doesn't support table property settings.

#### Table column types
### Table column types

| Gravitino Type | PostgreSQL Type |
|----------------|-----------------|
Expand All @@ -114,7 +114,7 @@ PostgreSQL doesn't support Gravitino `Fixed` `Struct` `Map` `IntervalDay` `Inter
Meanwhile, the data types other than listed above are mapped to Gravitino **[External Type](./manage-relational-metadata-using-gravitino.md#external-type)** that represents an unresolvable data type since 0.6.0-incubating.
:::

#### Table column auto-increment
### Table column auto-increment

- Supports setting auto-increment.

Expand Down
Loading
Loading