Objeto objeto integrado

Objeto Redis

Objeto de cliente de base de datos de Redis

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

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

Herencia

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<this>Redis|onsuberror|command();set();setNX();setXX();mset();msetNX();append();setRange();getRange();strlen();bitcount();get();mget();getset();decr();incr();setBit();getBit();exists();type();keys();del();expire();ttl();persist();rename();renameNX();sub();unsub();psub();unpsub();pub();getHash();getList();getSet();getSortedSet();dump();restore();close()] [object] <:- [Redis] Redis onsuberror command() set() setNX() setXX() mset() msetNX() append() setRange() getRange() strlen() bitcount() get() mget() getset() decr() incr() setBit() getBit() exists() type() keys() del() expire() ttl() persist() rename() renameNX() sub() unsub() psub() unpsub() pub() getHash() getList() getSet() getSortedSet() dump() restore() close() object toString() toJSON()

Atributos de miembros

onsuberror

Función, consultar y configurar la función de manejo de errores, volver a llamar cuando hay un error en el sub o la red se interrumpe, cuando se produce el retorno de llamada, todos los sub de este objeto serán abortados

1
Function Redis.onsuberror;

Función miembro

command

Método de comando básico de Redis

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

Parámetros de llamada:

  • cmd: Cadena, especifique el comando enviado
  • args: ..., especifique los parámetros a enviar

Devolver resultado:

  • Value, Devuelve el resultado devuelto por el servidor

set

Asocie el valor del valor de la 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, no establezca el tiempo de supervivencia

setNX

Establezca el valor de la 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, no establezca el tiempo de supervivencia

setXX

Establezca el valor de la 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, no establezca el tiempo de supervivencia

mset

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

1
Redis.mset(Object kvs);

Parámetros de llamada:

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

Establezca uno o más pares clave-valor al mismo tiempo. Si una clave determinada ya existe, 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

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

1
Redis.msetNX(Object kvs);

Parámetros de llamada:

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

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

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

Devolver resultado:

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

setRange

Utilice el parámetro de valor para sobrescribir el valor de cadena almacenado en la clave dada, comenzando desde el desplazamiento de compensación

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 de bytes modificado
  • value: Buffer, Especifique los datos que se sobrescribirán

