Objecte objecte incorporat

Objecte Redis

Redis objecte client de la base de dades

S’utilitza per crear i gestionar la base de dades de Redis, mètode de creació:

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

Herència

#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()

Atributs de membre

onsuberror

Funció, consulta i configuració de la funció de maneig d'errors, trucada de tornada quan hi ha un error en sub o s'interromp la xarxa, quan es produeix la devolució de trucada, s'abortarà tot el sub d'aquest objecte

1
Function Redis.onsuberror;

Funció de membre

command

Redis mètode d’ordres bàsic

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

Paràmetres de trucada:

  • cmd: Cadena, especifiqueu l'ordre enviada
  • args: ..., especifiqueu els paràmetres a enviar

Resultat de retorn:

  • Value, Retorna el resultat retornat pel servidor

set

Associeu el valor del valor de la cadena a la clau, si la clau ja conté altres valors, SET sobreescriu el valor antic, independentment del tipus

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que cal associar
  • value: Buffer, Especifiqueu les dades que cal associar
  • ttl: Llarg, establiu el temps de supervivència de la clau en mil·lisegons; si ttl és 0, no configureu el temps de supervivència

setNX

Definiu el valor de la clau a valor si i només si la clau no existeix. Si la clau donada ja existeix, SETNX no fa res.

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que cal associar
  • value: Buffer, Especifiqueu les dades que cal associar
  • ttl: Llarg, establiu el temps de supervivència de la clau en mil·lisegons; si ttl és 0, no configureu el temps de supervivència

setXX

Establiu el valor de la clau a valor i configureu la clau només quan la clau ja existeixi.

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que cal associar
  • value: Buffer, Especifiqueu les dades que cal associar
  • ttl: Llarg, establiu el temps de supervivència de la clau en mil·lisegons; si ttl és 0, no configureu el temps de supervivència

mset

Definiu un o més parells valor-clau alhora. Si ja existeix una clau determinada, MSET sobreescriurà el valor antic amb el valor nou

1
Redis.mset(Object kvs);

Paràmetres de trucada:

  • kvs: Objecte, especifiqueu l'objecte clau / valor que cal establir

Definiu un o més parells valor-clau alhora. Si ja existeix una clau determinada, MSET sobreescriurà el valor antic amb el valor nou

1
Redis.mset(...kvs);

Paràmetres de trucada:

  • kvs: ..., especifiqueu la llista de claus / valors que cal establir

msetNX

Definiu un o més parells valor-clau al mateix temps, si i només si no existeixen totes les claus donades

1
Redis.msetNX(Object kvs);

Paràmetres de trucada:

  • kvs: Objecte, especifiqueu l'objecte clau / valor que cal establir

Definiu un o més parells valor-clau al mateix temps, si i només si no existeixen totes les claus donades

1
Redis.msetNX(...kvs);

Paràmetres de trucada:

  • kvs: ..., especifiqueu la llista de claus / valors que cal establir

append

Si la clau ja existeix i és una cadena, l'ordre append afegeix el valor al final del valor original de la clau. Si la clau no existeix, afegiu simplement defineix el valor de la clau donada

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que cal afegir
  • value: Buffer, Especifiqueu les dades que voleu afegir

Resultat de retorn:

  • Integer, Després d'afegir el valor, la longitud de la cadena a la clau

setRange

Utilitzeu el paràmetre value per sobreescriure el valor de la cadena emmagatzemat a la clau donada, a partir de la compensació de desplaçament

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que voleu modificar
  • offset: Enter, especifiqueu el desplaçament de bytes modificat
  • value: Buffer, Especifiqueu les dades que voleu sobreescriure

Resultat de retorn:

  • Integer, Després de modificar-se, la longitud de la cadena

getRange

Retorna la subcadena del valor de la cadena en clau. L'interval d'intercepció de la cadena està determinat pels dos desplaçaments d'inici i final (inclosos l'inici i el final)

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que voleu consultar
  • start: Enter, especifiqueu el desplaçament de bytes inicials de la consulta
  • end: Enter, especifiqueu el desplaçament de bytes finals de la consulta

Resultat de retorn:

  • Buffer, Intercepteu la subcadena

strlen

Retorna la longitud del valor de la cadena emmagatzemat a la clau. Quan la clau no és un valor de cadena, es torna un error

1
Integer Redis.strlen(Buffer key);

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau a calcular

Resultat de retorn:

  • Integer, La longitud del valor de la cadena. Quan la clau no existeix, torneu 0

