Package org.apache.iceberg

Class TableProperties

  • public class TableProperties
extends java.lang.Object

    • Field Detail

      • FORMAT_VERSION

        public static final java.lang.String FORMAT_VERSION
        Reserved table property for table format version.

        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.

        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.

        Note: incomplete or unstable versions cannot be selected using this property.

        See Also:
        Constant Field Values

      • UUID

        public static final java.lang.String UUID
        Reserved table property for UUID.

        This reserved property is used to store the UUID of the table.

        See Also:
        Constant Field Values

      • RESERVED_PROPERTIES

        public static final java.util.Set<java.lang.String> RESERVED_PROPERTIES
        Reserved Iceberg table properties list.

        Reserved table properties are only used to control behaviors when creating or updating a table. The value of these properties are not persisted as a part of the table metadata.

      • COMMIT_NUM_RETRIES

        public static final java.lang.String COMMIT_NUM_RETRIES
        See Also:
        Constant Field Values

      • COMMIT_NUM_RETRIES_DEFAULT

        public static final int COMMIT_NUM_RETRIES_DEFAULT
        See Also:
        Constant Field Values

      • COMMIT_MIN_RETRY_WAIT_MS

        public static final java.lang.String COMMIT_MIN_RETRY_WAIT_MS
        See Also:
        Constant Field Values

      • COMMIT_MIN_RETRY_WAIT_MS_DEFAULT

        public static final int COMMIT_MIN_RETRY_WAIT_MS_DEFAULT
        See Also:
        Constant Field Values

      • COMMIT_MAX_RETRY_WAIT_MS

        public static final java.lang.String COMMIT_MAX_RETRY_WAIT_MS
        See Also:
        Constant Field Values

      • COMMIT_MAX_RETRY_WAIT_MS_DEFAULT

        public static final int COMMIT_MAX_RETRY_WAIT_MS_DEFAULT
        See Also:
        Constant Field Values

      • COMMIT_TOTAL_RETRY_TIME_MS

        public static final java.lang.String COMMIT_TOTAL_RETRY_TIME_MS
        See Also:
        Constant Field Values

      • COMMIT_TOTAL_RETRY_TIME_MS_DEFAULT

        public static final int COMMIT_TOTAL_RETRY_TIME_MS_DEFAULT
        See Also:
        Constant Field Values

      • COMMIT_NUM_STATUS_CHECKS

        public static final java.lang.String COMMIT_NUM_STATUS_CHECKS
        See Also:
        Constant Field Values

      • COMMIT_NUM_STATUS_CHECKS_DEFAULT

        public static final int COMMIT_NUM_STATUS_CHECKS_DEFAULT
        See Also:
        Constant Field Values

      • COMMIT_STATUS_CHECKS_MIN_WAIT_MS

        public static final java.lang.String COMMIT_STATUS_CHECKS_MIN_WAIT_MS
        See Also:
        Constant Field Values

      • COMMIT_STATUS_CHECKS_MIN_WAIT_MS_DEFAULT

        public static final long COMMIT_STATUS_CHECKS_MIN_WAIT_MS_DEFAULT
        See Also:
        Constant Field Values

      • COMMIT_STATUS_CHECKS_MAX_WAIT_MS

        public static final java.lang.String COMMIT_STATUS_CHECKS_MAX_WAIT_MS
        See Also:
        Constant Field Values

      • COMMIT_STATUS_CHECKS_MAX_WAIT_MS_DEFAULT

        public static final long COMMIT_STATUS_CHECKS_MAX_WAIT_MS_DEFAULT
        See Also:
        Constant Field Values

      • COMMIT_STATUS_CHECKS_TOTAL_WAIT_MS

        public static final java.lang.String COMMIT_STATUS_CHECKS_TOTAL_WAIT_MS
        See Also:
        Constant Field Values

      • COMMIT_STATUS_CHECKS_TOTAL_WAIT_MS_DEFAULT

        public static final long COMMIT_STATUS_CHECKS_TOTAL_WAIT_MS_DEFAULT
        See Also:
        Constant Field Values

      • MANIFEST_TARGET_SIZE_BYTES

        public static final java.lang.String MANIFEST_TARGET_SIZE_BYTES
        See Also:
        Constant Field Values

      • MANIFEST_TARGET_SIZE_BYTES_DEFAULT

        public static final long MANIFEST_TARGET_SIZE_BYTES_DEFAULT
        See Also:
        Constant Field Values

      • MANIFEST_MIN_MERGE_COUNT

        public static final java.lang.String MANIFEST_MIN_MERGE_COUNT
        See Also:
        Constant Field Values

      • MANIFEST_MIN_MERGE_COUNT_DEFAULT

        public static final int MANIFEST_MIN_MERGE_COUNT_DEFAULT
        See Also:
        Constant Field Values

      • MANIFEST_MERGE_ENABLED

        public static final java.lang.String MANIFEST_MERGE_ENABLED
        See Also:
        Constant Field Values

      • MANIFEST_MERGE_ENABLED_DEFAULT

        public static final boolean MANIFEST_MERGE_ENABLED_DEFAULT
        See Also:
        Constant Field Values

      • DEFAULT_FILE_FORMAT

        public static final java.lang.String DEFAULT_FILE_FORMAT
        See Also:
        Constant Field Values

      • DELETE_DEFAULT_FILE_FORMAT

        public static final java.lang.String DELETE_DEFAULT_FILE_FORMAT
        See Also:
        Constant Field Values

      • DEFAULT_FILE_FORMAT_DEFAULT

        public static final java.lang.String DEFAULT_FILE_FORMAT_DEFAULT
        See Also:
        Constant Field Values

      • PARQUET_ROW_GROUP_SIZE_BYTES

        public static final java.lang.String PARQUET_ROW_GROUP_SIZE_BYTES
        See Also:
        Constant Field Values

      • DELETE_PARQUET_ROW_GROUP_SIZE_BYTES

        public static final java.lang.String DELETE_PARQUET_ROW_GROUP_SIZE_BYTES
        See Also:
        Constant Field Values

      • PARQUET_ROW_GROUP_SIZE_BYTES_DEFAULT

        public static final java.lang.String PARQUET_ROW_GROUP_SIZE_BYTES_DEFAULT
        See Also:
        Constant Field Values

      • PARQUET_PAGE_SIZE_BYTES

        public static final java.lang.String PARQUET_PAGE_SIZE_BYTES
        See Also:
        Constant Field Values

      • DELETE_PARQUET_PAGE_SIZE_BYTES

        public static final java.lang.String DELETE_PARQUET_PAGE_SIZE_BYTES
        See Also:
        Constant Field Values

      • PARQUET_PAGE_SIZE_BYTES_DEFAULT

        public static final java.lang.String PARQUET_PAGE_SIZE_BYTES_DEFAULT
        See Also:
        Constant Field Values

      • PARQUET_DICT_SIZE_BYTES

        public static final java.lang.String PARQUET_DICT_SIZE_BYTES
        See Also:
        Constant Field Values

      • DELETE_PARQUET_DICT_SIZE_BYTES

        public static final java.lang.String DELETE_PARQUET_DICT_SIZE_BYTES
        See Also:
        Constant Field Values

      • PARQUET_DICT_SIZE_BYTES_DEFAULT

        public static final java.lang.String PARQUET_DICT_SIZE_BYTES_DEFAULT
        See Also:
        Constant Field Values

      • PARQUET_COMPRESSION

        public static final java.lang.String PARQUET_COMPRESSION
        See Also:
        Constant Field Values

      • DELETE_PARQUET_COMPRESSION

        public static final java.lang.String DELETE_PARQUET_COMPRESSION
        See Also:
        Constant Field Values

      • PARQUET_COMPRESSION_DEFAULT

        public static final java.lang.String PARQUET_COMPRESSION_DEFAULT
        See Also:
        Constant Field Values

      • PARQUET_COMPRESSION_LEVEL

        public static final java.lang.String PARQUET_COMPRESSION_LEVEL
        See Also:
        Constant Field Values

      • DELETE_PARQUET_COMPRESSION_LEVEL

        public static final java.lang.String DELETE_PARQUET_COMPRESSION_LEVEL
        See Also:
        Constant Field Values

      • PARQUET_COMPRESSION_LEVEL_DEFAULT

        public static final java.lang.String PARQUET_COMPRESSION_LEVEL_DEFAULT

      • AVRO_COMPRESSION

        public static final java.lang.String AVRO_COMPRESSION
        See Also:
        Constant Field Values

      • DELETE_AVRO_COMPRESSION

        public static final java.lang.String DELETE_AVRO_COMPRESSION
        See Also:
        Constant Field Values

      • AVRO_COMPRESSION_DEFAULT

        public static final java.lang.String AVRO_COMPRESSION_DEFAULT
        See Also:
        Constant Field Values

      • METADATA_SPLIT_SIZE

        public static final java.lang.String METADATA_SPLIT_SIZE
        See Also:
        Constant Field Values

      • METADATA_SPLIT_SIZE_DEFAULT

        public static final long METADATA_SPLIT_SIZE_DEFAULT
        See Also:
        Constant Field Values

      • SPLIT_OPEN_FILE_COST

        public static final java.lang.String SPLIT_OPEN_FILE_COST
        See Also:
        Constant Field Values

      • SPLIT_OPEN_FILE_COST_DEFAULT

        public static final long SPLIT_OPEN_FILE_COST_DEFAULT
        See Also:
        Constant Field Values

      • PARQUET_VECTORIZATION_ENABLED

        public static final java.lang.String PARQUET_VECTORIZATION_ENABLED
        See Also:
        Constant Field Values

      • PARQUET_VECTORIZATION_ENABLED_DEFAULT

        public static final boolean PARQUET_VECTORIZATION_ENABLED_DEFAULT
        See Also:
        Constant Field Values

      • PARQUET_BATCH_SIZE

        public static final java.lang.String PARQUET_BATCH_SIZE
        See Also:
        Constant Field Values

      • PARQUET_BATCH_SIZE_DEFAULT

        public static final int PARQUET_BATCH_SIZE_DEFAULT
        See Also:
        Constant Field Values

      • ORC_VECTORIZATION_ENABLED

        public static final java.lang.String ORC_VECTORIZATION_ENABLED
        See Also:
        Constant Field Values

      • ORC_VECTORIZATION_ENABLED_DEFAULT

        public static final boolean ORC_VECTORIZATION_ENABLED_DEFAULT
        See Also:
        Constant Field Values

      • OBJECT_STORE_ENABLED

        public static final java.lang.String OBJECT_STORE_ENABLED
        See Also:
        Constant Field Values

      • OBJECT_STORE_ENABLED_DEFAULT

        public static final boolean OBJECT_STORE_ENABLED_DEFAULT
        See Also:
        Constant Field Values

      • WRITE_LOCATION_PROVIDER_IMPL

        public static final java.lang.String WRITE_LOCATION_PROVIDER_IMPL
        See Also:
        Constant Field Values

      • WRITE_NEW_DATA_LOCATION

        @Deprecated
