Trash APIs on INFINI Pizza

List the cluster trash

Mon, 01 Jan 0001 00:00:00 +0000

List the cluster trash #

List every node’s trash, merged into one cluster-wide, namespace-centric view. The request may be sent to any node; the node that receives it aggregates the trash of every cluster member.

Examples #

GET /_cluster/trash

A typical item — here a deleted namespace held on two nodes:

{
 "nodes_scanned": 2,
 "unreachable_nodes": [],
 "retention_secs": 86400,
 "items": [
 {
 "name": "1788916375_namespace-website",
 "deleted_at": 1788916375,
 "bytes": 2097152,
 "files": 42,
 "kind": "namespace",
 "namespace": "website",
 "collections": 3,
 "shard_groups": 12,
 "shard_copies": 14,
 "restorable": true,
 "holders": [
 { "node_id": "…", "node_name": "pizza-1", "bytes": 1048576, "files": 21 },
 { "node_id": "…", "node_name": "pizza-2", "bytes": 1048576, "files": 21 }
 ]
 }
 ]
}

Request #

GET /_cluster/trash

Response #

items — newest first; each item merges every node that still holds a copy of the data into holders.
kind — namespace or collection, parsed from the delete-time snapshot. Items without a snapshot (legacy items swept by the orphan scanner before snapshots existed, or a failed snapshot write) report restorable: false and cannot be restored.
retention_secs — the effective retention; items are physically deleted once older than this.
unreachable_nodes — members that could not be reached; the list may be incomplete for items they hold.

Verify a trash item

Mon, 01 Jan 0001 00:00:00 +0000

Verify a trash item #

Run a read-only shard-completeness check on a trash item, across every node that still holds its data. Nothing is moved or written — this is the preflight for a restore.

Examples #

POST /_cluster/trash/1788916375_namespace-website/verify

With ?deep=true, every present segment file additionally has its footer parsed — truncated or corrupted files are reported by name. Deep mode can take noticeably longer on large items.

{
 "item": "1788916375_namespace-website",
 "deep": false,
 "kind": "namespace",
 "namespace": "website",
 "restorable": true,
 "degraded": false,
 "shard_groups": [
 {
 "collection": "website:logs",
 "shard": "a1b2…",
 "expected_copies": 2,
 "complete_copies": 2,
 "copies": [
 { "node": "…", "node_name": "pizza-1", "primary": true, "complete": true },
 { "node": "…", "node_name": "pizza-2", "primary": false, "complete": true }
 ]
 }
 ],
 "issues": [],
 "unreachable_nodes": []
}

Request #

POST /_cluster/trash/<item>/verify[?deep=true]

Path parameters #

<item>
(Required, string) The trash item name, as listed by List the cluster trash.

Response #

restorable — true when every shard group with recorded data has at least one complete copy on some node. A shard group counts a copy as complete when its allocation directory AND its segment manifest with all declared local files are present (and, in deep mode, every file’s footer parses).
degraded — true when the item is restorable but some recorded copies are missing; the restore comes back with fewer replicas, which the allocator backfills.
issues — human-readable problem lines (missing directories, missing/corrupt segment files, unreachable nodes), each prefixed with the node it applies to.

Restore a trash item

Mon, 01 Jan 0001 00:00:00 +0000

Restore a trash item #

Restore a trashed collection — or a whole deleted namespace — back into the cluster, cluster-coordinated: every holder node moves its copy of the data back, the metadata is re-registered through Raft with the ORIGINAL collection/rolling/shard UUIDs, and the recorded shard placements are replayed so every engine re-opens its original working directory with all documents.

Examples #

Restore a deleted namespace under a new name (every collection comes back inside it):

Delete a trash item everywhere

Mon, 01 Jan 0001 00:00:00 +0000

Delete a trash item everywhere #

Physically delete one trash item on every node that still holds it, without waiting for the retention window. This cannot be undone.

Examples #

POST /_cluster/trash/1788916375_namespace-website/delete

{ "deleted": true, "item": "1788916375_namespace-website", "nodes": 2 }

Request #

POST /_cluster/trash/<item>/delete

Path parameters #

<item>
(Required, string) The trash item name, as listed by List the cluster trash.

Empty the trash everywhere

Mon, 01 Jan 0001 00:00:00 +0000

Empty the trash everywhere #

Physically delete every trashed item on every node, without waiting for the retention window. This cannot be undone.

Examples #

POST /_cluster/trash/empty

{ "nodes": 2, "removed": 5 }

Request #

POST /_cluster/trash/empty