Obxecto obxecto incorporado
  1. paxina principal
  2. obxectos incorporados
  3. ObjectRedis

ObjectRedis

Obxecto cliente de base de datos Redis

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

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

relación de herdanza

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

onsuberror

Funciona, consulta e establece a función de tratamento de erros. Cando o subterráneo teña un erro ou a rede estea interrompida, devolverase a chamada. Cando se produza a devolución de chamada, finalizaranse todos os subs deste obxecto.

1
Function Redis.onsuberror;

función de membro

command

método de comando básico redis

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

Parámetros de chamada:

  • cmd: Cadea, especifica o comando a enviar
  • args: ..., especifique os parámetros a enviar

Resultados de devolución:

  • Value, devolve o resultado devolto polo servidor

set

Asocie o valor do valor da cadea á chave. Se a chave xa contén outro valor, SET sobrescribe o valor antigo, independentemente do tipo.

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

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai asociar
  • value:Buffer, especifique os datos que se van asociar
  • ttl: Longo, establece o tempo de supervivencia para a chave en milisegundos; se ttl é 0, entón o tempo de supervivencia non está definido

setNX

Establece o valor da chave como valor se e só se a chave non existe. Se a chave indicada xa existe, SETNX non realiza ningunha acción.

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

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai asociar
  • value:Buffer, especifique os datos que se van asociar
  • ttl: Longo, establece o tempo de supervivencia para a chave en milisegundos; se ttl é 0, entón o tempo de supervivencia non está definido

setXX

Establece o valor de chave en valor e establece a chave só se xa existe.

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

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai asociar
  • value:Buffer, especifique os datos que se van asociar
  • ttl: Longo, establece o tempo de supervivencia para a chave en milisegundos; se ttl é 0, entón o tempo de supervivencia non está definido

mset

Establece un ou máis pares clave-valor ao mesmo tempo. Se xa existe unha chave determinada, MSET sobrescribirá o valor antigo polo novo.

1
Redis.mset(Object kvs);

Parámetros de chamada:

  • kvs: Obxecto, especifica o obxecto clave/valor a definir

Establece un ou máis pares clave-valor ao mesmo tempo. Se xa existe unha chave determinada, MSET sobrescribirá o valor antigo polo novo.

1
Redis.mset(...kvs);

Parámetros de chamada:

  • kvs: ..., especifique a lista de claves/valores a definir

msetNX

Establece 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, especifica o obxecto clave/valor a definir

Establece 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 a definir

append

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

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

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai engadir
  • value:Buffer, especifique os datos que se van engadir

Resultados de devolución:

  • Integer, despois de engadir o valor, a lonxitude da cadea na clave

setRange

Use o parámetro value para sobrescribir o valor de cadea almacenado na clave indicada, comezando desde o desplazamento

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

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai modificar
  • offset: Número enteiro, especifica a compensación de bytes modificada
  • value:Buffer, especifique os datos que se van sobrescribir

Resultados de devolución:

  • Integer, a lonxitude da cadea despois de ser modificada

getRange

Devolve a subcadea do valor da cadea na clave. O intervalo de interceptación da cadea está determinado polos dous desplazamentos de inicio e final (incluíndo o inicio e o final).

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

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai consultar
  • start: Número enteiro, especifica a compensación de bytes de inicio da consulta
  • end: Número enteiro, especifica a compensación do byte final da consulta

Resultados de devolución:

  • Buffer, intercepta a subcadea obtida

strlen

Devolve a lonxitude do valor da cadea almacenado na clave. Cando a chave almacena un valor distinto dun valor de cadea, devólvese un erro.

1
Integer Redis.strlen(Buffer key);

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai calcular

Resultados de devolución:

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

bitcount

Conta o número de bits establecidos en 1 na 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 que se vai calcular
  • start: Enteiro, especifica o byte inicial que se vai calcular, pode usar valores negativos, -1 representa o último byte e -2 representa o penúltimo byte, etc.
  • end: Enteiro, especifica o byte final que se vai calcular, pode usar valores negativos, -1 representa o último byte e -2 representa o penúltimo byte, etc.

Resultados de devolución:

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

get

Devolve o valor de cadea asociado coa 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 que se vai asociar

Resultados de devolución:

  • Buffer, cando a chave non existe, devolve Nulo, se non, devolve o valor de clave

mget

Devolve todos os valores (un ou máis) para a chave indicada. Se unha chave non existe na chave indicada, esta chave devolve o valor especial nil.

1
NArray Redis.mget(Array keys);

Parámetros de chamada:

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

Resultados de devolución:

  • NArray, unha lista que contén todos os valores dunha chave determinada