bitcount

Compteu el nombre de bits establert a 1 en una cadena determinada

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau a calcular
  • start: Enter, especifiqueu el byte inicial a calcular, es poden utilitzar valors negatius, -1 significa l'últim byte i -2 significa el penúltim byte, etc.
  • end: Enter, especifiqueu el byte final a calcular, es poden utilitzar valors negatius, -1 significa l'últim byte i -2 significa el penúltim byte, etc.

Resultat de retorn:

  • Integer, El nombre de bits establert a 1

get

Retorna el valor de la cadena associat a la clau, si la clau no existeix, torna el valor especial Nul

1
Buffer Redis.get(Buffer key);

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que cal associar

Resultat de retorn:

  • Buffer, Quan la clau no existeix, torneu a Nul, en cas contrari, torneu el valor de la clau

mget

Retorna tots (un o més) valors de la clau donada. Si no existeix una clau a la clau donada, aquesta clau retorna el valor especial nul.

1
NArray Redis.mget(Array keys);

Paràmetres de trucada:

  • keys: Matriu, especifiqueu la matriu de claus a consultar

Resultat de retorn:

  • NArray, Una llista que conté tots els valors d'una clau determinada

Retorna tots (un o més) valors de la clau donada. Si no existeix una clau a la clau donada, aquesta clau retorna el valor especial nul.

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

Paràmetres de trucada:

  • keys: ..., especifiqueu la llista de claus a consultar

Resultat de retorn:

  • NArray, Una llista que conté tots els valors d'una clau determinada

getset

Estableix el valor de la clau donada a valor i retorna el valor antic de la clau (valor antic)

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que voleu consultar i modificar
  • value: Buffer, Especifiqueu el valor modificat

Resultat de retorn:

  • Buffer, Retorna el valor antic de la clau donada

decr

Resteu la disminució del valor emmagatzemat a la clau

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que voleu modificar
  • num: Llarg, especifiqueu el valor a restar

Resultat de retorn:

  • Long, Després de restar num, el valor de la clau

incr

Afegiu l'increment al valor emmagatzemat a la clau

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que voleu modificar
  • num: Llarg, especifiqueu el valor que voleu afegir

Resultat de retorn:

  • Long, Després d'afegir num, el valor de la clau

setBit

Per al valor de la cadena emmagatzemat a la clau, definiu o esborreu el bit en el desplaçament especificat (bit)

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que voleu modificar
  • offset: Enter, especifiqueu el desplaçament de bits modificat
  • value: Enter, especifiqueu el paràmetre que cal definir o esborrar; pot ser 0 o 1

Resultat de retorn:

  • Integer, Especifiqueu el bit emmagatzemat original del desplaçament

getBit

Obteniu el bit en el desplaçament especificat per al valor de cadena emmagatzemat a la clau

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que voleu consultar
  • offset: Enter, especifiqueu el desplaçament de bits de la consulta

Resultat de retorn:

  • Integer, El valor de la cadena especifica el bit al desplaçament (bit)

exists

Comproveu si existeix la clau donada

1
Boolean Redis.exists(Buffer key);

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que cal associar

Resultat de retorn:

  • Boolean, Si la clau existeix, torneu a True, en cas contrari torneu a False

type

Retorna el tipus de valor emmagatzemat a la clau

1
String Redis.type(Buffer key);

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que voleu consultar

Resultat de retorn:

  • String, Retorna el tipus de valor emmagatzemat a la clau; el valor possible és cap (la clau no existeix) cadena (cadena) llista (llista) conjunt (col·lecció) zset (conjunt ordenat) hash(Taula de hash)

keys

Cerqueu totes les claus que coincideixin amb el patró donat

1
NArray Redis.keys(String pattern);

Paràmetres de trucada:

  • pattern: Cadena, especifiqueu el mode de consulta

Resultat de retorn:

  • NArray, Una llista de tecles que coincideixen amb el patró donat

del

Suprimiu una o més claus donades, les claus inexistents s'ignoraran

1
Integer Redis.del(Array keys);

Paràmetres de trucada:

  • keys: Matriu, especifiqueu la matriu de claus a suprimir

Resultat de retorn:

  • Integer, El nombre de claus suprimides

Suprimiu una o més claus donades, les claus inexistents s'ignoraran

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

Paràmetres de trucada:

  • keys: ..., especifiqueu la llista de claus a suprimir

