From f48e9ad529ced9125199820d7dbdc157a884d41d Mon Sep 17 00:00:00 2001 From: FANNG Date: Wed, 11 Sep 2024 00:58:09 +0800 Subject: [PATCH] [MINOR] docs: polish document for spark connector and Iceberg REST server (#4899) ### What changes were proposed in this pull request? polish document for spark connector and Iceberg REST server ### Why are the changes needed? Fix: # (issue) ### Does this PR introduce _any_ user-facing change? no ### How was this patch tested? just document --- docs/iceberg-rest-service.md | 2 +- docs/manage-relational-metadata-using-gravitino.md | 12 ++++++------ docs/spark-connector/spark-connector.md | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/iceberg-rest-service.md b/docs/iceberg-rest-service.md index 1d8a20c40fa..ab16feba93e 100644 --- a/docs/iceberg-rest-service.md +++ b/docs/iceberg-rest-service.md @@ -28,7 +28,7 @@ The Apache Gravitino Iceberg REST Server follows the [Apache Iceberg REST API sp ## Server management There are three deployment scenarios for Gravitino Iceberg REST server: -- A standalone server with a standalone Gravitino Iceberg REST server package. +- A standalone server in a standalone Gravitino Iceberg REST server package. - A standalone server in the Gravitino server package. - An auxiliary service embedded in the Gravitino server. diff --git a/docs/manage-relational-metadata-using-gravitino.md b/docs/manage-relational-metadata-using-gravitino.md index 228be9f7a53..a5d4d44ece6 100644 --- a/docs/manage-relational-metadata-using-gravitino.md +++ b/docs/manage-relational-metadata-using-gravitino.md @@ -162,12 +162,12 @@ Catalog catalog = gravitinoClient.alterCatalog("catalog", Currently, Gravitino supports the following changes to a catalog: -| Supported modification | JSON | Java | -|------------------------|--------------------------------------------------------------|------------------------------------------------| -| Rename metalake | `{"@type":"rename","newName":"metalake_renamed"}` | `CatalogChange.rename("catalog_renamed")` | -| Update comment | `{"@type":"updateComment","newComment":"new_comment"}` | `CatalogChange.updateComment("new_comment")` | -| Set a property | `{"@type":"setProperty","property":"key1","value":"value1"}` | `CatalogChange.setProperty("key1", "value1")` | -| Remove a property | `{"@type":"removeProperty","property":"key1"}` | `CatalogChange.removeProperty("key1")` | +| Supported modification | JSON | Java | +|------------------------|--------------------------------------------------------------|-----------------------------------------------| +| Rename catalog | `{"@type":"rename","newName":"catalog_renamed"}` | `CatalogChange.rename("catalog_renamed")` | +| Update comment | `{"@type":"updateComment","newComment":"new_comment"}` | `CatalogChange.updateComment("new_comment")` | +| Set a property | `{"@type":"setProperty","property":"key1","value":"value1"}` | `CatalogChange.setProperty("key1", "value1")` | +| Remove a property | `{"@type":"removeProperty","property":"key1"}` | `CatalogChange.removeProperty("key1")` | :::warning diff --git a/docs/spark-connector/spark-connector.md b/docs/spark-connector/spark-connector.md index c0c5b168401..44179e05f55 100644 --- a/docs/spark-connector/spark-connector.md +++ b/docs/spark-connector/spark-connector.md @@ -27,7 +27,7 @@ Gravitino Spark connector doesn't support Scala 2.13 for Spark3.3. ## How to use it -1. [Build](../how-to-build.md) or download ([gravitino-spark-connector-runtime-3.3](https://mvnrepository.com/artifact/org.apache.gravitino/gravitino-spark-connector-runtime-3.3), [gravitino-spark-connector-runtime-3.4](https://mvnrepository.com/artifact/org.apache.gravitino/gravitino-spark-connector-runtime-3.4), [gravitino-spark-connector-runtime-3.5](https://mvnrepository.com/artifact/org.apache.gravitino/gravitino-spark-connector-runtime-3.5)) (https://mvnrepository.com/artifact/org.apache.gravitino/spark-connector-runtime), and place it to the classpath of Spark. +1. [Build](../how-to-build.md) or download the package ([gravitino-spark-connector-runtime-3.3](https://mvnrepository.com/artifact/org.apache.gravitino/gravitino-spark-connector-runtime-3.3), [gravitino-spark-connector-runtime-3.4](https://mvnrepository.com/artifact/org.apache.gravitino/gravitino-spark-connector-runtime-3.4), [gravitino-spark-connector-runtime-3.5](https://mvnrepository.com/artifact/org.apache.gravitino/gravitino-spark-connector-runtime-3.5)), and place it to the classpath of Spark. 2. Configure the Spark session to use the Gravitino spark connector. | Property | Type | Default Value | Description | Required | Since Version |