Oggetto oggetto incorporato

Object Redis

Oggetto client del database Redis

Utilizzato per creare e gestire il database Redis, il metodo di creazione:

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

Eredità

Attributo membro

onsuberror

Funzione, query e impostazione della funzione di gestione degli errori, richiamata quando il sub presenta un errore o un'interruzione della rete, dopo che si verifica la richiamata, tutti i sottotitoli di questo oggetto verranno interrotti

1
Function Redis.onsuberror;

Funzione membro

command

Metodo di comando di base Redis

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

Parametri di chiamata:

  • cmd : String, specifica il comando inviato
  • args : ..., specifica i parametri inviati

Risultato di ritorno:

  • Value , restituisce il risultato restituito dal server

set

Associare il valore del valore di stringa alla chiave, se la chiave contiene già altri valori, SET sovrascriverà il vecchio valore, indipendentemente dal tipo

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

Parametri di chiamata:

  • key : Buffer , specifica la chiave da associare
  • value : Buffer , specificare i dati da associare
  • ttl : Long, imposta il tempo di sopravvivenza in millisecondi come chiave; se ttl è 0, non impostare il tempo di sopravvivenza

setNX

Impostare il valore della chiave su value se e solo se la chiave non esiste. Se la chiave fornita esiste già, SETNX non fa nulla.

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

Parametri di chiamata:

  • key : Buffer , specifica la chiave da associare
  • value : Buffer , specificare i dati da associare
  • ttl : Long, imposta il tempo di sopravvivenza in millisecondi come chiave; se ttl è 0, non impostare il tempo di sopravvivenza

setXX

Impostare il valore della chiave su valore e impostare la chiave solo quando la chiave esiste già.

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

Parametri di chiamata:

  • key : Buffer , specifica la chiave da associare
  • value : Buffer , specificare i dati da associare
  • ttl : Long, imposta il tempo di sopravvivenza in millisecondi come chiave; se ttl è 0, non impostare il tempo di sopravvivenza

mset

Imposta una o più coppie chiave-valore contemporaneamente. Se esiste già una determinata chiave, MSET sovrascriverà il vecchio valore originale con il nuovo valore

1
Redis.mset(Object kvs);

Parametri di chiamata:

  • kvs : Object, specifica l'oggetto chiave / valore da impostare

Imposta una o più coppie chiave-valore contemporaneamente. Se esiste già una determinata chiave, MSET sovrascriverà il vecchio valore originale con il nuovo valore

1
Redis.mset(...kvs);

Parametri di chiamata:

  • kvs : ..., specifica l'elenco chiave / valore da impostare

msetNX

Imposta una o più coppie chiave-valore contemporaneamente se e solo se non esistono tutte le chiavi indicate

1
Redis.msetNX(Object kvs);

Parametri di chiamata:

  • kvs : Object, specifica l'oggetto chiave / valore da impostare

Imposta una o più coppie chiave-valore contemporaneamente se e solo se non esistono tutte le chiavi indicate

1
Redis.msetNX(...kvs);

Parametri di chiamata:

  • kvs : ..., specifica l'elenco chiave / valore da impostare

append

Se la chiave esiste già ed è una stringa, il comando append aggiunge il valore alla fine del valore originale della chiave. Se la chiave non esiste, append semplicemente imposta la chiave fornita su value

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

Parametri di chiamata:

  • key : Buffer , specifica la chiave da aggiungere
  • value : Buffer , specificare i dati da aggiungere

Risultato di ritorno:

  • Integer , dopo aver aggiunto il valore, la lunghezza della stringa nella chiave

setRange

Sovrascrivi il valore di stringa memorizzato nella chiave specificata con il parametro value, a partire dall'offset

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

Parametri di chiamata:

  • key : Buffer , specificare la chiave da modificare
  • offset : intero, specificare l'offset di byte modificato
  • value : Buffer , specifica i dati da sovrascrivere

Risultato di ritorno:

  • Integer , dopo essere stato modificato, la lunghezza della stringa

getRange

Restituisce la sottostringa del valore di stringa nella chiave. L'intervallo di intercettazione della stringa è determinato dai due offset di inizio e fine (inclusi inizio e fine)

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

Parametri di chiamata:

  • key : Buffer , specifica la chiave da interrogare
  • start : intero, specifica l'offset di byte iniziale della query
  • end : intero, specificare l'offset del byte finale della query

Risultato di ritorno:

  • Buffer , sottostringa intercettata

strlen

Restituisce la lunghezza del valore di stringa memorizzato dalla chiave. Quando la chiave non memorizza un valore di stringa, viene restituito un errore

1
Integer Redis.strlen(Buffer key);

Parametri di chiamata:

  • key : Buffer , specificare la chiave da calcolare