Devolve todos os valores (un ou máis) para a chave indicada. Se unha chave non existe na chave indicada, esta chave devolve o valor especial nil.

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

Parámetros de chamada:

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

Resultados de devolución:

  • NArray, unha lista que contén todos os valores dunha chave determinada

getset

Establece o valor da chave indicada en valor e devolve o valor antigo da chave

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

Resultados de devolución:

  • Buffer, devolve o valor antigo da chave indicada

decr

Reste o decremento do valor almacenado na clave

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

Parámetros de chamada:

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

Resultados de devolución:

  • Long, despois de restar num, o valor de key

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 que se vai modificar
  • num: Long, especifica o valor a engadir

Resultados de devolución:

  • Long, despois de engadir num, o valor de key

setBit

Para o valor de cadea almacenado na clave, configure ou borre o bit na compensación especificada.

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

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai modificar
  • offset: Número enteiro, especifica a compensación de bits modificada
  • value: Número enteiro, especifica o parámetro a definir ou borrar, que pode ser 0 ou 1

Resultados de devolución:

  • Integer, especifica o bit onde se gardou orixinalmente a compensación

getBit

Para o valor de cadea almacenado na clave, obtén o bit no offset especificado

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

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai consultar
  • offset: Número enteiro, especifica o desplazamento de bits da consulta

Resultados de devolución:

  • Integer, o valor da cadea especifica o bit no desplazamento

exists

Comproba se existe a chave indicada

1
Boolean Redis.exists(Buffer key);

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai asociar

Resultados de devolución:

  • Boolean, se a chave 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 que se vai consultar

Resultados de devolución:

  • String, devolve o tipo de valor almacenado na clave. Os valores posibles son none (a clave non existe) cadea (cadea) lista (lista) conxunto (conxunto) zset (conxunto ordenado)hash(táboa hash)

keys

Busca todas as claves que coincidan co patrón indicado

1
NArray Redis.keys(String pattern);

Parámetros de chamada:

  • pattern: Cadea, especifique o modo de consulta

Resultados de devolución:

  • NArray, unha lista de claves que coinciden co patrón indicado

del

Elimina unha ou máis chaves dadas. Ignoraranse as claves que non existan.

1
Integer Redis.del(Array keys);

Parámetros de chamada:

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

Resultados de devolución:

  • Integer, o número de claves eliminadas

Elimina unha ou máis chaves dadas. Ignoraranse as claves que non existan.

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

Parámetros de chamada:

  • keys: ..., especifique a lista de claves a eliminar

Resultados de devolución:

  • Integer, o número de claves eliminadas

expire

Establece a duración dunha determinada chave. Cando a chave caduque, eliminarase automaticamente.

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

Parámetros de chamada:

  • key:Buffer, especifique a clave que se quere establecer
  • ttl: longo, establece o tempo de supervivencia da clave en milisegundos

Resultados de devolución:

  • Boolean, se a chave existe, devolve True, se non, devolve False

ttl

Devolve o tempo de supervivencia restante da chave indicada

1
Long Redis.ttl(Buffer key);

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai consultar

Resultados de devolución:

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

persist

Elimina a duración dunha determinada chave e convertela de "volátil" (clave con vida útil) a "persistente" (chave sen vida útil e que nunca caduca)

1
Boolean Redis.persist(Buffer key);

Parámetros de chamada:

  • key:Buffer, especifique a clave que se quere establecer

Resultados de devolución:

  • Boolean, se a chave existe, devolve True, se non, devolve False

rename

Cambia o nome da chave a chave nova. Cando a chave é a mesma que a chave nova ou a chave non existe, devólvese un erro.

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

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai renomear
  • newkey:Buffer, especifique a clave de destino que se vai renomear

renameNX

Se e só se a chave nova non existe, cambie o nome da chave a chave nova. Cando a chave non exista, devolve un erro.

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

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai renomear
  • newkey:Buffer, especifique a clave de destino que se vai renomear

Resultados de devolución:

  • Boolean, cando a modificación teña éxito, devolve True, se xa existe a nova clave, devolve False

sub

Subscríbete á información dunha determinada canle e chama automaticamente a func cando se produce unha mensaxe. func contén dous parámetros, a canle e a mensaxe en orde. A mesma función da mesma canle só se 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 á función de devolución de chamada correspondente cando se produza unha mensaxe. A mesma función da mesma canle só se chamará unha vez.

1
Redis.sub(Object map);

Parámetros de chamada:

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

unsub

Cancelar a subscrición de todas as devolucións de chamada para a canle indicada

1
Redis.unsub(Buffer channel);

Parámetros de chamada:

  • channel:Buffer, especifique o nome da canle da que desexa cancelar a subscrición

