Skip to content

IcebergRetentionConfiguration

Source code in docs_src/capo_glue/types/iceberg_retention_configuration.py
class IcebergRetentionConfiguration(TypedDict, closed=True):
    snapshot_retention_period_in_days: NotRequired[
        "capo_glue.types.nullable_integer.NullableInteger"
    ]
    """<p>The number of days to retain the Iceberg snapshots. If an input is not provided, the corresponding Iceberg table configuration field will be used or if not present, the default value 5 will be used.</p>"""
    number_of_snapshots_to_retain: NotRequired[
        "capo_glue.types.nullable_integer.NullableInteger"
    ]
    """<p>The number of Iceberg snapshots to retain within the retention period. If an input is not provided, the corresponding Iceberg table configuration field will be used or if not present, the default value 1 will be used.</p>"""
    clean_expired_files: NotRequired["capo_glue.types.nullable_boolean.NullableBoolean"]
    """<p>If set to false, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted.</p>"""
    run_rate_in_hours: NotRequired["capo_glue.types.nullable_integer.NullableInteger"]
    """<p>The interval in hours between retention job runs. This parameter controls how frequently the retention optimizer will run to clean up expired snapshots. The value must be between 3 and 168 hours (7 days). If an input is not provided, the default value 24 will be used.</p>"""

clean_expired_files instance-attribute

clean_expired_files: NotRequired[NullableBoolean]

If set to false, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted.

number_of_snapshots_to_retain instance-attribute

number_of_snapshots_to_retain: NotRequired[NullableInteger]

The number of Iceberg snapshots to retain within the retention period. If an input is not provided, the corresponding Iceberg table configuration field will be used or if not present, the default value 1 will be used.

run_rate_in_hours instance-attribute

run_rate_in_hours: NotRequired[NullableInteger]

The interval in hours between retention job runs. This parameter controls how frequently the retention optimizer will run to clean up expired snapshots. The value must be between 3 and 168 hours (7 days). If an input is not provided, the default value 24 will be used.

snapshot_retention_period_in_days instance-attribute

snapshot_retention_period_in_days: NotRequired[NullableInteger]

The number of days to retain the Iceberg snapshots. If an input is not provided, the corresponding Iceberg table configuration field will be used or if not present, the default value 5 will be used.