Skip to main content

Remove-ZrStore

Removes a Zaris store and deletes its on-disk state — the Management Service stops every running instance of the store, then deletes its config, data, and logs. Use it to tear down a store you no longer need, such as a repro cluster between runs.

warning

This is a destructive, irreversible operation. Removing a store stops all of its instances and permanently deletes its config, data, and logs across the workspace. There is no undo — back up anything you need first. The cmdlet prompts for confirmation (high impact); -Force skips the prompt.

Syntax

Remove-ZrStore
-Name <string>
[-Force]
[-Managers <string[]>] [-Port <int>] [-Token <string>] [-TimeoutSec <int>] [-FailFast]
[-WhatIf] [-Confirm]

Description

Remove-ZrStore targets the named store on each resolved Management Service. For every manager it stops the store's running instances and then deletes the store's on-disk config, data, and logs, printing a per-manager result table. Because the deletion cannot be undone, the cmdlet supports -WhatIf/-Confirm and defaults to a high-impact confirmation prompt; pass -Force to skip it (for example, in automated teardown scripts). Requires an active workspace or an explicit -Managers.

Parameters

ParameterTypeRequiredDescription
-NamestringYesName of the store to remove. Position 0.
-ForceswitchNoSkip the confirmation prompt.
-Managersstring[]NoManagement Service endpoints to target; when omitted the active workspace's managers are used.
-PortintNoManagement Service port for bare-host managers. Default 7801.
-TokenstringNoAdmin bearer token for authenticated control-plane calls.
-TimeoutSecintNoPer-request timeout in seconds. Default 30.
-FailFastswitchNoStop at the first manager that returns an error instead of continuing across the remaining managers.

Supports -WhatIf and -Confirm.

Examples

Remove the orders store, prompting for confirmation before anything is deleted.

Remove-ZrStore -Name orders

Remove the orders store without prompting — for example, during automated repro-cluster teardown between runs.

Remove-ZrStore -Name orders -Force