This is an automated email from the ASF dual-hosted git repository. yzheng pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new 3e9f9313e (doc) Add doc for couple new feature flags introduced
recently (#3511)
3e9f9313e is described below
commit 3e9f9313e0b1ea0f600faae6afc852b5c9f402ea
Author: Yong Zheng <[email protected]>
AuthorDate: Fri Jan 23 13:15:09 2026 -0600
(doc) Add doc for couple new feature flags introduced recently (#3511)
* Add doc for couple new feature flags
* Add doc for couple new feature flags
---
site/content/in-dev/unreleased/configuration.md | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/site/content/in-dev/unreleased/configuration.md
b/site/content/in-dev/unreleased/configuration.md
index 5e666d5a7..2e5975ebb 100644
--- a/site/content/in-dev/unreleased/configuration.md
+++ b/site/content/in-dev/unreleased/configuration.md
@@ -83,7 +83,7 @@ read-only mode, as Polaris only reads the configuration file
once, at startup.
| Configuration Property
| Default Value | Description
[...]
|----------------------------------------------------------------------------------------|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| `polaris.persistence.type`
| `relational-jdbc` | Define the persistence
backend used by Polaris (`in-memory`, `relational-jdbc`). See [Configuring
Apache Polaris for Production)[{{% ref "configuring-polaris-for-production.md"
%}})
[...]
+| `polaris.persistence.type`
| `relational-jdbc` | Define the persistence
backend used by Polaris (`in-memory`, `relational-jdbc`). See [Configuring
Apache Polaris for Production)[{{% ref "configuring-polaris-for-production.md"
%}})
[...]
| `polaris.persistence.relational.jdbc.max-retries`
| `1` | Total number of retries JDBC
persistence will attempt on connection resets or serialization failures before
giving up.
[...]
| `polaris.persistence.relational.jdbc.max_duaration_in_ms`
| `5000 ms` | Max time interval (ms) since
the start of a transaction when retries can be attempted.
[...]
| `polaris.persistence.relational.jdbc.initial_delay_in_ms`
| `100 ms` | Initial delay before
retrying. The delay is doubled after each retry.
[...]
@@ -100,11 +100,13 @@ read-only mode, as Polaris only reads the configuration
file once, at startup.
| `polaris.features."ALLOW_UNSTRUCTURED_TABLE_LOCATION"`
| `false` | (DEPRECATION) If set to true,
allows unstructured table locations.
[...]
| `polaris.features."ALLOW_EXTERNAL_TABLE_LOCATION"`
| `false` | (DEPRECATION) If set to true,
allows tables to have external locations outside the default structure.
[...]
| `polaris.features."ALLOW_EXTERNAL_CATALOG_CREDENTIAL_VENDING"`
| `true` | (DEPRECATION) If set to true,
allow credential vending for external catalogs.
[...]
+| `polaris.features."ALLOW_WILDCARD_LOCATION"`
| `false` | Indicates whether asterisks
('*') in configuration values defining allowed storage locations are processed
as meaning 'any location'.
[...]
| `polaris.features."SUPPORTED_CATALOG_STORAGE_TYPES"`
| `S3`, `AZURE`, `GCS` | (DEPRECATION) The list of
supported storage types for a catalog.
[...]
| `polaris.features."CLEANUP_ON_NAMESPACE_DROP"`
| `false` | (DEPRECATION) If set to true,
clean up data when a namespace is dropped.
[...]
| `polaris.features."CLEANUP_ON_CATALOG_DROP"`
| `false` | (DEPRECATION) If set to true,
clean up data when a catalog is dropped.
[...]
| `polaris.features."DROP_WITH_PURGE_ENABLED"`
| `false` | (DEPRECATION) If set to true,
allows tables to be dropped with the purge parameter set to true.
[...]
| `polaris.features."PURGE_VIEW_METADATA_ON_DROP"`
| `true` | If set to true, Polaris will
attempt to delete view metadata files when a view is dropped.
[...]
+| `polaris.features."POLARIS_TASK_TIMEOUT_MILLIS"`
| `300000` | Polaris task expiry timeout
(milliseconds). Older unfinished tasks may not be processed.
[...]
| `polaris.features."STORAGE_CREDENTIAL_DURATION_SECONDS"`
| `3600` | The duration of time that
vended storage credentials are valid for. Support for longer (or shorter)
durations is dependent on the storage provider. GCS current does not respect
this value.
[...]
| `polaris.features."STORAGE_CREDENTIAL_CACHE_DURATION_SECONDS"`
| `1800` | How long to store storage
credentials in the local cache. This should be less than
STORAGE_CREDENTIAL_DURATION_SECONDS.key().
[...]
| `polaris.features."MAX_METADATA_REFRESH_RETRIES"`
| `2` | How many times to retry
refreshing metadata when the previous error was retryable.
[...]
@@ -129,6 +131,11 @@ read-only mode, as Polaris only reads the configuration
file once, at startup.
| `polaris.features."ALLOW_DROPPING_NON_EMPTY_PASSTHROUGH_FACADE_CATALOG"`
| `false` | If enabled, allow dropping a
passthrough-facade catalog even if it contains namespaces or tables.
passthrough-facade catalogs may contain leftover entities when syncing with
source catalog.In the short term these entities will be ignored, in the long
term there will be method/background job to clean them up.
[...]
| `polaris.features."ENABLE_FINE_GRAINED_UPDATE_TABLE_PRIVILEGES"`
| `true` | When true, enables finer
grained update table privileges which are passed to the authorizer for update
table operations.
[...]
| `polaris.features."ALLOW_FEDERATED_CATALOGS_CREDENTIAL_VENDING"`
| `true` | If set to true (default),
allow credential vending for external catalogs. Note this requires
ALLOW_EXTERNAL_CATALOG_CREDENTIAL_VENDING to be true first.
[...]
+| `polaris.features."AZURE_TIMEOUT_MILLIS"`
| `15000` | Timeout in milliseconds for
Azure API requests. Prevents indefinite blocking when Azure endpoints are slow
or unresponsive. Used internally by Azure storage integration for credential
vending and other operations.
[...]
+| `polaris.features."AZURE_RETRY_COUNT"`
| `3` | Number of retry attempts for
Azure API requests. Uses exponential backoff with jitter to handle transient
failures.
[...]
+| `polaris.features."AZURE_RETRY_DELAY_MILLIS"`
| `2000` | Initial delay in milliseconds
before first retry for Azure API requests. Delay doubles with each retry
(exponential backoff).
[...]
+| `polaris.features."AZURE_RETRY_JITTER_FACTOR"`
| `0.5` | Jitter factor (0.0 to 1.0)
applied to retry delays for Azure API requests. The jitter is applied as a
random percentage of the computed exponential backoff delay. For example, 0.5
means up to 50%% random jitter will be added to each retry delay. Helps prevent
thundering herd when multiple requests fail simultaneously.
[...]
+| `polaris.features."TABLE_METADATA_CLEANUP_BATCH_SIZE"`
| `10` | Metadata batch size for tasks
that clean up dropped tables' files.
[...]
|
`polaris.features.realm-overrides."my-realm"."SKIP_CREDENTIAL_SUBSCOPING_INDIRECTION"`
| `true` | "Override" realm features, here the
skip credential subscoping indirection flag.
[...]
| `polaris.authentication.type`
| `internal` | The type of authentication to
use. Three built-in types are supported: `internal`, `external`, and `mixed`.
[...]
| `polaris.authentication.authenticator.type`
| `default` | Define the Polaris
authenticator type.
[...]
@@ -158,7 +165,7 @@ read-only mode, as Polaris only reads the configuration
file once, at startup.
| `polaris.rate-limiter.token-bucket.type`
| `default` | Define the token bucket rate
limiter.
[...]
| `polaris.rate-limiter.token-bucket.requests-per-second`
| `9999` | Define the number of requests
per second for the token bucket rate limiter.
[...]
| `polaris.rate-limiter.token-bucket.window`
| `PT10S` | Define the window type for
the token bucket rate limiter.
[...]
-| `polaris.metrics.tags.<tag-name>=<tag-value>`
| `application=Polaris` | Define arbitrary metric tags
to include in every request.
[...]
+| `polaris.metrics.tags.<tag-name>=<tag-value>`
| `application=Polaris` | Define arbitrary metric tags
to include in every request.
[...]
| `polaris.metrics.realm-id-tag.api-metrics-enabled`
| `false` | Whether to enable the
`realm_id` metric tag in API metrics.
[...]
| `polaris.metrics.realm-id-tag.http-metrics-enabled`
| `false` | Whether to enable the
`realm_id` metric tag in HTTP request metrics.
[...]
| `polaris.metrics.realm-id-tag.http-metrics-max-cardinality`
| `100` | The maximum cardinality for
the `realm_id` tag in HTTP request metrics.
[...]
