Documentation by Topic

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.

Valkey Documentation

1. Introduction

2. Developer Guide

Core Concepts

  • 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.

Application Patterns & Tutorials

3. Extending Valkey

Server-side scripting in Valkey

Valkey modules API

4. Administration

Core Management

Deployment Topology

  • 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.

Security

  • 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.
  • Encryption: How to use TLS for communication.

Platform Specific

  • 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.

5. Performance & Troubleshooting

6. Low-Level Internals