rdblue commented on a change in pull request #2887:
URL: https://github.com/apache/iceberg/pull/2887#discussion_r681883365
##########
File path: core/src/main/java/org/apache/iceberg/TableProperties.java
##########
@@ -19,11 +19,38 @@
package org.apache.iceberg;
+import java.util.List;
+import org.apache.iceberg.relocated.com.google.common.collect.ImmutableList;
+
public class TableProperties {
private TableProperties() {
}
+ /**
+ * Reserved table property for table format version.
+ * <p>
+ * Iceberg will default a new table's format version to the latest stable
and recommended version.
+ * This reserved property keyword allows users to override the Iceberg
format version of the table metadata.
+ * <p>
+ * If this table property exists when creating a table, the table will use
the specified format version.
+ * If a table updates this property, it will try to upgrade to the specified
format version.
+ * This helps developers to try out new features in an unreleased version or
migrate existing tables to a new version.
+ * <p>
+ * Note: incomplete or unstable versions cannot be selected using this
property.
+ */
+ public static final String RESERVED_PROPERTY_FORMAT_VERSION =
"format-version";
+
+ /**
+ * Reserved Iceberg table properties list.
+ * <p>
+ * Reserved table properties are only used to control behaviors during the
construction of table metadata.
+ * The value of these properties are not persisted as a part of the table
metadata.
+ */
+ public static final List<String> RESERVED_PROPERTIES = ImmutableList.of(
Review comment:
The code to filter out reserved properties calls `contains`, so I think
this should be an `ImmutableSet` instead of a list.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
