Garnet 中文文档

Appearance

连接命令 ​

AUTH ​

语法 ​

bash
    AUTH <placeholderforpassword>

对连接进行身份验证。

返回值 ​

字符串返回值：OK，或者如果密码或用户名/密码对无效，则返回错误。

安全通知：

只使用强密码并保持密码长度足够长，这样攻击就变得不可行。更好的身份验证管理方式是使用 ACL 功能。

ECHO ​

Syntax ​

bash
    ECHO <message>

返回 message。

返回值 ​

块字符串返回值：给定的字符串。

PING ​

Syntax ​

bash
    PING key

如果没有提供参数，则返回 PONG，否则将参数的副本作为块字符串返回。

返回值 ​

以下之一：

  • 字符串返回值：当没有提供参数时返回 PONG。
  • 块字符串返回值：输入的参数。

QUIT ​

Syntax ​

bash
    QUIT

要求服务器关闭连接。当所有待处理的回复都已写入客户端时，连接关闭。

返回值 ​

字符串返回值：OK。

通用命令 ​

DEL ​

Syntax ​

bash
    DEL key [key ...]

移除指定的键。如果键不存在，则忽略它。

返回值 ​

整数返回值：已移除的键的数量。

EXISTS ​

Syntax ​

bash
    EXISTS key [key ...]

确定一个或多个键是否存在。如果在参数中多次提到相同的现有键，则会多次计数。因此，如果 foo 存在，EXISTS foo foo 将返回 2。

返回值 ​

整数返回值：作为参数指定的键中存在的数量。

EXPIRE ​

Syntax ​

bash
    EXPIRE key seconds [NX | XX | GT | LT]

以秒为单位设置 key 的超时时间。超时后，键将自动删除。

EXPIRE 命令支持支持以下选项：

  • NX -- 仅在键没有到期时设置
  • XX -- 仅在键已经设置到期时设置
  • GT -- 仅当新到期时间大于当前到期时间时设置
  • LT -- 仅当新到期时间小于当前到期时间时设置

返回值 ​

以下之一：

  • 整数返回值：如果未设置超时时间，则为 0；例如，键不存在，或者由于提供的参数而跳过了操作。

  • 整数返回值：如果设置了超时时间，则为 1。

KEYS ​

Syntax ​

bash
    KEYS pattern

返回与模式匹配的所有键。

警告: 请谨慎使用 KEYS 命令，因为它可能会在执行大型数据库时影响性能。

支持的模式示例：

  • h?llo 匹配 hello、hallo 和 hxllo
  • h*llo 匹配 hllo 和 heeeello
  • h[ae]llo 匹配 hello 和 hallo，但不匹配 hillo
  • h[^e]llo 匹配 hallo、hbllo，...，但不匹配 hello
  • h[a-b]llo 匹配 hallo 和 hbllo

如果要匹配特殊字符，请使用 \ 进行转义。

返回值 ​

数组返回值：与模式匹配的键列表。

MIGRATE ​

TODO: 验证语法和功能

返回值 ​

PERSIST ​

Syntax ​

bash
    PERSIST key

移除键的现有超时，将键从易失性（具有设置到期的键）更改为持久性（不会到期的键）。

返回值 ​

PEXPIRE ​

Syntax ​

bash
    PEXPIRE key milliseconds [NX | XX | GT | LT]

此命令与 EXPIRE 完全相同，但键的超时时间以毫秒为单位指定，而不是以秒为单位。

返回值 ​

以下之一：

  • 整数返回值：如果键不存在或未关联超时，则为 0。
  • 整数返回值：如果已删除超时，则为 1。

PTTL ​

Syntax ​

bash
    PTTL  key

此命令与 TTL 相似，但是剩余的时间以毫秒为单位返回，而不是以秒为单位。

返回值 ​

以下之一：

  • 整数返回值：剩余的 TTL（以毫秒为单位）。
  • 整数返回值：如果键存在但未关联到期时间，则为 -1。
  • 整数返回值：如果键不存在，则为 -2。

RENAME ​

Syntax ​

bash
    RENAME key newkey

将 key 重命名为 newkey。当 key 不存在时返回错误。如果 newkey 已存在，则将其覆盖；在这种情况下，RENAME 执行隐式的 DEL 操作。

返回值 ​

字符串返回值：OK。

SCAN ​

Syntax ​

bash
    SCAN cursor [MATCH pattern] [COUNT count] [TYPE type]

遍历存储中存在的键，并仅返回与选定过滤器匹配的键。

MATCH 选项 可以仅遍历与给定 glob 风格模式匹配的元素，与 KEYS 命令的行为类似，该命令将模式作为其唯一参数。

TYPE 选项 您可以使用 TYPE 选项来要求 SCAN 仅返回与特定类型匹配的对象，允许您遍历数据库以查找特定类型的键。

COUNT 选项

默认的 COUNT 值为 10，但用户可以自由更改它。

返回值 ​

数组返回值：具体来说，是一个具有两个元素的数组。

  • 第一个元素是表示无符号 64 位数字的块字符串返回值，即游标。
  • 第二个元素是扫描键的名称的数组。

TTL ​

Syntax ​

bash
    TTL key

返回键的剩余过期时间（TTL）。

返回值 ​

以下之一：

  • 整数返回值：TTL（以秒为单位）。
  • 整数返回值：如果键存在但未关联到期时间，则为 -1。
  • 整数返回值：如果键不存在，则为 -2。

TYPE ​

Syntax ​

bash
    TYPE key

返回存储在键中的值的类型的字符串表示。可能返回的不同类型包括：字符串、列表、集合、有序集合和哈希。

返回值 ​

字符串返回值：键的类型，或者键不存在时返回 none。

Syntax ​

bash

此命令与 DEL 非常相似：它会移除指定的键。与 DEL 一样，如果键不存在，则会忽略它。但是，该命令在不同的线程中执行实际的内存回收，因此它不会阻塞，而 DEL 会阻塞.

返回值 ​

整数返回值：已取消链接的键的数量。