JavaScript API

JavaScript API 概述

Redis 对象

  • 自版本起：2.0.0

JavaScript API 中的触发器和函数提供了一个名为 redis 的单例对象实例。redis 实例使注册的函数能够与它们运行的 Redis 服务器进行交互。以下是 redis 实例提供的 API。

redis.registerFunction

  • 自版本起：2.0.0

注册一个新函数，以后可以使用TFCALL命令调用。

//name and callback mandatory
//object with optional arguments
redis.registerFunction(
  'foo', //name
  function(client, args) {}, //callback
  {
    description: 'The description',
    flags: [redis.functionFlags.NO_WRITES, redis.functionFlags.ALLOW_OOM]
  } // optional arguments
);

redis.registerAsyncFunction

  • 自版本起：2.0.0

注册一个新的异步函数，稍后可以使用TFCALLASYNC命令调用。

redis.registerAsyncFunction(
  'foo', //Function name
  function(client, args){}, //callback
  {
    description: 'description',
    flags: [redis.functionFlags.NO_WRITES, redis.functionFlags.ALLOW_OOM]
  } //optional arguments
);

redis.registerKeySpaceTrigger

  • 自版本起：2.0.0

注册一个键空间通知触发器，每当键空间通知触发时运行。

redis.registerKeySpaceTrigger(
  'foo', // trigger name
  'keys:*', //key prefix
  function(client, data) {}, //callback
  {
    description: 'description'
    onTriggerFired: function(client, data){}
  } //optional arguments
)

redis.registerStreamTrigger

  • 自版本起：2.0.0

注册一个流触发器，每当数据被添加到流中时将被调用。

redis.registerStreamTrigger(
  'foo', //trigger name
  'stream:*', //prefix
  function(client, data){},//callback
  {
    description: 'Description'
    window: 1,
    isStreamTrimmed: false 
  } //optional arguments
)

redis.registerClusterFunction

  • 自版本起：2.0.0

注册一个集群函数，稍后可以使用async_client.runOnKey()或async_client.runOnShards()调用

redis.registerClusterFunction(
  'foo', //name
  async function(client, ...args){} //callback
)

redis.config

  • 自版本起：2.0.0
redis-cli -x RG.FUNCTION LOAD UPGRADE CONFIG '{"example_config": "example_config_value"}' < main.js

var configExample = redis.config.example_config;

客户端对象

用于在Redis上执行操作的客户端对象。

client.call

  • 自版本起：2.0.0

在Redis上运行一个命令。该命令在当前Redis实例上执行。

client.call(
  '',
  ...args
)

client.callRaw

  • 自版本起：2.0.0

在Redis上运行一个命令，但不对结果执行UTF8解码。该命令在当前Redis实例上执行。

client.callRaw(
  '',
  ...args
)

client.callAsync

  • 自版本起：2.0.0

在Redis上调用一个命令。允许Redis在需要时阻塞执行（如blpop命令），并异步返回结果。返回一个承诺对象，该对象将在命令调用完成时被解析。

client.callAsync(
  '',
  ...args
)

client.callAsyncRaw

  • 自版本起：2.0.0

在Redis上调用一个命令。允许Redis在需要时阻塞执行（如blpop命令），并异步返回结果。返回一个承诺对象，该对象将在命令调用完成时被解析。该命令在当前Redis实例上执行。

client.callRaw(
  '',
  ...args
)

client.isBlockAllowed

  • 自版本起：2.0.0

如果允许从函数回调中返回promise，则返回true。如果允许并且返回了promise，Redis将等待promise完成，然后才会返回函数结果。

client.isBlockAllowed(); // True / False

client.executeAsync

  • 自版本起：2.0.0

异步执行给定的函数。返回一个承诺，当承诺被解决/拒绝时将实现。

client.executeAsync(
  async function(client){}
)

异步客户端对象

用于在Redis上执行后台操作的背景客户端对象。 此客户端被提供给任何作为JS协程运行的后台任务。

async_client.block

  • 自版本起：2.0.0

阻止Redis执行命令调用。在给定函数内执行的所有命令都被视为原子操作，并将使用Multi/Exec进行包装并发送到副本/AOF。

async_client.block(
  function(client){}
)

async_client.runOnKey

  • 自版本起：2.0.0

在给定的键上运行一个远程函数。如果该键位于当前运行的分片上，远程函数将立即运行。否则，远程函数将在远程分片上运行。返回一个承诺，该承诺将在调用完成时被履行。请注意，远程函数必须返回一个可序列化为JSON的结果，以便我们可以将结果序列化回原始分片。

请注意，远程函数只能执行读取操作，不允许写入。

async_client.runOnKey(
  'key1', // key
  'foo', // function name
  ...args
)

async_client.runOnShards

  • 自版本起：2.0.0

在所有分片上运行一个远程函数。返回一个承诺，当所有分片上的调用完成时，该承诺将被履行。

结果是包含2个元素的数组，第一个是另一个包含所有结果的数组。第二个是调用期间发生的所有错误的数组。请注意，远程函数必须返回一个可JSON序列化的结果，以便我们可以将结果序列化回原始分片。

请注意，远程函数只能执行读取操作，不允许写入。

async_client.runOnShards(
  'foo', //name
  ...args //arguments
)
RATE THIS PAGE
Back to top ↑