Risultato di ritorno:

  • Integer , la lunghezza del valore della stringa. Quando la chiave non esiste, restituisce 0

bitcount

Contare il numero di bit impostato su 1 in una determinata stringa

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

Parametri di chiamata:

  • key : Buffer , specificare la chiave da calcolare
  • start : numero intero, specificare il byte iniziale da calcolare, è possibile utilizzare un valore negativo, -1 indica l'ultimo byte, -2 indica il penultimo byte e così via
  • end : intero, specificare il byte finale da calcolare, è possibile utilizzare un valore negativo, -1 indica l'ultimo byte, -2 indica il penultimo byte e così via

Risultato di ritorno:

  • Numero Integer , il numero di bit impostato su 1

get

Restituisce il valore di stringa associato alla chiave o restituisce il valore speciale Null se la chiave non esiste

1
Buffer Redis.get(Buffer key);

Parametri di chiamata:

  • key : Buffer , specifica la chiave da associare

Risultato di ritorno:

  • Buffer , quando la chiave non esiste, restituisce Null, altrimenti restituisce il valore della chiave

mget

Restituisce tutti (uno o più) valori della chiave specificata. Se una chiave non esiste nella chiave specificata, la chiave restituisce il valore speciale nullo.

1
NArray Redis.mget(Array keys);

Parametri di chiamata:

  • keys : matrice, specifica la matrice di chiavi da interrogare

Risultato di ritorno:

  • NArray , un elenco che contiene tutti i valori della chiave specificata

Restituisce tutti (uno o più) valori della chiave specificata. Se una chiave non esiste nella chiave specificata, la chiave restituisce il valore speciale nullo.

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

Parametri di chiamata:

  • keys : ..., specifica l'elenco delle keys da interrogare

Risultato di ritorno:

  • NArray , un elenco che contiene tutti i valori della chiave specificata

getset

Impostare il valore della chiave fornita su value e restituire il vecchio valore della chiave

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

Parametri di chiamata:

  • key : Buffer , specificare la chiave da modificare
  • value : Buffer , specificare il valore modificato

Risultato di ritorno:

  • Buffer , restituisce il vecchio valore della chiave specificata

decr

Ridurre il valore memorizzato dalla chiave

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

Parametri di chiamata:

  • key : Buffer , specificare la chiave da modificare
  • num : lungo, specifica il valore da sottrarre

Risultato di ritorno:

  • Long , dopo aver sottratto num, il valore della chiave

incr

Aggiungi l'incremento del valore memorizzato dalla chiave

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

Parametri di chiamata:

  • key : Buffer , specificare la chiave da modificare
  • num : lungo, specifica il valore da aggiungere

Risultato di ritorno:

  • Long , dopo aver aggiunto num, il valore della chiave

setBit

Imposta o cancella il bit all'offset specificato per il valore di stringa memorizzato nella chiave

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

Parametri di chiamata:

  • key : Buffer , specificare la chiave da modificare
  • offset : intero, specificare l'offset bit modificato
  • value : intero, specifica il parametro da impostare o cancellare, può essere 0 o 1

Risultato di ritorno:

  • Integer , specificare il bit in cui era originariamente memorizzato l'offset

getBit

Per il valore di stringa memorizzato nella chiave, ottenere il bit all'offset specificato

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

Parametri di chiamata:

  • key : Buffer , specifica la chiave da interrogare
  • offset : intero, specifica l'offset dei bit della query

Risultato di ritorno:

  • Integer , il valore della stringa specifica il bit all'offset

exists

Controlla se esiste la chiave fornita

1
Boolean Redis.exists(Buffer key);

Parametri di chiamata:

  • key : Buffer , specifica la chiave da associare

Risultato di ritorno:

  • Boolean , se la chiave esiste, restituisce True, altrimenti restituisce False

type

Restituisce il tipo di valore memorizzato dalla chiave

1
String Redis.type(Buffer key);

Parametri di chiamata:

  • key : Buffer , specifica la chiave da interrogare

Risultato di ritorno:

  • String , restituisce il tipo di valore memorizzato dalla chiave, i valori possibili sono none (la chiave non esiste) string (string) list (list) set (collection) zset (set ordinato) hash (tabella hash)

keys

Trova tutti i tasti corrispondenti al modello dato

1
NArray Redis.keys(String pattern);

Parametri di chiamata:

  • pattern : String, specifica la modalità query

Risultato di ritorno:

  • NArray , un elenco di chiavi che corrispondono al modello dato

del

Elimina la chiave o le chiavi fornite, le chiavi inesistenti verranno ignorate

1
Integer Redis.del(Array keys);

Parametri di chiamata:

  • keys : matrice, specifica la matrice di chiavi da eliminare

