civex record
Manage records
| Command | Description |
|---|---|
add |
Add a record, prompting for each field defined on the schema. |
delete |
Delete a record (and its children) to Recently Deleted. |
delete-all |
Delete all records in a dataset (optionally filtered by schema). |
find |
List records in a dataset. Use --schema to filter by type and show field columns. |
orphans |
List live records that sit under a deleted record, so nothing above them lists them, with what they sit under. Put one back in place with civex record restore-above <id>, or delete it. |
purge |
Permanently delete a record that's already in Recently Deleted. Irreversible. |
restore |
Restore a soft-deleted record (and the children cascade-deleted with it). |
restore-above |
Bring back what a live record sits under that is deleted: each deleted record directly above it, by itself, so their other children stay deleted. |
show |
Show a record's field values. |
update |
Update a record's field values, prompting for each field. |
civex record add
Add a record, prompting for each field defined on the schema.
Usage
Options
| Option | Type | Default | Description |
|---|---|---|---|
--to |
str |
Dataset to add the record to (required) | |
--schema, -s |
str |
Schema for this record (required) |
civex record delete
Delete a record (and its children) to Recently Deleted.
Reversible with civex record restore within the retention window
(see civex trash list); civex record purge deletes permanently.
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
RECORD_ID |
str |
yes | Record ID or short prefix |
Options
| Option | Type | Default | Description |
|---|---|---|---|
--yes, -y |
flag | false |
Skip confirmation prompt |
--force |
flag | false |
Clear any reference/reference_list fields pointing at this record instead of blocking the delete |
civex record delete-all
Delete all records in a dataset (optionally filtered by schema).
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
DATASET_NAME |
str |
yes | Dataset to delete records from |
Options
| Option | Type | Default | Description |
|---|---|---|---|
--schema, -s |
str |
Limit to this schema | |
--yes, -y |
flag | false |
Skip confirmation prompt |
--force |
flag | false |
Clear any reference/reference_list fields pointing at deleted records instead of blocking the delete |
civex record find
List records in a dataset. Use --schema to filter by type and show field columns.
Usage
Options
| Option | Type | Default | Description |
|---|---|---|---|
--in |
str |
Dataset to search (required) | |
--schema, -s |
str |
Filter by schema | |
--where |
str |
field=value filter (repeatable) | |
--limit, -n |
int |
50 |
Maximum records to return |
civex record orphans
List live records that sit under a deleted record, so nothing above them
lists them, with what they sit under. Put one back in place with
civex record restore-above <id>, or delete it.
Usage
Options
| Option | Type | Default | Description |
|---|---|---|---|
--limit |
int |
200 |
Show at most this many. |
civex record purge
Permanently delete a record that's already in Recently Deleted. Irreversible.
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
RECORD_ID |
str |
yes | Record ID or short prefix |
Options
| Option | Type | Default | Description |
|---|---|---|---|
--yes, -y |
flag | false |
Skip confirmation prompt |
civex record restore
Restore a soft-deleted record (and the children cascade-deleted with it).
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
RECORD_ID |
str |
yes | Record ID or short prefix |
Options
| Option | Type | Default | Description |
|---|---|---|---|
--only-this |
flag | false |
Restore just this record, not the children deleted with it. |
--with-parents |
flag | false |
If deleted records above it hold it back, restore them too, each by itself, leaving their other children deleted. |
civex record restore-above
Bring back what a live record sits under that is deleted: each deleted record directly above it, by itself, so their other children stay deleted.
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
RECORD_ID |
str |
yes | Record ID or short prefix |
civex record show
Show a record's field values.
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
RECORD_ID |
str |
yes | Record ID or short prefix |
civex record update
Update a record's field values, prompting for each field.
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
RECORD_ID |
str |
yes | Record ID or short prefix |