This is an automated email from the ASF dual-hosted git repository.
jshao pushed a commit to branch branch-0.6
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/branch-0.6 by this push:
new 82cbfbd17 [Minor] improvement(docs): Polish docs (#4537)
82cbfbd17 is described below
commit 82cbfbd178726a7f7f9365bc9a93d51ed7923a3b
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Thu Aug 15 17:33:58 2024 +0800
[Minor] improvement(docs): Polish docs (#4537)
### What changes were proposed in this pull request?
Refine docs as we are going to release version 0.6.0-incubating.
### Why are the changes needed?
Better user experience.
### Does this PR introduce _any_ user-facing change?
N/A
### How was this patch tested?
N/A
Co-authored-by: Qi Yu <[email protected]>
---
docs/how-to-use-relational-backend-storage.md | 15 +++++++++------
docs/manage-relational-metadata-using-gravitino.md | 2 +-
docs/manage-tags-in-gravitino.md | 2 +-
3 files changed, 11 insertions(+), 8 deletions(-)
diff --git a/docs/how-to-use-relational-backend-storage.md
b/docs/how-to-use-relational-backend-storage.md
index 0ccb57f6b..cc282d9d7 100644
--- a/docs/how-to-use-relational-backend-storage.md
+++ b/docs/how-to-use-relational-backend-storage.md
@@ -6,9 +6,8 @@ license: "This software is licensed under the Apache License
version 2."
## Introduction
-Before the version `0.5.0`, Apache Gravitino only supports KV backend storage
to store metadata. Since
-RDBMS is widely used in the industry, starting from the version `0.5.0`,
Gravitino 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`, 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
relational backend storage in Gravitino.
Relational backend storage mainly aims to the users who are accustomed to
using RDBMS to
@@ -17,12 +16,12 @@ store data or lack available a KV storage, and want to use
Gravitino.
With relational backend storage, you can quickly deploy Gravitino in a
production environment and
take advantage of relational storage to manage metadata.
-### What kind of backend storage are supported
+### What kind of backend storage is supported
-Currently, relational backend storage supports the `JDBCBackend`, and uses
`MySQL` as the
+Currently, relational backend storage supports the `JDBCBackend`, and `MySQL`
and `H2` are supported currently for `JDBCBackend`, `H2` is the
default storage for `JDBCBackend`.
-## How to use
+## How to use MySQL
### Prerequisites
@@ -87,3 +86,7 @@ Finally, you can run the script in the distribution package
directory to start t
```shell
./${GRAVITINO_HOME}/bin/gravitino.sh start
```
+
+## How to use H2
+
+As mentioned above, `H2` is the default storage for `JDBCBackend`, so you can
use `H2` directly without any additional configuration.
\ No newline at end of file
diff --git a/docs/manage-relational-metadata-using-gravitino.md
b/docs/manage-relational-metadata-using-gravitino.md
index 27333ec9e..6b9bda300 100644
--- a/docs/manage-relational-metadata-using-gravitino.md
+++ b/docs/manage-relational-metadata-using-gravitino.md
@@ -21,7 +21,7 @@ For more details, please refer to the related doc.
- [**Apache Hive**](./apache-hive-catalog.md)
- [**MySQL**](./jdbc-mysql-catalog.md)
- [**PostgreSQL**](./jdbc-postgresql-catalog.md)
-- [**Doris**](./jdbc-doris-catalog.md)
+- [**Apache Doris**](./jdbc-doris-catalog.md)
- [**Apache Iceberg**](./lakehouse-iceberg-catalog.md)
Assuming:
diff --git a/docs/manage-tags-in-gravitino.md b/docs/manage-tags-in-gravitino.md
index 0f04726df..a02bf4faf 100644
--- a/docs/manage-tags-in-gravitino.md
+++ b/docs/manage-tags-in-gravitino.md
@@ -83,7 +83,7 @@ curl -X GET -H "Accept: application/vnd.gravitino.v1+json" \
http://localhost:8090/api/metalakes/test/tags
curl -X GET -H "Accept: application/vnd.gravitino.v1+json" \
-http://localhost:8090/api/metalakes/test/tags?detailed=true
+http://localhost:8090/api/metalakes/test/tags?details=true
```
</TabItem>