Risultato di ritorno:

  • Numero Integer , il numero di chiavi cancellate

Elimina la chiave o le chiavi fornite, le chiavi inesistenti verranno ignorate

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

Parametri di chiamata:

  • keys : ..., specifica l'elenco di keys da eliminare

Risultato di ritorno:

  • Numero Integer , il numero di chiavi cancellate

expire

Impostare il tempo di sopravvivenza per una determinata chiave, quando la chiave scade, verrà automaticamente eliminata

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

Parametri di chiamata:

  • key : Buffer , specifica la chiave da impostare
  • ttl : Long, imposta il tempo di sopravvivenza in millisecondi come chiave

Risultato di ritorno:

  • Boolean , se la chiave esiste, restituisce True, altrimenti restituisce False

ttl

Restituisce il tempo rimanente per vivere per una determinata chiave

1
Long Redis.ttl(Buffer key);

Parametri di chiamata:

  • key : Buffer , specifica la chiave da interrogare

Risultato di ritorno:

  • Long , in millisecondi, restituisce il tempo rimanente per vivere della chiave. Quando la chiave non esiste, restituisce -2. Quando la chiave esiste ma il tempo rimanente non è impostato, restituisce -1

persist

Rimuovi il tempo di sopravvivenza di una determinata chiave e converti questa chiave da "volatile" (con chiave del tempo di sopravvivenza) a "persistente" (una chiave senza tempo di sopravvivenza e non scade mai)

1
Boolean Redis.persist(Buffer key);

Parametri di chiamata:

  • key : Buffer , specifica la chiave da impostare

Risultato di ritorno:

  • Boolean , se la chiave esiste, restituisce True, altrimenti restituisce False

rename

Rinominare la chiave in newkey, quando la chiave e newkey sono uguali o la chiave non esiste, viene restituito un errore

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

Parametri di chiamata:

  • key : Buffer , specifica la chiave da rinominare
  • newkey : Buffer , specifica la chiave di destinazione da rinominare

renameNX

Se e solo se newkey non esiste, rinominare la chiave in newkey e restituire un errore quando la chiave non esiste

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

Parametri di chiamata:

  • key : Buffer , specifica la chiave da rinominare
  • newkey : Buffer , specifica la chiave di destinazione da rinominare

Risultato di ritorno:

  • Boolean , True se la modifica ha esito positivo, False se newkey esiste già

sub

Iscriviti alle informazioni di un determinato canale e chiama func automaticamente quando si verifica il messaggio, func contiene due parametri, canale e messaggio, e la stessa funzione dello stesso canale verrà richiamata una sola volta.

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

Parametri di chiamata:

  • channel : Buffer , specifica il nome del canale sottoscritto
  • func : Function, specifica la funzione di callback

Iscriviti alle informazioni di un determinato gruppo di canali e chiama automaticamente la funzione di richiamata corrispondente quando si verifica il messaggio, la stessa funzione dello stesso canale verrà richiamata una sola volta

