Valkey Documentation
Description
The Valkey documentation is managed in markdown files in the valkey-doc
repository. It’s released under the Creative Commons
Attribution-ShareAlike 4.0 International license.
What is Valkey? See Introduction.
Programming with Valkey
- The full list of commands, with
documentation for each of them.
- Data types: Keys are strings, but
values can be of many different data types.
- Pipelining: How to send multiple
commands at once, saving on round trip time.
- Pub/Sub: Using Valkey as a message broker
using the Publish/Subscribe messaging system.
- Memory optimization:
Understand how Valkey uses RAM.
- Expires: How to set a Time To
Live (TTL) on key so that it will be automatically removed from the
server when it expires.
- Valkey as an LRU cache: How to
configure Valkey as a cache with a fixed amount of memory and automatic
eviction of keys.
- Transactions: Valkey’s approach to
atomic transactions.
- Client side caching: How a
client can be notified by the server when a key has changed.
- Keyspace notifications: Get
notifications of keyspace events via Pub/Sub.
- Protocol specification: The
client-server protocol, for client authors.
Server-side scripting in
Valkey
Administration
- Installation: How to install and
configure Valkey. This targets people without prior experience with
Valkey.
- valkey-cli: The Valkey command line
interface, used for administration, troubleshooting and experimenting
with Valkey.
- valkey-server: How to run the Valkey
server.
- Configuration: How to configure
Valkey.
- Replication: What you need to know to
set up primary-replica replication.
- Migration: How to migrate from Redis to
Valkey.
- Persistence: Options for configuring
durability using disk backups.
- Administration: Various administration
topics.
- Security: An overview of Valkey’s
security.
- RDMA: An overview of RDMA support.
- Access Control Lists: ACLs make it possible
to allow users to run only selected commands and access only specific
key patterns.
- Encryption: How to use TLS for
communication.
- Signals Handling: How Valkey handles
signals.
- Connections Handling: How Valkey handles
clients connections.
- Sentinel: Valkey Sentinel is one of the
official high availability deployment modes.
- Releases: Valkey’s development cycle and
version numbering.
Valkey Cluster
- Cluster tutorial: A gentle
introduction to Valkey Cluster, a deployment mode for horizontal scaling
and high availability.
- Cluster specification: The more
formal description of the behavior and algorithms used in Valkey
Cluster.
Valkey modules API
Tutorials & FAQ
Command runtime
introspection
- Command key specifications: How to
extract the names of keys accessed by every command.
- Command tips: Command tips
communicate non-trivial execution modes and post-processing information
about commands.
- Command arguments: An overview
of command arguments as returned by the
COMMAND DOCS
command.