Clustron Zaris ClientShell
Clustron Zaris ClientShell is the PowerShell module (Clustron.Zaris.ClientShell) for working with a Zaris distributed key-value store from the command line — connecting to a store, reading and writing items, driving counters and leases, watching keys, and running benchmarks — without writing application code.
What ClientShell is
ClientShell is a binary PowerShell module whose cmdlets all share the Zr noun prefix (for example Connect-ZrStore, Get-ZrItem, Grant-ZrLease). The cmdlets talk directly to the Zaris data-plane endpoints exposed by store nodes. It is aimed at administrators, developers, and operators who need to inspect or manipulate a store interactively or from scripts.
Prerequisites: import the module
Import the module before running any cmdlet:
Import-Module Clustron.Zaris.ClientShell
List the cmdlets it provides:
Get-Command -Module Clustron.Zaris.ClientShell
How you connect
Most cmdlets operate against an ambient, session-wide connection that you open once with Connect-ZrStore. After connecting, the item, counter, lease, and watch cmdlets reuse that connection automatically — you do not repeat the store name or endpoints:
Connect-ZrStore -ConnectionString "zaris://10.0.0.11:7861,10.0.0.12:7861/OrdersStore"
Set-ZrItem -Key "order:1001" -Value "confirmed"
Get-ZrItem -Key "order:1001"
Disconnect-ZrStore
Only one store may be connected per session; use -Force on Connect-ZrStore to replace an existing connection. Check the current state with Get-ZrConnection and probe reachability with Test-ZrConnection.
As an alternative to a session connection, the item cmdlets also accept -ConnectionString (a Zaris connection string such as zaris://host:7861/store) — or -StoreName and -Endpoints — directly for a one-shot (independent) connection. Those parameters are ignored while a Connect-ZrStore session is active.
Cmdlets by purpose
Connection and diagnostics
| Cmdlet | Description |
|---|---|
| Connect-ZrStore | Opens a session-wide connection to a store |
| Disconnect-ZrStore | Closes the active session connection |
| Get-ZrConnection | Reports the current connection state |
| Test-ZrConnection | Probes a store for reachability |
Items
| Cmdlet | Description |
|---|---|
| Set-ZrItem | Writes or updates a single item |
| Set-ZrItems | Writes multiple items in one bulk call |
| Get-ZrItem | Reads a single item by key |
| Get-ZrItems | Reads multiple items in one bulk call |
| Remove-ZrItem | Deletes a single item |
| Remove-ZrItems | Deletes multiple items |
| Test-ZrItem | Checks whether a key exists |
| Get-ZrItemMetadata | Returns metadata for a key |
| Refresh-ZrItem | Refreshes an item's expiration |
| Set-ZrItemExpiration | Updates an item's expiration |
Counters
| Cmdlet | Description |
|---|---|
| Get-ZrCounter | Returns a counter value |
| Increment-ZrCounter | Atomically increments a counter |
| Decrement-ZrCounter | Atomically decrements a counter |
| Set-ZrCounter | Sets a counter value |
Leases
| Cmdlet | Description |
|---|---|
| Grant-ZrLease | Acquires a lease |
| Refresh-ZrLease | Extends a lease |
| Revoke-ZrLease | Releases a lease |
| Test-ZrLease | Tests lease validity |
Watch
| Cmdlet | Description |
|---|---|
| Watch-ZrKey | Watches changes for a single key |
| Watch-ZrPrefix | Watches changes for keys under a prefix |
Store maintenance
| Cmdlet | Description |
|---|---|
| Clear-ZrStore | Removes every item from the connected store (destructive; prompts unless -Force) |
Tracing
These cmdlets act on the Management Service at -ManagementUrl rather than a Connect-ZrStore session.
| Cmdlet | Description |
|---|---|
| Enable-ZrTrace | Turns on runtime distributed tracing for a store or one instance, with no restart |
| Disable-ZrTrace | Turns off runtime distributed tracing for a store or one instance |
Benchmarking
| Cmdlet | Description |
|---|---|
| Benchmark-ZrStore | Runs a benchmark workload |
| Stress-ZrStore | Performs sustained load testing |
| Test-ZrLatency | Measures request latency |
| Test-ZrThroughput | Measures cluster throughput |