Obxecto incorporado

Obxecto Redis

Redis obxecto cliente da base de datos

Usado para crear e xestionar a base de datos Redis, método de creación:

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

Herdanza

#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 dos membros

onsuberror

Función, consulta e función de xestión de erros, chama de volta cando hai un erro en sub ou a rede está interrompida, cando se produce a devolución de chamada, abortarase todo o sub deste obxecto

1
Function Redis.onsuberror;

Función de membro

command

Redis método de comando básico

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

Parámetros de chamada:

  • cmd: Cadea, especifica o comando enviado
  • args: ..., especifique os parámetros que se van enviar

Resultado de volta:

  • Value, Devolve o resultado devolto polo servidor

set

Asocie o valor do valor da cadea á clave, se a clave xa ten outros valores, SET sobrescribe o valor anterior, independentemente do tipo

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave a asociar
  • value: Buffer, Especifique os datos que se van asociar
  • ttl: Longo, define o tempo de supervivencia da clave en milisegundos; se ttl é 0, entón non configure o tempo de supervivencia

setNX

Estableza o valor da clave a valor se e só se a clave non existe. Se a clave dada xa existe, SETNX non fai nada.

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave a asociar
  • value: Buffer, Especifique os datos que se van asociar
  • ttl: Longo, define o tempo de supervivencia da clave en milisegundos; se ttl é 0, entón non configure o tempo de supervivencia

setXX

Estableza o valor da clave a valor e configúraa só cando a clave xa exista.

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave a asociar
  • value: Buffer, Especifique os datos que se van asociar
  • ttl: Longo, define o tempo de supervivencia da clave en milisegundos; se ttl é 0, entón non configure o tempo de supervivencia

mset

Estableza un ou máis pares clave-valor ao mesmo tempo. Se xa existe unha clave dada, MSET sobrescribirá o valor anterior co novo valor

1
Redis.mset(Object kvs);

Parámetros de chamada:

  • kvs: Obxecto, especifique o obxecto clave / valor que se vai definir

Estableza un ou máis pares clave-valor ao mesmo tempo. Se xa existe unha clave dada, MSET sobrescribirá o valor anterior co novo valor

1
Redis.mset(...kvs);

Parámetros de chamada:

  • kvs: ..., especifique a lista de claves / valores que se vai establecer

msetNX

Estableza un ou máis pares clave-valor ao mesmo tempo, se e só se non existen todas as claves dadas

1
Redis.msetNX(Object kvs);

Parámetros de chamada:

  • kvs: Obxecto, especifique o obxecto clave / valor que se vai definir

Estableza un ou máis pares clave-valor ao mesmo tempo, se e só se non existen todas as claves dadas

1
Redis.msetNX(...kvs);

Parámetros de chamada:

  • kvs: ..., especifique a lista de claves / valores que se vai establecer

append

Se a clave xa existe e é unha cadea, o comando append engade o valor ao final do valor orixinal da clave. Se a clave non existe, engada simplemente configura o valor da clave dada

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave a engadir
  • value: Buffer, Especifique os datos a engadir

Resultado de volta:

  • IntegerDespois de engadir valor, a lonxitude da cadea na clave

setRange

Use o parámetro value para sobrescribir o valor da cadea almacenado na clave dada, comezando polo offset

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave a modificar
  • offset: Enteiro, especifica o desprazamento de bytes modificado
  • value: Buffer, Especifique os datos que se van sobreescribir

Resultado de volta:

  • Integer, Despois de ser modificado, a lonxitude da corda

getRange

Devolve a subcadea do valor da cadea na clave. O intervalo de intercepción da cadea está determinado polos dous desprazamentos de inicio e fin (incluíndo inicio e fin)

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave a consultar
  • start: Enteiro, especifique a compensación de bytes de inicio da consulta
  • end: Enteiro, especifique a compensación de bytes finais da consulta

Resultado de volta:

  • Buffer, Intercepta a subcadea

strlen

Devolve a lonxitude do valor da cadea almacenado na clave. Cando a clave non é un valor de cadea, devólvese un erro

1
Integer Redis.strlen(Buffer key);

Parámetros de chamada:

  • key: Buffer, Especifique a clave a calcular