public static final java.lang.String WRITE_NEW_DATA_LOCATION
        Deprecated.
        will be removed in 0.14.0, use WRITE_DATA_LOCATION instead
        See Also:
        Constant Field Values

      • WRITE_DATA_LOCATION

        public static final java.lang.String WRITE_DATA_LOCATION
        See Also:
        Constant Field Values

      • WRITE_METADATA_LOCATION

        public static final java.lang.String WRITE_METADATA_LOCATION
        See Also:
        Constant Field Values

      • WRITE_PARTITION_SUMMARY_LIMIT

        public static final java.lang.String WRITE_PARTITION_SUMMARY_LIMIT
        See Also:
        Constant Field Values

      • WRITE_PARTITION_SUMMARY_LIMIT_DEFAULT

        public static final int WRITE_PARTITION_SUMMARY_LIMIT_DEFAULT
        See Also:
        Constant Field Values

      • MANIFEST_LISTS_ENABLED

        public static final java.lang.String MANIFEST_LISTS_ENABLED
        See Also:
        Constant Field Values

      • MANIFEST_LISTS_ENABLED_DEFAULT

        public static final boolean MANIFEST_LISTS_ENABLED_DEFAULT
        See Also:
        Constant Field Values

      • METADATA_COMPRESSION

        public static final java.lang.String METADATA_COMPRESSION
        See Also:
        Constant Field Values

      • METADATA_COMPRESSION_DEFAULT

        public static final java.lang.String METADATA_COMPRESSION_DEFAULT
        See Also:
        Constant Field Values

      • METADATA_PREVIOUS_VERSIONS_MAX

        public static final java.lang.String METADATA_PREVIOUS_VERSIONS_MAX
        See Also:
        Constant Field Values

      • METADATA_PREVIOUS_VERSIONS_MAX_DEFAULT

        public static final int METADATA_PREVIOUS_VERSIONS_MAX_DEFAULT
        See Also:
        Constant Field Values

      • METADATA_DELETE_AFTER_COMMIT_ENABLED

        public static final java.lang.String METADATA_DELETE_AFTER_COMMIT_ENABLED
        See Also:
        Constant Field Values

      • METADATA_DELETE_AFTER_COMMIT_ENABLED_DEFAULT

        public static final boolean METADATA_DELETE_AFTER_COMMIT_ENABLED_DEFAULT
        See Also:
        Constant Field Values

      • METRICS_MODE_COLUMN_CONF_PREFIX

        public static final java.lang.String METRICS_MODE_COLUMN_CONF_PREFIX
        See Also:
        Constant Field Values

      • DEFAULT_WRITE_METRICS_MODE

        public static final java.lang.String DEFAULT_WRITE_METRICS_MODE
        See Also:
        Constant Field Values

      • DEFAULT_WRITE_METRICS_MODE_DEFAULT

        public static final java.lang.String DEFAULT_WRITE_METRICS_MODE_DEFAULT
        See Also:
        Constant Field Values

      • DEFAULT_NAME_MAPPING

        public static final java.lang.String DEFAULT_NAME_MAPPING
        See Also:
        Constant Field Values

      • WRITE_AUDIT_PUBLISH_ENABLED

        public static final java.lang.String WRITE_AUDIT_PUBLISH_ENABLED
        See Also:
        Constant Field Values

      • WRITE_AUDIT_PUBLISH_ENABLED_DEFAULT

        public static final java.lang.String WRITE_AUDIT_PUBLISH_ENABLED_DEFAULT
        See Also:
        Constant Field Values

      • WRITE_TARGET_FILE_SIZE_BYTES

        public static final java.lang.String WRITE_TARGET_FILE_SIZE_BYTES
        See Also:
        Constant Field Values

      • WRITE_TARGET_FILE_SIZE_BYTES_DEFAULT

        public static final long WRITE_TARGET_FILE_SIZE_BYTES_DEFAULT
        See Also:
        Constant Field Values

      • DELETE_TARGET_FILE_SIZE_BYTES

        public static final java.lang.String DELETE_TARGET_FILE_SIZE_BYTES
        See Also:
        Constant Field Values

      • DELETE_TARGET_FILE_SIZE_BYTES_DEFAULT

        public static final long DELETE_TARGET_FILE_SIZE_BYTES_DEFAULT
        See Also:
        Constant Field Values

      • SPARK_WRITE_PARTITIONED_FANOUT_ENABLED

        public static final java.lang.String SPARK_WRITE_PARTITIONED_FANOUT_ENABLED
        See Also:
        Constant Field Values

      • SPARK_WRITE_PARTITIONED_FANOUT_ENABLED_DEFAULT

        public static final boolean SPARK_WRITE_PARTITIONED_FANOUT_ENABLED_DEFAULT
        See Also:
        Constant Field Values

      • SNAPSHOT_ID_INHERITANCE_ENABLED

        public static final java.lang.String SNAPSHOT_ID_INHERITANCE_ENABLED
        See Also:
        Constant Field Values

      • SNAPSHOT_ID_INHERITANCE_ENABLED_DEFAULT

        public static final boolean SNAPSHOT_ID_INHERITANCE_ENABLED_DEFAULT
        See Also:
        Constant Field Values

      • ENGINE_HIVE_ENABLED

        public static final java.lang.String ENGINE_HIVE_ENABLED
        See Also:
        Constant Field Values

      • ENGINE_HIVE_ENABLED_DEFAULT

        public static final boolean ENGINE_HIVE_ENABLED_DEFAULT
        See Also:
        Constant Field Values

      • WRITE_DISTRIBUTION_MODE

        public static final java.lang.String WRITE_DISTRIBUTION_MODE
        See Also:
        Constant Field Values

      • WRITE_DISTRIBUTION_MODE_NONE

        public static final java.lang.String WRITE_DISTRIBUTION_MODE_NONE
        See Also:
        Constant Field Values

      • WRITE_DISTRIBUTION_MODE_HASH

        public static final java.lang.String WRITE_DISTRIBUTION_MODE_HASH
        See Also:
        Constant Field Values

      • WRITE_DISTRIBUTION_MODE_RANGE

        public static final java.lang.String WRITE_DISTRIBUTION_MODE_RANGE
        See Also:
        Constant Field Values

      • WRITE_DISTRIBUTION_MODE_DEFAULT

        @Deprecated
