ngx_http_keyval_module 模块

ngx_http_keyval_module 模块 (1.13.3) 使用从 API 管理的键值对中获取的值创建变量，或者也可以使用 njs 设置的变量 (1.15.10)。

该模块作为我们商业订阅的一部分提供。

示例配置

http {

    keyval_zone zone=one:32k state=/var/lib/nginx/state/one.keyval;
    keyval $arg_text $text zone=one;
    ...
    server {
        ...
        location / {
            return 200 $text;
        }

        location /api {
            api write=on;
        }
    }
}

指令

keyval 指令

语　法：keyval key $variable zone=name;
默认值：—
上下文：http

创建一个新的 $variable，其值由键值数据库中的键查找。匹配规则由 keyval_zone 指令的类型参数定义。数据库存储在由 zone 参数指定的共享内存区域中。

keyval_zone 指令

语　法：keyval_zone zone=name:size [state=file] [timeout=time] [type=string|ip|prefix] [sync];
默认值：—
上下文：http

设置保存键值数据库的共享内存区域的名称和大小。键值对由 API 管理。

可选的 state 参数指定一个文件，该文件以 JSON 格式保存键值数据库的当前状态，并使其在 nginx 重启后保持持久。

例如：

keyval_zone zone=one:32k state=/var/lib/nginx/state/one.keyval; # path for Linux
keyval_zone zone=one:32k state=/var/db/nginx/state/one.keyval;  # path for FreeBSD

可选的 timeout 参数 (1.15.0) 设置从区域中删除键值对的时间。

可选的 type 参数 (1.17.1) 激活为匹配特定类型的键而优化的额外索引，并在计算 keyval $variable 时定义匹配规则。

索引存储在相同的共享内存区域中，因此需要额外的存储空间。