Removes records, derived text, vectors, logs and backup snapshots written by the service. Point-in-time database copies age out within 30 days, and the report states the date. The audit log keeps identifiers only, including this deletion. Irreversible: it needs –force without a terminal, and an agent needs an independent agent’s approval.
Usage
overlane enterprise data delete [--scope SCOPE] [--subject ID] [--dry-run] [--force]Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--scope |
one of tenant, project, user |
no | tenant |
tenant (default), project or user |
--subject |
string | no | The project or user ID for a project or user scope | |
--dry-run |
boolean | no | Print the requests and file changes this command would make, then stop. Needs no credentials. | |
--force |
boolean | no | Confirm a destructive action when there is no terminal to ask on. Without it, exit 2. |
Examples
overlane enterprise data delete --scope project --subject prj-1 --dry-runBehavior
- Effect:
destructive(deletes or reverts; needs--forcewithout a terminal). - Needs credentials: yes. Uses the network: yes.
- Supports
--dry-run: yes. Accepts--force: yes. - Machine-readable description:
overlane schema enterprise data delete.
Result
With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.
{
"anyOf": [
{
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
"description": "tenant identifier"
},
"scope": {
"type": "string",
"enum": [
"tenant",
"project",
"user"
]
},
"deletedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"stores": {
"type": "array",
"items": {
"type": "object",
"properties": {
"store": {
"type": "string",
"enum": [
"d1",
"r2",
"kv",
"durable_objects",
"vectors",
"logs",
"backups"
]
},
"dataClass": {
"type": "string",
"maxLength": 60
},
"rows": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"store",
"dataClass",
"rows"
],
"additionalProperties": false
}
},
"totalRows": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"backupsPurgedBy": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"tenantId",
"scope",
"deletedAt",
"stores",
"totalRows",
"backupsPurgedBy"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"dryRun": {
"type": "boolean",
"const": true
},
"service": {
"type": "string"
},
"requests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"body": {},
"note": {
"type": "string"
}
},
"required": [
"method",
"path"
],
"additionalProperties": false
}
},
"commands": {
"type": "array",
"items": {
"type": "string"
}
},
"writes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"write",
"append",
"delete"
]
},
"description": {
"type": "string"
}
},
"required": [
"path",
"action",
"description"
],
"additionalProperties": false
}
},
"notes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"dryRun",
"requests",
"commands",
"writes",
"notes"
],
"additionalProperties": false
}
]
}See exit codes for the status the process returns.