Resultat de retorn:

  • Integer, El nombre de claus suprimides

expire

Definiu el temps de vida per a una determinada clau, quan caduqui la clau, se suprimirà automàticament

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que cal establir
  • ttl: Llarg, estableix el temps de supervivència de la clau en mil·lisegons

Resultat de retorn:

  • Boolean, Si la clau existeix, torneu a True, en cas contrari torneu a False

ttl

Retorna el temps de supervivència restant de la clau donada

1
Long Redis.ttl(Buffer key);

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que voleu consultar

Resultat de retorn:

  • Long, Retorna el temps de supervivència restant de la clau en mil·lisegons. Quan la clau no existeix, retorna -2. Quan la clau existeix però el temps de supervivència restant no està definit, torna -1

persist

Elimineu la vida útil d'una clau determinada i convertiu aquesta clau de "volàtil" (amb una clau de vida útil) a "persistent" (una clau sense vida útil i que no caduca mai)

1
Boolean Redis.persist(Buffer key);

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que cal establir

Resultat de retorn:

  • Boolean, Si la clau existeix, torneu a True, en cas contrari torneu a False

rename

Canvieu el nom de la clau per clau nova. Quan la clau i la clau nova són iguals o no existeix, es retornarà un error

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau per canviar el nom
  • newkey: Buffer, Especifiqueu la clau de destinació que es canviarà el nom

renameNX

Si i només si la clau nova no existeix, canvieu el nom de la clau a clau nova i torneu a produir un error quan la clau no existeixi

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau per canviar el nom
  • newkey: Buffer, Especifiqueu la clau de destinació que es canviarà el nom

Resultat de retorn:

  • Boolean, Quan la modificació té èxit, torna True, si la tecla nova ja existeix, torna False

sub

Subscriviu-vos a la informació d’un canal determinat i truqueu automàticament a les funcions quan es produeixi un missatge. Func conté dos paràmetres, canal i missatge al seu torn. La mateixa funció del mateix canal només es tornarà a trucar una vegada

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

Paràmetres de trucada:

  • channel: Buffer, Especifiqueu el nom del canal subscrit
  • func: Funció, especifiqueu la funció de devolució de trucada

Subscriviu-vos a la informació d’un determinat conjunt de canals i truqueu automàticament a la funció de devolució de trucada corresponent quan es produeixi un missatge. La mateixa funció del mateix canal només es tornarà a cridar una vegada

