valkey
Valkey (Redis-compatible) client for Nim
Summary
| Latest Version | 0.1.0 |
|---|---|
| License | MIT |
| CI Status | Failing |
| Downloads | 0 |
| Last Indexed | 2026-07-21 05:27 |
Tags
Authors
- Parker Shankin Clarke <parkerwsc1@gmail.com>
Installation
nimble install valkey
choosenim install valkey
git clone https://github.com/pshankinclarke/valkey-nim
OS Compatibility
| Platform | Linux | macOS | Windows | FreeBSD | OpenBSD | NetBSD | Android | iOS | WASM | Embedded |
|---|---|---|---|---|---|---|---|---|---|---|
| valkey | ✓ | ✓ | ✓ | - | - | - | - | - | - | - |
Dependencies
| Package | Version | Optional |
|---|---|---|
| nim >= | 2.0.0 | No |
Source
| Repository | https://github.com/pshankinclarke/valkey-nim |
|---|---|
| Homepage | https://github.com/pshankinclarke/valkey-nim |
| Registry Source | nimble_official |
README
Valkey
A Valkey client for Nim.
Installation
Add the following to your .nimble file:
# Dependencies
requires "valkey >= 0.1.0"
Or, to install globally:
nimble install valkey
Usage
import valkey, asyncdispatch
proc main() {.async.} =
## Open a connection to Valkey running on localhost on the default port (6379)
let valkeyClient = await connectValkeyAsync()
## Set the key `nim_valkey:test` to the value `Hello, World`
await valkeyClient.setk("nim_valkey:test", "Hello, World")
## Get the value of the key `nim_valkey:test`
let value = await valkeyClient.get("nim_valkey:test")
assert(value == "Hello, World")
waitFor main()
There is also a synchronous version of the client that can be created using the connectValkey() procedure rather than connectValkeyAsync().
PubSub
import valkey, asyncdispatch
proc main() {.async.} =
let v = await connectValkeyAsync()
let p = v.pubsub()
await p.subscribe("my-first-channel")
let msg = await p.receiveMessage()
echo msg.channel, ": ", msg.data
# my-first-channel: hello from valkey-cli
await p.close()
await v.close()
waitFor main()
receiveEvent() returns the next Pub/Sub event (you can hide or show subscribe acknowledgements with pubsub(ignoreSubscribeMessages=true/false)). receiveMessage() is a wrapper that skips everything except published messages.
Pipelining (sync)
When pipelining is enabled, commands are appended to an internal buffer instead of being sent immediately, which can reduce round-trip time. Nothing is sent to the server until the pipeline is flushed.
When pipelining is active, you can keep calling commands as normal, but their return values should be treated as placeholders. Call flushPipeline() to send the buffered commands and return the responses as a seq[string] in command order.
import valkey
let r = connectValkey()
r.startPipelining()
r.setk("k1", "a")
r.setk("k2", "b")
discard r.get("k1") # placeholder while pipelining
discard r.get("k2") # placeholder while pipelining
# Sends all queued commands, then reads exactly N replies in order:
let replies = r.flushPipeline()
# Example reply:
# ["OK", "OK", "a", "b"]
echo replies
r.close()
If a command in the pipeline fails, flushPipeline() raises a ResponseError, but still drains the replies so the connection stays in sync.
License
Released under the MIT License, the same license as nim-lang/redis when this project was forked.