ObjectRedis

Objecte client de base de dades Redis

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

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

relació hereditària

propietats dels membres

onsuberror

Funcioneu, consulteu i configureu la funció de gestió d'errors. Quan el subordinat té un error o la xarxa s'interromp, es tornarà a trucar. Quan es produeixi la devolució de trucada, s'acabaran tots els subs d'aquest objecte.

1
Function Redis.onsuberror;

funció de membre

command

mètode de comandament bàsic redis

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

Paràmetres de trucada:

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

Resultats de retorn:

Value, retorna el resultat retornat pel servidor

set

Associa el valor del valor de cadena a la clau. Si la clau ja conté un altre valor, 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 voleu associar
value:Buffer, especifiqueu les dades a associar
ttl: llarg, establiu el temps de supervivència per a la clau en mil·lisegons; si ttl és 0, el temps de supervivència no està definit

setNX

Estableix 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 cap acció.

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

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu associar
value:Buffer, especifiqueu les dades a associar
ttl: llarg, establiu el temps de supervivència per a la clau en mil·lisegons; si ttl és 0, el temps de supervivència no està definit

setXX

Establiu el valor de la clau en el valor i la clau només si la clau ja existeix.

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

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu associar
value:Buffer, especifiqueu les dades a associar
ttl: llarg, establiu el temps de supervivència per a la clau en mil·lisegons; si ttl és 0, el temps de supervivència no està definit

mset

Estableix un o més parells clau-valor 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, especifica l'objecte clau/valor que s'ha d'establir

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

1Redis.mset(...kvs);

Paràmetres de trucada:

kvs: ..., especifiqueu la llista de claus/valors que s'ha d'establir

msetNX

Estableix un o més parells clau-valor alhora si i només si no existeixen totes les claus donades

1
Redis.msetNX(Object kvs);

Paràmetres de trucada:

kvs: Objecte, especifica l'objecte clau/valor que s'ha d'establir

Estableix un o més parells clau-valor alhora si i només si no existeixen totes les claus donades

1Redis.msetNX(...kvs);

Paràmetres de trucada:

kvs: ..., especifiqueu la llista de claus/valors que s'ha d'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, append simplement estableix 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 voleu afegir
value:Buffer, especifiqueu les dades que voleu adjuntar

Resultats de retorn:

Integer, després d'afegir valor, la longitud de la cadena a la clau

setRange

Utilitzeu el paràmetre de valor per sobreescriure el valor de cadena emmagatzemat a la clau donada, començant per l'offset

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

Paràmetres de trucada:

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

Resultats de retorn:

Integer, la longitud de la cadena després de modificar-la

getRange

Retorna la subcadena del valor de la cadena a la clau. L'interval d'intercepció de la cadena ve 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, especifica l'offset de bytes inicial de la consulta
end: Enter, especifica el desplaçament del byte final de la consulta

Resultats de retorn:

Buffer, intercepta la subcadena obtinguda

strlen

Retorna la longitud del valor de cadena emmagatzemat a la clau. Quan la clau emmagatzema un valor diferent d'un valor de cadena, es retorna un error.

1Integer Redis.strlen(Buffer key);

Paràmetres de trucada:

key:Buffer, especifiqueu la clau a calcular

Resultats de retorn:

Integer, la longitud del valor de la cadena. Quan la clau no existeix, retorna 0

bitcount

Compta el nombre de bits establerts a 1 a la cadena donada

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, especifica el byte inicial que cal calcular, podeu utilitzar valors negatius, -1 representa l'últim byte i -2 representa el penúltim byte, etc.
end: Enter, especifica el byte final que cal calcular, podeu utilitzar valors negatius, -1 representa l'últim byte i -2 representa el penúltim byte, etc.

Resultats de retorn:

Integer, el nombre de bits establert a 1

get

Retorna el valor de cadena associat a la clau. Si la clau no existeix, retorna el valor especial Null.

1Buffer Redis.get(Buffer key);

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu associar

Resultats de retorn:

Buffer, quan la clau no existeix, retorna Null, en cas contrari, retorna el valor de la clau

mget

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

1
NArray Redis.mget(Array keys);

Paràmetres de trucada:

keys: Matriu, especifica la matriu de claus que s'ha de consultar

Resultats de retorn:

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

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

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

Paràmetres de trucada:

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

Resultats de retorn:

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

getset

Estableix el valor de la clau donada en valor i retorna el valor antic de la clau

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

Resultats de retorn:

Buffer, retorna el valor antic de la clau donada

decr

Resta el decrement 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 a modificar
num: Llarg, especifica el valor que s'ha de restar

