Objeto objeto incorporado

Objeto Redis

Redis objeto de cliente de base de datos

Para crear y administrar la base de datos Redis, cree métodos:

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

Herencia

Atributos del miembro

onsuberror

Función, consulta y establece la función de manejo de errores, devolución de llamada cuando se produce un sub error o interrupción de la red, después de la devolución de llamada, todos los sub de este objeto serán abortados

1
Function Redis.onsuberror;

Función miembro

command

métodos de comando básicos de redis

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

Parámetros de llamada:

  • cmd : String, especifique el comando para enviar
  • args : ..., especifique los parámetros para enviar

Devuelve el resultado:

  • Value , devuelve el resultado devuelto por el servidor

set

Asociar el valor de la cadena con la clave. Si la clave ya contiene otro valor, 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 , especifica los datos a asociar
  • ttl : Largo, establezca el tiempo de vida en milisegundos como la clave; si ttl es 0, entonces no hay tiempo de vida

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 , especifica los datos a asociar
  • ttl : Largo, establezca el tiempo de vida en milisegundos como la clave; si ttl es 0, entonces no hay tiempo de vida

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 , especifica los datos a asociar
  • ttl : Largo, establezca el tiempo de vida en milisegundos como la clave; si ttl es 0, entonces no hay tiempo de vida

mset

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

1
Redis.mset(Object kvs);

Parámetros de llamada:

  • kvs : Object, especifica 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 sobrescribe 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, especifica 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 anexar agrega 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 , especifica los datos que se agregarán

Devuelve el resultado:

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

setRange

Anule el valor de cadena almacenado por la clave dada con el parámetro de valor, comenzando en el 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 : Integer, especifica el desplazamiento del byte modificado
  • value : Buffer , especifica los datos que se sobrescribirán

Devuelve el resultado:

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

getRange

Devuelve la subcadena del valor de la cadena en clave. El rango de truncamiento de la cadena está determinado por los 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 para consultar
  • start : entero, especifica el desplazamiento del byte inicial de la consulta
  • end : entero, especifica el desplazamiento del byte final de la consulta

Devuelve el resultado:

  • Buffer , subcadena interceptada

strlen

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

Devuelve el resultado:

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

bitcount

Cuente el número de bits establecido 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á, puede usar valores negativos, -1 significa el último byte, -2 significa el penúltimo byte, y así sucesivamente
  • end : Entero, especifique el byte final que se calculará, puede usar un valor negativo, -1 significa el último byte, -2 significa el penúltimo byte, etc.

Devuelve el resultado:

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

get

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

