This is an automated email from the ASF dual-hosted git repository.
jshao pushed a commit to branch branch-0.7
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/branch-0.7 by this push:
new d9921582c [MINOR] fix(docs): Correct document (#5427)
d9921582c is described below
commit d9921582cf5e0d90e6199ee1ca59b378a0df28bf
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Fri Nov 1 16:13:16 2024 +0800
[MINOR] fix(docs): Correct document (#5427)
### What changes were proposed in this pull request?
Correct document
### Why are the changes needed?
Correct document
### Does this PR introduce _any_ user-facing change?
no
### How was this patch tested?
no need
Co-authored-by: mchades <[email protected]>
---
docs/apache-hive-catalog.md | 6 +--
docs/gravitino-server-config.md | 4 +-
docs/index.md | 4 ++
docs/jdbc-doris-catalog.md | 4 +-
docs/jdbc-mysql-catalog.md | 4 +-
docs/jdbc-oceanbase-catalog.md | 8 +++-
docs/jdbc-postgresql-catalog.md | 4 +-
docs/manage-relational-metadata-using-gravitino.md | 54 +++++++++++++---------
8 files changed, 53 insertions(+), 35 deletions(-)
diff --git a/docs/apache-hive-catalog.md b/docs/apache-hive-catalog.md
index 732183b3d..fc303e9e4 100644
--- a/docs/apache-hive-catalog.md
+++ b/docs/apache-hive-catalog.md
@@ -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.
@@ -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.
@@ -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.
diff --git a/docs/gravitino-server-config.md b/docs/gravitino-server-config.md
index a7c696051..308a9781f 100644
--- a/docs/gravitino-server-config.md
+++ b/docs/gravitino-server-config.md
@@ -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
diff --git a/docs/index.md b/docs/index.md
index 3dc8a4561..42eb85a0c 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -69,10 +69,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:**
@@ -104,10 +106,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.
diff --git a/docs/jdbc-doris-catalog.md b/docs/jdbc-doris-catalog.md
index 454c4604c..b2a223de2 100644
--- a/docs/jdbc-doris-catalog.md
+++ b/docs/jdbc-doris-catalog.md
@@ -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.
@@ -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.
diff --git a/docs/jdbc-mysql-catalog.md b/docs/jdbc-mysql-catalog.md
index 58042188c..cca3b1603 100644
--- a/docs/jdbc-mysql-catalog.md
+++ b/docs/jdbc-mysql-catalog.md
@@ -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 |
|--------------------|---------------------|
@@ -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.
diff --git a/docs/jdbc-oceanbase-catalog.md b/docs/jdbc-oceanbase-catalog.md
index 0d44752a8..209582d9c 100644
--- a/docs/jdbc-oceanbase-catalog.md
+++ b/docs/jdbc-oceanbase-catalog.md
@@ -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 |
|-------------------|---------------------|
@@ -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.
diff --git a/docs/jdbc-postgresql-catalog.md b/docs/jdbc-postgresql-catalog.md
index 6550a0242..008d5c831 100644
--- a/docs/jdbc-postgresql-catalog.md
+++ b/docs/jdbc-postgresql-catalog.md
@@ -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 |
|----------------|-----------------|
@@ -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.
diff --git a/docs/manage-relational-metadata-using-gravitino.md
b/docs/manage-relational-metadata-using-gravitino.md
index 4ceab5b61..d35ae863d 100644
--- a/docs/manage-relational-metadata-using-gravitino.md
+++ b/docs/manage-relational-metadata-using-gravitino.md
@@ -22,6 +22,7 @@ For more details, please refer to the related doc.
- [**MySQL**](./jdbc-mysql-catalog.md)
- [**PostgreSQL**](./jdbc-postgresql-catalog.md)
- [**Apache Doris**](./jdbc-doris-catalog.md)
+- [**OceanBase**](./jdbc-oceanbase-catalog.md)
- [**Apache Iceberg**](./lakehouse-iceberg-catalog.md)
- [**Apache Paimon**](./lakehouse-paimon-catalog.md)
- [**Apache Hudi**](./lakehouse-hudi-catalog.md)
@@ -111,6 +112,7 @@ Currently, Gravitino supports the following catalog
providers:
| `jdbc-mysql` | [MySQL catalog
property](./jdbc-mysql-catalog.md#catalog-properties) |
| `jdbc-postgresql` | [PostgreSQL catalog
property](./jdbc-postgresql-catalog.md#catalog-properties) |
| `jdbc-doris` | [Doris catalog
property](./jdbc-doris-catalog.md#catalog-properties) |
+| `jdbc-oceanbase` | [OceanBase catalog
property](./jdbc-oceanbase-catalog.md#catalog-properties) |
### Load a catalog
@@ -493,6 +495,7 @@ Currently, Gravitino supports the following schema property:
| `jdbc-mysql` | [MySQL schema
property](./jdbc-mysql-catalog.md#schema-properties) |
| `jdbc-postgresql` | [PostgreSQL schema
property](./jdbc-postgresql-catalog.md#schema-properties) |
| `jdbc-doris` | [Doris schema
property](./jdbc-doris-catalog.md#schema-properties) |
+| `jdbc-oceanbase` | [OceanBase schema
property](./jdbc-oceanbase-catalog.md#schema-properties) |
### Load a schema
@@ -974,45 +977,50 @@ The following is a table of the column default value that
Gravitino supports for
| `lakehouse-hudi` | ✘ |
| `jdbc-mysql` | ✔ |
| `jdbc-postgresql` | ✔ |
+| `jdbc-doris` | ✔ |
+| `jdbc-oceanbase` | ✔ |
#### Table column auto-increment
Auto-increment provides a convenient way to ensure that each row in a table
has a unique identifier without the need for manually managing identifier
allocation.
The following table shows the column auto-increment that Gravitino supports
for different catalogs:
-| Catalog provider | Supported auto-increment
|
-|---------------------|------------------------------------------------------------------------------|
-| `hive` | ✘
|
-| `lakehouse-iceberg` | ✘
|
-| `lakehouse-paimon` | ✘
|
-| `lakehouse-hudi` | ✘
|
-| `jdbc-mysql` |
✔([limitations](./jdbc-mysql-catalog.md#table-column-auto-increment)) |
-| `jdbc-postgresql` | ✔
|
+| Catalog provider | Supported auto-increment
|
+|---------------------|----------------------------------------------------------------------------------|
+| `hive` | ✘
|
+| `lakehouse-iceberg` | ✘
|
+| `lakehouse-paimon` | ✘
|
+| `lakehouse-hudi` | ✘
|
+| `jdbc-mysql` |
✔([limitations](./jdbc-mysql-catalog.md#table-column-auto-increment))
|
+| `jdbc-postgresql` | ✔
|
+| `jdbc-doris` | ✘
|
+| `jdbc-oceanbase` |
✔([limitations](./jdbc-oceanbase-catalog.md#table-column-auto-increment))
|
#### Table property and type mapping
The following is the table property that Gravitino supports:
-| Catalog provider | Table property
| Type mapping
|
-|---------------------|----------------------------------------------------------------------------|----------------------------------------------------------------------------|
-| `hive` | [Hive table
property](./apache-hive-catalog.md#table-properties) | [Hive type
mapping](./apache-hive-catalog.md#table-column-types) |
-| `lakehouse-iceberg` | [Iceberg table
property](./lakehouse-iceberg-catalog.md#table-properties) | [Iceberg type
mapping](./lakehouse-iceberg-catalog.md#table-column-types) |
-| `lakehouse-paimon` | [Paimon table
property](./lakehouse-paimon-catalog.md#table-properties) | [Paimon type
mapping](./lakehouse-paimon-catalog.md#table-column-types) |
-| `lakehouse-hudi` | [Hudi table
property](./lakehouse-hudi-catalog.md#table-properties) | [Hudi type
mapping](./lakehouse-hudi-catalog.md#table-column-types) |
-| `jdbc-mysql` | [MySQL table
property](./jdbc-mysql-catalog.md#table-properties) | [MySQL type
mapping](./jdbc-mysql-catalog.md#table-column-types) |
-| `jdbc-postgresql` | [PostgreSQL table
property](./jdbc-postgresql-catalog.md#table-properties) | [PostgreSQL type
mapping](./jdbc-postgresql-catalog.md#table-column-types) |
-| `doris` | [Doris table
property](./jdbc-doris-catalog.md#table-properties) | [Doris type
mapping](./jdbc-doris-catalog.md#table-column-types) |
+| Catalog provider | Table property
| Type mapping
|
+|---------------------|-----------------------------------------------------------------------------|----------------------------------------------------------------------------|
+| `hive` | [Hive table
property](./apache-hive-catalog.md#table-properties) | [Hive type
mapping](./apache-hive-catalog.md#table-column-types) |
+| `lakehouse-iceberg` | [Iceberg table
property](./lakehouse-iceberg-catalog.md#table-properties) | [Iceberg type
mapping](./lakehouse-iceberg-catalog.md#table-column-types) |
+| `lakehouse-paimon` | [Paimon table
property](./lakehouse-paimon-catalog.md#table-properties) | [Paimon type
mapping](./lakehouse-paimon-catalog.md#table-column-types) |
+| `lakehouse-hudi` | [Hudi table
property](./lakehouse-hudi-catalog.md#table-properties) | [Hudi type
mapping](./lakehouse-hudi-catalog.md#table-column-types) |
+| `jdbc-mysql` | [MySQL table
property](./jdbc-mysql-catalog.md#table-properties) | [MySQL type
mapping](./jdbc-mysql-catalog.md#table-column-types) |
+| `jdbc-postgresql` | [PostgreSQL table
property](./jdbc-postgresql-catalog.md#table-properties) | [PostgreSQL type
mapping](./jdbc-postgresql-catalog.md#table-column-types) |
+| `jdbc-doris` | [Doris table
property](./jdbc-doris-catalog.md#table-properties) | [Doris type
mapping](./jdbc-doris-catalog.md#table-column-types) |
+| `jdbc-oceanbase` | [OceanBase table
property](./jdbc-oceanbase-catalog.md#table-properties) | [OceanBase type
mapping](./jdbc-oceanbase-catalog.md#table-column-types) |
#### Table partitioning, distribution, sort ordering and indexes
In addition to the basic settings, Gravitino supports the following features:
-| Feature | Description
| Java
doc
|
-|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
-| Table partitioning | Equal to `PARTITION BY` in Apache Hive, It is a
partitioning strategy that is used to split a table into parts based on
partition keys. Some table engine may not support this feature
|
[Partition](pathname:///docs/0.7.0-incubating/api/java/org/apache/gravitino/dto/rel/partitioning/Partitioning.html)
|
-| Table distribution | Equal to `CLUSTERED BY` in Apache Hive, distribution
a.k.a (Clustering) is a technique to split the data into more manageable
files/parts, (By specifying the number of buckets to create). The value of the
distribution column will be hashed by a user-defined number into buckets.
|
[Distribution](pathname:///docs/0.7.0-incubating/api/java/org/apache/gravitino/rel/expressions/distributions/Distribution.html)
|
-| Table sort ordering | Equal to `SORTED BY` in Apache Hive, sort ordering is
a method to sort the data in specific ways such as by a column or a function,
and then store table data. it will highly improve the query performance under
certain scenarios. |
[SortOrder](pathname:///docs/0.7.0-incubating/api/java/org/apache/gravitino/rel/expressions/sorts/SortOrder.html)
|
-| Table indexes | Equal to `KEY/INDEX` in MySQL , unique key enforces
uniqueness of values in one or more columns within a table. It ensures that no
two rows have identical values in specified columns, thereby facilitating data
integrity and enabling efficient data retrieval and manipulation operations. |
[Index](pathname:///docs/0.7.0-incubating/api/java/org/apache/gravitino/rel/indexes/Index.html)
|
+| Feature | Description
| Java
doc
|
+|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
+| Table partitioning | Equal to `PARTITION BY` in Apache Hive, It is a
partitioning strategy that is used to split a table into parts based on
partition keys. Some table engine may not support this feature
|
[Partition](pathname:///docs/0.8.0-incubating-SNAPSHOT/api/java/org/apache/gravitino/dto/rel/partitioning/Partitioning.html)
|
+| Table distribution | Equal to `CLUSTERED BY` in Apache Hive, distribution
a.k.a (Clustering) is a technique to split the data into more manageable
files/parts, (By specifying the number of buckets to create). The value of the
distribution column will be hashed by a user-defined number into buckets.
|
[Distribution](pathname:///docs/0.8.0-incubating-SNAPSHOT/api/java/org/apache/gravitino/rel/expressions/distributions/Distribution.html)
|
+| Table sort ordering | Equal to `SORTED BY` in Apache Hive, sort ordering is
a method to sort the data in specific ways such as by a column or a function,
and then store table data. it will highly improve the query performance under
certain scenarios. |
[SortOrder](pathname:///docs/0.8.0-incubating-SNAPSHOT/api/java/org/apache/gravitino/rel/expressions/sorts/SortOrder.html)
|
+| Table indexes | Equal to `KEY/INDEX` in MySQL , unique key enforces
uniqueness of values in one or more columns within a table. It ensures that no
two rows have identical values in specified columns, thereby facilitating data
integrity and enabling efficient data retrieval and manipulation operations. |
[Index](pathname:///docs/0.8.0-incubating-SNAPSHOT/api/java/org/apache/gravitino/rel/indexes/Index.html)
|
For more information, please see the related document on [partitioning,
bucketing, sorting, and
indexes](table-partitioning-bucketing-sort-order-indexes.md).