Resultats 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 a modificar
num: Llarg, especifica el valor que cal afegir

Resultats de retorn:

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

setBit

Per al valor de cadena emmagatzemat a la clau, estableixi o esborra el bit al desplaçament especificat.

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

Paràmetres de trucada:

key:Buffer, especifiqueu la clau a modificar
offset: Enter, especifica el desplaçament de bits modificat
value: Enter, especifica el paràmetre que s'ha d'establir o esborrar, que pot ser 0 o 1

Resultats de retorn:

Integer, especifica el bit on es va emmagatzemar originalment el desplaçament

getBit

Per al valor de cadena emmagatzemat a la clau, obteniu el bit a l'offset especificat

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

Paràmetres de trucada:

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

Resultats de retorn:

Integer, el valor de la cadena especifica el bit al desplaçament

exists

Comproveu si la clau donada existeix

1
Boolean Redis.exists(Buffer key);

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu associar

Resultats de retorn:

Boolean, si la clau existeix, retorna True, en cas contrari retorna 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

Resultats de retorn:

String, retorna el tipus de valor emmagatzemat a la clau. Els valors possibles són cap (la clau no existeix) cadena (cadena) llista (lista) conjunt (conjunt) zset (conjunt ordenat)hash(taula hash)

keys

Trobeu 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

Resultats de retorn:

NArray, una llista de claus que coincideixen amb el patró donat

del

Suprimeix una o més claus donades. Les claus que no existeixen s'ignoraran.

1
Integer Redis.del(Array keys);

Paràmetres de trucada:

keys: Matriu, especifica la matriu de claus que s'ha d'eliminar

Resultats de retorn:

Integer, el nombre de claus suprimides

Suprimeix una o més claus donades. Les claus que no existeixen s'ignoraran.

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

Paràmetres de trucada:

keys: ..., especifiqueu la llista de claus que voleu suprimir

Resultats de retorn:

Integer, el nombre de claus suprimides

expire

Estableix la vida útil d'una clau determinada. Quan la clau caduqui, se suprimirà automàticament.

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

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu configurar
ttl: llarg, establiu el temps de supervivència de la clau en mil·lisegons

Resultats de retorn:

Boolean, si la clau existeix, retorna True, en cas contrari retorna False

ttl

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

1Long Redis.ttl(Buffer key);

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu consultar

Resultats 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, retorna -1.

persist

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

1
Boolean Redis.persist(Buffer key);

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu configurar

Resultats de retorn:

Boolean, si la clau existeix, retorna True, en cas contrari retorna False

rename

Canvia el nom de la clau a la clau nova. Quan la clau és la mateixa que la clau nova o no existeix, es retorna un error.

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

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu canviar el nom
newkey:Buffer, especifiqueu la clau de destinació que voleu canviar el nom

renameNX

Si i només si la clau nova no existeix, canvieu el nom de la clau a clau nova. Quan la clau no existeix, retorneu un error.

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

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu canviar el nom
newkey:Buffer, especifiqueu la clau de destinació que voleu canviar el nom

Resultats de retorn:

Boolean, quan la modificació tingui èxit, retorna True, si la nova clau ja existeix, retorna False

sub

Subscriu-te a la informació d'un canal determinat i truca automàticament a func quan es produeix un missatge. func conté dos paràmetres, el canal i el missatge en ordre. La mateixa funció del mateix canal només es tornarà a cridar una vegada.

1
2Redis.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 conjunt determinat 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 trucarà una vegada.

1
Redis.sub(Object map);

Paràmetres de trucada:

map: Objecte, especifica la relació de mapatge del canal, el nom de l'atribut de l'objecte s'utilitzarà com a nom del canal i el valor de l'atribut s'utilitzarà com a funció de devolució de trucada

unsub

Cancel·la la subscripció de totes les devolucions de trucada del canal donat

1Redis.unsub(Buffer channel);

Paràmetres de trucada:

channel:Buffer, especifiqueu el nom del canal del qual voleu cancel·lar la subscripció

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

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

Paràmetres de trucada:

channel:Buffer, especifiqueu el nom del canal del qual voleu cancel·lar la subscripció
func: Funció, especifica la funció de devolució de trucada per a la cancel·lació de la subscripció

Cancel·la la subscripció de totes les devolucions de trucada per a un determinat conjunt de canals

1
Redis.unsub(Array channels);

Paràmetres de trucada:

channels: Matriu, especifica la matriu de canals de la qual es cancel·la la subscripció

Funció de devolució de trucada especificada per cancel·lar la subscripció a un conjunt determinat de canals

1
Redis.unsub(Object map);

