Skip to main content

Get-DkvStore

Synopsis​

Retrieves information about Clustron Distributed Key-Value (DKV) stores and their runtime status.

Description

Get-DkvStore queries the Clustron manager API and returns a summary of stores running in the cluster.

The cmdlet can be used in two ways:

  1. List all stores in the cluster.
  2. Retrieve details for a specific store.

For each store, the cmdlet produces a summary view containing:

  • Store name
  • Overall store status
  • Instance counts
  • Running instance count
  • Stopped instance count
  • Participating node count

The command queries one or more manager services resolved using:

  • -Managers parameter
  • Active Connect-DkvManager session
  • Fallback resolution from DkvCmdletBase

The cmdlet calls the following manager APIs:

GET /admin/v1/stores GET /admin/v1/stores/{StoreName}

Syntax

List all stores​

Get-DkvStore

Retrieve a specific store​

Get-DkvStore -Name <string>

Optional parameters inherited from DkvCmdletBase:

[-Managers <string[]>] [-Port <int>] [-TimeoutSec <int>]

Parameters

-Name​

Name of the store to retrieve.

If omitted, the cmdlet returns all stores in the cluster.

Example:

OrdersStore

Required: No

-Managers​

Target Clustron manager services.

Example:

-Managers 10.0.0.11,10.0.0.12

If omitted, the cmdlet uses the current Connect-DkvManager session context.

-Port​

Manager API port used when resolving managers.

Default:

7801

-TimeoutSec​

Maximum time allowed for the request.

Default:

30 seconds

Examples

Example 1 — List all stores​

Get-DkvStore

Example output:

Manager            : http://10.0.0.11:7801
StoreName          : OrdersStore
StoreStatus        : Running
InstanceCount      : 3
RunningInstances   : 3
StoppedInstances   : 0
ParticipatingNodes : 3

Example 2 — Get a specific store​

Get-DkvStore -Name OrdersStore

Example 3 — Query specific manager services​

Get-DkvStore -Managers 10.0.0.11,10.0.0.12

Example 4 — Use a connected manager session​

Connect-DkvManager -Managers 10.0.0.11,10.0.0.12

Get-DkvStore

Example 5 — Retrieve a store from multiple manager nodes​

Get-DkvStore `
    -Name OrdersStore `
    -Managers 10.0.0.11,10.0.0.12,10.0.0.13

Output

The command writes results to the console in table format.

Example:

Manager               Store                          Result  Message
---------------------------------------------------------------------------
10.0.0.11:7801        OrdersStore                    OK      Running | Instances:3 Running:3 Stopped:0
10.0.0.12:7801        OrdersStore                    OK      Running | Instances:3 Running:3 Stopped:0

Each row represents the summary returned by a manager.

Store Status Calculation

The store status is derived from instance states:

ConditionStatus
No instancesNoInstances
All runningRunning
All stoppedStopped
Mixed statesPartial

Example Cluster

NodeInstanceStatus
10.0.0.11orders-1Running
10.0.0.12orders-2Running
10.0.0.13orders-3Running

Result:

StoreStatus : Running
InstanceCount : 3
RunningInstances : 3
StoppedInstances : 0

Notes

Manager Context Requirement​

If no -Managers parameter is provided and no manager session exists, the cmdlet requires a connection via:

Connect-DkvManager

Summary Output​

The cmdlet intentionally returns a summary view instead of raw JSON to make the output easy to read in PowerShell.

Related Cmdlets

  • Connect-DkvManager
  • New-DkvStore
  • Add-DkvInstance
  • Start-DkvStore
  • Stop-DkvStore
  • Watch-DkvStoreMetrics