Objeto incorporado
  1. página delantera
  2. objetos incorporados
  3. ObjetoRedis

ObjetoRedis

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");

relación de herencia

%0 object object toString() toJSON() 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->Redis

propiedades de miembros

onsuberror

Función, consulta y configuración de la función de manejo de errores. Cuando el sub tiene un error o la red se interrumpe, se le devolverá la llamada. Cuando se produzca la devolución de llamada, se terminarán todos los subs de este objeto.

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, especifica el comando a enviar
  • args: ..., especifica los parámetros a enviar

Resultados de devolución:

  • Value, devuelve el resultado devuelto por el servidor

set

Asocie el valor de la cadena a 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 que se asociará
  • value:Buffer, especifica los datos a asociar
  • ttl: Largo, establece el tiempo de supervivencia para la clave en milisegundos; si ttl es 0, entonces el tiempo de supervivencia no está establecido

setNX

Establezca el valor de la clave en valor si y solo si la clave no existe. Si la clave proporcionada ya existe, SETNX no realiza ninguna acción.

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

Parámetros de llamada:

  • key:Buffer, especifique la clave que se asociará
  • value:Buffer, especifica los datos a asociar
  • ttl: Largo, establece el tiempo de supervivencia para la clave en milisegundos; si ttl es 0, entonces el tiempo de supervivencia no está establecido

setXX

Establezca el valor de la clave en valor y establezca la clave solo si la clave ya existe.

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

Parámetros de llamada:

  • key:Buffer, especifique la clave que se asociará
  • value:Buffer, especifica los datos a asociar
  • ttl: Largo, establece el tiempo de supervivencia para la clave en milisegundos; si ttl es 0, entonces el tiempo de supervivencia no está establecido

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, especifica el objeto 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 claves/valores que se establecerán

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: Objeto, 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 claves/valores que se establecerán

append

Si la clave ya existe y es una cadena, el comando agregar 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, especifique los datos que se adjuntarán

Resultados de devolución:

  • 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

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

Resultados de devolución:

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

getRange

Devuelve la subcadena del valor de la cadena en la clave. El rango de interceptació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, especifica el desplazamiento del byte inicial de la consulta.
  • end: Entero, especifica el desplazamiento del byte final de la consulta.

Resultados de devolución:

  • Buffer, intercepta la subcadena obtenida

strlen

Devuelve la longitud del valor de cadena almacenado en la clave. Cuando la clave almacena un valor distinto de 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

Resultados de devolución:

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

bitcount

Cuenta el número de bits establecidos en 1 en la 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, especifica el byte inicial que se calculará, puede usar valores negativos, -1 representa el último byte y -2 representa el penúltimo byte, y así sucesivamente.
  • end: Entero, especifica el byte final que se calculará, puede usar valores negativos, -1 representa el último byte y -2 representa el penúltimo byte, y así sucesivamente.

Resultados de devolución:

  • Integer, el número de bits establecidos 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 que se asociará

Resultados de devolución:

  • 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 para la clave dada. Si una clave no existe en la clave dada, entonces esta clave devuelve el valor especial nulo.

1
NArray Redis.mget(Array keys);

Parámetros de llamada:

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

Resultados de devolución:

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

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

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

Parámetros de llamada:

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

Resultados de devolución:

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

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 que se consultará y modificará.
  • value:Buffer, especifique el valor modificado

Resultados de devolución:

  • 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, especifica el valor a restar

Resultados de devolución:

  • 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, especifica el valor que se agregará

Resultados de devolución:

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

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

Resultados de devolución:

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

getBit

Para el valor de cadena almacenado en la clave, obtenga el bit en el desplazamiento especificado

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

Parámetros de llamada:

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

Resultados de devolución:

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

exists

Compruebe si la clave proporcionada existe

1
Boolean Redis.exists(Buffer key);

Parámetros de llamada:

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

Resultados de devolución:

  • Boolean, si la clave existe, devuelve Verdadero; de lo contrario, devuelve Falso

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

Resultados de devolución:

  • String, devuelve el tipo de valor almacenado en la clave. Los valores posibles son ninguno (la clave no existe) cadena (cadena) lista (lista) conjunto (conjunto) 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, especifica el modo de consulta

Resultados de devolución:

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

del

Elimina una o más claves dadas. Las claves que no existan serán ignoradas.

1
Integer Redis.del(Array keys);

Parámetros de llamada:

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

Resultados de devolución:

  • Integer, el número de claves eliminadas

Elimina una o más claves dadas. Las claves que no existan serán ignoradas.

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

Parámetros de llamada:

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

Resultados de devolución:

  • Integer, el número de claves eliminadas

expire

Establezca la vida útil 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 configurará
  • ttl: Largo, establece el tiempo de supervivencia de la clave en milisegundos

Resultados de devolución:

  • Boolean, si la clave existe, devuelve Verdadero; de lo contrario, devuelve Falso

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

Resultados de devolución:

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

persist

Elimine la vida útil de una clave determinada y convierta esta clave de "volátil" (clave con vida útil) a "persistente" (una clave sin vida útil y que nunca caduca)

1
Boolean Redis.persist(Buffer key);

Parámetros de llamada:

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