Paràmetres de trucada:

map: Objecte, especifica la relació de mapatge del canal, el nom de l'atribut de l'objecte s'utilitzarà com a nom del canal i el valor de l'atribut s'utilitzarà com a funció de devolució de trucada

psub

Subscriu-te a un grup d'informació del canal segons la plantilla i truca automàticament a func quan es produeix un missatge. func conté tres paràmetres, canal, missatge i patró en ordre. La mateixa funció de la mateixa plantilla només es tornarà a cridar una vegada.

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

Paràmetres de trucada:

pattern: Cadena, especifica la plantilla del canal subscrit
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 la funció corresponent quan es produeixi un missatge. 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, especifica la relació de mapatge del canal, el nom de l'atribut de l'objecte s'utilitzarà com a plantilla del canal i el valor de l'atribut s'utilitzarà com a funció de devolució de trucada

unpsub

Cancel·la la subscripció de totes les devolucions de trucada del canal de la plantilla donada

1
Redis.unpsub(String pattern);

Paràmetres de trucada:

pattern: Cadena, especifiqueu la plantilla del canal de cancel·lació de la subscripció

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 de cancel·lació de la subscripció
func: Funció, especifica la funció de devolució de trucada per a la cancel·lació de la subscripció

Cancel·la 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, especifica la matriu de plantilla de canal publicada

Funció de devolució de trucada especificada per cancel·lar la subscripció a un grup de canals de plantilla

1
Redis.unpsub(Object map);

Paràmetres de trucada:

map: Objecte, especifica la relació de mapatge del canal, el nom de l'atribut de l'objecte s'utilitzarà com a plantilla del canal i el valor de l'atribut s'utilitzarà com a funció de devolució de trucada

pub

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

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

Paràmetres de trucada:

channel:Buffer, especifiqueu el canal de publicació
message:Buffer, especifiqueu el missatge que voleu publicar

Resultats de retorn:

Integer, el nombre de clients que reben aquest missatge

getHash

Aconsegueix l'objecte Hash de la clau especificada. Aquest objecte és el client que conté la clau especificada. Només cridant al seu mètode es farà funcionar la base de dades.

1RedisHash Redis.getHash(Buffer key);

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu obtenir

Resultats de retorn:

RedisHash, retorna un objecte Hash que conté la clau especificada

getList

Aconsegueix l'objecte List de la clau especificada. Aquest objecte és el client que conté la clau especificada. Només cridant al seu mètode es farà funcionar la base de dades.

1RedisList Redis.getList(Buffer key);

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu obtenir

Resultats de retorn:

RedisList, retorna un objecte List que conté la clau especificada

getSet

Obteniu l'objecte Set de la clau especificada. Aquest objecte és el client que conté la clau especificada. Només cridant al seu mètode es farà funcionar la base de dades.

1RedisSet Redis.getSet(Buffer key);

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu obtenir

Resultats de retorn:

RedisSet, retorna un objecte Set que conté la clau especificada

getSortedSet

Aconsegueix l'objecte SortedSet de la clau especificada. Aquest objecte és el client que conté la clau especificada. Només cridant al seu mètode es farà funcionar la base de dades.

1RedisSortedSet Redis.getSortedSet(Buffer key);

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu obtenir

Resultats de retorn:

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

dump

Serialitza la clau donada i retorna el valor serialitzat. Utilitzeu l'ordre de restauració per deserialitzar aquest valor en una clau Redis.

1Buffer Redis.dump(Buffer key);

Paràmetres de trucada:

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

Resultats de retorn:

Buffer, retorna el valor després de la serialització, si la clau no existeix, retorna nul

restore

Deserialitzar el valor serialitzat donat i associar-lo amb la clau donada

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

Paràmetres de trucada:

key:Buffer, especifiqueu la clau que voleu deserialitzar
data:Buffer, especifiqueu les dades a deserialitzar
ttl: llarg, establiu el temps de supervivència per a la clau en mil·lisegons; si ttl és 0, el temps de supervivència no està definit

close

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

1Redis.close();

toString

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

1
String Redis.toString();

Resultats de retorn:

String, retorna la representació de cadena de l'objecte

toJSON

Retorna una representació en format JSON de l'objecte, generalment retornant una col·lecció de propietats llegibles definides per l'objecte.

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

Paràmetres de trucada:

key: Corda, no utilitzada

Resultats de retorn:

Value, retorna un valor que conté JSON serializable

Guia de desenvolupament

Mòdul bàsic

objectes incorporats

mòdul comunitari

ObjectRedis

relació hereditària

propietats dels membres

onsuberror

funció de membre

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

toString

toJSON