Devolver resultado:

  • 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 las dos compensaciones de inicio y final (incluido 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

Devolver resultado:

  • Buffer, Interceptar la subcadena

strlen

Devuelve la longitud del valor de cadena almacenado en 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

Devolver resultado:

  • 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 determinada

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 va a 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, y así sucesivamente

Devolver resultado:

  • 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 Null

1
Buffer Redis.get(Buffer key);

Parámetros de llamada:

  • key: Buffer, Especifique la clave a asociar

Devolver resultado:

  • 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, esta clave devuelve el valor especial nulo.

1
NArray Redis.mget(Array keys);

Parámetros de llamada:

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

Devolver resultado:

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

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

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

Parámetros de llamada:

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

Devolver resultado:

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

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 a consultar y modificar
  • value: Buffer, Especifique el valor modificado

Devolver resultado:

  • 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 que se restará

Devolver resultado:

  • 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á

Devolver resultado:

  • 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 modificado
  • value: Entero, especifique el parámetro a establecer o borrar, puede ser 0 o 1

Devolver resultado:

  • 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

Devolver resultado:

  • Integer, El valor de la cadena especifica el bit en el desplazamiento (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

Devolver resultado:

  • 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

Devolver resultado:

  • String, Devuelve el tipo de valor almacenado en la clave, el valor posible es ninguno (la clave no existe) cadena (cadena) lista (lista) conjunto (colección) zset (conjunto ordenado) hash(Tabla de picadillo)

keys

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

1
NArray Redis.keys(String pattern);

Parámetros de llamada:

  • pattern: Cadena, especifique el modo de consulta

Devolver resultado:

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

del

Elimine 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á

Devolver resultado:

  • Integer, El número de claves eliminadas

Elimine 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á

Devolver resultado:

  • 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, establezca el tiempo de supervivencia de la clave en milisegundos

Devolver resultado:

  • 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

Devolver resultado:

  • Long, Devuelve el tiempo de supervivencia restante de la clave en milisegundos. Cuando la clave no existe, devuelve -2. Cuando existe la clave pero el tiempo de supervivencia restante no está configurado, devuelve -1

persist

Elimina la vida útil de una clave determinada y conviértela de "volátil" (con una clave de por vida) a "persistente" (una clave sin vida y que nunca caduca).

1
Boolean Redis.persist(Buffer key);

Parámetros de llamada:

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

Devolver resultado:

  • 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 devolverá 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 a la que se le cambiará el nombre

renameNX

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

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 a la que se le cambiará el nombre

Devolver resultado:

  • Boolean, Cuando la modificación es exitosa, devuelve Verdadero, si la nueva clave ya existe, devuelve Falso

sub

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

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

Parámetros de llamada:

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

Suscríbete a la información de un determinado conjunto de canales y llama automáticamente a la función de devolución de llamada correspondiente cuando se produce un mensaje. La misma función del mismo canal solo se volverá a llamar una vez.

1
Redis.sub(Object map);

Parámetros de llamada:

  • map: Objeto, 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

Cancelar 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

Cancelar 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: Función, especifique la función de devolución de llamada para cancelar la suscripción

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

1
Redis.unsub(Array channels);

Parámetros de llamada:

  • channels: Matriz, especifique la matriz de canales sin suscripción

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

1
Redis.unsub(Object map);

Parámetros de llamada:

  • map: Objeto, 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íbete a la información de un grupo de canales según la plantilla. Cuando ocurre un mensaje, se llama automáticamente a func. Func contiene tres parámetros, que son canal, mensaje y patrón a su vez. Solo se llamará a la misma función de la misma plantilla volver una vez.

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

Parámetros de llamada:

  • pattern: Cadena, especifique la plantilla de canal suscrito
  • func: Función, especifique 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 a la función correspondiente cuando se produzca un mensaje, y la misma función en el mismo canal solo se volverá a llamar una vez

1
Redis.psub(Object map);

Parámetros de llamada:

  • map: Objeto, 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 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: Cadena, especifique la plantilla de canal para cancelar la suscripción

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

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

Parámetros de llamada:

  • pattern: Cadena, especifique la plantilla de canal para cancelar la suscripción
  • func: Función, especifique la función de devolución de llamada para cancelar la suscripción

Cancelar 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 del canal que da de baja un conjunto de plantillas

1
Redis.unpsub(Object map);

Parámetros de llamada:

  • map: Objeto, 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 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á

Devolver resultado:

  • Integer, La cantidad de clientes que reciben este mensaje

getHash

Obtiene 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 cuando se llama a su método

1
RedisHash Redis.getHash(Buffer key);

Parámetros de llamada:

  • key: Buffer, Especifique la clave a obtener

Devolver resultado:

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

getList

Obtiene el objeto List de la clave especificada. Este objeto es el cliente que contiene la clave especificada. La base de datos solo se puede operar cuando se llama a su método

1
RedisList Redis.getList(Buffer key);

Parámetros de llamada:

  • key: Buffer, Especifique la clave a obtener

Devolver resultado:

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

getSet

Obtiene 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 a obtener

Devolver resultado:

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

getSortedSet

Obtiene 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 cuando se llama a su método

1
RedisSortedSet Redis.getSortedSet(Buffer key);

Parámetros de llamada:

  • key: Buffer, Especifique la clave a obtener

Devolver resultado:

  • RedisSortedSet, Devuelve el objeto SortedSet que contiene la clave especificada

dump

Serializar la clave dada y devolver el valor serializado. Utilice el comando de restauración para deserializar este valor en una clave de Redis

1
Buffer Redis.dump(Buffer key);

Parámetros de llamada:

  • key: Buffer, Especifique la clave a serializar

Devolver resultado:

  • Buffer, Devuelve el valor serializado, si la clave no existe, 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 que se deserializarán
  • ttl: Largo, establezca el tiempo de supervivencia para la clave en milisegundos; si ttl es 0, 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 en cadena del objeto, generalmente devuelve "[Native Object]", el objeto se puede volver a implementar de acuerdo con sus propias características

1
String Redis.toString();

Devolver resultado:

  • 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

Devolver resultado:

  • Value, Devuelve un valor que contiene JSON serializable