This is an automated email from the ASF dual-hosted git repository.
jerryshao 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 7fac44b52e [MINOR] docs: align Markdown table columns (#11456)
7fac44b52e is described below
commit 7fac44b52efd4050e28f458df8346617d3aa4b48
Author: Qi Yu <[email protected]>
AuthorDate: Mon Jun 8 11:23:13 2026 +0800
[MINOR] docs: align Markdown table columns (#11456)
### What changes were proposed in this pull request?
Align Markdown table columns in 20 documentation files. No documentation
content is changed.
### Why are the changes needed?
Several Markdown table rows became misaligned after #11205, making the
source harder to read and maintain.
### Does this PR introduce _any_ user-facing change?
No. This is a documentation formatting-only change.
### How was this patch tested?
- Verified all affected table rows are aligned.
- Verified all changed table cells preserve their original content.
- Ran `git diff --check`.
- Ran Markdown link, heading hierarchy, and heading spacing checks.
---
docs/fileset-catalog-with-adls.md | 12 ++++----
docs/fileset-catalog-with-gcs.md | 10 +++---
docs/fileset-catalog-with-oss.md | 16 +++++-----
docs/fileset-catalog-with-s3.md | 14 ++++-----
docs/fileset-catalog.md | 6 ++--
docs/gravitino-server-config.md | 36 +++++++++++-----------
docs/how-to-use-gvfs.md | 10 +++---
docs/iceberg-rest-service.md | 8 ++---
docs/jdbc-clickhouse-catalog.md | 2 +-
docs/jdbc-doris-catalog.md | 2 +-
docs/lakehouse-generic-lance-table.md | 6 ++--
docs/lakehouse-iceberg-catalog.md | 8 ++---
docs/lakehouse-paimon-catalog.md | 2 +-
docs/lance-rest-service.md | 2 +-
docs/manage-relational-metadata-using-gravitino.md | 2 +-
docs/manage-table-partition-using-gravitino.md | 4 +--
docs/security/authorization-pushdown.md | 2 +-
docs/security/credential-vending.md | 4 +--
.../spark-authentication-with-gravitino.md | 4 +--
...partitioning-distribution-sort-order-indexes.md | 10 +++---
20 files changed, 80 insertions(+), 80 deletions(-)
diff --git a/docs/fileset-catalog-with-adls.md
b/docs/fileset-catalog-with-adls.md
index dd800cc57f..57c5606bf4 100644
--- a/docs/fileset-catalog-with-adls.md
+++ b/docs/fileset-catalog-with-adls.md
@@ -30,12 +30,12 @@ Once the server is up and running, you can proceed to
configure the Fileset cata
Apart from configurations mentioned in
[fileset-catalog-catalog-configuration](./fileset-catalog.md#catalog-properties),
the following properties are required to configure a Fileset catalog with ADLS:
-| Configuration item | Description
[...]
-|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| `filesystem-providers` | (deprecated) The file system providers to
add. Set it to `abs` if it's a Azure Blob Storage fileset, or a comma separated
string that contains `abs` like `oss,abs,s3` to support multiple kinds of
fileset including `abs`.
[...]
-| `default-filesystem-provider` | (deprecated) The name default filesystem
providers of this Fileset catalog if users do not specify the scheme in the
URI. Default value is `builtin-local`, for Azure Blob Storage, if we set this
value, we can omit the prefix 'abfss://' in the location.
[...]
-| `azure-storage-account-name ` | The account name of Azure Blob Storage.
[...]
-| `azure-storage-account-key` | The account key of Azure Blob Storage.
[...]
+| Configuration item | Description
[...]
+|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
+| `filesystem-providers` | (deprecated) The file system providers to
add. Set it to `abs` if it's a Azure Blob Storage fileset, or a comma separated
string that contains `abs` like `oss,abs,s3` to support multiple kinds of
fileset including `abs`.
[...]
+| `default-filesystem-provider` | (deprecated) The name default filesystem
providers of this Fileset catalog if users do not specify the scheme in the
URI. Default value is `builtin-local`, for Azure Blob Storage, if we set this
value, we can omit the prefix 'abfss://' in the location.
[...]
+| `azure-storage-account-name ` | The account name of Azure Blob Storage.
[...]
+| `azure-storage-account-key` | The account key of Azure Blob Storage.
[...]
| `credential-providers` | The credential provider types, separated by
comma, possible value can be `adls-token`, `azure-account-key`. As the default
authentication type is using account name and account key as the above, this
configuration can enable credential vending provided by Gravitino server and
client will no longer need to provide authentication information like
account_name/account_key to access ADLS by GVFS. Once it's set, more
configuration items are needed to make it [...]
:::note
diff --git a/docs/fileset-catalog-with-gcs.md b/docs/fileset-catalog-with-gcs.md
index dbf5ebaf80..84709722ac 100644
--- a/docs/fileset-catalog-with-gcs.md
+++ b/docs/fileset-catalog-with-gcs.md
@@ -30,11 +30,11 @@ Once the server is up and running, you can proceed to
configure the Fileset cata
Apart from configurations mentioned in
[Fileset-catalog-catalog-configuration](./fileset-catalog.md#catalog-properties),
the following properties are required to configure a Fileset catalog with GCS:
-| Configuration item | Description
[...]
-|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| `filesystem-providers` | (deprecated) The file system providers to
add. Set it to `gcs` if it's a GCS fileset, a comma separated string that
contains `gcs` like `gcs,s3` to support multiple kinds of fileset including
`gcs`.
[...]
-| `default-filesystem-provider` | (deprecated) The name default filesystem
providers of this Fileset catalog if users do not specify the scheme in the
URI. Default value is `builtin-local`, for GCS, if we set this value, we can
omit the prefix 'gs://' in the location.
[...]
-| `gcs-service-account-file` | The path of GCS service account JSON file.
[...]
+| Configuration item | Description
[...]
+|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
+| `filesystem-providers` | (deprecated) The file system providers to
add. Set it to `gcs` if it's a GCS fileset, a comma separated string that
contains `gcs` like `gcs,s3` to support multiple kinds of fileset including
`gcs`.
[...]
+| `default-filesystem-provider` | (deprecated) The name default filesystem
providers of this Fileset catalog if users do not specify the scheme in the
URI. Default value is `builtin-local`, for GCS, if we set this value, we can
omit the prefix 'gs://' in the location.
[...]
+| `gcs-service-account-file` | The path of GCS service account JSON file.
[...]
| `credential-providers` | The credential provider types, separated by
comma, possible value can be `gcs-token`. As the default authentication type is
using service account as the above, this configuration can enable credential
vending provided by Gravitino server and client will no longer need to provide
authentication information like service account to access GCS by GVFS. Once
it's set, more configuration items are needed to make it works, see
[gcs-credential-vending](security/ [...]
:::note
diff --git a/docs/fileset-catalog-with-oss.md b/docs/fileset-catalog-with-oss.md
index 98369bbd4e..e424c2eeb3 100644
--- a/docs/fileset-catalog-with-oss.md
+++ b/docs/fileset-catalog-with-oss.md
@@ -30,14 +30,14 @@ Once the server is up and running, you can proceed to
configure the Fileset cata
In addition to the basic configurations mentioned in
[Fileset-catalog-catalog-configuration](./fileset-catalog.md#catalog-properties),
the following properties are required to configure a Fileset catalog with OSS:
-| Configuration item | Description
[...]
-|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| `filesystem-providers` | (deprecated) The file system providers to
add. Set it to `oss` if it's a OSS fileset, or a comma separated string that
contains `oss` like `oss,gs,s3` to support multiple kinds of fileset including
`oss`.
[...]
-| `default-filesystem-provider` | (deprecated) The name default filesystem
providers of this Fileset catalog if users do not specify the scheme in the
URI. Default value is `builtin-local`, for OSS, if we set this value, we can
omit the prefix 'oss://' in the location.
[...]
-| `oss-endpoint` | The endpoint of the Aliyun OSS.
[...]
-| `oss-access-key-id` | The access key of the Aliyun OSS.
[...]
-| `oss-secret-access-key` | The secret key of the Aliyun OSS.
[...]
-| `credential-providers` | The credential provider types, separated by
comma, possible value can be `oss-token`, `oss-secret-key`. As the default
authentication type is using AKSK as the above, this configuration can enable
credential vending provided by Gravitino server and client will no longer need
to provide authentication information like AKSK to access OSS by GVFS. Once
it's set, more configuration items are needed to make it works, see
[oss-credential-vending](security/cred [...]
+| Configuration item | Description
[...]
+|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
+| `filesystem-providers` | (deprecated) The file system providers to
add. Set it to `oss` if it's a OSS fileset, or a comma separated string that
contains `oss` like `oss,gs,s3` to support multiple kinds of fileset including
`oss`.
[...]
+| `default-filesystem-provider` | (deprecated) The name default filesystem
providers of this Fileset catalog if users do not specify the scheme in the
URI. Default value is `builtin-local`, for OSS, if we set this value, we can
omit the prefix 'oss://' in the location.
[...]
+| `oss-endpoint` | The endpoint of the Aliyun OSS.
[...]
+| `oss-access-key-id` | The access key of the Aliyun OSS.
[...]
+| `oss-secret-access-key` | The secret key of the Aliyun OSS.
[...]
+| `credential-providers` | The credential provider types, separated by
comma, possible value can be `oss-token`, `oss-secret-key`. As the default
authentication type is using AKSK as the above, this configuration can enable
credential vending provided by Gravitino server and client will no longer need
to provide authentication information like AKSK to access OSS by GVFS. Once
it's set, more configuration items are needed to make it works, see
[oss-credential-vending](security/cred [...]
:::note
`default-filesystem-provider` and `filesystem-providers` are deprecated since
1.2.0. The fileset catalog automatically loads filesystem providers on the
classpath, including buildin filesystem provider and cloud providers when the
corresponding bundle jar is present (for example, `gravitino-aliyun-bundle`).
diff --git a/docs/fileset-catalog-with-s3.md b/docs/fileset-catalog-with-s3.md
index 99d810f243..b895ea99d0 100644
--- a/docs/fileset-catalog-with-s3.md
+++ b/docs/fileset-catalog-with-s3.md
@@ -30,13 +30,13 @@ Once the server is up and running, you can proceed to
configure the Fileset cata
In addition to the basic configurations mentioned in
[Fileset-catalog-catalog-configuration](./fileset-catalog.md#catalog-properties),
the following properties are necessary to configure a Fileset catalog with S3:
-| Configuration item | Description
[...]
-|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| `filesystem-providers` | (deprecated) The file system providers to
add. Set it to `s3` if it's a S3 fileset, or a comma separated string that
contains `s3` like `gs,s3` to support multiple kinds of fileset including `s3`.
[...]
-| `default-filesystem-provider` | (deprecated) The name default filesystem
providers of this Fileset catalog if users do not specify the scheme in the
URI. Default value is `builtin-local`, for S3, if we set this value, we can
omit the prefix 's3a://' in the location.
[...]
-| `s3-endpoint` | The endpoint of the AWS S3.
[...]
-| `s3-access-key-id` | The access key of the AWS S3.
[...]
-| `s3-secret-access-key` | The secret key of the AWS S3.
[...]
+| Configuration item | Description
[...]
+|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
+| `filesystem-providers` | (deprecated) The file system providers to
add. Set it to `s3` if it's a S3 fileset, or a comma separated string that
contains `s3` like `gs,s3` to support multiple kinds of fileset including `s3`.
[...]
+| `default-filesystem-provider` | (deprecated) The name default filesystem
providers of this Fileset catalog if users do not specify the scheme in the
URI. Default value is `builtin-local`, for S3, if we set this value, we can
omit the prefix 's3a://' in the location.
[...]
+| `s3-endpoint` | The endpoint of the AWS S3.
[...]
+| `s3-access-key-id` | The access key of the AWS S3.
[...]
+| `s3-secret-access-key` | The secret key of the AWS S3.
[...]
| `credential-providers` | The credential provider types, separated by
comma, possible value can be `s3-token`, `s3-secret-key`. As the default
authentication type is using AKSK as the above, this configuration can enable
credential vending provided by Gravitino server and client will no longer need
to provide authentication information like AKSK to access S3 by GVFS. Once it's
set, more configuration items are needed to make it works, see
[s3-credential-vending](security/credenti [...]
:::note
diff --git a/docs/fileset-catalog.md b/docs/fileset-catalog.md
index 40e4ba5255..60f9b51ee8 100644
--- a/docs/fileset-catalog.md
+++ b/docs/fileset-catalog.md
@@ -56,7 +56,7 @@ properties.
| Property Name | Description
|
Default Value | Required |
Since Version |
|----------------------------------------------------|-------------------------------------------------------------------------------------------------|---------------|-------------------------------------------------------------|---------------|
| `authentication.impersonation-enable` | Whether to enable
impersonation for the Fileset catalog. |
`false` | No |
0.5.1 |
-| `authentication.type` | The type of
authentication for Fileset catalog, we only support `kerberos`, `simple`. |
`simple` | No |
0.5.1 |
+| `authentication.type` | The type of
authentication for Fileset catalog, we only support `kerberos`, `simple`.
| `simple` | No
| 0.5.1 |
| `authentication.kerberos.principal` | The principal of the
Kerberos authentication |
(none) | required if the value of `authentication.type` is Kerberos. |
0.5.1 |
| `authentication.kerberos.keytab-uri` | The URI of The keytab
for the Kerberos authentication. |
(none) | required if the value of `authentication.type` is Kerberos. |
0.5.1 |
| `authentication.kerberos.check-interval-sec` | The check interval of
Kerberos credential for Fileset catalog. | 60
| No | 0.5.1
|
@@ -150,7 +150,7 @@ properties:
| `location` | The storage location managed by
schema. Its location name is `unknown`. It's also should be a directory or path
prefix. | (none) | No | 0.5.0 |
| `location-` | The property prefix. User can use
`location-{name}={path}` to set multiple locations with different names for the
schema. | (none) | No | 0.9.0-incubating |
| `authentication.impersonation-enable` | Whether to enable impersonation for
this schema of the Fileset catalog.
| The parent(catalog) value | No | 0.6.0-incubating |
-| `authentication.type` | The type of authentication for this
schema of Fileset catalog , we only support `kerberos`, `simple`. |
The parent(catalog) value | No | 0.6.0-incubating |
+| `authentication.type` | The type of authentication for this
schema of Fileset catalog , we only support `kerberos`, `simple`.
| The parent(catalog) value | No | 0.6.0-incubating |
| `authentication.kerberos.principal` | The principal of the Kerberos
authentication for this schema.
| The parent(catalog) value | No | 0.6.0-incubating |
| `authentication.kerberos.keytab-uri` | The URI of The keytab for the
Kerberos authentication for this schema.
| The parent(catalog) value | No | 0.6.0-incubating |
| `credential-providers` | The credential provider types,
separated by comma.
| (none) | No | 0.8.0-incubating |
@@ -184,7 +184,7 @@ Besides, the Fileset catalog fileset has the following
properties:
|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|--------------------------------------------|-----------|------------------|
| `location` | The storage location managed by
schema. Its location name is `unknown`. It's also should be a directory or path
prefix. | (none)
| No
| 0.5.0 |
| `authentication.impersonation-enable` | Whether to enable impersonation for
the Fileset catalog fileset.
| The parent(schema) value
| No
| Yes | 0.6.0-incubating |
-| `authentication.type` | The type of authentication for
Fileset catalog fileset, we only support `kerberos`, `simple`.
| The parent(schema) value
| No |
No | 0.6.0-incubating |
+| `authentication.type` | The type of authentication for
Fileset catalog fileset, we only support `kerberos`, `simple`.
| The parent(schema) value
| No
| No | 0.6.0-incubating |
| `authentication.kerberos.principal` | The principal of the Kerberos
authentication for the fileset.
| The parent(schema) value
| No
| No | 0.6.0-incubating |
| `authentication.kerberos.keytab-uri` | The URI of The keytab for the
Kerberos authentication for the fileset.
| The parent(schema) value
| No
| No | 0.6.0-incubating |
| `credential-providers` | The credential provider types,
separated by comma.
| (none)
| No
| No | 0.8.0-incubating |
diff --git a/docs/gravitino-server-config.md b/docs/gravitino-server-config.md
index 72a8c951ed..b5c8bfa708 100644
--- a/docs/gravitino-server-config.md
+++ b/docs/gravitino-server-config.md
@@ -30,7 +30,7 @@ The `gravitino.conf` file lists the configuration items in
the following table.
| `gravitino.server.webserver.minThreads` | The minimum number of
threads in the thread pool used by the Jetty webserver. `minThreads` is 8 if
the value is less than 8.
| `Math.max(Math.min(Runtime.getRuntime().availableProcessors() * 2, 100),
8)` | No | 0.2.0 |
| `gravitino.server.webserver.maxThreads` | The maximum number of
threads in the thread pool used by the Jetty webserver. `maxThreads` is 8 if
the value is less than 8, and `maxThreads` must be great or equal to
`minThreads`. | `Math.max(Runtime.getRuntime().availableProcessors() * 4, 400)`
| No | 0.1.0 |
| `gravitino.server.webserver.threadPoolWorkQueueSize` | The size of the queue
in the thread pool used by the Jetty webserver.
| `100`
| No | 0.1.0 |
-| `gravitino.server.webserver.stopTimeout` | Time in milliseconds
to gracefully shut down the Jetty webserver, for more, see
`org.eclipse.jetty.server.Server#setStopTimeout`.
| `30000`
| No | 0.2.0 |
+| `gravitino.server.webserver.stopTimeout` | Time in milliseconds
to gracefully shut down the Jetty webserver, for more, see
`org.eclipse.jetty.server.Server#setStopTimeout`.
| `30000`
| No | 0.2.0 |
| `gravitino.server.webserver.idleTimeout` | The timeout in
milliseconds of idle connections.
| `30000`
| No | 0.2.0 |
| `gravitino.server.webserver.requestHeaderSize` | Maximum size of HTTP
requests.
| `131072`
| No | 0.1.0 |
| `gravitino.server.webserver.responseHeaderSize` | Maximum size of HTTP
responses.
| `131072`
| No | 0.1.0 |
@@ -51,23 +51,23 @@ If you are going to use H2 in the production environment,
Gravitino will not gua
The following table lists the storage configuration items:
-| Configuration item | Description
| Default value
| Required | Since
version |
-|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|-------------------------------------------------|------------------|
-| `gravitino.entity.store` | Which entity storage
implementation to use. Only`relational` storage is supported.
| `relational`
| No | 0.1.0
|
-| `gravitino.entity.store.maxTransactionSkewTimeMs` | The maximum skew time of
transactions in milliseconds.
| `2000`
| No | 0.3.0
|
-| `gravitino.entity.store.deleteAfterTimeMs` | The maximum time in
milliseconds that deleted and old-version data is kept. Set to at least 10
minutes and no longer than 30 days.
|
`604800000`(7 days) | No
| 0.5.0 |
-| `gravitino.entity.store.versionRetentionCount` | The Count of versions
allowed to be retained, including the current version, used to delete old
versions data. Set to at least 1 and no greater than 10.
| `1`
| No |
0.5.0 |
-| `gravitino.entityChangeLog.pollIntervalSecs` | The interval in seconds
for polling the entity change log. The poller invalidates stale local caches
(e.g. the catalog cache) across HA nodes by consuming change log records. Must
be positive. | `3`
| No |
1.3.0 |
-| `gravitino.entityChangeLog.retentionSecs` | The retention time in
seconds for entity change log rows. Expired rows are pruned periodically. Set
to `0` to disable automatic cleanup. Must be non-negative.
| `86400`(1
day) | No |
1.3.0 |
-| `gravitino.entityChangeLog.cleanupIntervalSecs` | The interval in seconds
for pruning expired entity change log rows. Must be positive.
| `3600`(1
hour) | No |
1.3.0 |
-| `gravitino.entity.store.relational` | Detailed implementation
of Relational storage. `H2`, `MySQL` and `PostgreSQL` is supported, and the
implementation is `JDBCBackend`.
| `JDBCBackend`
| No | 0.5.0
|
-| `gravitino.entity.store.relational.jdbcUrl` | The database url that
the `JDBCBackend` needs to connect to. If you use `MySQL` or `PostgreSQL`, you
should firstly initialize the database tables yourself by executing the ddl
scripts in the `${GRAVITINO_HOME}/scripts/{DATABASE_TYPE}/` directory. |
`jdbc:h2` | No
| 0.5.0 |
-| `gravitino.entity.store.relational.jdbcDriver` | The jdbc driver name
that the `JDBCBackend` needs to use. You should place the driver Jar package in
the `${GRAVITINO_HOME}/libs/` directory.
|
`org.h2.Driver` | Yes if the jdbc connection url is not
`jdbc:h2` | 0.5.0 |
-| `gravitino.entity.store.relational.jdbcUser` | The username that the
`JDBCBackend` needs to use when connecting the database. It is required for
`MySQL`.
|
`gravitino` | Yes if the jdbc connection url is not
`jdbc:h2` | 0.5.0 |
-| `gravitino.entity.store.relational.jdbcPassword` | The password that the
`JDBCBackend` needs to use when connecting the database. It is required for
`MySQL`.
|
`gravitino` | Yes if the jdbc connection url is not
`jdbc:h2` | 0.5.0 |
-| `gravitino.entity.store.relational.storagePath` | The storage path for
embedded JDBC storage implementation. It supports both absolute and relative
path, if the value is a relative path, the final path is
`${GRAVITINO_HOME}/${PATH_YOU_HAVA_SET}`, default value is
`${GRAVITINO_HOME}/data/jdbc` | `${GRAVITINO_HOME}/data/jdbc` | No
| 0.6.0-incubating |
-| `gravitino.entity.store.relational.maxConnections`| The maximum number of
connections for the JDBC Backend connection pool
| `100`
| No |
0.9.0-incubating |
-| `gravitino.entity.store.relational.maxWaitMillis` | The maximum wait time in
milliseconds for a connection from the JDBC Backend connection pool
| `1000`
| No |
0.9.0-incubating |
+| Configuration item | Description
| Default value
| Required | Since
version |
+|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|-------------------------------------------------|------------------|
+| `gravitino.entity.store` | Which entity storage
implementation to use. Only`relational` storage is supported.
|
`relational` | No
| 0.1.0 |
+| `gravitino.entity.store.maxTransactionSkewTimeMs` | The maximum skew time
of transactions in milliseconds.
| `2000`
| No | 0.3.0
|
+| `gravitino.entity.store.deleteAfterTimeMs` | The maximum time in
milliseconds that deleted and old-version data is kept. Set to at least 10
minutes and no longer than 30 days.
|
`604800000`(7 days) | No
| 0.5.0 |
+| `gravitino.entity.store.versionRetentionCount` | The Count of versions
allowed to be retained, including the current version, used to delete old
versions data. Set to at least 1 and no greater than 10.
| `1`
| No |
0.5.0 |
+| `gravitino.entityChangeLog.pollIntervalSecs` | The interval in seconds
for polling the entity change log. The poller invalidates stale local caches
(e.g. the catalog cache) across HA nodes by consuming change log records. Must
be positive. | `3`
| No |
1.3.0 |
+| `gravitino.entityChangeLog.retentionSecs` | The retention time in
seconds for entity change log rows. Expired rows are pruned periodically. Set
to `0` to disable automatic cleanup. Must be non-negative.
| `86400`(1
day) | No |
1.3.0 |
+| `gravitino.entityChangeLog.cleanupIntervalSecs` | The interval in seconds
for pruning expired entity change log rows. Must be positive.
| `3600`(1
hour) | No |
1.3.0 |
+| `gravitino.entity.store.relational` | Detailed implementation
of Relational storage. `H2`, `MySQL` and `PostgreSQL` is supported, and the
implementation is `JDBCBackend`.
|
`JDBCBackend` | No
| 0.5.0 |
+| `gravitino.entity.store.relational.jdbcUrl` | The database url that
the `JDBCBackend` needs to connect to. If you use `MySQL` or `PostgreSQL`, you
should firstly initialize the database tables yourself by executing the ddl
scripts in the `${GRAVITINO_HOME}/scripts/{DATABASE_TYPE}/` directory. |
`jdbc:h2` | No
| 0.5.0 |
+| `gravitino.entity.store.relational.jdbcDriver` | The jdbc driver name
that the `JDBCBackend` needs to use. You should place the driver Jar package in
the `${GRAVITINO_HOME}/libs/` directory.
|
`org.h2.Driver` | Yes if the jdbc connection url is not
`jdbc:h2` | 0.5.0 |
+| `gravitino.entity.store.relational.jdbcUser` | The username that the
`JDBCBackend` needs to use when connecting the database. It is required for
`MySQL`.
|
`gravitino` | Yes if the jdbc connection url is not
`jdbc:h2` | 0.5.0 |
+| `gravitino.entity.store.relational.jdbcPassword` | The password that the
`JDBCBackend` needs to use when connecting the database. It is required for
`MySQL`.
|
`gravitino` | Yes if the jdbc connection url is not
`jdbc:h2` | 0.5.0 |
+| `gravitino.entity.store.relational.storagePath` | The storage path for
embedded JDBC storage implementation. It supports both absolute and relative
path, if the value is a relative path, the final path is
`${GRAVITINO_HOME}/${PATH_YOU_HAVA_SET}`, default value is
`${GRAVITINO_HOME}/data/jdbc` | `${GRAVITINO_HOME}/data/jdbc` | No
| 0.6.0-incubating |
+| `gravitino.entity.store.relational.maxConnections` | The maximum number of
connections for the JDBC Backend connection pool
| `100`
| No |
0.9.0-incubating |
+| `gravitino.entity.store.relational.maxWaitMillis` | The maximum wait time
in milliseconds for a connection from the JDBC Backend connection pool
| `1000`
| No |
0.9.0-incubating |
:::caution
diff --git a/docs/how-to-use-gvfs.md b/docs/how-to-use-gvfs.md
index a220aa300e..4bce46da14 100644
--- a/docs/how-to-use-gvfs.md
+++ b/docs/how-to-use-gvfs.md
@@ -50,10 +50,10 @@ the path mapping and convert automatically.
|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|---------
[...]
| `fs.AbstractFileSystem.gvfs.impl` | The Gravitino
Virtual File System abstract class, set it to
`org.apache.gravitino.filesystem.hadoop.Gvfs`.
| (none)
| Yes [...]
| `fs.gvfs.impl` | The Gravitino
Virtual File System implementation class, set it to
`org.apache.gravitino.filesystem.hadoop.GravitinoVirtualFileSystem`.
| (none)
| Yes [...]
-| `fs.gvfs.impl.disable.cache` | Disable the
Gravitino Virtual File System cache in the Hadoop environment. If you need to
proxy multi-user operations, set this value to `true` and create a separate
File System for each user.
| `false`
| No [...]
+| `fs.gvfs.impl.disable.cache` | Disable the
Gravitino Virtual File System cache in the Hadoop environment. If you need to
proxy multi-user operations, set this value to `true` and create a separate
File System for each user.
| `false`
| No [...]
| `fs.gravitino.server.uri` | The Gravitino server
URI which GVFS needs to load the fileset metadata.
| (none)
| Yes [...]
| `fs.gravitino.client.metalake` | The metalake to
which the fileset belongs.
| (none)
| Yes [...]
-| `fs.gravitino.client.authType` | The auth type the
Gravitino client uses with the Gravitino Virtual File System. Supports
`simple`, `oauth2`, and `kerberos`.
| `simple`
| No
| 0.5.0 |
+| `fs.gravitino.client.authType` | The auth type the
Gravitino client uses with the Gravitino Virtual File System. Supports
`simple`, `oauth2`, and `kerberos`.
| `simple`
| No [...]
| `fs.gravitino.client.oauth2.serverUri` | The auth server URI
for the Gravitino client when using `oauth2` auth type with the Gravitino
Virtual File System.
| (none)
| Yes if y [...]
| `fs.gravitino.client.oauth2.credential` | The auth credential
for the Gravitino client when using `oauth2` auth type in the Gravitino Virtual
File System.
| (none)
| Yes if y [...]
| `fs.gravitino.client.oauth2.path` | The auth server path
for the Gravitino client when using `oauth2` auth type with the Gravitino
Virtual File System. Please remove the first slash `/` from the path, for
example `oauth/token`.
| (none)
| Yes if y [...]
@@ -69,7 +69,7 @@ the path mapping and convert automatically.
| `fs.gravitino.client.request.header.` | The configuration
key prefix for the Gravitino client request header. You can set the request
header for the Gravitino client.
| (none)
| No [...]
| `fs.gravitino.enableCredentialVending` | Whether to enable
credential vending for the Gravitino Virtual File System.
| `false`
| No [...]
| `fs.gravitino.client.` | The configuration
key prefix for the Gravitino client config.
| (none)
| No [...]
-| `fs.gravitino.filesetMetadataCache.enable` | Whether to cache the
fileset, fileset schema or fileset catalog metadata in the Gravitino Virtual
File System. Note that this cache causes a side effect: if you modify the
fileset or fileset catalog metadata, the client cannot see the latest changes.
| `false`
| No [...]
+| `fs.gravitino.filesetMetadataCache.enable` | Whether to cache the
fileset, fileset schema or fileset catalog metadata in the Gravitino Virtual
File System. Note that this cache causes a side effect: if you modify the
fileset or fileset catalog metadata, the client cannot see the latest changes.
| `false`
| No [...]
| `fs.gravitino.autoCreateLocation` | The configuration
key for whether to enable auto-creation of fileset location when the
server-side filesystem ops are disabled and the location does not exist.
| `true`
| No [...]
| `fs.path.config.<name>` | Defines a logical
location entry. Set `fs.path.config.<name>` to the real base URI (for example,
`hdfs://cluster1/`). Any key that starts with the same prefix (such as
`fs.path.config.<name>.config.resource`) is treated as a location-scoped
property and will be forwarded to the underlying filesystem client. Note:
location names must not contain (`.`, `_`). | (none)
| No [...]
@@ -411,7 +411,7 @@ to recompile the native libraries like `libhdfs` and
others, and completely repl
| `metalake_name` | The metalake name which the fileset
belongs to.
| (none) | Yes
[...]
| `cache_size` | The cache capacity of the Gravitino
Virtual File System.
| `20` | No
[...]
| `cache_expired_time` | The value of time that the cache expires
after accessing in the Gravitino Virtual File System. The value is in
`seconds`.
| `3600`
| No [...]
-| `auth_type` | The auth type the Gravitino client uses
with the Gravitino Virtual File System. Supports `simple`, `basic`, and
`oauth2`.
| `simple`
| No |
0.6.0-incubating |
+| `auth_type` | The auth type the Gravitino client uses
with the Gravitino Virtual File System. Supports `simple`, `basic`, and
`oauth2`.
| `simple` |
No [...]
| `basic_username` | The username for the Gravitino client when
using `basic` auth type with the built-in IDP.
|
(none) | Yes if
you use `basic` [...]
| `basic_password` | The password for the Gravitino client when
using `basic` auth type with the built-in IDP.
|
(none) | Yes if
you use `basic` [...]
| `oauth2_server_uri` | The auth server URI for the Gravitino
client when using `oauth2` auth type.
| (none) | Yes
if you use `oauth2` [...]
@@ -426,7 +426,7 @@ to recompile the native libraries like `libhdfs` and
others, and completely repl
| `client_request_header_` | The configuration key prefix for the
Gravitino client request header. You can set the request header for the
Gravitino client.
| (none)
| No [...]
| `enable_credential_vending` | Whether to enable credential vending for
the Gravitino Virtual File System.
|
`false` | No
[...]
| `gvfs_gravitino_client_` | The configuration key prefix for the
Gravitino client. You can set the config for the Gravitino client.
| (none) | No
[...]
-| `enable_fileset_metadata_cache` | Whether to cache the fileset or fileset
catalog metadata in the Gravitino Virtual File System. Note that this cache
causes a side effect: if you modify the fileset or fileset catalog metadata,
the client cannot see the latest changes.
| `false` |
No [...]
+| `enable_fileset_metadata_cache` | Whether to cache the fileset or fileset
catalog metadata in the Gravitino Virtual File System. Note that this cache
causes a side effect: if you modify the fileset or fileset catalog metadata,
the client cannot see the latest changes.
| `false` |
No [...]
| `auto_create_location` | The configuration key for whether to
enable auto-creation of fileset location when the server-side filesystem ops
are disabled and the location does not exist.
| `true` |
No [...]
| `fs_path_config_<name>` | Defines a logical location entry. Set
`fs_path_config_<name>` to the real base URI (for example, `hdfs://cluster1/`).
Any key that starts with the same prefix (such as
`fs_path_config_<name>_config.resource`) is treated as a location-scoped
property and will be forwarded to the underlying filesystem client. Note:
location names must not contain (`.`, `_`). | (none)
| No [...]
diff --git a/docs/iceberg-rest-service.md b/docs/iceberg-rest-service.md
index 03f984a865..ed951ba5d6 100644
--- a/docs/iceberg-rest-service.md
+++ b/docs/iceberg-rest-service.md
@@ -296,10 +296,10 @@ Refer to [OAuth2
Configuration](./security/how-to-authenticate#server-configurat
When enabling OAuth2 and leveraging a dynamic configuration provider to
retrieve catalog information from the Gravitino server, use the following
configuration parameters to establish OAuth2 authentication for secure
communication with the Gravitino server:
-| Configuration item | Description
| Default value
| Required | Since Version |
-|------------------------------------------------------|-------------------------------------------------------------------------------------|-----------------------|-------------------|---------------|
+| Configuration item | Description
|
Default value | Required | Since Version |
+|------------------------------------------------------|--------------------------------------------------------------------------------------------------|-----------------------|-------------------|---------------|
| `gravitino.iceberg-rest.gravitino-auth-type` | The auth type for
communicating with the Gravitino server. Supported values: `simple`, `oauth2`.
| `simple` | No | 1.0.0 |
-| `gravitino.iceberg-rest.gravitino-simple.user-name` | The username when
using `simple` auth type. |
`iceberg-rest-server` | No | 1.0.0 |
+| `gravitino.iceberg-rest.gravitino-simple.user-name` | The username when
using `simple` auth type.
| `iceberg-rest-server` | No | 1.0.0 |
| `gravitino.iceberg-rest.gravitino-oauth2.server-uri` | The OAuth2 server uri
address. | (none)
| Yes, for `oauth2` | 1.0.0 |
| `gravitino.iceberg-rest.gravitino-oauth2.credential` | The credential to
request the OAuth2 token. | (none)
| Yes, for `oauth2` | 1.0.0 |
| `gravitino.iceberg-rest.gravitino-oauth2.token-path` | The path for token of
the default OAuth server. | (none)
| Yes, for `oauth2` | 1.0.0 |
@@ -525,7 +525,7 @@ For storages not managed by Gravitino directly, configure
them through custom ca
| Configuration item | Description
| Default value | Required |
Since Version |
|----------------------------------|-----------------------------------------------------------------------------------------|---------------|----------|------------------|
-| `gravitino.iceberg-rest.io-impl` | The IO implementation for `FileIO` in
Iceberg; use the fully qualified classname. | (none) | No |
0.6.0-incubating |
+| `gravitino.iceberg-rest.io-impl` | The IO implementation for `FileIO` in
Iceberg; use the fully qualified classname. | (none) | No |
0.6.0-incubating |
To pass custom properties such as `security-token` to your custom `FileIO`,
configure them via `gravitino.iceberg-rest.security-token`. The
`security-token` is included in the properties when the `FileIO` initialize
method is invoked.
diff --git a/docs/jdbc-clickhouse-catalog.md b/docs/jdbc-clickhouse-catalog.md
index 524b2b060a..b6859cdaf1 100644
--- a/docs/jdbc-clickhouse-catalog.md
+++ b/docs/jdbc-clickhouse-catalog.md
@@ -28,7 +28,7 @@ ClickHouse catalog is not included in the standard Gravitino
server distribution
| Scope | One catalog maps to one ClickHouse instance
|
| Metadata/DDL | Supports JDBC-based metadata management and DDL
|
| Column defaults | Supports column default values
|
-| Drivers | Requires user-provided ClickHouse JDBC driver in
`${GRAVITINO_HOME}/catalogs/jdbc-clickhouse/libs`, download the jar from
[link](https://repo1.maven.org/maven2/com/clickhouse/clickhouse-jdbc/0.7.1/) |
+| Drivers | Requires user-provided ClickHouse JDBC driver in
`${GRAVITINO_HOME}/catalogs/jdbc-clickhouse/libs`, download the jar from
[link](https://repo1.maven.org/maven2/com/clickhouse/clickhouse-jdbc/0.7.1/)
|
| Supported version | All the codes are tested by ClickHouse `24.8.14`, newer
versions like `25.x` may also work but we did not conduct thorough tests.
Report to the community if something does not work as expected. |
### ClickHouse Server and JDBC Driver Compatibility Matrix
diff --git a/docs/jdbc-doris-catalog.md b/docs/jdbc-doris-catalog.md
index 5fec89c72b..1a0093a22d 100644
--- a/docs/jdbc-doris-catalog.md
+++ b/docs/jdbc-doris-catalog.md
@@ -49,7 +49,7 @@ Besides the [common catalog
properties](./gravitino-server-config.md#catalog-pro
| `jdbc-password` | The JDBC password.
| (none) | Yes | 0.5.0 |
| `jdbc.pool.min-size` | The minimum number of connections in the pool. `2`
by default.
| `2` | No | 0.5.0 |
| `jdbc.pool.max-size` | The maximum number of connections in the pool.
`10` by default.
| `10` | No | 0.5.0
|
-| `replication_num` | The number of replications for the table. If not
specified and the number of backend servers less than 3, then the default value
is 1; If not specified and the number of backend servers greater or equals to
3, the default value (3) in Doris server will be used. For more, see the
[doc](https://doris.apache.org/docs/1.2/sql-manual/sql-reference/Data-Definition-Statements/Create/CREATE-TABLE/)
| `1` or `3` | No | 0.6.0-incubating |
+| `replication_num` | The number of replications for the table. If not
specified and the number of backend servers less than 3, then the default value
is 1; If not specified and the number of backend servers greater or equals to
3, the default value (3) in Doris server will be used. For more, see the
[doc](https://doris.apache.org/docs/1.2/sql-manual/sql-reference/Data-Definition-Statements/Create/CREATE-TABLE/)
| `1` or `3` | No | 0.6.0-incubating |
| `jdbc.pool.max-wait-ms` | The maximum Duration that the pool will wait for a
connection to be returned. `30000` by default.
| `30000` | No | 1.1.0 |
Before using the Doris Catalog, you must download the corresponding JDBC
driver to the `catalogs/jdbc-doris/libs` directory.
diff --git a/docs/lakehouse-generic-lance-table.md
b/docs/lakehouse-generic-lance-table.md
index 62e3bff8aa..6e88c301a8 100644
--- a/docs/lakehouse-generic-lance-table.md
+++ b/docs/lakehouse-generic-lance-table.md
@@ -103,12 +103,12 @@ Required and optional properties for tables in a Generic
Lakehouse Catalog:
| Property | Description
| Default | Required | Since
Version |
|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|--------------|---------------|
-| `format` | Table format: `lance`, only `lance` is fully
supported.
| (none) | Yes | 1.1.0
|
-| `location` | Storage path for table metadata and data, Lance
supports: S3, GCS, OSS, AZ, File, Memory and file-object-store.
| (none) | Conditional* | 1.1.0
|
+| `format` | Table format: `lance`, only `lance` is fully
supported.
| (none) | Yes |
1.1.0 |
+| `location` | Storage path for table metadata and data, Lance
supports: S3, GCS, OSS, AZ, File, Memory and file-object-store.
| (none) | Conditional* |
1.1.0 |
| `external` | Whether the data directory is an external location.
If it's `true`, dropping a table will only remove metadata in Gravitino and
will not delete the data directory, and purge table will delete both. For a
non-external table, dropping will drop both.
| false | No |
1.1.0 |
| `lance.creation-mode` | Create mode: for create table, it can be `CREATE`,
`EXIST_OK` or `OVERWRITE`. and it should be `CREATE` or `OVERWRITE` for
registering tables
| `CREATE` | No
| 1.1.0 |
| `lance.register` | Whether it is a register table operation. If it's
`true`, This API will not create data directory actually and it's the user's
responsibility to create and manage the data directory. `false` it will
actually create a table.
| false | No
| 1.1.0 |
-| `lance.storage.xxxx` | Any additional storage-specific properties required
by Lance format (e.g., S3 credentials, HDFS configs). Replace `xxxx` with
actual property names. For example, we can use
`lance.storage.aws_access_key_id` to set S3 aws_access_key_id when using a S3
location, for detail, refer to https://lancedb.com/docs/storage/integrations/ |
(none) | No | 1.1.0 |
+| `lance.storage.xxxx` | Any additional storage-specific properties required
by Lance format (e.g., S3 credentials, HDFS configs). Replace `xxxx` with
actual property names. For example, we can use
`lance.storage.aws_access_key_id` to set S3 aws_access_key_id when using a S3
location, for detail, refer to https://lancedb.com/docs/storage/integrations/
| (none) | No | 1.1.0 |
- `CREATE`: Create a new table, fail if the table already exists.
- `EXIST_OK`: Create a new table if it does not exist, otherwise do nothing.
diff --git a/docs/lakehouse-iceberg-catalog.md
b/docs/lakehouse-iceberg-catalog.md
index 4e098da075..7b2bd9f6a9 100644
--- a/docs/lakehouse-iceberg-catalog.md
+++ b/docs/lakehouse-iceberg-catalog.md
@@ -196,7 +196,7 @@ For other storages that are not managed by Gravitino
directly, you can manage th
| Configuration item | Description
| Default value | Required | Since Version |
|--------------------|-----------------------------------------------------------------------------------------|---------------|----------|------------------|
-| `io-impl` | The IO implementation for `FileIO` in Iceberg; use the
fully qualified classname. | (none) | No | 0.6.0-incubating |
+| `io-impl` | The IO implementation for `FileIO` in Iceberg; use the
fully qualified classname. | (none) | No | 0.6.0-incubating |
To pass custom properties such as `security-token` to your custom `FileIO`,
you can directly configure it by `gravitino.bypass.security-token`.
`security-token` will be included in the properties when the initialize method
of `FileIO` is invoked.
@@ -430,13 +430,13 @@ Pass [Iceberg table
properties](https://iceberg.apache.org/docs/1.5.2/configurat
| `provider` | The storage provider for table storage.
| (none) | No | No |
Yes | 0.2.0 |
| `format` | The format of table storage.
| (none) | No | No |
Yes | 0.2.0 |
| `format-version` | The format version of table storage.
| (none) | No | No |
Yes | 0.2.0 |
-| `comment` | The table comment; use the `comment` field in
table meta instead. | (none) | No | Yes | No
| 0.2.0 |
+| `comment` | The table comment; use the `comment` field in
table meta instead. | (none) | No | Yes |
No | 0.2.0 |
| `creator` | The table creator.
| (none) | No | Yes | No
| 0.2.0 |
| `current-snapshot-id` | The snapshot represents the current state of the
table. | (none) | No | Yes | No
| 0.2.0 |
| `cherry-pick-snapshot-id` | Selecting a specific snapshot in a merge
operation. | (none) | No | Yes
| No | 0.2.0 |
-| `sort-order` | Iceberg table sort order; use `SortOrder` in
table meta instead. | (none) | No | Yes | No
| 0.2.0 |
+| `sort-order` | Iceberg table sort order; use `SortOrder` in
table meta instead. | (none) | No | Yes
| No | 0.2.0 |
| `identifier-fields` | The identifier fields for defining the table.
| (none) | No | Yes | No
| 0.2.0 |
-| `write.distribution-mode` | Defines distribution of write data; use
`distribution` in table meta instead. | (none) | No | Yes |
No | 0.2.0 |
+| `write.distribution-mode` | Defines distribution of write data; use
`distribution` in table meta instead. | (none) | No | Yes
| No | 0.2.0 |
### Table Indexes
diff --git a/docs/lakehouse-paimon-catalog.md b/docs/lakehouse-paimon-catalog.md
index 4b082b1fb1..329330f3e2 100644
--- a/docs/lakehouse-paimon-catalog.md
+++ b/docs/lakehouse-paimon-catalog.md
@@ -35,7 +35,7 @@ Builds with Apache Paimon `1.2`.
| `uri` | The URI configuration
of the Paimon 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`. It is optional for
`FilesystemCatalog`. | (none)
| required if the value of `catalog-backend` is not
`filesystem`.
[...]
| `warehouse` | Warehouse directory of
catalog. `file:///user/hive/warehouse-paimon/` for local fs,
`hdfs://namespace/hdfs/path` for HDFS , `s3://{bucket-name}/path/` for S3 or
`oss://{bucket-name}/path` for Aliyun OSS | (none)
| Yes
[...]
| `catalog-backend-name` | The catalog name passed
to underlying Paimon catalog backend.
| The property value of `catalog-backend`, like `jdbc` for
JDBC catalog backend. | No
[...]
-| `authentication.type` | The type of
authentication for Paimon catalog backend, Gravitino only supports `Kerberos`
and `simple`.
| `simple`
| No
[...]
+| `authentication.type` | The type of
authentication for Paimon catalog backend, Gravitino only supports `Kerberos`
and `simple`.
| `simple`
| No
[...]
| `hive.metastore.sasl.enabled` | Whether to enable SASL
authentication protocol when connect to Kerberos Hive metastore. This is a raw
Hive configuration
| `false`
| No, This value should be true in most case(Some will
use SSL protocol, but it rather rare) if the value of
`gravitino.iceberg-rest.authentication.type [...]
| `authentication.kerberos.principal` | The principal of the
Kerberos authentication.
| (none)
| required if the value of `authentication.type` is
Kerberos.
[...]
| `authentication.kerberos.keytab-uri` | The URI of The keytab
for the Kerberos authentication.
| (none)
| required if the value of `authentication.type` is
Kerberos.
[...]
diff --git a/docs/lance-rest-service.md b/docs/lance-rest-service.md
index 0f5ae171cc..96e1af740a 100644
--- a/docs/lance-rest-service.md
+++ b/docs/lance-rest-service.md
@@ -130,7 +130,7 @@ To enable the Lance REST service within Gravitino server,
configure the followin
| `gravitino.lance-rest.classpath` | Classpath for Lance REST
service, relative to Gravitino home directory | lance-rest-server/libs |
Yes | 1.1.0 |
| `gravitino.lance-rest.httpPort` | Port number for Lance REST
service | 9101 |
No | 1.1.0 |
| `gravitino.lance-rest.host` | Hostname for Lance REST service
| 0.0.0.0 | No
| 1.1.0 |
-| `gravitino.lance-rest.namespace-backend` | Namespace metadata backend (only
`gravitino` is supported) | gravitino | Yes | 1.1.0
|
+| `gravitino.lance-rest.namespace-backend` | Namespace metadata backend (only
`gravitino` is supported) | gravitino | Yes
| 1.1.0 |
| `gravitino.lance-rest.gravitino-uri` | Gravitino server URI (required
when namespace-backend is `gravitino`) | http://localhost:8090 | Yes
| 1.1.0 |
| `gravitino.lance-rest.gravitino-metalake` | Gravitino metalake name
(required when namespace-backend is `gravitino`) | (none)
| Yes | 1.1.0 |
diff --git a/docs/manage-relational-metadata-using-gravitino.md
b/docs/manage-relational-metadata-using-gravitino.md
index 15f01b987b..cc335c5b1c 100644
--- a/docs/manage-relational-metadata-using-gravitino.md
+++ b/docs/manage-relational-metadata-using-gravitino.md
@@ -1051,7 +1051,7 @@ The following is the table property that Gravitino
supports:
| `jdbc-starrocks` | [StarRocks table
property](./jdbc-starrocks-catalog.md#table-properties)
| [StarRocks type
mapping](./jdbc-starrocks-catalog.md#table-column-types)
|
| `jdbc-clickhouse` | [ClickHouse table
property](./jdbc-clickhouse-catalog.md#table-properties)
| [ClickHouse type
mapping](./jdbc-clickhouse-catalog.md#table-column-types)
|
| `jdbc-hologres` | [Hologres table
property](./jdbc-hologres-catalog.md#table-properties)
| [Hologres type
mapping](./jdbc-hologres-catalog.md#table-column-types)
|
-| `lakehouse-generic` | Lakehouse generic table property depends on specific
table implementation, for Lance table, refer to
[doc](./lakehouse-generic-lance-table.md#table-properties), other table format,
refer to related docs. | Lakehouse generic type mapping. Similar to table
properties, for Lance table, refer to
[docs](./lakehouse-generic-lance-table.md#data-type-mappings) |
+| `lakehouse-generic` | Lakehouse generic table property depends on specific
table implementation, for Lance table, refer to
[doc](./lakehouse-generic-lance-table.md#table-properties), other table format,
refer to related docs. | Lakehouse generic type mapping. Similar
to table properties, for Lance table, refer to
[docs](./lakehouse-generic-lance-table.md#data-type-mappings) |
#### Table Partitioning, Distribution, Sort Ordering and Indexes
diff --git a/docs/manage-table-partition-using-gravitino.md
b/docs/manage-table-partition-using-gravitino.md
index 4f2fa30aee..6106ee005f 100644
--- a/docs/manage-table-partition-using-gravitino.md
+++ b/docs/manage-table-partition-using-gravitino.md
@@ -37,8 +37,8 @@ If you need additional partition management support for a
specific catalog, [cre
Match the partition types you want to add with the table's
[partitioning](./table-partitioning-distribution-sort-order-indexes.md#table-partitioning)
types; Gravitino supports adding the following partition types:
-| Partition Type | Description
|
-|----------------|------------------------------------------------------------------------------------------------------------------------------------------------|
+| Partition Type | Description
|
+|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| identity | An identity partition represents a result of identity
[partitioning](./table-partitioning-distribution-sort-order-indexes.md#table-partitioning).
|
| range | A range partition represents a result of range
[partitioning](./table-partitioning-distribution-sort-order-indexes.md#table-partitioning).
|
| list | A list partition represents a result of list
[partitioning](./table-partitioning-distribution-sort-order-indexes.md#table-partitioning).
|
diff --git a/docs/security/authorization-pushdown.md
b/docs/security/authorization-pushdown.md
index eb9b7b418f..6fa97b7066 100644
--- a/docs/security/authorization-pushdown.md
+++ b/docs/security/authorization-pushdown.md
@@ -21,7 +21,7 @@ To use the Ranger Hadoop SQL Plugin, you need to configure
the following propert
|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|----------|------------------|
| `authorization-provider` | Providers to use to
implement authorization plugin such as `ranger`.
| (none)
| No | 0.6.0-incubating |
| `authorization.ranger.admin.url` | The Apache Ranger
web URIs.
| (none)
| No | 0.6.0-incubating |
-| `authorization.ranger.service.type` | The Apache Ranger
service type. Supports `HadoopSQL` or `HDFS`.
| (none) | No
| 0.8.0-incubating |
+| `authorization.ranger.service.type` | The Apache Ranger
service type. Supports `HadoopSQL` or `HDFS`.
| (none)
| No | 0.8.0-incubating |
| `authorization.ranger.auth.type` | The Apache Ranger
authentication type `simple` or `kerberos`.
| `simple`
| No | 0.6.0-incubating |
| `authorization.ranger.username` | The Apache Ranger
admin web login username (auth type=simple), or kerberos principal(auth
type=kerberos), Need have Ranger administrator permission. | (none)
| No | 0.6.0-incubating |
| `authorization.ranger.password` | The Apache Ranger
admin web login user password (auth type=simple), or path of the keytab
file(auth type=kerberos) | (none)
| No | 0.6.0-incubating |
diff --git a/docs/security/credential-vending.md
b/docs/security/credential-vending.md
index da14eb4829..ebea691bd6 100644
--- a/docs/security/credential-vending.md
+++ b/docs/security/credential-vending.md
@@ -24,7 +24,7 @@ Gravitino credential vending is used to generate temporary or
static credentials
| Gravitino server catalog properties | Gravitino Iceberg REST server
configurations | Description
| Default value | Required | Since
Version |
|-------------------------------------|--------------------------------------------------------|--------------------------------------------------------------------------------------------|---------------|----------|------------------|
-| `credential-provider-type` |
`gravitino.iceberg-rest.credential-provider-type` | Deprecated; use
`credential-providers` instead. | (none)
| Yes | 0.7.0-incubating |
+| `credential-provider-type` |
`gravitino.iceberg-rest.credential-provider-type` | Deprecated; use
`credential-providers` instead. |
(none) | Yes | 0.7.0-incubating |
| `credential-providers` |
`gravitino.iceberg-rest.credential-providers` | The credential
provider types, separated by comma. |
(none) | Yes | 0.8.0-incubating |
| `credential-cache-expire-ratio` |
`gravitino.iceberg-rest.credential-cache-expire-ratio` | Ratio of the
credential's expiration time when Gravitino remove credential from the cache. |
0.15 | No | 0.8.0-incubating |
| `credential-cache-max-size` |
`gravitino.iceberg-rest.cache-max-size` | Max size for the
credential cache. |
10000 | No | 0.8.0-incubating |
@@ -146,7 +146,7 @@ An GCS token is a token credential with scoped privileges,
by leveraging GCS [Cr
| Gravitino server catalog properties | Gravitino Iceberg REST server
configurations | Description
| Default value | Required | Since Version |
|-------------------------------------|---------------------------------------------------|------------------------------------------------------------|-------------------------------------|----------|------------------|
| `credential-providers` |
`gravitino.iceberg-rest.credential-providers` | `gcs-token` for GCS token
credential. | (none) | Yes
| 0.8.0-incubating |
-| `gcs-credential-file-path` |
`gravitino.iceberg-rest.gcs-credential-file-path` | Deprecated; use
`gcs-service-account-file` instead. | GCS Application default credential. | No
| 0.7.0-incubating |
+| `gcs-credential-file-path` |
`gravitino.iceberg-rest.gcs-credential-file-path` | Deprecated; use
`gcs-service-account-file` instead. | GCS Application default
credential. | No | 0.7.0-incubating |
| `gcs-service-account-file` |
`gravitino.iceberg-rest.gcs-service-account-file` | The location of GCS
credential file. | GCS Application default credential. |
No | 0.8.0-incubating |
:::note
diff --git a/docs/spark-connector/spark-authentication-with-gravitino.md
b/docs/spark-connector/spark-authentication-with-gravitino.md
index 5f74593dd9..4b13cb7be0 100644
--- a/docs/spark-connector/spark-authentication-with-gravitino.md
+++ b/docs/spark-connector/spark-authentication-with-gravitino.md
@@ -9,8 +9,8 @@ license: "This software is licensed under the Apache License
version 2."
Spark connector supports `simple` `oauth2` and `kerberos` authentication when
accessing Gravitino server.
-| Property | Type | Default Value | Description
| Required | Since Version |
-|------------------------------|--------|---------------|---------------------------------------------------------------------------------------------------------------------|----------|------------------|
+| Property | Type | Default Value | Description
| Required | Since Version |
+|------------------------------|--------|---------------|-----------------------------------------------------------------------------------------------------------------------------|----------|------------------|
| spark.sql.gravitino.authType | string | `simple` | The authentication
mechanism for communicating with the Gravitino server. Supported values:
`simple`, `oauth2`, `kerberos`. | No | 0.7.0-incubating |
## Simple Mode
diff --git a/docs/table-partitioning-distribution-sort-order-indexes.md
b/docs/table-partitioning-distribution-sort-order-indexes.md
index 06688cf464..022ef204f7 100644
--- a/docs/table-partitioning-distribution-sort-order-indexes.md
+++ b/docs/table-partitioning-distribution-sort-order-indexes.md
@@ -55,11 +55,11 @@ To create a distribution(bucketed) table, you should use
the following three com
- Strategy. It defines how Gravitino distributes table data across partitions.
-| Distribution strategy | Description
| JSON | Java |
-|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|------------------|
-| hash | Distribution table using hash. Gravitino distributes
table data into buckets based on the hash value of the key.
| `hash` | `Strategy.HASH` |
-| range | Distribution table using range. Gravitino
distributes table data into buckets based on a specified range or interval of
values. | `range` |
`Strategy.RANGE` |
-| even | Distributes table data evenly across partitions.
`even` implements Doris's `random` distribution. | `even` | `Strategy.EVEN` |
+| Distribution strategy | Description
|
JSON | Java |
+|-----------------------|---------------------------------------------------------------------------------------------------------------------------------|---------|------------------|
+| hash | Distribution table using hash. Gravitino distributes
table data into buckets based on the hash value of the key. |
`hash` | `Strategy.HASH` |
+| range | Distribution table using range. Gravitino
distributes table data into buckets based on a specified range or interval of
values. | `range` | `Strategy.RANGE` |
+| even | Distributes table data evenly across partitions.
`even` implements Doris's `random` distribution.
| `even` | `Strategy.EVEN` |
- number. It defines how many buckets you use to distribution the table.
- funcArgs. It defines the arguments of the strategy, the argument must be an
[expression](./expression.md).
