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 014371bfb4 [MINOR] fix(docs): Fix typo and format problems in docs
(#8590)
014371bfb4 is described below
commit 014371bfb4487f7930728be8c0955918ac440694
Author: Mini Yu <[email protected]>
AuthorDate: Thu Sep 18 11:09:36 2025 +0800
[MINOR] fix(docs): Fix typo and format problems in docs (#8590)
### What changes were proposed in this pull request?
Fix typo and format problems in docs
### Why are the changes needed?
for better user experience.
### Does this PR introduce _any_ user-facing change?
N/A
### How was this patch tested?
N/A
---
docs/docker-image-details.md | 2 +-
docs/fileset-catalog-with-adls.md | 2 +-
docs/fileset-catalog-with-oss.md | 2 +-
docs/gravitino-mcp-server.md | 2 +-
docs/lakehouse-iceberg-catalog.md | 12 ++++++------
docs/lakehouse-paimon-catalog.md | 20 ++++++++++----------
docs/manage-fileset-metadata-using-gravitino.md | 2 +-
docs/manage-metalake-using-gravitino.md | 12 ++++++------
docs/manage-model-metadata-using-gravitino.md | 2 +-
docs/manage-relational-metadata-using-gravitino.md | 4 ++--
docs/manage-statistics-in-gravitino.md | 6 +++---
11 files changed, 33 insertions(+), 33 deletions(-)
diff --git a/docs/docker-image-details.md b/docs/docker-image-details.md
index 626a7ff0eb..1ec780ce92 100644
--- a/docs/docker-image-details.md
+++ b/docs/docker-image-details.md
@@ -429,7 +429,7 @@ Changelog
- Use `docker exec -it <container_id> bash` to enter the docker container.
- Add these context `export
JAVA_OPTS=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5001`
into
`/opt/ranger-admin/ews/webapp/WEB-INF/classes/conf/ranger-admin-env-debug.sh`
in the docker container.
- Execute `./opt/ranger-admin/stop-ranger-admin.sh` and
`./opt/ranger-admin/start-ranger-admin.sh` to restart Ranger admin.
- - Clone the `Apache Ranger` project from GiHub and checkout the `2.4.0`
release.
+ - Clone the `Apache Ranger` project from GitHub and checkout the `2.4.0`
release.
- Create a remote debug configuration (`Use model classpath` =
`EmbeddedServer`) in your IDE and connect to the Ranger admin container.
- datastrato/gravitino-ci-ranger:0.1.0
diff --git a/docs/fileset-catalog-with-adls.md
b/docs/fileset-catalog-with-adls.md
index 089d2454b0..fe03a83a7c 100644
--- a/docs/fileset-catalog-with-adls.md
+++ b/docs/fileset-catalog-with-adls.md
@@ -541,7 +541,7 @@ Spark:
```python
spark = SparkSession.builder
- .appName("adls_fielset_test")
+ .appName("adls_fileset_test")
.config("spark.hadoop.fs.gravitino.enableCredentialVending", "true")
.config("spark.hadoop.fs.AbstractFileSystem.gvfs.impl",
"org.apache.gravitino.filesystem.hadoop.Gvfs")
.config("spark.hadoop.fs.gvfs.impl",
"org.apache.gravitino.filesystem.hadoop.GravitinoVirtualFileSystem")
diff --git a/docs/fileset-catalog-with-oss.md b/docs/fileset-catalog-with-oss.md
index 43dcbef922..471b16c11d 100644
--- a/docs/fileset-catalog-with-oss.md
+++ b/docs/fileset-catalog-with-oss.md
@@ -482,7 +482,7 @@ The following are examples of how to use the pandas library
to access the OSS fi
import pandas as pd
storage_options = {
- "server_uri": "http://localhost:8090";,
+ "server_uri": "http://mini.io:9000";,
"metalake_name": "test",
"options": {
"oss_access_key_id": "access_key",
diff --git a/docs/gravitino-mcp-server.md b/docs/gravitino-mcp-server.md
index 7eed314e68..9c080e056b 100644
--- a/docs/gravitino-mcp-server.md
+++ b/docs/gravitino-mcp-server.md
@@ -39,7 +39,7 @@ Gravitino MCP server provides the ability to manage Gravitino
metadata for LLM.
}
```
-Or start a HTTP MCP server by `uv run mcp_server --metalake test --uri
http://127.0.0.1:8090 --transport http --mcp-url http://localhost:8000/mcp`,
and use the configuration:
+Or start an HTTP MCP server by `uv run mcp_server --metalake test --uri
http://127.0.0.1:8090 --transport http --mcp-url http://localhost:8000/mcp`,
and use the configuration:
```json
{
diff --git a/docs/lakehouse-iceberg-catalog.md
b/docs/lakehouse-iceberg-catalog.md
index db3cdf676b..7138a49e78 100644
--- a/docs/lakehouse-iceberg-catalog.md
+++ b/docs/lakehouse-iceberg-catalog.md
@@ -33,12 +33,12 @@ Builds with Apache Iceberg `1.9.2`. The Apache Iceberg
table format version is `
### Catalog properties
-| Property name | Description
| Default value
| Required
| Since Version |
-|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|-------------------------------------------------------------|---------------|
-| `catalog-backend` | Catalog backend of
Gravitino Iceberg catalog. Supports `hive` or `jdbc` or `rest`.
| (none)
| Yes
| 0.2.0 |
-| `uri` | The URI configuration
of the Iceberg catalog. `thrift://127.0.0.1:9083` or
`jdbc:postgresql://127.0.0.1:5432/db_name` or
`jdbc:mysql://127.0.0.1:3306/metastore_db` or `http://127.0.0.1:9001`.
| (none)
| Yes
| 0.2.0 |
-| `warehouse` | Warehouse directory of
catalog. `file:///user/hive/warehouse-hive/` for local fs or
`hdfs://namespace/hdfs/path` for HDFS.
|
(none)
| Yes | 0.2.0 |
-| `catalog-backend-name` | The catalog name passed
to underlying Iceberg catalog backend. Catalog name in JDBC backend is used to
isolate namespace and tables.
| The property value
of `catalog-backend`, like `jdbc` for JDBC catalog backend. | No
| 0.5.2 |
+| Property name | Description
| Default value
| Required | Since
Version |
+|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|----------|---------------|
+| `catalog-backend` | Catalog backend of Gravitino Iceberg catalog.
Supports `hive` or `jdbc` or `rest`.
| (none)
| Yes |
0.2.0 |
+| `uri` | The URI configuration of the Iceberg catalog.
`thrift://127.0.0.1:9083` or `jdbc:postgresql://127.0.0.1:5432/db_name` or
`jdbc:mysql://127.0.0.1:3306/metastore_db` or `http://127.0.0.1:9001`. | (none)
| Yes
| 0.2.0 |
+| `warehouse` | Warehouse directory of catalog.
`file:///user/hive/warehouse-hive/` for local fs or
`hdfs://namespace/hdfs/path` for HDFS.
| (none)
| Yes | 0.2.0 |
+| `catalog-backend-name` | The catalog name passed to underlying Iceberg
catalog backend. Catalog name in JDBC backend is used to isolate namespace and
tables. | The
property value of `catalog-backend`, like `jdbc` for JDBC catalog backend. | No
| 0.5.2 |
Any property not defined by Gravitino with `gravitino.bypass.` prefix will
pass to Iceberg catalog properties and HDFS configuration. For example, if
specify `gravitino.bypass.list-all-tables`, `list-all-tables` will pass to
Iceberg catalog properties.
diff --git a/docs/lakehouse-paimon-catalog.md b/docs/lakehouse-paimon-catalog.md
index 52b8ba5036..1289708fae 100644
--- a/docs/lakehouse-paimon-catalog.md
+++ b/docs/lakehouse-paimon-catalog.md
@@ -192,16 +192,16 @@ You can pass [Paimon table
properties](https://paimon.apache.org/docs/0.8/mainte
**Immutable**: Fields that cannot be modified once set.
:::
-| Configuration item | Description
| Default Value | Required | Reserved | Immutable | Since
version |
-|------------------------------------|--------------------------------------------------------------|---------------|-----------|----------|-----------|-------------------|
-| `merge-engine` | The table merge-engine.
| (none) | No | No | Yes |
0.6.0-incubating |
-| `sequence.field` | The table sequence.field.
| (none) | No | No | Yes |
0.6.0-incubating |
-| `rowkind.field` | The table rowkind.field.
| (none) | No | No | Yes |
0.6.0-incubating |
-| `comment` | The table comment.
| (none) | No | Yes | No |
0.6.0-incubating |
-| `owner` | The table owner.
| (none) | No | Yes | No |
0.6.0-incubating |
-| `bucket-key` | The table bucket-key.
| (none) | No | Yes | No |
0.6.0-incubating |
-| `primary-key` | The table primary-key.
| (none) | No | Yes | No |
0.6.0-incubating |
-| `partition` | The table partition.
| (none) | No | Yes | No |
0.6.0-incubating |
+| Configuration item | Description | Default Value | Required |
Reserved | Immutable | Since version |
+|--------------------|---------------------------|---------------|-----------|----------|-----------|-------------------|
+| `merge-engine` | The table merge-engine. | (none) | No |
No | Yes | 0.6.0-incubating |
+| `sequence.field` | The table sequence.field. | (none) | No |
No | Yes | 0.6.0-incubating |
+| `rowkind.field` | The table rowkind.field. | (none) | No |
No | Yes | 0.6.0-incubating |
+| `comment` | The table comment. | (none) | No |
Yes | No | 0.6.0-incubating |
+| `owner` | The table owner. | (none) | No |
Yes | No | 0.6.0-incubating |
+| `bucket-key` | The table bucket-key. | (none) | No |
Yes | No | 0.6.0-incubating |
+| `primary-key` | The table primary-key. | (none) | No |
Yes | No | 0.6.0-incubating |
+| `partition` | The table partition. | (none) | No |
Yes | No | 0.6.0-incubating |
### Table operations
diff --git a/docs/manage-fileset-metadata-using-gravitino.md
b/docs/manage-fileset-metadata-using-gravitino.md
index 79929d6e95..0b666eb38f 100644
--- a/docs/manage-fileset-metadata-using-gravitino.md
+++ b/docs/manage-fileset-metadata-using-gravitino.md
@@ -697,7 +697,7 @@ gravitino_client: GravitinoClient =
GravitinoClient(uri="http://localhost:8090";,
catalog: Catalog = gravitino_client.load_catalog(name="catalog")
changes = (
FilesetChange.remove_property("fileset_properties_key1"),
- FilesetChange.set_property("fileset_properties_key2",
"fileset_propertie_new_value"),
+ FilesetChange.set_property("fileset_properties_key2",
"fileset_properties_new_value"),
)
fileset_new =
catalog.as_fileset_catalog().alter_fileset(NameIdentifier.of("schema",
"fileset"),
*changes)
diff --git a/docs/manage-metalake-using-gravitino.md
b/docs/manage-metalake-using-gravitino.md
index ae15bbbb15..098a0c4cc0 100644
--- a/docs/manage-metalake-using-gravitino.md
+++ b/docs/manage-metalake-using-gravitino.md
@@ -144,12 +144,12 @@ metalake =
gravitino_admin_client.alter_metalake("metalake", *changes)
The following table outlines the supported modifications that you can make to
a metalake:
-| Supported modification | JSON
| Java | Python
|
-|------------------------|--------------------------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------------------------|
-| Rename metalake | `{"@type":"rename","newName":"metalake_renamed"}`
| `MetalakeChange.rename("metalake_renamed")` |
`MetalakeChange.rename("metalake_renamed")`
|
-| Update comment |
`{"@type":"updateComment","newComment":"new_comment"}` |
`MetalakeChange.updateComment("new_comment")` |
`MetalakeChange.update_comment("new_comment")`
|
-| Set property |
`{"@type":"setProperty","property":"key1","value":"value1"}` |
`MetalakeChange.setProperty("key1", "value1")` |
`MetalakeChange.set_property("key1", "value1")` |
-| Remove property | `{"@type":"removeProperty","property":"key1"}`
| `MetalakeChange.removeProperty("key1")` |
`MetalakeChange.remove_property("key1")` |
+| Supported modification | JSON
| Java | Python
|
+|------------------------|--------------------------------------------------------------|------------------------------------------------|-------------------------------------------------|
+| Rename metalake | `{"@type":"rename","newName":"metalake_renamed"}`
| `MetalakeChange.rename("metalake_renamed")` |
`MetalakeChange.rename("metalake_renamed")` |
+| Update comment |
`{"@type":"updateComment","newComment":"new_comment"}` |
`MetalakeChange.updateComment("new_comment")` |
`MetalakeChange.update_comment("new_comment")` |
+| Set property |
`{"@type":"setProperty","property":"key1","value":"value1"}` |
`MetalakeChange.setProperty("key1", "value1")` |
`MetalakeChange.set_property("key1", "value1")` |
+| Remove property | `{"@type":"removeProperty","property":"key1"}`
| `MetalakeChange.removeProperty("key1")` |
`MetalakeChange.remove_property("key1")` |
## Enable a metalake
diff --git a/docs/manage-model-metadata-using-gravitino.md
b/docs/manage-model-metadata-using-gravitino.md
index 494e5f1c6e..6190595c69 100644
--- a/docs/manage-model-metadata-using-gravitino.md
+++ b/docs/manage-model-metadata-using-gravitino.md
@@ -403,7 +403,7 @@ The following operations are supported for altering a model:
| Operation | JSON Example
| Java Method | Python Method
|
-
|---------------------|------------------------------------------------------------|--------------------------------------------|---------------------------------------------|
+|---------------------|------------------------------------------------------------|--------------------------------------------|---------------------------------------------|
| **Rename model** | `{"@type":"rename","newName":"new_name"}`
| `ModelChange.rename("new_name")` |
`ModelChange.rename("new_name")` |
| **Update comment** | `{"@type":"updateComment","newComment":"new comment"}`
| `ModelChange.updateComment("new comment")` |
`ModelChange.update_comment("new comment")` |
| **Set property** |
`{"@type":"setProperty","property":"key","value":"value"}` |
`ModelChange.setProperty("key", "value")` | `ModelChange.set_property("key",
"value")` |
diff --git a/docs/manage-relational-metadata-using-gravitino.md
b/docs/manage-relational-metadata-using-gravitino.md
index f2c1240afd..224d9a2500 100644
--- a/docs/manage-relational-metadata-using-gravitino.md
+++ b/docs/manage-relational-metadata-using-gravitino.md
@@ -900,8 +900,8 @@ The following types that Gravitino supports:
| String | `Types.StringType.get()`
| `string`
| String type
|
| FixedChar(length) | `Types.FixedCharType.of(length)`
| `char(l)`
| Char type, indicates a fixed-length string
|
| VarChar(length) | `Types.VarCharType.of(length)`
| `varchar(l)`
| Varchar type, indicates a variable-length string, the length is the maximum
length of the string
|
-| Timestamp(p) | `Types.TimestampType.withoutTimeZone(p)`
| `timestamp(p)`
| Timestamp type, indicates a timestamp without timezone, where p is the
precision of fractional seconds (0-12)
|
-| TimestampWithTimezone(p) | `Types.TimestampType.withTimeZone(p)`
| `timestamp_tz(p)`
| Timestamp with timezone type, indicates a timestamp with timezone, where p is
the precision of fractional seconds (0-12)
|
+| Timestamp(p) | `Types.TimestampType.withoutTimeZone(p)`
| `timestamp(p)`
| Timestamp type, indicates a timestamp without timezone, where p is the
precision of fractional seconds (0-12)
|
+| TimestampWithTimezone(p) | `Types.TimestampType.withTimeZone(p)`
| `timestamp_tz(p)`
| Timestamp with timezone type, indicates a timestamp with timezone, where p is
the precision of fractional seconds (0-12)
|
| Date | `Types.DateType.get()`
| `date`
| Date type
|
| Time | `Types.TimeType.withoutTimeZone()`
| `time`
| Time type
|
| IntervalToYearMonth | `Types.IntervalYearType.get()`
| `interval_year`
| Interval type, indicates an interval of year and month
|
diff --git a/docs/manage-statistics-in-gravitino.md
b/docs/manage-statistics-in-gravitino.md
index 45e80829a4..139790fd39 100644
--- a/docs/manage-statistics-in-gravitino.md
+++ b/docs/manage-statistics-in-gravitino.md
@@ -234,9 +234,9 @@ table.dropPartitionStatistics(statisticsToDrop);
### Server configuration
-| Configuration item | Description
| Default value
| Required
| Since version |
-|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|-------------------------------------------------|---------------|
-| `gravitino.stats.partition.storageFactoryClass` | The storage factory
class for partition statistics, which is used to store partition statistics in
the different storage. The
`org.apache.gravitino.stats.storage.MemoryPartitionStatsStorageFactory` can
only be used for testing. |
`org.apache.gravitino.stats.storage.LancePartitionStatisticStorageFactory` |
No | 1.0.0 |
+| Configuration item | Description
| Default value
| Required | Since version |
+|-------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|-----------|---------------|
+| `gravitino.stats.partition.storageFactoryClass` | The storage factory class
for partition statistics, which is used to store partition statistics in the
different storage. The
`org.apache.gravitino.stats.storage.MemoryPartitionStatsStorageFactory` can
only be used for testing. |
`org.apache.gravitino.stats.storage.LancePartitionStatisticStorageFactory` |
No | 1.0.0 |
If you use [Lance](https://lancedb.github.io/lance/) as the partition
statistics storage, you can set the options below, if you have other lance
storage options, you can pass it by adding prefix
`gravitino.stats.partition.storageOption.`.