Resultado de volta:

  • Integer, A lonxitude do valor da cadea. Cando a clave non existe, devolve 0

bitcount

Conta o número de bits establecido en 1 nunha cadea dada

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave a calcular
  • start: Enteiro, especifique o byte inicial que se vai calcular, pódense usar valores negativos, -1 significa o último byte e -2 significa o penúltimo byte, etc.
  • end: Enteiro, especifique o byte final que se vai calcular, pódense usar valores negativos, -1 significa o último byte e -2 significa o penúltimo byte, etc.

Resultado de volta:

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

get

Devolve o valor da cadea asociado á clave, se a clave non existe, devolve o valor especial Nulo

1
Buffer Redis.get(Buffer key);

Parámetros de chamada:

  • key: Buffer, Especifique a clave a asociar

Resultado de volta:

  • Buffer, Cando a clave non existe, devolve Nulo, se non, devolve o valor da clave

mget

Devolve todos (un ou máis) valores da clave dada. Se non existe unha clave na clave dada, entón devolve o valor especial cero.

1
NArray Redis.mget(Array keys);

Parámetros de chamada:

  • keys: Matriz, especifique a matriz de claves que se vai consultar

Resultado de volta:

  • NArray, Unha lista que contén todos os valores dunha clave dada

Devolve todos (un ou máis) valores da clave dada. Se non existe unha clave na clave dada, entón devolve o valor especial cero.

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

Parámetros de chamada:

  • keys: ..., especifique a lista de claves que se vai consultar

Resultado de volta:

  • NArray, Unha lista que contén todos os valores dunha clave dada

getset

Estableza o valor da clave indicada para valorar e devolve o valor anterior da clave (valor antigo)

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave que se vai consultar e modificar
  • value: Buffer, Especifique o valor modificado

Resultado de volta:

  • Buffer, Devolve o valor antigo da clave dada

decr

Restar a diminución do valor almacenado na clave

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave a modificar
  • num: Longo, especifique o valor que se vai restar

Resultado de volta:

  • LongDespois de restar num, o valor da clave

incr

Engade o incremento ao valor almacenado na clave

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave a modificar
  • num: Longo, especifique o valor que se vai engadir

Resultado de volta:

  • LongDespois de engadir num, o valor da clave

setBit

Para o valor da cadea almacenado na clave, configure ou borre o bit no desprazamento (bit) especificado

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave a modificar
  • offset: Enteiro, especifique o desprazamento de bits modificado
  • value: En número enteiro, especifique o parámetro que se vai definir ou borrar, pode ser 0 ou 1

Resultado de volta:

  • Integer, Especifique o bit orixinal almacenado do offset

getBit

Obtén o bit no desprazamento especificado para o valor da cadea almacenado na clave

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave a consultar
  • offset: Enteiro, especifica o desprazamento de bits da consulta

Resultado de volta:

  • Integer, O valor da cadea especifica o bit no desprazamento (bit)

exists

Comprobe se existe a clave indicada

1
Boolean Redis.exists(Buffer key);

Parámetros de chamada:

  • key: Buffer, Especifique a clave a asociar

Resultado de volta:

  • Boolean, Se a clave existe, devolve True, se non, devolve False

type

Devolve o tipo de valor almacenado na clave

1
String Redis.type(Buffer key);

Parámetros de chamada:

  • key: Buffer, Especifique a clave a consultar

Resultado de volta:

  • String, Devolve o tipo de valor almacenado na clave, o valor posible é ningún (a clave non existe) cadea (cadea) lista (lista) conxunto (colección) zset (conxunto ordenado) hash(Táboa hash)

keys

Buscar todas as teclas que coincidan co patrón dado

1
NArray Redis.keys(String pattern);

Parámetros de chamada:

  • pattern: Cadea, especifica o modo de consulta

Resultado de volta:

  • NArray, Unha lista de teclas que coinciden co patrón dado

del

Elimina unha ou máis claves dadas, ignoraranse as claves inexistentes

1
Integer Redis.del(Array keys);

Parámetros de chamada:

  • keys: Matriz, especifique a matriz de claves que se vai eliminar

Resultado de volta:

  • Integer, O número de claves eliminadas

Elimina unha ou máis claves dadas, ignoraranse as claves inexistentes

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