public static final java.lang.String WRITE_DISTRIBUTION_MODE_DEFAULT
        Deprecated.
        will be removed in 0.14.0, use specific modes instead
        See Also:
        Constant Field Values

      • MAX_SNAPSHOT_AGE_MS

        public static final java.lang.String MAX_SNAPSHOT_AGE_MS
        See Also:
        Constant Field Values

      • MAX_SNAPSHOT_AGE_MS_DEFAULT

        public static final long MAX_SNAPSHOT_AGE_MS_DEFAULT
        See Also:
        Constant Field Values

      • MIN_SNAPSHOTS_TO_KEEP

        public static final java.lang.String MIN_SNAPSHOTS_TO_KEEP
        See Also:
        Constant Field Values

      • MIN_SNAPSHOTS_TO_KEEP_DEFAULT

        public static final int MIN_SNAPSHOTS_TO_KEEP_DEFAULT
        See Also:
        Constant Field Values

      • DELETE_ISOLATION_LEVEL

        public static final java.lang.String DELETE_ISOLATION_LEVEL
        See Also:
        Constant Field Values

      • DELETE_ISOLATION_LEVEL_DEFAULT

        public static final java.lang.String DELETE_ISOLATION_LEVEL_DEFAULT
        See Also:
        Constant Field Values

      • DELETE_MODE_DEFAULT

        public static final java.lang.String DELETE_MODE_DEFAULT
        See Also:
        Constant Field Values

      • DELETE_DISTRIBUTION_MODE

        public static final java.lang.String DELETE_DISTRIBUTION_MODE
        See Also:
        Constant Field Values

      • UPDATE_ISOLATION_LEVEL

        public static final java.lang.String UPDATE_ISOLATION_LEVEL
        See Also:
        Constant Field Values

      • UPDATE_ISOLATION_LEVEL_DEFAULT

        public static final java.lang.String UPDATE_ISOLATION_LEVEL_DEFAULT
        See Also:
        Constant Field Values

      • UPDATE_MODE_DEFAULT

        public static final java.lang.String UPDATE_MODE_DEFAULT
        See Also:
        Constant Field Values

      • UPDATE_DISTRIBUTION_MODE

        public static final java.lang.String UPDATE_DISTRIBUTION_MODE
        See Also:
        Constant Field Values

      • MERGE_ISOLATION_LEVEL

        public static final java.lang.String MERGE_ISOLATION_LEVEL
        See Also:
        Constant Field Values

      • MERGE_ISOLATION_LEVEL_DEFAULT

        public static final java.lang.String MERGE_ISOLATION_LEVEL_DEFAULT
        See Also:
        Constant Field Values

      • MERGE_MODE_DEFAULT

        public static final java.lang.String MERGE_MODE_DEFAULT
        See Also:
        Constant Field Values

      • MERGE_CARDINALITY_CHECK_ENABLED

        @Deprecated
public static final java.lang.String MERGE_CARDINALITY_CHECK_ENABLED
        Deprecated.
        will be removed in 0.14.0, the cardinality check is always performed starting from 0.13.0.
        See Also:
        Constant Field Values

      • MERGE_CARDINALITY_CHECK_ENABLED_DEFAULT

        @Deprecated
public static final boolean MERGE_CARDINALITY_CHECK_ENABLED_DEFAULT
        Deprecated.
        will be removed in 0.14.0, the cardinality check is always performed starting from 0.13.0.
        See Also:
        Constant Field Values

      • MERGE_DISTRIBUTION_MODE

        public static final java.lang.String MERGE_DISTRIBUTION_MODE
        See Also:
        Constant Field Values

      • UPSERT_ENABLED_DEFAULT

        public static final boolean UPSERT_ENABLED_DEFAULT
        See Also:
        Constant Field Values