This is an automated email from the ASF dual-hosted git repository.
yufei 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 26ea0222a Docs: Fix the misleading deprecation labels (#3694)
26ea0222a is described below
commit 26ea0222a140c8de59becbb8cbf971ac166cfed6
Author: Yufei Gu <[email protected]>
AuthorDate: Tue Feb 10 14:36:17 2026 -0800
Docs: Fix the misleading deprecation labels (#3694)
---
.../polaris/core/config/FeatureConfiguration.java | 24 ++++++++++++++--------
site/content/in-dev/unreleased/configuration.md | 16 +++++++--------
2 files changed, 24 insertions(+), 16 deletions(-)
diff --git
a/polaris-core/src/main/java/org/apache/polaris/core/config/FeatureConfiguration.java
b/polaris-core/src/main/java/org/apache/polaris/core/config/FeatureConfiguration.java
index d9fe3d564..d352c95b7 100644
---
a/polaris-core/src/main/java/org/apache/polaris/core/config/FeatureConfiguration.java
+++
b/polaris-core/src/main/java/org/apache/polaris/core/config/FeatureConfiguration.java
@@ -128,7 +128,8 @@ public class FeatureConfiguration<T> extends
PolarisConfiguration<T> {
.defaultValue(true)
.buildFeatureConfiguration();
- @SuppressWarnings("deprecation")
+ @SuppressWarnings(
+ "deprecation") // catalogConfigUnsafe() is deprecated, not the feature
config itself
public static final FeatureConfiguration<Boolean>
ALLOW_TABLE_LOCATION_OVERLAP =
PolarisConfiguration.<Boolean>builder()
.key("ALLOW_TABLE_LOCATION_OVERLAP")
@@ -164,7 +165,8 @@ public class FeatureConfiguration<T> extends
PolarisConfiguration<T> {
.defaultValue(false)
.buildFeatureConfiguration();
- @SuppressWarnings("deprecation")
+ @SuppressWarnings(
+ "deprecation") // catalogConfigUnsafe() is deprecated, not the feature
config itself
public static final FeatureConfiguration<Boolean>
ALLOW_UNSTRUCTURED_TABLE_LOCATION =
PolarisConfiguration.<Boolean>builder()
.key("ALLOW_UNSTRUCTURED_TABLE_LOCATION")
@@ -174,7 +176,8 @@ public class FeatureConfiguration<T> extends
PolarisConfiguration<T> {
.defaultValue(false)
.buildFeatureConfiguration();
- @SuppressWarnings("deprecation")
+ @SuppressWarnings(
+ "deprecation") // catalogConfigUnsafe() is deprecated, not the feature
config itself
public static final FeatureConfiguration<Boolean>
ALLOW_EXTERNAL_TABLE_LOCATION =
PolarisConfiguration.<Boolean>builder()
.key("ALLOW_EXTERNAL_TABLE_LOCATION")
@@ -185,7 +188,8 @@ public class FeatureConfiguration<T> extends
PolarisConfiguration<T> {
.defaultValue(false)
.buildFeatureConfiguration();
- @SuppressWarnings("deprecation")
+ @SuppressWarnings(
+ "deprecation") // catalogConfigUnsafe() is deprecated, not the feature
config itself
public static final FeatureConfiguration<Boolean>
ALLOW_EXTERNAL_CATALOG_CREDENTIAL_VENDING =
PolarisConfiguration.<Boolean>builder()
.key("ALLOW_EXTERNAL_CATALOG_CREDENTIAL_VENDING")
@@ -204,7 +208,8 @@ public class FeatureConfiguration<T> extends
PolarisConfiguration<T> {
.defaultValue(false)
.buildFeatureConfiguration();
- @SuppressWarnings("deprecation")
+ @SuppressWarnings(
+ "deprecation") // catalogConfigUnsafe() is deprecated, not the feature
config itself
public static final FeatureConfiguration<List<String>>
SUPPORTED_CATALOG_STORAGE_TYPES =
PolarisConfiguration.<List<String>>builder()
.key("SUPPORTED_CATALOG_STORAGE_TYPES")
@@ -218,7 +223,8 @@ public class FeatureConfiguration<T> extends
PolarisConfiguration<T> {
StorageConfigInfo.StorageTypeEnum.GCS.name()))
.buildFeatureConfiguration();
- @SuppressWarnings("deprecation")
+ @SuppressWarnings(
+ "deprecation") // catalogConfigUnsafe() is deprecated, not the feature
config itself
public static final FeatureConfiguration<Boolean> CLEANUP_ON_NAMESPACE_DROP =
PolarisConfiguration.<Boolean>builder()
.key("CLEANUP_ON_NAMESPACE_DROP")
@@ -228,7 +234,8 @@ public class FeatureConfiguration<T> extends
PolarisConfiguration<T> {
.defaultValue(false)
.buildFeatureConfiguration();
- @SuppressWarnings("deprecation")
+ @SuppressWarnings(
+ "deprecation") // catalogConfigUnsafe() is deprecated, not the feature
config itself
public static final FeatureConfiguration<Boolean> CLEANUP_ON_CATALOG_DROP =
PolarisConfiguration.<Boolean>builder()
.key("CLEANUP_ON_CATALOG_DROP")
@@ -238,7 +245,8 @@ public class FeatureConfiguration<T> extends
PolarisConfiguration<T> {
.defaultValue(false)
.buildFeatureConfiguration();
- @SuppressWarnings("deprecation")
+ @SuppressWarnings(
+ "deprecation") // catalogConfigUnsafe() is deprecated, not the feature
config itself
public static final FeatureConfiguration<Boolean> DROP_WITH_PURGE_ENABLED =
PolarisConfiguration.<Boolean>builder()
.key("DROP_WITH_PURGE_ENABLED")
diff --git a/site/content/in-dev/unreleased/configuration.md
b/site/content/in-dev/unreleased/configuration.md
index 1572b73e1..92f19c71c 100644
--- a/site/content/in-dev/unreleased/configuration.md
+++ b/site/content/in-dev/unreleased/configuration.md
@@ -93,18 +93,18 @@ read-only mode, as Polaris only reads the configuration
file once, at startup.
| `polaris.features."ENFORCE_PRINCIPAL_CREDENTIAL_ROTATION_REQUIRED_CHECKING"`
| `false` | If set to true, require that
principals must rotate their credentials before being used for anything else.
[...]
| `polaris.features."SKIP_CREDENTIAL_SUBSCOPING_INDIRECTION"`
| `false` | If set to true, skip
credential-subscoping indirection entirely whenever trying to obtain storage
credentials for instantiating a FileIO. If 'true', no attempt is made to use
StorageConfigs to generate table-specific storage credentials, but instead the
default fallthrough of table-level credential properties or else
provider-specific APPLICATION_DEFAULT creden [...]
| `polaris.features."ALLOW_SETTING_S3_ENDPOINTS"`
| `true` | If set to true (default),
Polaris will permit S3 storage configurations to have custom endpoints. If set
to false, Polaris will not accept catalog create and update requests that
contain S3 endpoint properties.
[...]
-| `polaris.features."ALLOW_TABLE_LOCATION_OVERLAP"`
| `false` | (DEPRECATION) If set to true,
allow one table's location to reside within another table's location. This is
only enforced within a given namespace.
[...]
+| `polaris.features."ALLOW_TABLE_LOCATION_OVERLAP"`
| `false` | If set to true, allow one
table's location to reside within another table's location. This is only
enforced within a given namespace.
[...]
| `polaris.features."ALLOW_NAMESPACE_LOCATION_OVERLAP"`
| `false` | If set to true, allow one
namespace's location to reside within another namespace's location. This is
only enforced within a parent catalog or namespace.
[...]
| `polaris.features."ALLOW_EXTERNAL_METADATA_FILE_LOCATION"`
| `false` | If set to true, allows
metadata files to be located outside the default metadata directory.
[...]
| `polaris.features."ALLOW_OVERLAPPING_CATALOG_URLS"`
| `false` | If set to true, allows
catalog URLs to overlap.
[...]
-| `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_UNSTRUCTURED_TABLE_LOCATION"`
| `false` | If set to true, allows
unstructured table locations.
[...]
+| `polaris.features."ALLOW_EXTERNAL_TABLE_LOCATION"`
| `false` | If set to true, allows tables
to have external locations outside the default structure.
[...]
+| `polaris.features."ALLOW_EXTERNAL_CATALOG_CREDENTIAL_VENDING"`
| `true` | 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."SUPPORTED_CATALOG_STORAGE_TYPES"`
| `S3`, `AZURE`, `GCS` | The list of supported storage
types for a catalog.
[...]
+| `polaris.features."CLEANUP_ON_NAMESPACE_DROP"`
| `false` | If set to true, clean up data
when a namespace is dropped.
[...]
+| `polaris.features."CLEANUP_ON_CATALOG_DROP"`
| `false` | If set to true, clean up data
when a catalog is dropped.
[...]
+| `polaris.features."DROP_WITH_PURGE_ENABLED"`
| `false` | 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.
[...]
