Skip to content

Commit

Permalink
[MINOR] docs: polish document for spark connector and Iceberg REST se…
Browse files Browse the repository at this point in the history
…rver (#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
  • Loading branch information
FANNG1 authored Sep 10, 2024
1 parent 738cb6c commit f48e9ad
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/iceberg-rest-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
12 changes: 6 additions & 6 deletions docs/manage-relational-metadata-using-gravitino.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/spark-connector/spark-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down

0 comments on commit f48e9ad

Please sign in to comment.