VOLUME.ADMIN PRUNE-CHANGELOG
Removes changelog entries older than a given retention period to reclaim storage.
Syntax
Section titled “Syntax”VOLUME.ADMIN PRUNE-CHANGELOG <volume-name> <retention-period>Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
volume-name | string | Name of the volume, in <kind>-shard-<id> format (e.g. bucket-shard-0) |
retention-period | integer | Number of hours of changelog history to retain. Must be greater than zero. |
Return Value
Section titled “Return Value”Simple string OK on success.
Behavior
Section titled “Behavior”Calculates a cutoff timestamp as now() - retention-period hours. Clears changelog entries older than the cutoff
in a single atomic operation.
It is available on the management port (default 3320).
Errors
Section titled “Errors”Argument errors:
| Error Code | Error message | Cause |
|---|---|---|
ERR | invalid number of parameters | - |
ERR | retention period must be greater than zero | - |
ERR | invalid volume name: <name> | The name does not match the <kind>-shard-<id> format. |
Examples
Section titled “Examples”Prune changelog entries older than 24 hours:
127.0.0.1:3320> VOLUME.ADMIN PRUNE-CHANGELOG bucket-shard-0 24OKRetention period is zero:
127.0.0.1:3320> VOLUME.ADMIN PRUNE-CHANGELOG bucket-shard-0 0(error) ERR retention period must be greater than zeroInvalid volume name:
127.0.0.1:3320> VOLUME.ADMIN PRUNE-CHANGELOG non-existent-volume 24(error) ERR invalid volume name: non-existent-volumeMissing parameters:
127.0.0.1:3320> VOLUME.ADMIN PRUNE-CHANGELOG(error) ERR invalid number of parameters