1
Redis.sub(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu la relació d'assignació de canals, el nom de l'atribut de l'objecte serà el nom del canal i el valor de l'atribut serà la funció de devolució de trucada.

unsub

Cancel·leu la subscripció a totes les devolucions de trucada d’un canal determinat

1
Redis.unsub(Buffer channel);

Paràmetres de trucada:

  • channel: Buffer, Especifiqueu el nom del canal sense subscripció

Cancel·leu la subscripció a la funció de devolució de trucada especificada del canal indicat

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

Paràmetres de trucada:

  • channel: Buffer, Especifiqueu el nom del canal sense subscripció
  • func: Funció, especifiqueu la funció de devolució de trucada per a la baixa

Cancel·leu la subscripció a totes les devolucions de trucada d’un canal determinat

1
Redis.unsub(Array channels);

Paràmetres de trucada:

  • channels: Matriu, especifiqueu una matriu de canals sense subscripció

Cancel·leu la subscripció a la funció de devolució de trucada especificada d’un determinat conjunt de canals

1
Redis.unsub(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu la relació d'assignació de canals, el nom de l'atribut de l'objecte serà el nom del canal i el valor de l'atribut serà la funció de devolució de trucada.

psub

Subscriviu-vos a la informació d'un grup de canals segons la plantilla. Quan es produeix un missatge, func s'anomena automàticament. Func conté tres paràmetres, que són canals, missatges i patrons al seu torn. La mateixa funció de la mateixa plantilla només es cridarà tornar una vegada.

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

Paràmetres de trucada:

  • pattern: Cadena, especifiqueu la plantilla de canal subscrita
  • func: Funció, especifiqueu la funció de devolució de trucada

Subscriviu-vos a la informació d’un conjunt determinat de plantilles de canal i truqueu automàticament a les funcions corresponents quan es produeixi un missatge i la mateixa funció del mateix canal només es tornarà a trucar una vegada

1
Redis.psub(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu la relació d'assignació de canals, s'utilitzarà el nom de l'atribut d'objecte com a plantilla de canal i el valor de l'atribut s'utilitzarà com a funció de devolució de trucada

unpsub

Cancel·leu la subscripció de totes les devolucions de trucada dels canals amb una plantilla determinada

1
Redis.unpsub(String pattern);

Paràmetres de trucada:

  • pattern: Cadena, especifiqueu la plantilla del canal per cancel·lar la subscripció

La funció de devolució de trucada especificada per cancel·lar la subscripció al canal de la plantilla donada

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

Paràmetres de trucada:

  • pattern: Cadena, especifiqueu la plantilla del canal per cancel·lar la subscripció
  • func: Funció, especifiqueu la funció de devolució de trucada per a la baixa

Anul·leu la subscripció de totes les devolucions de trucada d’un conjunt de canals amb una plantilla determinada

1
Redis.unpsub(Array patterns);

Paràmetres de trucada:

  • patterns: Matriu, especifiqueu la matriu de plantilles de canal que voleu publicar

La funció de devolució de trucada especificada del canal que dóna de baixa un conjunt de plantilles

1
Redis.unpsub(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu la relació d'assignació de canals, s'utilitzarà el nom de l'atribut d'objecte com a plantilla de canal i el valor de l'atribut s'utilitzarà com a funció de devolució de trucada

pub

Envia un missatge d'informació al canal del canal especificat

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

Paràmetres de trucada:

  • channel: Buffer, Especifiqueu el canal publicat
  • message: Buffer, Especifiqueu el missatge que es publicarà

Resultat de retorn:

  • Integer, El nombre de clients que reben aquest missatge

getHash

Obteniu l'objecte Hash de la clau especificada. Aquest objecte és el client que conté la clau especificada. La base de dades només es pot operar quan s'anomena el seu mètode.

1
RedisHash Redis.getHash(Buffer key);

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que voleu obtenir

Resultat de retorn:

  • RedisHash, Retorna un objecte Hash que contingui la clau especificada

getList

Obteniu l'objecte List de la clau especificada. Aquest objecte és el client que conté la clau especificada. La base de dades només es pot operar quan es diu el seu mètode.

1
RedisList Redis.getList(Buffer key);

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que voleu obtenir

Resultat de retorn:

  • RedisList, Retorna un objecte de llista que contingui la clau especificada

getSet

Obteniu l'objecte Set de la clau especificada. Aquest objecte és el client que conté la clau especificada. La base de dades només es pot operar trucant al seu mètode.

1
RedisSet Redis.getSet(Buffer key);

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que voleu obtenir

Resultat de retorn:

  • RedisSet, Retorna un objecte Set que conté la clau especificada

getSortedSet

Obteniu l'objecte SortedSet de la clau especificada. Aquest objecte és el client que conté la clau especificada. La base de dades només es pot operar quan es diu el seu mètode.

1
RedisSortedSet Redis.getSortedSet(Buffer key);

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que voleu obtenir

Resultat de retorn:

  • RedisSortedSet, Retorna l'objecte SortedSet que conté la clau especificada

dump

Feu una sèrie de sèries de la clau donada i torneu el valor serialitzat. Utilitzeu l'ordre restore per deserialitzar aquest valor en una clau Redis.

1
Buffer Redis.dump(Buffer key);

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau que s'ha de serialitzar

Resultat de retorn:

  • Buffer, Retorna el valor serialitzat, si la clau no existeix, torna nul

restore

Deserialitzeu el valor serialitzat donat i associeu-lo a la clau donada

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

Paràmetres de trucada:

  • key: Buffer, Especifiqueu la clau per deserialitzar
  • data: Buffer, Especifiqueu les dades a deserialitzar
  • ttl: Llarg, establiu el temps de supervivència de la clau en mil·lisegons; si ttl és 0, no configureu el temps de supervivència

close

Tanqueu la connexió o transacció de base de dades actual

1
Redis.close();

toString

Retorna la representació de cadena de l'objecte, generalment retorna "[Objecte natiu]", l'objecte es pot tornar a implementar segons les seves pròpies característiques

1
String Redis.toString();

Resultat de retorn:

  • String, Retorna la representació de cadena de l'objecte

toJSON

Retorna la representació en format JSON de l'objecte, generalment retorna una col·lecció d'atributs llegibles definits per l'objecte

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

Paràmetres de trucada:

  • key: Cadena, sense utilitzar

Resultat de retorn:

  • Value, Retorna un valor que conté JSON serialitzable