This is an automated email from the ASF dual-hosted git repository.
jshao pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new b795ea2a5 [#4437] improvement(docs): Upgrade Gravitino Java doc
version from 0.5.1 to 0.6.0. (#4438)
b795ea2a5 is described below
commit b795ea2a5e10ca4180e1260b8e463d8b47741eea
Author: Qi Yu <[email protected]>
AuthorDate: Wed Aug 14 20:20:54 2024 +0800
[#4437] improvement(docs): Upgrade Gravitino Java doc version from 0.5.1 to
0.6.0. (#4438)
### What changes were proposed in this pull request?
Change the Gravitino Java doc from 0.5.1 to 0.6.0.
### Why are the changes needed?
Gravitino 0.6.0 will be released soon.
Fix: #4437
### Does this PR introduce _any_ user-facing change?
N/A.
### How was this patch tested?
N/A.
---
dev/release/update-java-doc-version.sh | 49 ++++++++++++++++++++++
docs/index.md | 4 +-
docs/manage-relational-metadata-using-gravitino.md | 10 ++---
3 files changed, 56 insertions(+), 7 deletions(-)
diff --git a/dev/release/update-java-doc-version.sh
b/dev/release/update-java-doc-version.sh
new file mode 100755
index 000000000..71f4bbc91
--- /dev/null
+++ b/dev/release/update-java-doc-version.sh
@@ -0,0 +1,49 @@
+#!/bin/bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+set -e
+
+if [[ $# -ne 1 ]]; then
+ echo "Usage: $0 <new_version>"
+ exit 1
+fi
+
+NEW_VERSION=$1
+cd "$(cd "$(dirname "$0")" && pwd)/../docs"
+CURRENT_VERSION=`cat index.md| grep pathname:///docs | head -n 1 | awk -F
'///docs' '{print $2}' | awk -F '/' '{print $2}'`
+
+if [[ "${NEW_VERSION}" == "${CURRENT_VERSION}" ]]; then
+ echo "The new version is the same as the current version."
+ exit 1
+fi
+
+# Detect the operating system
+if [[ "$OSTYPE" == "darwin"* ]]; then
+ # macOS
+ find "$(pwd)" -name "*.md" | xargs sed -i ''
"s|/docs/${CURRENT_VERSION}/api|/docs/${NEW_VERSION}/api|g"
+elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
+ # Linux
+ find "$(pwd)" -name "*.md" | xargs sed -i
"s|/docs/${CURRENT_VERSION}/api|/docs/${NEW_VERSION}/api|g"
+else
+ echo "Unsupported OS"
+ exit 1
+fi
+
+echo "Update the version from ${CURRENT_VERSION} to ${NEW_VERSION}
successfully."
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
index fb73ca18f..748767bf7 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -59,7 +59,7 @@ REST API and the Java SDK. You can use either to manage
metadata. See
Also, you can find the complete REST API definition in
[Gravitino Open API](./api/rest/gravitino-rest-api), and the
-Java SDK definition in [Gravitino
Javadoc](pathname:///docs/0.5.1/api/java/index.html).
+Java SDK definition in [Gravitino
Javadoc](pathname:///docs/0.6.0/api/java/index.html).
Gravitino provides a web UI to manage the metadata. Visit the web UI in the
browser via `http://<ip-address>:8090`. See [Gravitino web UI](./webui.md) for
details.
@@ -153,7 +153,7 @@ Gravitino provides several ways to configure and manage the
Gravitino server. Se
* [Gravitino Open API](./api/rest/gravitino-rest-api): provides the complete
Open API definition of
Gravitino.
-* [Gravitino Javadoc](pathname:///docs/0.5.1/api/java/index.html): provides
the Javadoc for the Gravitino API.
+* [Gravitino Javadoc](pathname:///docs/0.6.0/api/java/index.html): provides
the Javadoc for the Gravitino API.
### Development guides
diff --git a/docs/manage-relational-metadata-using-gravitino.md
b/docs/manage-relational-metadata-using-gravitino.md
index 8e06fa142..6f6b6bcff 100644
--- a/docs/manage-relational-metadata-using-gravitino.md
+++ b/docs/manage-relational-metadata-using-gravitino.md
@@ -734,7 +734,7 @@ The following types that Gravitino supports:
| Union | `Types.UnionType.of([type1, type2, ...])`
| `{"type": "union", "types": [type JSON, ...]}`
| Union type, indicates a union of types
|
| UUID | `Types.UUIDType.get()`
| `uuid`
| UUID type, indicates a universally unique identifier
|
-The related java doc is
[here](pathname:///docs/0.5.1/api/java/org/apache/gravitino/rel/types/Type.html).
+The related java doc is
[here](pathname:///docs/0.6.0/api/java/org/apache/gravitino/rel/types/Type.html).
##### External type
@@ -836,10 +836,10 @@ 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.5.1/api/java/org/apache/gravitino/dto/rel/partitioning/Partitioning.html)
|
-| Table bucketing | Equal to `CLUSTERED BY` in Apache Hive, Bucketing
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
bucketing column will be hashed by a user-defined number into buckets.
|
[Distribution](pathname:///docs/0.5.1/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.5.1/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.5.1/api/java/org/apache/gravitino/rel/indexes/Index.html)
|
+| 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.6.0/api/java/org/apache/gravitino/dto/rel/partitioning/Partitioning.html)
|
+| Table bucketing | Equal to `CLUSTERED BY` in Apache Hive, Bucketing
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
bucketing column will be hashed by a user-defined number into buckets.
|
[Distribution](pathname:///docs/0.6.0/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.6.0/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.6.0/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).