1
Redis.sub(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mappatura del canale, il nome dell'attributo dell'oggetto verrà utilizzato come nome del canale e il valore dell'attributo verrà utilizzato come funzione di callback

unsub

Annulla l'iscrizione a tutti i callback per un determinato canale

1
Redis.unsub(Buffer channel);

Parametri di chiamata:

  • channel : Buffer , specifica il nome del canale non iscritto

Annulla l'iscrizione alla funzione di richiamata specificata per il canale specificato

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

Parametri di chiamata:

  • channel : Buffer , specifica il nome del canale non iscritto
  • func : Function, specifica la funzione di callback per annullare l'iscrizione

Annulla l'iscrizione a tutti i callback per un determinato set di canali

1
Redis.unsub(Array channels);

Parametri di chiamata:

  • channels : array, specifica l'array del canale di annullamento dell'iscrizione

Annulla l'iscrizione alla funzione di richiamata specificata per un determinato set di canali

1
Redis.unsub(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mappatura del canale, il nome dell'attributo dell'oggetto verrà utilizzato come nome del canale e il valore dell'attributo verrà utilizzato come funzione di callback

psub

Abbonati a un gruppo di informazioni sul canale in base al modello. Quando viene visualizzato il messaggio, func viene chiamato automaticamente Func contiene tre parametri, che sono canale, messaggio e modello. La stessa funzione può essere richiamata una sola volta per lo stesso modello

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

Parametri di chiamata:

  • pattern : String, specifica il modello di canale sottoscritto
  • func : Function, specifica la funzione di callback

Iscriviti alle informazioni di un determinato set di modelli di canale e chiama automaticamente la funzione corrispondente quando compare il messaggio, la stessa funzione dello stesso canale verrà richiamata una sola volta

1
Redis.psub(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mappatura del canale, il nome dell'attributo oggetto verrà utilizzato come modello di canale e il valore dell'attributo verrà utilizzato come funzione di callback

unpsub

Annulla l'iscrizione a tutti i callback per i canali di un determinato modello

1
Redis.unpsub(String pattern);

Parametri di chiamata:

  • pattern : String, specifica il modello di canale non sottoscritto

La funzione di richiamata specificata per annullare l'iscrizione al canale del modello specificato

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

Parametri di chiamata:

  • pattern : String, specifica il modello di canale non sottoscritto
  • func : Function, specifica la funzione di callback per annullare l'iscrizione

Annulla l'iscrizione a tutti i callback per un gruppo di canali con un determinato modello

1
Redis.unpsub(Array patterns);

Parametri di chiamata:

  • patterns : matrice, matrice dei modelli di canale specificati

La funzione di richiamata specificata per annullare l'iscrizione di un set di canali modello

1
Redis.unpsub(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mappatura del canale, il nome dell'attributo oggetto verrà utilizzato come modello di canale e il valore dell'attributo verrà utilizzato come funzione di callback

pub

Invia un messaggio al canale del canale specificato

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

Parametri di chiamata:

  • channel : Buffer , specifica il canale pubblicato
  • message : Buffer , specificare il messaggio pubblicato

Risultato di ritorno:

  • Numero Integer , il numero di client che ricevono questo messaggio

getHash

Ottieni l'oggetto Hash della chiave specificata Questo oggetto è il client che contiene la chiave specificata Solo quando viene chiamato il suo metodo, gestirà il database.

1
RedisHash Redis.getHash(Buffer key);

Parametri di chiamata:

  • key : Buffer , specificare la chiave da ottenere

Risultato di ritorno:

  • RedisHash , restituisce l'oggetto Hash contenente la chiave specificata

getList

Ottieni l'oggetto Elenco della chiave specificata Questo oggetto è il client che contiene la chiave specificata Solo quando viene chiamato il suo metodo, gestirà il database.

1
RedisList Redis.getList(Buffer key);

Parametri di chiamata:

  • key : Buffer , specificare la chiave da ottenere

Risultato di ritorno:

  • RedisList , restituisce un oggetto List contenente la chiave specificata

getSet

Ottieni l'oggetto Set della chiave specificata. Questo oggetto è il client che contiene la chiave specificata. Solo quando viene chiamato il suo metodo, gestirà il database.

1
RedisSet Redis.getSet(Buffer key);

Parametri di chiamata:

  • key : Buffer , specificare la chiave da ottenere

Risultato di ritorno:

  • RedisSet , restituisce l'oggetto Set contenente la chiave specificata

getSortedSet

Ottieni l'oggetto SortedSet della chiave specificata. Questo oggetto è il client che contiene la chiave specificata. Solo quando viene chiamato il suo metodo, gestirà il database.

1
RedisSortedSet Redis.getSortedSet(Buffer key);

Parametri di chiamata:

  • key : Buffer , specificare la chiave da ottenere

Risultato di ritorno:

  • RedisSortedSet , restituisce l'oggetto SortedSet contenente la chiave specificata

dump

Serializzare la chiave fornita e restituire il valore serializzato. Utilizzare il comando restore per deserializzare questo valore in una chiave Redis

1
Buffer Redis.dump(Buffer key);

Parametri di chiamata:

  • key : Buffer , specificare la chiave da serializzare

Risultato di ritorno:

  • Buffer , restituisce il valore dopo la serializzazione, se la chiave non esiste, quindi restituisce null

restore

Deserializzare il valore serializzato specificato e associarlo alla chiave specificata

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

Parametri di chiamata:

  • key : Buffer , specifica la chiave da deserializzare
  • data : Buffer , specificare i dati da deserializzare
  • ttl : Long, imposta il tempo di sopravvivenza in millisecondi come chiave; se ttl è 0, non impostare il tempo di sopravvivenza

close

Chiudi la connessione o la transazione del database corrente

1
Redis.close();

toString

Restituisce la rappresentazione in forma di stringa dell'oggetto, in genere restituisce "[Native Object]", l'oggetto può essere reimplementato in base alle proprie caratteristiche

1
String Redis.toString();

Risultato di ritorno:

  • String , restituisce una rappresentazione in formato stringa dell'oggetto

toJSON

Restituisce la rappresentazione JSON dell'oggetto, in genere restituisce una raccolta di attributi leggibili definiti dall'oggetto

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

Parametri di chiamata:

  • key : stringa, non utilizzata

Risultato di ritorno:

  • Value , restituisce un valore contenente serializzabile JSON