Parámetros de chamada:

  • keys: ..., especifique a lista de claves que se vai eliminar

Resultado de volta:

  • Integer, O número de claves eliminadas

expire

Estableza o tempo de vida dunha tecla dada, cando expire a tecla, eliminarase automaticamente

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave a configurar
  • ttl: Longo, define o tempo de supervivencia da clave en milisegundos

Resultado de volta:

  • Boolean, Se a clave existe, devolve True, se non, devolve False

ttl

Devolve o tempo de supervivencia restante da clave dada

1
Long Redis.ttl(Buffer key);

Parámetros de chamada:

  • key: Buffer, Especifique a clave a consultar

Resultado de volta:

  • Long, Devolve o tempo de supervivencia restante da clave en milisegundos. Cando a clave non existe, devolve -2. Cando a clave existe pero o tempo de supervivencia restante non está configurado, devolve -1

persist

Elimina a vida útil dunha clave determinada e converte esta clave de "volátil" (cunha clave de vida) a "persistente" (unha clave sen vida útil e que nunca caduca)

1
Boolean Redis.persist(Buffer key);

Parámetros de chamada:

  • key: Buffer, Especifique a clave a configurar

Resultado de volta:

  • Boolean, Se a clave existe, devolve True, se non, devolve False

rename

Cambia o nome da clave a nova clave. Cando a clave e a nova son as mesmas ou a clave non existe, devolverase un erro

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave para cambiar o nome
  • newkey: Buffer, Especifique a clave de destino que se renomeará

renameNX

Se e só se a chave nova non existe, cambie o nome da chave a chave nova e devolva un erro cando a chave non existe

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave para cambiar o nome
  • newkey: Buffer, Especifique a clave de destino que se renomeará

Resultado de volta:

  • Boolean, Cando a modificación ten éxito, devolve Verdadeiro, se a nova tecla xa existe, devolve Falso

sub

Subscríbete á información dunha canle determinada e chama automaticamente ás funcións cando se produce unha mensaxe. Func contén dous parámetros, canle e mensaxe á súa vez. A mesma función na mesma canle só se volverá chamar unha vez

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

Parámetros de chamada:

  • channel: Buffer, Especifique o nome da canle subscrita
  • func: Función, especifique a función de devolución de chamada

Subscríbete á información dun determinado conxunto de canles e chama automaticamente á correspondente función de devolución de chamada cando se produza unha mensaxe. A mesma función da mesma canle só se volverá chamar unha vez

