Set-DkvCounter
Synopsis​
Sets the value of a distributed counter in a Clustron Distributed Key-Value (DKV) store.
Syntax
Set-DkvCounter [-Key] <string> [-Value] <long>
Description
Set-DkvCounter explicitly assigns a numeric value to a distributed
counter.
Counters in Clustron DKV are designed for:
- distributed metrics
- rate limiting
- quotas
- coordination counters
- system statistics
Unlike Increment-DkvCounter or Decrement-DkvCounter, this command
overwrites the counter value directly.
If the counter does not already exist, it will be created.
Parameters
-Key​
Specifies the counter key.
Type: String
Mandatory: True
Position: 0
Example:
Set-DkvCounter -Key requests:today -Value 100
-Value​
Specifies the value to assign to the counter.
Type: Int64
Mandatory: True
Position: 1
Example:
Set-DkvCounter -Key rate:limit -Value 5000
Output
Returns an object describing the result of the operation.
Property Description
StoreName Target DKV store Key Counter key Value Value assigned Success Indicates whether operation succeeded Error Error message if operation failed
Example output:
StoreName : MetricsStore Key : requests:today Value : 100 Success : True Error :
Examples
Set a counter value​
Set-DkvCounter -Key requests:today -Value 100
Initialize a quota counter​
Set-DkvCounter -Key api:quota:user123 -Value 1000
Notes
- This operation overwrites the existing counter value.
- Use
Increment-DkvCounterorDecrement-DkvCounterfor relative updates. - Press Ctrl+C to safely cancel the operation.