Resultados de devolución:

  • Boolean, si la clave existe, devuelve Verdadero; de lo contrario, devuelve Falso

rename

Cambie el nombre de la clave a clave nueva. Cuando la clave es la misma que la clave nueva, 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 cuyo nombre se va a cambiar
  • newkey:Buffer, especifique la clave de destino cuyo nombre se cambiará

renameNX

Si y solo si la clave nueva no existe, cambie el nombre de la clave a clave nueva. Cuando la clave no exista, devolverá un error.

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

Parámetros de llamada:

  • key:Buffer, especifique la clave cuyo nombre se va a cambiar
  • newkey:Buffer, especifique la clave de destino cuyo nombre se cambiará

Resultados de devolución:

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

sub

Suscríbete a la información de un canal determinado y llama automáticamente a func cuando aparece un mensaje. func contiene dos parámetros, canal y mensaje en orden. 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, especifica el nombre del canal suscrito
  • func: Función, 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 aparezca un mensaje. La misma función en el mismo canal solo se llamará una vez.

1
Redis.sub(Object map);

Parámetros de llamada:

  • map: Objeto, especifica la relación de asignación de canales, el nombre del atributo del objeto se utilizará como nombre del canal y el valor del atributo se utilizará como función de devolución de llamada.

unsub

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

1
Redis.unsub(Buffer channel);

Parámetros de llamada:

  • channel:Buffer, especifica el nombre del canal del que cancelar la suscripción

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

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

Parámetros de llamada:

  • channel:Buffer, especifica el nombre del canal del que cancelar la suscripción
  • func: Función, especifica la función de devolución de llamada para cancelar la suscripción.

Cancelar la suscripción de todas las devoluciones de llamada para un conjunto determinado de canales

1
Redis.unsub(Array channels);

Parámetros de llamada:

  • channels: Matriz, especifica la matriz de canales de la que cancelar la suscripción

Función de devolución de llamada especificada para cancelar la suscripción a un conjunto determinado de canales

1
Redis.unsub(Object map);

Parámetros de llamada:

  • map: Objeto, especifica la relación de asignación de canales, el nombre del atributo del objeto se utilizará como nombre del canal y el valor del atributo se utilizará como función de devolución de llamada.

psub

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

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

Parámetros de llamada:

  • pattern: Cadena, especifica la plantilla del canal suscrito
  • func: Función, especifica la función de devolución de llamada

Suscríbase a la información de un conjunto determinado de plantillas de canales y llame automáticamente a la función correspondiente cuando aparezca un mensaje. 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, especifica la relación de asignación de canales, el nombre del atributo del objeto se utilizará como plantilla de canal y el valor del atributo se utilizará como función de devolución de llamada.

unpsub

Cancelar la suscripción de todas las devoluciones de llamada del canal de la plantilla dada

1
Redis.unpsub(String pattern);

Parámetros de llamada:

  • pattern: Cadena, especifique la plantilla del canal para cancelar la suscripción

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 del canal para cancelar la suscripción
  • func: Función, especifica la función de devolución de llamada para cancelar la suscripción.

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

1
Redis.unpsub(Array patterns);

Parámetros de llamada:

  • patterns: Matriz, especifica la matriz de plantilla de canal publicada

Función de devolución de llamada especificada para cancelar la suscripción a un grupo de canales de plantilla

1
Redis.unpsub(Object map);

Parámetros de llamada:

  • map: Objeto, especifica la relación de asignación de canales, el nombre del atributo del objeto se utilizará como plantilla de canal y el valor del atributo se utilizará 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, especifica el canal de publicación
  • message:Buffer, especifica el mensaje a publicar

Resultados de devolución:

  • Integer, el número 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. Solo llamando a su método se operará la base de datos.

1
RedisHash Redis.getHash(Buffer key);

Parámetros de llamada:

  • key:Buffer, especifique la clave a obtener

Resultados de devolución:

  • 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. Solo llamando a su método se operará la base de datos.

1
RedisList Redis.getList(Buffer key);

Parámetros de llamada:

  • key:Buffer, especifique la clave a obtener

Resultados de devolución:

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

getSet

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

1
RedisSet Redis.getSet(Buffer key);

Parámetros de llamada:

  • key:Buffer, especifique la clave a obtener

Resultados de devolución:

  • 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. Solo llamando a su método se operará la base de datos.

1
RedisSortedSet Redis.getSortedSet(Buffer key);

Parámetros de llamada:

  • key:Buffer, especifique la clave a obtener

Resultados de devolución:

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

dump

Serializa la clave dada y devuelve 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 que se serializará

Resultados de devolución:

  • Buffer, devuelve el valor después de la serialización, 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 va a deserializar
  • data:Buffer, especifique los datos que se van a deserializar
  • ttl: Largo, establece el tiempo de supervivencia para la clave en milisegundos; si ttl es 0, entonces el tiempo de supervivencia no está establecido

close

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

1
Redis.close();

toString

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

1
String Redis.toString();

Resultados de devolución:

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

toJSON

Devuelve una representación en formato 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, no utilizada

Resultados de devolución:

  • Value, devuelve un valor que contiene JSON serializable
© Copyright 2012-2024 fibjs.org | Apóyanos