Valkey Documentation

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.

1. Introduction

Data types: Keys are strings, but values can be of many different data types.
The full list of commands, with documentation for each of them.
Pipelining: How to send multiple commands at once, saving on round trip time.
Transactions: Valkey’s approach to atomic transactions.
Expires: How to set a Time To Live (TTL) on key so that it will be automatically removed from the server when it expires.
Pub/Sub: Using Valkey as a message broker using the Publish/Subscribe messaging system.
Keyspace notifications: Get notifications of keyspace events via Pub/Sub.
Keyspace management: How to alter, query, and navigate the keyspace.

Valkey as an LRU cache: How to configure Valkey as a cache with a fixed amount of memory and automatic eviction of keys.
Client side caching: How a client can be notified by the server when a key has changed.
Distributed locks: Implementing a distributed lock manager.
Secondary indexes: How to simulate secondary indexes, composed indexes and traverse graphs using various data structures.
Writing a simple Twitter clone with PHP and Valkey

Programmability overview: An overview of programmability in Valkey.
Introduction to Eval Scripts: An introduction about using cached scripts.
Introduction to Valkey Functions: An introduction about using functions.
Valkey Lua API: The embedded Lua 5.1 interpreter runtime environment and APIs.
Debugging Lua scripts: An overview of the native Valkey Lua debugger for cached scripts.

Introduction to Valkey modules: Extend Valkey using dynamically linked modules.
Implementing native data types: Modules scan implement new data types (data structures and more) that look like built-in data types. This documentation covers the API to do so.
Blocking operations: Write commands that can block the client (without blocking Valkey) and can execute tasks in other threads.
Modules API reference: Documentation of all module API functions. Low level details about API usage.

License: License information for Valkey.
Installation: How to install and configure Valkey. This targets people without prior experience with Valkey.
Release Downloads: Lists links to download all current and previous releases.
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.
Persistence: Options for configuring durability using disk backups.
Signals Handling: How Valkey handles signals.
Connections Handling: How Valkey handles clients connections.
Migration: How to migrate from Redis to Valkey.
Releases and Versioning: Valkey’s development cycle and version numbering.
Administration: Various administration topics.

Replication: What you need to know to set up primary-replica replication.
Sentinel: Valkey Sentinel is one of the official high availability deployment modes.
Sentinel client spec: How to build clients for Valkey Sentinel.
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.
Atomic slot migration: An overview of atomic slot migration in Valkey Cluster.

Security: An overview of Valkey’s security.
Access Control Lists: ACLs make it possible to allow users to run only selected commands and access only specific key patterns.
TLS: How to use TLS for communication.

ARM and Raspberry Pi: ARM and the Raspberry Pi are supported platforms. This page contains general information and benchmarks.
RDMA: An overview of RDMA support.

Troubleshooting: Problems? Bugs? High latency? Other issues? Use our problems troubleshooting page as a starting point to find more information.
Memory optimization: Understand how Valkey uses RAM.
Latency monitoring: Integrated latency monitoring and reporting help tuning for low latency.
valkey-benchmark: The benchmarking tool shipped with Valkey.
On-CPU profiling and tracing: How to find on-CPU resource bottlenecks.
Debugging: How to debug Valkey server processes.
Diagnosing latency issues: How to diagnose latency problems with Valkey.
Mass insertion of data: How to add a big amount of data to a Valkey instance in a short time.

Protocol specification: The client-server protocol, for client authors.
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.