1
Buffer Redis.get(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave a asociar

Devuelve el resultado:

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

mget

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

1
NArray Redis.mget(Array keys);

Parámetros de llamada:

  • keys : matriz, especifique la matriz de keys para consultar

Devuelve el resultado:

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

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

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

Parámetros de llamada:

  • keys : ..., especifique una lista de keys para consultar

Devuelve el resultado:

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

getset

Establece el valor de la clave dada en valor y devuelve el valor anterior de la clave

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

Parámetros de llamada:

  • key : Buffer , especifique la clave para consultar y modificar
  • value : Buffer , especifique el valor modificado

Devuelve el resultado:

  • Buffer , devuelve el valor anterior de la clave dada

decr

Disminuya el valor almacenado por 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

Devuelve el resultado:

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

incr

Incrementar el valor almacenado por 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 a agregar

Devuelve el resultado:

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

setBit

Establece o borra el bit en el desplazamiento especificado para el valor de cadena almacenado en la clave

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, especifica el desplazamiento del bit modificado
  • value : Entero, especifica el parámetro que se establecerá o borrará, que puede ser 0 o 1

Devuelve el resultado:

  • Integer , especifica el bit donde se almacenó originalmente el desplazamiento

getBit

Obtiene el bit en el desplazamiento especificado del 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 para consultar
  • offset : entero, especifica el desplazamiento de bits de la consulta

Devuelve el resultado:

  • Integer , el valor de cadena especifica el bit en el desplazamiento

exists

Comprueba si la clave dada existe

1
Boolean Redis.exists(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave a asociar

Devuelve el resultado:

  • Boolean , devuelve verdadero si la clave existe, de lo contrario devuelve falso

type

Devuelve el tipo de valor almacenado por clave

1
String Redis.type(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave para consultar

Devuelve el resultado:

  • String , devuelve el tipo de valor almacenado por clave, los valores posibles son ninguno (la clave no existe) cadena (cadena) lista (lista) conjunto (conjunto) 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, especifica el patrón de consulta

Devuelve el resultado:

  • 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 keys para eliminar

Devuelve el resultado:

  • Integer , 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 una lista de keys para eliminar

Devuelve el resultado:

  • Integer , número de claves eliminadas

expire

Establece la vida útil de una clave determinada. Cuando una clave caduca, se elimina 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 vida en milisegundos para la clave

Devuelve el resultado:

  • Boolean , devuelve verdadero si la clave existe, de lo contrario devuelve falso

ttl

Devuelve el tiempo restante de vida para una clave determinada

1
Long Redis.ttl(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave para consultar

Devuelve el resultado:

  • Long , en milisegundos, devuelve la vida útil restante de la clave. Cuando la clave no existe, devuelve -2. Cuando la clave existe pero no se establece el tiempo 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á

Devuelve el resultado:

  • Boolean , devuelve verdadero si la clave existe, de lo contrario devuelve falso

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 , especifica la clave de destino a 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 , especifica la clave de destino a renombrar

Devuelve el resultado:

  • Boolean , verdadero si la modificación es exitosa, falso si newkey ya existe

sub

Suscríbase a la información de un canal determinado. Func se llama automáticamente cuando aparece un mensaje. Func contiene dos parámetros, canal y mensaje, y la misma función del 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 para suscribirse
  • func : Función, especifique la función de devolución de llamada

Suscríbase a la información de un conjunto de canales determinado 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, especifica la relación de mapeo del canal, el nombre de la propiedad del objeto se usará como el nombre del canal y el valor de la propiedad se usará como la función de devolución de llamada

unsub

Darse de baja de todas las devoluciones de llamada para 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 para el 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 conjunto de canales determinado

1
Redis.unsub(Array channels);

Parámetros de llamada:

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

Darse de baja de la función de devolución de llamada especificada para un conjunto dado de canales

1
Redis.unsub(Object map);

Parámetros de llamada:

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

psub

Suscríbase a un conjunto de información de canales de acuerdo con la plantilla. Func se llama automáticamente cuando aparece un mensaje. Func contiene tres parámetros, canal, mensaje y patrón. La misma plantilla y función solo se devolverán una vez.

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

Parámetros de llamada:

  • pattern : String, la plantilla de canal especificada
  • 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 al func correspondiente cuando aparezca un mensaje. La misma función del mismo canal solo se devolverá una vez.

1
Redis.psub(Object map);

Parámetros de llamada:

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

unpsub

Deshacer todas las devoluciones de llamada para el canal de la plantilla dada

1
Redis.unpsub(String pattern);

Parámetros de llamada:

  • pattern : String, especifica la plantilla de canal no suscrita

La función de devolución de llamada especificada para el canal que se da de baja de la plantilla dada

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

Parámetros de llamada:

  • pattern : String, especifica la plantilla de canal no suscrita
  • 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 conjunto de canales determinado

1
Redis.unpsub(Array patterns);

Parámetros de llamada:

  • patterns : matriz, especifica una matriz de plantillas de canales para publicar

Función de devolución de llamada especificada para canales que cancelan la suscripción a un conjunto de plantillas

1
Redis.unpsub(Object map);

Parámetros de llamada:

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

pub

Enviar mensaje al canal especificado

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

Parámetros de llamada:

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

Devuelve el resultado:

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

getHash

Obtiene el objeto Hash de la clave especificada. Este objeto es un cliente que contiene la clave especificada. La base de datos solo funcionará si se llama a su método.

1
RedisHash Redis.getHash(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave para obtener

Devuelve el resultado:

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

getList

Obtiene el objeto Lista de la clave especificada. Este objeto es un cliente que contiene la clave especificada. La base de datos solo funcionará si se llama a su método.

1
RedisList Redis.getList(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave para obtener

Devuelve el resultado:

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

getSet

Obtiene un objeto Set con la clave especificada. Este objeto es un cliente que contiene la clave especificada. La base de datos solo se manipulará si se llama a su método.

1
RedisSet Redis.getSet(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave para obtener

Devuelve el resultado:

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

getSortedSet

Obtiene el objeto SortedSet de la clave especificada. Este objeto es un cliente que contiene la clave especificada. La base de datos solo se manipulará si se llama a su método.

1
RedisSortedSet Redis.getSortedSet(Buffer key);

Parámetros de llamada:

  • key : Buffer , especifique la clave para obtener

Devuelve el resultado:

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

dump

Serialice la clave dada y devuelva el valor serializado. Utilice 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 , especifica la clave a serializar

Devuelve el resultado:

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

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 , especifica la clave a ser deserializada
  • data : Buffer , especifica los datos a ser deserializados
  • ttl : Largo, establezca el tiempo de vida en milisegundos como la clave; si ttl es 0, entonces no hay tiempo de vida

close

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

1
Redis.close();

toString

Devuelve una representación de cadena del objeto, generalmente "[Objeto nativo]". Los objetos se pueden volver a implementar de acuerdo con sus propias características

1
String Redis.toString();

Devuelve el resultado:

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

toJSON

Devuelve una representación JSON del objeto, que generalmente devuelve una colección de propiedades legibles definidas por el objeto

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

Parámetros de llamada:

  • key : cadena, sin usar

Devuelve el resultado:

  • Value , devuelve un valor que contiene un JSON serializable