Objeto objeto incorporado

Objeto Redis

Redis objeto de cliente de base de datos

Se utiliza para crear y administrar la base de datos Redis, método de creación:

1 2
var db = require("db"); var test = new db.openRedis("redis-server");

Herencia

Atributos del miembro

onsuberror

Función, consulta y función de manejo de errores establecida, devuelve la llamada cuando ocurre el sub error o la red se interrumpe, cuando ocurre la devolución de llamada, todos los sub de este objeto se detendrán

1
Function Redis.onsuberror;

Función miembro

command

Redis método de comando básico

1 2
Value Redis.command(String cmd, ...args);

Parámetros de llamada:

  • cmd : String, especifique el comando enviado
  • args : ..., especifique los parámetros enviados

Resultado devuelto:

  • Value , devuelve el resultado devuelto por el servidor

set

Asociar el valor del valor de cadena a la clave, si la clave ya contiene otros valores, SET sobrescribe el valor anterior, independientemente del tipo

1 2 3
Redis.set(Buffer key, Buffer value, Long ttl = 0);

Parámetros de llamada:

  • key : Buffer , especifique la clave a asociar
  • value : Buffer , especifique los datos a asociar
  • ttl : Largo, establezca el tiempo de supervivencia para la clave en milisegundos; si ttl es 0, entonces no establezca el tiempo de supervivencia

setNX

Establezca el valor de clave en valor si y solo si la clave no existe. Si la clave dada ya existe, SETNX no hace nada.

1 2 3
Redis.setNX(Buffer key, Buffer value, Long ttl = 0);

Parámetros de llamada:

  • key : Buffer , especifique la clave a asociar
  • value : Buffer , especifique los datos a asociar
  • ttl : Largo, establezca el tiempo de supervivencia para la clave en milisegundos; si ttl es 0, entonces no establezca el tiempo de supervivencia

setXX

Establezca el valor de clave en valor, y establezca la clave solo cuando la clave ya exista.

1 2 3
Redis.setXX(Buffer key, Buffer value, Long ttl = 0);

Parámetros de llamada:

  • key : Buffer , especifique la clave a asociar
  • value : Buffer , especifique los datos a asociar
  • ttl : Largo, establezca el tiempo de supervivencia para la clave en milisegundos; si ttl es 0, entonces no establezca el tiempo de supervivencia

mset

Establezca uno o más pares clave-valor al mismo tiempo. Si ya existe una clave determinada, MSET sobrescribirá el valor anterior con el nuevo valor

1
Redis.mset(Object kvs);

Parámetros de llamada:

  • kvs : Object, especifique el objeto clave / valor que se establecerá

Establezca uno o más pares clave-valor al mismo tiempo. Si ya existe una clave determinada, MSET sobrescribirá el valor anterior con el nuevo valor

1
Redis.mset(...kvs);

Parámetros de llamada:

  • kvs : ..., especifique la lista de clave / valor que se establecerá

msetNX

Establezca uno o más pares clave-valor al mismo tiempo, si y solo si todas las claves dadas no existen

1
Redis.msetNX(Object kvs);

Parámetros de llamada:

  • kvs : Object, especifique el objeto clave / valor que se establecerá

Establezca uno o más pares clave-valor al mismo tiempo, si y solo si todas las claves dadas no existen

1
Redis.msetNX(...kvs);

Parámetros de llamada:

  • kvs : ..., especifique la lista de clave / valor que se establecerá

append

Si la clave ya existe y es una cadena, el comando append agrega el valor al final del valor original de la clave. Si la clave no existe, agregar simplemente establece la clave dada en valor

1 2
Integer Redis.append(Buffer key, Buffer value);

Parámetros de llamada:

  • key : Buffer , especifique la clave que se agregará
  • value : Buffer , especifique los datos que se agregarán

Resultado devuelto:

  • Integer , después de agregar valor, la longitud de la cadena en clave

setRange

Use el parámetro de valor para sobrescribir el valor de cadena almacenado en la clave dada, comenzando desde el desplazamiento de desplazamiento

1 2 3
Integer Redis.setRange(Buffer key, Integer offset, Buffer value);

Parámetros de llamada:

  • key : Buffer , especifique la clave a modificar
  • offset : entero, especifique el desplazamiento del byte modificado
  • value : Buffer , especifique los datos que se sobrescribirán

Resultado devuelto:

  • Integer , después de ser modificado, la longitud de la cadena

getRange

Devuelve la subcadena del valor de la cadena en la clave. El rango de intercepción de la cadena está determinado por los dos desplazamientos de inicio y fin (incluidos el inicio y el final)

1 2 3
Buffer Redis.getRange(Buffer key, Integer start, Integer end);

