按主题分类的文档

Valkey 文档以 Markdown 文件的形式保存在 valkey-doc 仓库中。它根据知识共享署名-相同方式共享 4.0 国际许可协议发布。

什么是 Valkey？请参阅简介。

Valkey 编程

• 完整的命令列表，附有每个命令的文档。
• 数据类型：键是字符串，但值可以是许多不同的数据类型。
• 管道：如何一次发送多个命令，节省往返时间。
• 发布/订阅：使用发布/订阅消息系统将 Valkey 作为消息代理。
• 内存优化：了解 Valkey 如何使用 RAM。
• 过期：如何为键设置生存时间 (TTL)，使其在过期时自动从服务器中移除。
• 将 Valkey 作为 LRU 缓存：如何将 Valkey 配置为具有固定内存量并自动逐出键的缓存。
• 事务：Valkey 的原子事务处理方法。
• 客户端缓存：当键发生更改时，客户端如何从服务器接收通知。
• 键空间通知：通过发布/订阅获取键空间事件通知。
• 协议规范：客户端-服务器协议，供客户端开发者参考。

Valkey 中的服务器端脚本

• 可编程性概述：Valkey 中可编程性的概述。
• Valkey Lua API：嵌入式 Lua 5.1 解释器运行时环境和 API。
• Eval 脚本简介：关于使用缓存脚本的介绍。
• Valkey 函数简介：关于使用函数的介绍。
• 调试 Lua 脚本：Valkey 原生 Lua 调试器（用于缓存脚本）的概述。

管理

• 安装：如何安装和配置 Valkey。本部分面向没有 Valkey 使用经验的用户。
• valkey-cli：Valkey 命令行界面，用于管理、故障排除和实验 Valkey。
• valkey-server：如何运行 Valkey 服务器。
• 配置：如何配置 Valkey。
• 复制：设置主从复制所需了解的知识。
• 迁移：如何从 Redis 迁移到 Valkey。
• 持久化：使用磁盘备份配置持久性的选项。
• 管理：各种管理主题。
• 安全性：Valkey 安全性概述。
• RDMA：RDMA 支持概述。
• 访问控制列表：ACL 允许用户仅运行选定命令并访问特定键模式。
• 加密：如何使用 TLS 进行通信。
• 信号处理：Valkey 如何处理信号。
• 连接处理：Valkey 如何处理客户端连接。
• Sentinel：Valkey Sentinel 是官方高可用部署模式之一。
• 发布：Valkey 的开发周期和版本编号。

Valkey 集群

• 集群教程：Valkey 集群简介，一种用于水平扩展和高可用的部署模式。
• 集群规范：Valkey 集群中使用的行为和算法的更正式描述。

Valkey 模块 API

• Valkey 模块简介：使用动态链接模块扩展 Valkey。
• 实现原生数据类型：模块可以实现看起来像内置数据类型的新数据类型（数据结构等）。本文档涵盖了实现此目的的 API。
• 阻塞操作：编写可以阻塞客户端（而不阻塞 Valkey）并可以在其他线程中执行任务的命令。
• 模块 API 参考：所有模块 API 函数的文档。关于 API 使用的底层细节。

性能

• 延迟监控：集成的延迟监控和报告有助于实现低延迟调优。
• valkey-benchmark：Valkey 附带的基准测试工具。
• CPU 性能分析和追踪：如何查找 CPU 资源瓶颈。

教程与常见问题

• 快速入门：Valkey 入门。
• 数据批量插入：如何在短时间内向 Valkey 实例添加大量数据。
• 分布式锁：实现分布式锁管理器。
• 二级索引：如何模拟二级索引、复合索引以及使用各种数据结构遍历图。
• ARM 和树莓派：ARM 和树莓派是支持的平台。此页面包含一般信息和基准测试。
• 使用 PHP 和 Valkey 编写一个简单的 Twitter 克隆
• 故障排除：遇到问题？Bug？高延迟？其他问题？请使用我们的故障排除页面作为起点，查找更多信息。
• 常见问题：常见问题解答。

命令运行时内省

• 命令键规范：如何提取每个命令访问的键名。
• 命令提示：命令提示传达非平凡的执行模式和关于命令的后处理信息。
• 命令参数：COMMAND DOCS 命令返回的命令参数概述。