A función de devolución de chamada especificada para cancelar a subscrición da canle indicada

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

Parámetros de chamada:

  • channel:Buffer, especifique o nome da canle da que desexa cancelar a subscrición
  • func: Función, especifica a función de devolución de chamada para cancelar a subscrición

Cancela a subscrición de todas as devolucións de chamada para un determinado conxunto de canles

1
Redis.unsub(Array channels);

Parámetros de chamada:

  • channels: Matriz, especifica a matriz de canles da que se cancela a subscrición

Función de devolución de chamada especificada para cancelar a subscrición dun determinado conxunto de canles

1
Redis.unsub(Object map);

Parámetros de chamada:

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

psub

Subscríbete a un grupo de información da canle segundo o modelo e chama automaticamente a func cando se produce unha mensaxe. func contén tres parámetros, canle, mensaxe e patrón en orde. A mesma función do mesmo modelo só se chamará unha vez.

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

Parámetros de chamada:

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

Subscríbete á información dun determinado conxunto de modelos de canle e chama automaticamente á función correspondente cando se produza unha mensaxe. Só se chamará unha vez á mesma función da mesma canle.

1
Redis.psub(Object map);

Parámetros de chamada:

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

unpsub

Cancela a subscrición de todas as devolucións de chamada da canle do modelo indicado

1
Redis.unpsub(String pattern);

Parámetros de chamada:

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

Función de devolución de chamada especificada para cancelar a subscrición da canle do modelo indicado

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

Parámetros de chamada:

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

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

1
Redis.unpsub(Array patterns);

Parámetros de chamada:

  • patterns: Matriz, especifica a matriz de modelos de canle publicada

Función de devolución de chamada especificada para cancelar a subscrición dun grupo de canles de modelos

1
Redis.unpsub(Object map);

Parámetros de chamada:

  • map: Obxecto, especifica a relación de asignación de canles, o nome do atributo do obxecto empregarase como modelo da canle e o valor do atributo empregarase 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 de publicación
  • message:Buffer, especifique a mensaxe que se vai publicar

Resultados de devolución:

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

getHash

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

1
RedisHash Redis.getHash(Buffer key);

Parámetros de chamada:

  • key:Buffer, especifique a clave que se quere obter

Resultados de devolución:

  • RedisHash, devolve un obxecto Hash que contén a clave especificada

getList

Obtén o obxecto Lista da clave especificada. Este obxecto é o cliente que contén a clave especificada. Só se chamará ao seu método a base de datos operarase.

1
RedisList Redis.getList(Buffer key);

Parámetros de chamada:

  • key:Buffer, especifique a clave que se quere obter

Resultados de devolución:

  • RedisList, devolve un obxecto List que contén a clave especificada

getSet

Obtén o obxecto Establecer da clave especificada. Este obxecto é o cliente que contén a clave especificada. Só chamando ao seu método operarase a base de datos.

1
RedisSet Redis.getSet(Buffer key);

Parámetros de chamada:

  • key:Buffer, especifique a clave que se quere obter

Resultados de devolución:

  • 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. Só se chamará ao seu método a base de datos operarase.

1
RedisSortedSet Redis.getSortedSet(Buffer key);

Parámetros de chamada:

  • key:Buffer, especifique a clave que se quere obter

Resultados de devolución:

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

dump

Serializa a clave indicada e devolve o valor serializado. Usa o comando de restauración para deserializar este valor nunha clave Redis.

1
Buffer Redis.dump(Buffer key);

Parámetros de chamada:

  • key:Buffer, especifique a clave a serializar

Resultados de devolución:

  • Buffer, devolve o valor despois da serialización, se a chave non existe, entón devolve nulo

restore

Deserializar o valor serializado dado e asocialo coa clave indicada

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

Parámetros de chamada:

  • key:Buffer, especifique a clave que se vai deserializar
  • data:Buffer, especifique os datos que se van deserializar
  • ttl: Longo, establece o tempo de supervivencia para a chave en milisegundos; se ttl é 0, entón o tempo de supervivencia non está definido

close

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

1
Redis.close();

toString

Devolve a representación en cadea do obxecto. Polo xeral, devólvese "[Obxecto nativo]". O obxecto pódese volver implementar segundo as súas propias características.

1
String Redis.toString();

Resultados de devolución:

  • String, devolve a representación en cadea do obxecto

toJSON

Devolve unha representación en formato JSON do obxecto, devolvendo xeralmente unha colección de propiedades lexibles definidas polo obxecto.

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

Parámetros de chamada:

  • key: Cadena, non usada

Resultados de devolución:

  • Value, devolve un valor que contén JSON serializable
© Copyright 2012-2024 fibjs.org | Apóyanos