Skip to content

Commit

Permalink
[MINOR] fix(docs): change version info from 0.6.0 to 0.6.0-incubating (…
Browse files Browse the repository at this point in the history 
…#5111)

### What changes were proposed in this pull request?

change version info from 0.6.0 to 0.6.0-incubating

### Why are the changes needed?

Version 0.6.0 is inaccurate.

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

no

### How was this patch tested?

no need

---------

Co-authored-by: mchades <liminghuang@datastrato.com>
  • Loading branch information
@github-actions @mchades
github-actions[bot] and mchades authored Oct 11, 2024
1 parent f3dd643 commit 9298b8f
Show file tree
Hide file tree
Showing 12 changed files with 112 additions and 114 deletions.
4 changes: 2 additions & 2 deletions MAINTAINERS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ something like that, all PRs should have related issues.
6. After PR is merged, please check the related issue:
- If the issue is not closed, please close it as fixed manually.
- Assign the issue "Assignees" to the PR author.
- Starting from 0.6.0, we will use the "labels" to manage the release versions, so please add
the corresponding labels to the issue. For example, if the issue is fixed in 0.6.0, please
- Starting from 0.6.0-incubating, we will use the "labels" to manage the release versions, so please add
the corresponding labels to the issue. For example, if the issue is fixed in 0.6.0-incubating, please
add the label "0.6.0". If the issue is fixed both in 0.6.0 and 0.5.1, please add both labels.

## Policy on backporting bug fixes
Expand Down
2 changes: 1 addition & 1 deletion docs/apache-hive-catalog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ The following table lists the data types mapped from the Hive catalog to Graviti
| `uniontype` | `union` | 0.2.0 |

:::info
Since 0.6.0, 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 from the Hive catalog.
Since 0.6.0-incubating, 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 from the Hive catalog.
:::

### Table properties
Expand Down
67 changes: 33 additions & 34 deletions docs/gravitino-server-config.md
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/hadoop-catalog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,13 @@ The Hadoop catalog supports creating, updating, deleting, and listing schema.

### Schema properties

| Property name | Description | Default value | Required | Since Version |
|----------------------------------------------------|----------------------------------------------------------------------------------------------------------------|---------------------------|----------|-----------------|
| `location` | The storage location managed by Hadoop schema. | (none) | No | 0.5.0 |
| `authentication.impersonation-enable` | Whether to enable impersonation for this schema of the Hadoop catalog. | The parent(catalog) value | No | 0.6.0 |
| `authentication.type` | The type of authentication for this schema of Hadoop catalog , currently we only support `kerberos`, `simple`. | The parent(catalog) value | No | 0.6.0 |
| `authentication.kerberos.principal` | The principal of the Kerberos authentication for this schema. | The parent(catalog) value | No | 0.6.0 |
| `authentication.kerberos.keytab-uri` | The URI of The keytab for the Kerberos authentication for this scheam. | The parent(catalog) value | No | 0.6.0 |
| Property name | Description | Default value | Required | Since Version |
|---------------------------------------|----------------------------------------------------------------------------------------------------------------|---------------------------|----------|------------------|
| `location` | The storage location managed by Hadoop schema. | (none) | No | 0.5.0 |
| `authentication.impersonation-enable` | Whether to enable impersonation for this schema of the Hadoop catalog. | The parent(catalog) value | No | 0.6.0-incubating |
| `authentication.type` | The type of authentication for this schema of Hadoop catalog , currently we only support `kerberos`, `simple`. | The parent(catalog) value | No | 0.6.0-incubating |
| `authentication.kerberos.principal` | The principal of the Kerberos authentication for this schema. | The parent(catalog) value | No | 0.6.0-incubating |
| `authentication.kerberos.keytab-uri` | The URI of The keytab for the Kerberos authentication for this scheam. | The parent(catalog) value | No | 0.6.0-incubating |

### Schema operations

Expand Down
6 changes: 3 additions & 3 deletions docs/how-to-use-relational-backend-storage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ license: "This software is licensed under the Apache License version 2."

## Introduction

Before the version `0.6.0`, Apache Gravitino supports KV and Relational backend storage to store metadata.
Since 0.6.0, Gravitino only supports using RDBMS as relational backend storage to store metadata. This doc will guide you on how to use the
Before the version `0.6.0-incubating`, Apache Gravitino supports KV and Relational backend storage to store metadata.
Since 0.6.0-incubating, Gravitino only supports using RDBMS as relational backend storage to store metadata. This doc will guide you on how to use the
relational backend storage in Gravitino.

Relational backend storage mainly aims to the users who are accustomed to using RDBMS to
Expand Down Expand Up @@ -41,7 +41,7 @@ ${GRAVITINO_HOME}/scripts/mysql/
```

The script name is like `schema-{version}-mysql.sql`, and the `version` depends on your Gravitino version.
For example, if your Gravitino version is `0.6.0`, then you can choose the **latest version** script.
For example, if your Gravitino version is `0.6.0-incubating`, then you can choose the **latest version** script.
If you used a legacy script, you can use `upgrade-{old version}-to-{new version}-mysql.sql` to upgrade the schema.

### Step 2: Initialize the database
Expand Down
2 changes: 1 addition & 1 deletion docs/iceberg-rest-service.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ For detailed instructions on how to build and install the Gravitino server packa

There are distinct configuration files for standalone and auxiliary server: `gravitino-iceberg-rest-server.conf` is used for the standalone server, while `gravitino.conf` is for the auxiliary server. Although the configuration files differ, the configuration items remain the same.

Starting with version `0.6.0`, the prefix `gravitino.auxService.iceberg-rest.` for auxiliary server configurations has been deprecated. If both `gravitino.auxService.iceberg-rest.key` and `gravitino.iceberg-rest.key` are present, the latter will take precedence. The configurations listed below use the `gravitino.iceberg-rest.` prefix.
Starting with version `0.6.0-incubating`, the prefix `gravitino.auxService.iceberg-rest.` for auxiliary server configurations has been deprecated. If both `gravitino.auxService.iceberg-rest.key` and `gravitino.iceberg-rest.key` are present, the latter will take precedence. The configurations listed below use the `gravitino.iceberg-rest.` prefix.

### Configuration to enable Iceberg REST service in Gravitino server.

Expand Down
20 changes: 10 additions & 10 deletions docs/jdbc-doris-catalog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,16 @@ more details.

Besides the [common catalog properties](./gravitino-server-config.md#gravitino-catalog-properties-configuration), the Doris catalog has the following properties:

| Configuration item | Description | Default value | Required | Since Version |
|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|----------|---------------|
| `jdbc-url` | JDBC URL for connecting to the database. For example, `jdbc:mysql://localhost:9030` | (none) | Yes | 0.5.0 |
| `jdbc-driver` | The driver of the JDBC connection. For example, `com.mysql.jdbc.Driver`. | (none) | Yes | 0.5.0 |
| `jdbc-user` | The JDBC user name. | (none) | Yes | 0.5.0 |
| `jdbc-password` | The JDBC password. | (none) | Yes | 0.5.0 |
| `jdbc.pool.min-size` | The minimum number of connections in the pool. `2` by default. | `2` | No | 0.5.0 |
| `jdbc.pool.max-size` | The maximum number of connections in the pool. `10` by default. | `10` | No | 0.5.0 |
| `jdbc.pool.max-size` | The maximum number of connections in the pool. `10` by default. | `10` | No | 0.5.0 |
| `replication_num` | The number of replications for the table. If not specified and the number of backend servers less than 3, then the default value is 1; If not specified and the number of backend servers greater or equals to 3, the default value (3) in Doris server will be used. For more, please see the [doc](https://doris.apache.org/docs/1.2/sql-manual/sql-reference/Data-Definition-Statements/Create/CREATE-TABLE/) | `1` or `3` | No | 0.6.0 |
| Configuration item | Description | Default value | Required | Since Version |
|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|----------|------------------|
| `jdbc-url` | JDBC URL for connecting to the database. For example, `jdbc:mysql://localhost:9030` | (none) | Yes | 0.5.0 |
| `jdbc-driver` | The driver of the JDBC connection. For example, `com.mysql.jdbc.Driver`. | (none) | Yes | 0.5.0 |
| `jdbc-user` | The JDBC user name. | (none) | Yes | 0.5.0 |
| `jdbc-password` | The JDBC password. | (none) | Yes | 0.5.0 |
| `jdbc.pool.min-size` | The minimum number of connections in the pool. `2` by default. | `2` | No | 0.5.0 |
| `jdbc.pool.max-size` | The maximum number of connections in the pool. `10` by default. | `10` | No | 0.5.0 |
| `jdbc.pool.max-size` | The maximum number of connections in the pool. `10` by default. | `10` | No | 0.5.0 |
| `replication_num` | The number of replications for the table. If not specified and the number of backend servers less than 3, then the default value is 1; If not specified and the number of backend servers greater or equals to 3, the default value (3) in Doris server will be used. For more, please see the [doc](https://doris.apache.org/docs/1.2/sql-manual/sql-reference/Data-Definition-Statements/Create/CREATE-TABLE/) | `1` or `3` | No | 0.6.0-incubating |
Before using the Doris Catalog, you must download the corresponding JDBC driver to the `catalogs/jdbc-doris/libs` directory.
Gravitino doesn't package the JDBC driver for Doris due to licensing issues.

Expand Down
42 changes: 21 additions & 21 deletions docs/jdbc-mysql-catalog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,30 +87,30 @@ Refer to [Manage Relational Metadata Using Gravitino](./manage-relational-metada

#### Table column types

| Gravitino Type | MySQL Type |
|------------------|---------------------|
| `Byte` | `Tinyint` |
| `Byte(false)` | `Tinyint Unsigned` |
| `Short` | `Smallint` |
| `Short(false)` | `Smallint Unsigned` |
| `Integer` | `Int` |
| `Integer(false)` | `Int Unsigned` |
| `Long` | `Bigint` |
| `Long(false)` | `Bigint Unsigned` |
| `Float` | `Float` |
| `Double` | `Double` |
| `String` | `Text` |
| `Date` | `Date` |
| `Time` | `Time` |
| `Timestamp` | `Timestamp` |
| `Decimal` | `Decimal` |
| `VarChar` | `VarChar` |
| `FixedChar` | `FixedChar` |
| `Binary` | `Binary` |
| Gravitino Type | MySQL Type |
|--------------------|---------------------|
| `Byte` | `Tinyint` |
| `Unsigned Byte` | `Tinyint Unsigned` |
| `Short` | `Smallint` |
| `Unsigned Short` | `Smallint Unsigned` |
| `Integer` | `Int` |
| `Unsigned Integer` | `Int Unsigned` |
| `Long` | `Bigint` |
| `Unsigned Long` | `Bigint Unsigned` |
| `Float` | `Float` |
| `Double` | `Double` |
| `String` | `Text` |
| `Date` | `Date` |
| `Time` | `Time` |
| `Timestamp` | `Timestamp` |
| `Decimal` | `Decimal` |
| `VarChar` | `VarChar` |
| `FixedChar` | `FixedChar` |
| `Binary` | `Binary` |

:::info
MySQL doesn't support Gravitino `Boolean` `Fixed` `Struct` `List` `Map` `Timestamp_tz` `IntervalDay` `IntervalYear` `Union` `UUID` type.
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.
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
Expand Down
2 changes: 1 addition & 1 deletion docs/jdbc-postgresql-catalog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Please refer to [Manage Relational Metadata Using Gravitino](./manage-relational

:::info
PostgreSQL doesn't support Gravitino `Fixed` `Struct` `Map` `IntervalDay` `IntervalYear` `Union` `UUID` type.
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.
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
Expand Down
Loading

0 comments on commit 9298b8f

Please sign in to comment.