Parámetros de llamada:

  • key : Buffer , especifique la clave a consultar
  • start : entero, especifique el desplazamiento del byte de inicio de la consulta
  • end : entero, especifique el desplazamiento del byte final de la consulta

Resultado devuelto:

  • Buffer , interceptar la subcadena

strlen

Devuelve la longitud del valor de cadena almacenado en la clave. Cuando la clave no es un valor de cadena, se devuelve un error

1
Integer Redis.strlen(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave a calcular

Resultado devuelto:

  • Integer , la longitud del valor de la cadena. Cuando la clave no existe, devuelve 0

bitcount

Cuente el número de bits establecidos en 1 en una cadena dada

1 2 3
Integer Redis.bitcount(Buffer key, Integer start = 0, Integer end = -1);

Parámetros de llamada:

  • key : Buffer , especifique la clave a calcular
  • start : entero, especifique el byte inicial que se calculará, se pueden usar valores negativos, -1 significa el último byte y -2 significa el penúltimo byte, y así sucesivamente
  • end : entero, especifique el byte final que se calculará, se pueden usar valores negativos, -1 significa el último byte y -2 significa el penúltimo byte, etc.

Resultado devuelto:

  • Integer , el número de bits establecido en 1

get

Devuelve el valor de cadena asociado con la clave, si la clave no existe, devuelve el valor especial Nulo

1
Buffer Redis.get(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave a asociar

Resultado devuelto:

  • Buffer , cuando la clave no existe, devuelve Null, de lo contrario, devuelve el valor de la clave

mget

Devuelve todos (uno o más) valores de la clave dada. Si una clave no existe en la clave dada, entonces esta clave devuelve el valor especial nil.

1
NArray Redis.mget(Array keys);

Parámetros de llamada:

  • keys : matriz, especifique la matriz de claves que se consultará

Resultado devuelto:

  • NArray , una lista que contiene todos los valores de una clave dada

Devuelve todos (uno o más) valores de la clave dada. Si una clave no existe en la clave dada, entonces esta clave devuelve el valor especial nil.

1
NArray Redis.mget(...keys);

Parámetros de llamada:

  • keys : ..., especifique la lista de keys a consultar

Resultado devuelto:

  • NArray , una lista que contiene todos los valores de una clave dada

getset

Establezca el valor de la clave dada en valor y devuelva el valor anterior de la clave (valor anterior)

1 2
Buffer Redis.getset(Buffer key, Buffer value);

Parámetros de llamada:

  • key : Buffer , especifique la clave que se consultará y modificará
  • value : Buffer , especifique el valor modificado

Resultado devuelto:

  • Buffer , devuelve el valor anterior de la clave dada

decr

Reste la disminución del valor almacenado en la clave

1 2
Long Redis.decr(Buffer key, Long num = 1);

Parámetros de llamada:

  • key : Buffer , especifique la clave a modificar
  • num : Largo, especifique el valor a restar

Resultado devuelto:

  • Long , después de restar num, el valor de la clave

incr

Agregue el incremento al valor almacenado en la clave

1 2
Long Redis.incr(Buffer key, Long num = 1);

Parámetros de llamada:

  • key : Buffer , especifique la clave a modificar
  • num : Largo, especifique el valor que se agregará

Resultado devuelto:

  • Long , después de agregar num, el valor de la clave

setBit

Para el valor de cadena almacenado en la clave, establezca o borre el bit en el desplazamiento especificado (bit)

1 2 3
Integer Redis.setBit(Buffer key, Integer offset, Integer value);

Parámetros de llamada:

  • key : Buffer , especifique la clave a modificar
  • offset : entero, especifique el desplazamiento de bit para la modificación
  • value : entero, especifica el parámetro que se establecerá o borrará, puede ser 0 o 1

Resultado devuelto:

  • Integer , especifique el bit original almacenado del desplazamiento

getBit

Obtenga el bit en el desplazamiento especificado para el valor de cadena almacenado en la clave

1 2
Integer Redis.getBit(Buffer key, Integer offset);

Parámetros de llamada:

  • key : Buffer , especifique la clave a consultar
  • offset : entero, especifique el desplazamiento de bits de la consulta

Resultado devuelto:

  • Integer , el bit en el desplazamiento especificado del valor de cadena (bit)

exists

Compruebe si existe la clave dada

1
Boolean Redis.exists(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave a asociar

Resultado devuelto:

  • Boolean , si la clave existe, devuelve True, de lo contrario devuelve False

type

Devuelve el tipo de valor almacenado en la clave

1
String Redis.type(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave a consultar

Resultado devuelto:

  • String , devuelve el tipo del valor almacenado por la clave, el valor posible es ninguno (la clave no existe) cadena (cadena) lista (lista) conjunto (colección) zset (conjunto ordenado) hash (tabla hash)

keys

Encuentra todas las claves que coinciden con el patrón dado

1
NArray Redis.keys(String pattern);

Parámetros de llamada:

  • pattern : String, especifique el patrón de consulta

Resultado devuelto:

  • NArray , una lista de claves que coinciden con el patrón dado

del

Eliminar una o más claves dadas, las claves inexistentes serán ignoradas

1
Integer Redis.del(Array keys);

Parámetros de llamada:

  • keys : matriz, especifique la matriz de claves que se eliminará

Resultado devuelto:

  • Integer , el número de claves eliminadas

Eliminar una o más claves dadas, las claves inexistentes serán ignoradas

1
Integer Redis.del(...keys);

Parámetros de llamada:

  • keys : ..., especifique la lista de claves que se eliminará

Resultado devuelto:

  • Integer , el número de claves eliminadas

expire

Establezca el tiempo de vida de una clave determinada, cuando la clave caduque, se eliminará automáticamente

1 2
Boolean Redis.expire(Buffer key, Long ttl);

Parámetros de llamada:

  • key : Buffer , especifique la clave que se establecerá
  • ttl : Largo, establece el tiempo de supervivencia para la clave en milisegundos

Resultado devuelto:

  • Boolean , si la clave existe, devuelve True, de lo contrario devuelve False

ttl

Devuelve el tiempo de supervivencia restante de la clave dada

1
Long Redis.ttl(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave a consultar

Resultado devuelto:

  • Long , devuelve el tiempo de supervivencia restante de la clave en milisegundos. Cuando la clave no existe, devuelve -2. Cuando existe la clave pero no se establece el tiempo de supervivencia restante, devuelve -1

persist

Elimine la duración de una clave determinada y convierta esta clave de "volátil" (con clave de duración) a "persistente" (una clave sin duración y nunca caduca)

1
Boolean Redis.persist(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave que se establecerá

Resultado devuelto:

  • Boolean , si la clave existe, devuelve True, de lo contrario devuelve False

rename

Cambie el nombre de la clave a newkey. Cuando la clave y la nueva clave son iguales o la clave no existe, se devuelve un error

1 2
Redis.rename(Buffer key, Buffer newkey);

Parámetros de llamada:

  • key : Buffer , especifique la clave a renombrar
  • newkey : Buffer , especifique la clave de destino para renombrar

renameNX

Si y solo si newkey no existe, cambie el nombre de la clave a newkey y devuelva un error cuando la clave no exista

1 2
Boolean Redis.renameNX(Buffer key, Buffer newkey);

Parámetros de llamada:

  • key : Buffer , especifique la clave a renombrar
  • newkey : Buffer , especifique la clave de destino para renombrar

Resultado devuelto:

  • Boolean , cuando la modificación es exitosa, devuelve True, si la nueva clave ya existe, devuelve False

sub

Suscríbase a la información de un canal determinado y llame automáticamente a func cuando aparezca un mensaje. Func contiene dos parámetros, canal y mensaje, a su vez. La misma función en el mismo canal solo se devolverá una vez

1 2
Redis.sub(Buffer channel, Function func);

Parámetros de llamada:

  • channel : Buffer , especifique el nombre del canal suscrito
  • func : Function, especifica la función de devolución de llamada

Suscríbase a la información de un conjunto determinado de canales y llame automáticamente a la función de devolución de llamada correspondiente cuando se produzca un mensaje. La misma función del mismo canal solo se devolverá una vez

1
Redis.sub(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de canales, el nombre del atributo del objeto será el nombre del canal y el valor del atributo será la función de devolución de llamada

unsub

Anular la suscripción de todas las devoluciones de llamada de un canal determinado

1
Redis.unsub(Buffer channel);

Parámetros de llamada:

  • channel : Buffer , especifique el nombre del canal no suscrito

Anular la suscripción a la función de devolución de llamada especificada del canal dado

1 2
Redis.unsub(Buffer channel, Function func);

Parámetros de llamada:

  • channel : Buffer , especifique el nombre del canal no suscrito
  • func : Function, especifica la función de devolución de llamada para cancelar la suscripción

Anular la suscripción de todas las devoluciones de llamada para un canal determinado

1
Redis.unsub(Array channels);

Parámetros de llamada:

  • channels : matriz, especifique la matriz de canales no suscritos

Anular la suscripción a la función de devolución de llamada especificada de un conjunto dado de canales

1
Redis.unsub(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de canales, el nombre del atributo del objeto será el nombre del canal y el valor del atributo será la función de devolución de llamada

psub

Suscríbase a la información de un grupo de canales de acuerdo con la plantilla y llame automáticamente a func cuando aparezca un mensaje. Func contiene tres parámetros, que son canal, mensaje y patrón a su vez. La misma función de la misma plantilla solo se devolverá una vez

1 2
Redis.psub(String pattern, Function func);

Parámetros de llamada:

  • pattern : String, especifique la plantilla de canal suscrita
  • func : Function, especifica la función de devolución de llamada

Suscríbase a la información de un conjunto determinado de plantillas de canal y llame automáticamente al func correspondiente cuando aparezca un mensaje. La misma función en el mismo canal solo se devolverá una vez

1
Redis.psub(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de canales, el nombre del atributo del objeto se usará como plantilla de canal y el valor del atributo se usará como la función de devolución de llamada

unpsub

Anular la suscripción de todas las devoluciones de llamada de canales con una plantilla determinada

1
Redis.unpsub(String pattern);

Parámetros de llamada:

  • pattern : String, especifique la plantilla de canal para cancelar la suscripción

La función de devolución de llamada especificada para cancelar la suscripción del canal de la plantilla dada

1 2
Redis.unpsub(String pattern, Function func);

Parámetros de llamada:

  • pattern : String, especifique la plantilla de canal para cancelar la suscripción
  • func : Function, especifica la función de devolución de llamada para cancelar la suscripción

Anular la suscripción de todas las devoluciones de llamada de un conjunto de canales con una plantilla determinada

1
Redis.unpsub(Array patterns);

Parámetros de llamada:

  • patterns : matriz, especifique la matriz de plantillas de canal para publicar

La función de devolución de llamada especificada para canales no suscritos de un conjunto de plantillas

1
Redis.unpsub(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de canales, el nombre del atributo del objeto se usará como plantilla de canal y el valor del atributo se usará como la función de devolución de llamada

pub

Enviar mensaje de información al canal de canal especificado

1 2
Integer Redis.pub(Buffer channel, Buffer message);

Parámetros de llamada:

  • channel : Buffer , especifique el canal publicado
  • message : Buffer , especifique el mensaje que se publicará

Resultado devuelto:

  • Integer , el número de clientes que reciben este mensaje

getHash

Obtenga el objeto Hash de la clave especificada. Este objeto es el cliente que contiene la clave especificada. La base de datos solo se puede operar llamando a su método

1
RedisHash Redis.getHash(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave que se obtendrá

Resultado devuelto:

  • RedisHash , devuelve un objeto Hash que contiene la clave especificada

getList

Obtenga el objeto Lista de la clave especificada. Este objeto es el cliente que contiene la clave especificada. La base de datos solo se puede operar llamando a su método

1
RedisList Redis.getList(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave que se obtendrá

Resultado devuelto:

  • RedisList , devuelve un objeto List que contiene la clave especificada

getSet

Obtenga el objeto Set de la clave especificada. Este objeto es el cliente que contiene la clave especificada. La base de datos solo se puede operar llamando a su método

1
RedisSet Redis.getSet(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave que se obtendrá

Resultado devuelto:

  • RedisSet , devuelve un objeto Set que contiene la clave especificada

getSortedSet

Obtenga el objeto SortedSet de la clave especificada. Este objeto es el cliente que contiene la clave especificada. La base de datos solo se puede operar llamando a su método

1
RedisSortedSet Redis.getSortedSet(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave que se obtendrá

Resultado devuelto:

  • RedisSortedSet , devuelve un objeto SortedSet que contiene la clave especificada

dump

Serialice la clave dada y devuelva el valor serializado. Use el comando de restauración para deserializar este valor en una clave Redis

1
Buffer Redis.dump(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave a serializar

Resultado devuelto:

  • Buffer , devuelve el valor serializado, si la clave no existe, luego devuelve nulo

restore

Deserializar el valor serializado dado y asociarlo con la clave dada

1 2 3
Redis.restore(Buffer key, Buffer data, Long ttl = 0);

Parámetros de llamada:

  • key : Buffer , especifique la clave que se deserializará
  • data : Buffer , especifique los datos a ser deserializados
  • ttl : Largo, establezca el tiempo de supervivencia para la clave en milisegundos; si ttl es 0, entonces no establezca el tiempo de supervivencia

close

Cerrar la conexión o transacción actual de la base de datos

1
Redis.close();

toString

Devuelve la representación de cadena del objeto, generalmente devuelve "[Objeto nativo]", el objeto se puede volver a implementar de acuerdo con sus propias características

1
String Redis.toString();

Resultado devuelto:

  • String , devuelve la representación de cadena del objeto

toJSON

Devuelve la representación en formato JSON del objeto, generalmente devuelve una colección de atributos legibles definidos por el objeto

1
Value Redis.toJSON(String key = "");

Parámetros de llamada:

  • key : cadena, sin usar

Resultado devuelto:

  • Value , devuelve un valor que contiene JSON serializable