1
Redis.sub(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de canles, o nome do atributo do obxecto será o nome da canle e o valor do atributo será a función de devolución de chamada.

unsub

Cancelar a subscrición a todas as devolucións de chamada dunha determinada canle

1
Redis.unsub(Buffer channel);

Parámetros de chamada:

  • channel: Buffer, Especifique o nome da canle non subscrita

Cancelar a subscrición á función de devolución de chamada especificada da canle indicada

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

Parámetros de chamada:

  • channel: Buffer, Especifique o nome da canle non subscrita
  • func: Función, especifique a función de devolución de chamada para a baixa

Cancelar a subscrición a todas as devolucións de chamada dunha determinada canle

1
Redis.unsub(Array channels);

Parámetros de chamada:

  • channels: Matriz, especifique a matriz de canles non subscritas

Cancelar a subscrición á función de devolución de chamada especificada dun determinado conxunto de canles

1
Redis.unsub(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de canles, o nome do atributo do obxecto será o nome da canle e o valor do atributo será a función de devolución de chamada.

psub

Subscríbete á información dun grupo de canles segundo o modelo. Cando se produce unha mensaxe, func chama automaticamente. Func contén tres parámetros, que son canle, mensaxe e patrón á súa vez. A mesma función do mesmo modelo só se chamará volta unha vez.

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

Parámetros de chamada:

  • pattern: Cadea, especifica o modelo de canle subscrito
  • func: Función, especifique a función de devolución de chamada

Subscríbete á información dun determinado conxunto de modelos de canles e chama automaticamente ás funcións correspondentes cando se produce unha mensaxe e a mesma función na mesma canle só se volverá chamar unha vez

1
Redis.psub(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de canles, o nome do atributo do obxecto usarase como modelo de canle e o valor do atributo usarase como función de devolución de chamada

unpsub

Cancelar a subscrición a todas as devolucións de chamada de canles cun modelo determinado

1
Redis.unpsub(String pattern);

Parámetros de chamada:

  • pattern: Cadea, especifica o modelo da canle para cancelar a subscrición

A función de devolución de chamada especificada para dar de baixa a canle do modelo dado

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

Parámetros de chamada:

  • pattern: Cadea, especifica o modelo da canle para cancelar a subscrición
  • func: Función, especifique a función de devolución de chamada para a baixa

Cancelar a subscrición a todas as devolucións de chamada dun conxunto de canles cun modelo determinado

1
Redis.unpsub(Array patterns);

Parámetros de chamada:

  • patterns: Matriz, especifique a matriz de modelos de canles para publicar

A función de devolución de chamada especificada da canle que dá de baixa un conxunto de modelos

1
Redis.unpsub(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de canles, o nome do atributo do obxecto usarase como modelo de canle e o valor do atributo usarase como función de devolución de chamada

pub

Enviar mensaxe de información á canle da canle especificada

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

Parámetros de chamada:

  • channel: Buffer, Especifique a canle publicada
  • message: Buffer, Especifique a mensaxe que se publicará

Resultado de volta:

  • Integer, O número de clientes que reciben esta mensaxe

getHash

Obtén o obxecto Hash da clave especificada. Este obxecto é o cliente que contén a clave especificada. A base de datos só se pode operar cando se chama ao seu método

1
RedisHash Redis.getHash(Buffer key);

Parámetros de chamada:

  • key: Buffer, Especifique a clave que se vai obter

Resultado de volta:

  • RedisHash, Devolve un obxecto Hash que conteña a clave especificada

getList

Obtén o obxecto List da clave especificada. Este obxecto é o cliente que contén a clave especificada. A base de datos só se pode operar cando se chama ao seu método

1
RedisList Redis.getList(Buffer key);

Parámetros de chamada:

  • key: Buffer, Especifique a clave que se vai obter

Resultado de volta:

  • RedisList, Devolve un obxecto List que conteña a clave especificada

getSet

Obtén o obxecto Set da clave especificada. Este obxecto é o cliente que contén a clave especificada. A base de datos só se pode operar chamando ao seu método

1
RedisSet Redis.getSet(Buffer key);

Parámetros de chamada:

  • key: Buffer, Especifique a clave que se vai obter

Resultado de volta:

  • RedisSet, Devolve un obxecto Set que contén a clave especificada

getSortedSet

Obtén o obxecto SortedSet da clave especificada. Este obxecto é o cliente que contén a clave especificada. A base de datos só se pode operar cando se chama ao seu método

1
RedisSortedSet Redis.getSortedSet(Buffer key);

Parámetros de chamada:

  • key: Buffer, Especifique a clave que se vai obter

Resultado de volta:

  • RedisSortedSet, Devolve o obxecto SortedSet que contén a clave especificada

dump

Serialice a clave dada e devolve o valor serializado. Utilice o comando restaurar para deserializar este valor nunha clave Redis.

1
Buffer Redis.dump(Buffer key);

Parámetros de chamada:

  • key: Buffer, Especifique a clave a serializar

Resultado de volta:

  • Buffer, Devolve o valor serializado, se a clave non existe, devolve nulo

restore

Deserialice o valor serializado dado e asóceo coa clave dada

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

Parámetros de chamada:

  • key: Buffer, Especifique a clave a deserializar
  • data: Buffer, Especifique os datos que se deserializarán
  • ttl: Longo, define o tempo de supervivencia da clave en milisegundos; se ttl é 0, entón non configure o tempo de supervivencia

close

Peche a conexión ou transacción de base de datos actual

1
Redis.close();

toString

Devolve a representación de cadea do obxecto, xeralmente devolve "[Obxecto nativo]", o obxecto pode reimplementarse segundo as súas propias características

1
String Redis.toString();

Resultado de volta:

  • String, Devolve a representación de cadea do obxecto

toJSON

Devolve a representación en formato JSON do obxecto, xeralmente devolve unha colección de atributos lexibles definidos polo obxecto

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

Parámetros de chamada:

  • key: Cadea, sen usar

Resultado de volta:

  • Value, Devolve un valor que contén JSON serializable