valkey - Man Page

Valkey Documentation

Description

The Valkey documentation is managed in markdown files in the valkey-doc repository\c . It’s released under the Creative Commons Attribution-ShareAlike 4.0 International license\c .

valkey-commands(7) The full list of commands, with documentation for each of them.
valkey-data-types(7): Keys are strings, but values can be of many different data types.
valkey-pipelining(7): How to send multiple commands at once, saving on round trip time.
valkey-pubsub(7) Pub/Sub: Using Valkey as a message broker using the Publish/Subscribe messaging system.
valkey-memory-optimization(7): Understand how Valkey uses RAM.
expire(3valkey): How to set a Time To Live (TTL) on key so that it will be automatically removed from the server when it expires.
valkey-lru-cache(7) Valkey as an LRU cache: How to configure Valkey as a cache with a fixed amount of memory and automatic eviction of keys.
valkey-transactions(7): Valkey’s approach to atomic transactions.
valkey-client-side-caching(7): How a client can be notified by the server when a key has changed.
valkey-notifications(7) Keyspace notifications: Get notifications of keyspace events via Pub/Sub.
valkey-protocol(7) Protocol specification: The client-server protocol, for client authors.

valkey-programmability(7) Programmability overview: An overview of programmability in Valkey.
valkey-lua-api(7): The embedded Lua 5.1\c interpreter runtime environment and APIs.
valkey-eval-intro(7) Introduction to Eval Scripts: An introduction about using cached scripts.
valkey-functions-intro(7) Introduction to Valkey Functions: An introduction about using functions.
valkey-ldb(7) Debugging Lua scripts: An overview of the native Valkey Lua debugger for cached scripts.

valkey-installation(7): How to install and configure Valkey. This targets people without prior experience with Valkey.
valkey-cli(1): The Valkey command line interface, used for administration, troubleshooting and experimenting with Valkey.
valkey-server(1): How to run the Valkey server.
valkey.conf(5): How to configure Valkey.
valkey-replication(7): What you need to know to set up primary-replica replication.
valkey-persistence(7): Options for configuring durability using disk backups.
valkey-admin(7) Administration: Various administration topics.
valkey-security(7): An overview of Valkey’s security.
valkey-acl(7) Access Control Lists: ACLs make it possible to allow users to run only selected commands and access only specific key patterns.
valkey-encryption(7): How to use TLS for communication.
valkey-signals(7) Signals Handling: How Valkey handles signals.
valkey-clients(7) Connections Handling: How Valkey handles clients connections.
valkey-sentinel(1): Valkey Sentinel is one of the official high availability deployment modes.
valkey-releases(7): Valkey’s development cycle and version numbering.

valkey-cluster-tutorial(7): A gentle introduction to Valkey Cluster, a deployment mode for horizontal scaling and high availability.
valkey-cluster-spec(7) Cluster specification: The more formal description of the behavior and algorithms used in Valkey Cluster.

valkey-modules-intro(7) Introduction to Valkey modules: Extend Valkey using dynamically linked modules.
valkey-modules-native-types(7) 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.
valkey-modules-blocking-ops(7) Blocking operations: Write commands that can block the client (without blocking Valkey) and can execute tasks in other threads.
valkey-modules-api-ref(7) Modules API reference: Documentation of all module API functions. Low level details about API usage.

valkey-latency-monitor(7) Latency monitoring: Integrated latency monitoring and reporting help tuning for low latency.
valkey-benchmark(1): The benchmarking tool shipped with Valkey.
valkey-performance-on-cpu(7) On-CPU profiling and tracing: How to find on-CPU resource bottlenecks.

valkey-quickstart(7) Quick start: Get started with Valkey.
valkey-mass-insertion(7) Mass insertion of data: How to add a big amount of data to a Valkey instance in a short time.
valkey-distlock(7) Distributed locks: Implementing a distributed lock manager.
valkey-indexing(7) Secondary indexes: How to simulate secondary indexes, composed indexes and traverse graphs using various data structures.
valkey-arm(7) ARM and Raspberry Pi: ARM and the Raspberry Pi are supported platforms. This page contains general information and benchmarks.
valkey-twitter-clone(7) Writing a simple Twitter clone with PHP and Valkey
valkey-problems(7) Troubleshooting: Problems? Bugs? High latency? Other issues? Use our problems troubleshooting page as a starting point to find more information.
valkey-faq(7): Frequently asked questions.

valkey-key-specs(7) Command key specifications: How to extract the names of keys accessed by every command.
valkey-command-tips(7): Command tips communicate non-trivial execution modes and post-processing information about commands.
valkey-command-arguments(7): An overview of command arguments as returned by the COMMAND DOCS command.

2024-09-23 8.0.0 Valkey Manual