SimetrikDocs
ReferenceAccount & workspace

delete

Subcommands of simetrik delete.

simetrik delete column

Delete a column from a resource.

Destructive action

This command modifies or deletes data irreversibly.

Deletes a single column from a resource, identified by its column ID. This removes the column definition and its data from the underlying table; it does not affect the rest of the resource's schema.

Reach for this when you've added a calculated or imported column you no longer need. To delete a whole resource instead of one column, use simetrik delete resource; to remove a slice of a resource's rows, use simetrik delete segment. Pass -y/--yes to skip the interactive confirmation when scripting.

Deleting a column that downstream rulesets, reconciliations, or unions still reference may be rejected by the server (exit 1) or break those resources — confirm nothing depends on the column before removing it.

See also: delete segment, delete resource. Requires the resources · create_edit permission. See permissions.

Arguments

  • column_id — Column ID to delete

Flags

  • -y, --yes — Skip confirmation prompt
  • -f, --format <fmt> — Output format: json|table

Examples

simetrik delete column col_8f2a
simetrik delete column col_8f2a --yes
simetrik delete column col_8f2a -y --format table

Exit codes

CodeMeaning
0Column deleted
1Server rejected the request — column not found, or in use by a rule/recon
2Invalid input — missing or malformed column ID
4Authentication required — run simetrik login

simetrik delete ruleset

Delete a reconciliation rule set.

Destructive action

This command modifies or deletes data irreversibly.

Deletes a matching rule set from a reconciliation. A rule set is the group of matching rules a reconciliation runs to pair records, so removing one changes how that reconciliation matches going forward.

The --recon option is required: the rule set is scoped to a specific reconciliation, and the command exits 2 with MISSING_OPTION if you omit it. Use this when you're retiring or replacing a matching strategy on a reconciliation; to remove the reconciliation itself, use simetrik delete resource. Pass -y/--yes to skip the confirmation prompt.

See also: delete resource, delete schedule. Requires the resources · create_edit permission. See permissions.

Arguments

  • rule_set_id — Rule set ID

Flags

  • --recon <id> — Reconciliation ID
  • -y, --yes — Skip confirmation prompt
  • -f, --format <fmt> — Output format: json|table

Examples

simetrik delete ruleset rs_4c1d --recon rec_9a77
simetrik delete ruleset rs_4c1d --recon rec_9a77 --yes

Exit codes

CodeMeaning
0Rule set deleted
1Server rejected the request — rule set or reconciliation not found
2Invalid input — missing rule set ID or the required --recon option
4Authentication required — run simetrik login

simetrik delete schedule

Delete an automated run schedule from a resource (match the schedule type with --type).

Destructive action

This command modifies or deletes data irreversibly.

Deletes a schedule that automatically runs a resource. Once removed, the resource stops running on that cadence; it does not delete the resource itself or any past runs.

Schedules are typed by the kind of resource they drive. Pass --type to match the schedule's type — reconciliation (the default), union, consolidation, or resource_join. The server may reject the delete if the type doesn't match the schedule (exit 1). Use this to stop an automated run; to remove the underlying resource, use simetrik delete resource. Pass -y/--yes to skip the confirmation prompt.

See also: delete resource, delete ruleset. Requires the resources · create_edit permission. See permissions.

Arguments

  • schedule_id — Schedule ID

Flags

  • --type <type> — Type: reconciliation, union, consolidation, resource_join
  • -y, --yes — Skip confirmation prompt
  • -f, --format <fmt> — Output format: json|table

Examples

simetrik delete schedule sch_72bd
simetrik delete schedule sch_72bd --type union
simetrik delete schedule sch_72bd --type consolidation --yes

Exit codes

CodeMeaning
0Schedule deleted
1Server rejected the request — schedule not found, or wrong --type for this schedule
2Invalid input — missing schedule ID
4Authentication required — run simetrik login

simetrik delete resource

Archive a resource (soft-delete; recoverable, required before permanent deletion).

Destructive action

This command modifies or deletes data irreversibly.

Archives (soft-deletes) a resource of any type — a source, reconciliation, union, consolidation, and so on. The resource is hidden from active use but recoverable; it is not erased from storage.

Use this as the normal way to retire a resource you may want back later, or as the required first step before erasing it for good with simetrik delete resource-permanent (which only works on an already-archived resource). The server may reject the archive if other resources still depend on this one (exit 1). Pass -y/--yes to skip the confirmation prompt when scripting.

See also: delete resource-permanent, delete schedule. Requires the resources · create_edit permission. See permissions.

Arguments

  • resource_id — Resource ID to archive

Flags

  • -y, --yes — Skip confirmation prompt
  • -f, --format <fmt> — Output format: json|table

Examples

simetrik delete resource rec_9a77
simetrik delete resource src_1f04 --yes
simetrik delete resource src_1f04 -y --format table

Exit codes

CodeMeaning
0Resource archived
1Server rejected the request — resource not found, or still referenced by another resource
2Invalid input — missing or malformed resource ID
4Authentication required — run simetrik login

simetrik delete segment

Delete a segment from a resource.

Destructive action

This command modifies or deletes data irreversibly.

Deletes a single segment from a resource, identified by its segment ID. A segment is a defined slice of a resource's data; removing it deletes that slice's definition without touching the rest of the resource.

Reach for this when you're cleaning up a segment you no longer need. To remove an individual column instead, use simetrik delete column; to retire the whole resource, use simetrik delete resource. Pass -y/--yes to skip the confirmation prompt when scripting.

See also: delete column, delete resource. Requires the resources · create_edit permission. See permissions.

Arguments

  • segment_id — Segment ID to delete

Flags

  • -y, --yes — Skip confirmation prompt
  • -f, --format <fmt> — Output format: json|table

Examples

simetrik delete segment seg_3e90
simetrik delete segment seg_3e90 --yes
simetrik delete segment seg_3e90 -y --format table

Exit codes

CodeMeaning
0Segment deleted
1Server rejected the request — segment not found, or in use
2Invalid input — missing or malformed segment ID
4Authentication required — run simetrik login

simetrik delete resource-permanent

Permanently delete a resource (must be archived first).

Destructive action

This command modifies or deletes data irreversibly.

Permanently erases a resource and its data. Unlike simetrik delete resource (which archives and is recoverable), this is irreversible: there is no recovery once the server completes the delete.

The resource must already be archived — run simetrik delete resource first, or the server rejects the request (exit 1). Use this only when you're certain the resource and its data are no longer needed anywhere. Pass -y/--yes to skip the confirmation prompt; do so deliberately in scripts, since there is no undo.

See also: delete resource. Requires the resources · create_edit permission. See permissions.

Arguments

  • resource_id — Resource ID to permanently delete

Flags

  • -y, --yes — Skip confirmation prompt
  • -f, --format <fmt> — Output format: json|table

Examples

simetrik delete resource-permanent src_1f04
simetrik delete resource-permanent src_1f04 --yes

Exit codes

CodeMeaning
0Resource permanently deleted
1Server rejected the request — resource not found, or not archived yet
2Invalid input — missing or malformed resource ID
4Authentication required — run simetrik login

On this page