You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/reference/partials/properties/topic-properties.adoc
+22-4Lines changed: 22 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -317,6 +317,8 @@ endif::[]
317
317
318
318
The retention time for tombstone records in a compacted topic. Redpanda removes tombstone records after the retention limit is exceeded.
319
319
320
+
This property supports three states: set to a specific millisecond value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (no per-topic limit applied). Setting the value to 0 means tombstone records are immediately eligible for removal.
321
+
320
322
If you have enabled Tiered Storage and set <<redpandaremoteread,`redpanda.remote.read`>> or <<redpandaremotewrite,`redpanda.remote.write`>> for the topic, you cannot enable tombstone removal.
321
323
322
324
If both `delete.retention.ms` and the cluster property config_ref:tombstone_retention_ms,true,properties/cluster-properties[] are set, `delete.retention.ms` overrides the cluster level tombstone retention for an individual topic.
@@ -499,6 +501,8 @@ endif::[]
499
501
500
502
A size-based initial retention limit for Tiered Storage that determines how much data in local storage is transferred to a partition replica when a cluster is resized. If `null` (default), all locally retained data is transferred.
501
503
504
+
This property supports three states: set to a specific byte value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (transfers all locally retained data).
505
+
502
506
[cols="1s,2a"]
503
507
|===
504
508
| Property | Value
@@ -546,6 +550,8 @@ endif::[]
546
550
547
551
A time-based initial retention limit for Tiered Storage that determines how much data in local storage is transferred to a partition replica when a cluster is resized. If `null` (default), all locally retained data is transferred.
548
552
553
+
This property supports three states: set to a specific millisecond value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (transfers all locally retained data).
554
+
549
555
[cols="1s,2a"]
550
556
|===
551
557
| Property | Value
@@ -832,6 +838,8 @@ endif::[]
832
838
833
839
The minimum ratio between the number of bytes in dirty segments and the total number of bytes in closed segments that must be reached before a partition's log is eligible for compaction in a compact topic.
834
840
841
+
This property supports three states: set to a specific ratio value (including 0.0), unset (inherits cluster default), or disabled by setting to a negative value (inherits cluster default). Setting the value to 0.0 means compaction is always eligible regardless of dirty ratio.
842
+
835
843
[cols="1s,2a"]
836
844
|===
837
845
| Property | Value
@@ -1701,7 +1709,9 @@ endif::[]
1701
1709
1702
1710
A size-based retention limit that configures the maximum size that a topic partition can grow before becoming eligible for cleanup.
1703
1711
1704
-
If `retention.bytes` is set to a positive value, it overrides the cluster property xref:cluster-properties.adoc#retention_bytes[`retention_bytes`] for the topic, and the total retained size for the topic is `retention.bytes` multiplied by the number of partitions for the topic.
1712
+
This property supports three states: set to a specific byte value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (no per-topic limit applied). Setting the value to 0 means partitions are immediately eligible for cleanup.
1713
+
1714
+
If `retention.bytes` is set to a non-negative value, it overrides the cluster property xref:cluster-properties.adoc#retention_bytes[`retention_bytes`] for the topic, and the total retained size for the topic is `retention.bytes` multiplied by the number of partitions for the topic.
1705
1715
1706
1716
When both size-based (`retention.bytes`) and time-based (`retention.ms`) retention limits are set, cleanup occurs when either limit is reached.
1707
1717
@@ -1754,6 +1764,8 @@ endif::[]
1754
1764
1755
1765
A size-based retention limit for Tiered Storage that configures the maximum size that a topic partition in local storage can grow before becoming eligible for cleanup. It applies per partition and is equivalent to <<retentionbytes, `retention.bytes`>> without Tiered Storage.
1756
1766
1767
+
This property supports three states: set to a specific byte value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (no per-topic limit applied). Setting the value to 0 means data in local storage is immediately eligible for cleanup.
1768
+
1757
1769
[cols="1s,2a"]
1758
1770
|===
1759
1771
| Property | Value
@@ -1801,6 +1813,8 @@ endif::[]
1801
1813
1802
1814
A time-based retention limit for Tiered Storage that sets the maximum duration that a log's segment file for a topic is retained in local storage before it's eligible for cleanup. This property is equivalent to <<retentionms, `retention.ms`>> without Tiered Storage.
1803
1815
1816
+
This property supports three states: set to a specific millisecond value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (no per-topic limit applied). Setting the value to 0 means data in local storage is immediately eligible for cleanup.
1817
+
1804
1818
[cols="1s,2a"]
1805
1819
|===
1806
1820
| Property | Value
@@ -1848,9 +1862,11 @@ endif::[]
1848
1862
// tag::category-retention-compaction[]
1849
1863
=== retention.ms
1850
1864
1851
-
A time-based retention limit that configures the maximum duration that a log's segment file for a topic is retained before it becomes eligible to be cleaned up. To consume all data, a consumer of the topic must read from a segment before its `retention.ms` elapses, otherwise the segment may be compacted and/or deleted. If a non-positive value, no per-topic limit is applied.
1865
+
A time-based retention limit that configures the maximum duration that a log's segment file for a topic is retained before it becomes eligible to be cleaned up. To consume all data, a consumer of the topic must read from a segment before its `retention.ms` elapses, otherwise the segment may be compacted and/or deleted.
1852
1866
1853
-
If `retention.ms` is set to a positive value, it overrides the cluster property xref:./cluster-properties.adoc#log_retention_ms[`log_retention_ms`] for the topic.
1867
+
This property supports three states: set to a specific millisecond value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (no per-topic limit applied). Setting the value to 0 means data is immediately eligible for cleanup.
1868
+
1869
+
If `retention.ms` is set to a non-negative value, it overrides the cluster property xref:./cluster-properties.adoc#log_retention_ms[`log_retention_ms`] for the topic.
1854
1870
1855
1871
When both size-based (`retention.bytes`) and time-based (`retention.ms`) retention limits are set, the earliest occurring limit applies.
1856
1872
@@ -1956,7 +1972,9 @@ endif::[]
1956
1972
1957
1973
The maximum duration that a log segment of a topic is active (open for writes and not deletable). A periodic event, with `segment.ms` as its period, forcibly closes the active segment and transitions, or rolls, to a new active segment. The closed (inactive) segment is then eligible to be cleaned up according to cleanup and retention properties.
1958
1974
1959
-
If set to a positive duration, `segment.ms` overrides the cluster property xref:./cluster-properties.adoc#log_segment_ms[`log_segment_ms`]. Values are automatically clamped between the cluster bounds set by xref:./cluster-properties.adoc#log_segment_ms_min[`log_segment_ms_min`] (default: 10 minutes) and xref:./cluster-properties.adoc#log_segment_ms_max[`log_segment_ms_max`] (default: 1 year). If your configured value exceeds these bounds, Redpanda uses the bound value and logs a warning. Check current cluster bounds with `rpk cluster config get log_segment_ms_min log_segment_ms_max`.
1975
+
This property supports three states: set to a specific millisecond value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (inherits cluster default). Setting the value to 0 means segments are immediately eligible for closure.
1976
+
1977
+
If set to a non-negative value, `segment.ms` overrides the cluster property xref:./cluster-properties.adoc#log_segment_ms[`log_segment_ms`]. Values are automatically clamped between the cluster bounds set by xref:./cluster-properties.adoc#log_segment_ms_min[`log_segment_ms_min`] (default: 10 minutes) and xref:./cluster-properties.adoc#log_segment_ms_max[`log_segment_ms_max`] (default: 1 year). If your configured value exceeds these bounds, Redpanda uses the bound value and logs a warning. Check current cluster bounds with `rpk cluster config get log_segment_ms_min log_segment_ms_max`.
0 commit comments