Oggetto oggetto incorporato

Ridisposizione oggetto

Oggetto client del database Redis

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

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

Eredità

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

Attributi dei membri

onsuberror

Funzione, interrogazione e impostazione della funzione di gestione degli errori, richiama quando si verifica un errore in sub o la rete viene interrotta, quando si verifica la richiamata, tutti i sub di questo oggetto verranno interrotti

1
Function Redis.onsuberror;

Funzione membro

command

Metodo di comando di base di Redis

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

Parametri di chiamata:

  • cmd: String, specifica il comando inviato
  • args: ..., specificare i parametri da inviare

Risultato di ritorno:

  • Value, Restituisce il risultato restituito dal server

set

Associa alla chiave il valore del valore della stringa, se la chiave contiene già altri valori, SET sovrascrive il vecchio valore, indipendentemente dal tipo

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

Parametri di chiamata:

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

setNX

Imposta il valore di chiave su valore se e solo se la chiave non esiste. Se la chiave data esiste già, SETNX non fa nulla.

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

Parametri di chiamata:

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

setXX

Imposta il valore di chiave su valore e imposta 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, Specificare la chiave da associare
  • value: Buffer, Specificare i dati da associare
  • ttl: Long, imposta il tempo di sopravvivenza per la chiave in millisecondi; se ttl è 0, non impostare il tempo di sopravvivenza

mset

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

1
Redis.mset(Object kvs);

Parametri di chiamata:

  • kvs: Oggetto, specificare l'oggetto chiave/valore da impostare

Imposta una o più coppie chiave-valore contemporaneamente. Se una determinata chiave esiste già, MSET sovrascriverà il vecchio valore 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 tutte le chiavi fornite non esistono

1
Redis.msetNX(Object kvs);

Parametri di chiamata:

  • kvs: Oggetto, specificare l'oggetto chiave/valore da impostare

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

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 imposta semplicemente la chiave data su value

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

Parametri di chiamata:

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

Risultato di ritorno:

  • Integer, Dopo aver aggiunto il valore, la lunghezza della stringa in chiave

setRange

Utilizzare il parametro value per sovrascrivere il valore della stringa memorizzato nella chiave data, a partire dall'offset 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, specifica l'offset di byte modificato
  • value: Buffer, Specificare i dati da sovrascrivere

Risultato di ritorno:

  • Integer, Dopo essere stata modificata, la lunghezza della stringa

getRange

Restituisce la sottostringa del valore della 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, Specificare la chiave da interrogare
  • start: Intero, specifica l'offset del byte iniziale della query
  • end: Intero, specifica l'offset del byte finale della query

Risultato di ritorno:

  • Buffer, Intercetta la sottostringa

strlen

Restituisce la lunghezza del valore stringa memorizzato nella chiave. Quando la chiave non è un valore 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 impostati su 1 in una data 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: Intero, specificare il byte iniziale da calcolare, possono essere utilizzati valori negativi, -1 indica l'ultimo byte e -2 indica il penultimo byte e così via
  • end: Intero, specificare il byte finale da calcolare, possono essere utilizzati valori negativi, -1 indica l'ultimo byte e -2 indica il penultimo byte e così via

Risultato di ritorno:

  • Integer, Il numero di bit impostato su 1

get

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

1
Buffer Redis.get(Buffer key);

Parametri di chiamata:

  • key: Buffer, Specificare la chiave da associare

Risultato di ritorno:

  • Buffer, Quando la chiave non esiste, restituisce Null, altrimenti restituisce il valore di chiave

mget

Restituisce tutti (uno o più) valori della chiave data. Se una chiave non esiste nella chiave data, questa chiave restituisce il valore speciale nil.

1
NArray Redis.mget(Array keys);

Parametri di chiamata:

  • keys: Array, specifica l'array di chiavi da interrogare

Risultato di ritorno:

  • NArray, Un elenco contenente tutti i valori di una determinata chiave

Restituisce tutti (uno o più) valori della chiave data. Se una chiave non esiste nella chiave data, questa chiave restituisce il valore speciale nil.

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

Parametri di chiamata:

  • keys: ..., specificare l'elenco delle chiavi da interrogare

Risultato di ritorno:

  • NArray, Un elenco contenente tutti i valori di una determinata chiave

getset

Imposta il valore della chiave data su value e restituisce il vecchio valore della chiave (vecchio valore)

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

Parametri di chiamata:

  • key: Buffer, Specificare la chiave da interrogare e modificare
  • value: Buffer, Specificare il valore modificato

Risultato di ritorno:

  • Buffer, Restituisce il vecchio valore della chiave data

decr

Sottrarre il decremento dal valore memorizzato nella 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 di chiave

incr

Aggiungi l'incremento al valore memorizzato nella chiave

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

Parametri di chiamata:

  • key: Buffer, Specificare la chiave da modificare
  • num: Lungo, specificare il valore da aggiungere

Risultato di ritorno:

  • Long, Dopo aver aggiunto num, il valore di key

setBit

Per il valore della stringa memorizzato nella chiave, impostare o cancellare il bit all'offset specificato (bit)

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

Parametri di chiamata:

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

Risultato di ritorno:

  • Integer, Specificare il bit originale memorizzato dell'offset

getBit

Ottieni il bit all'offset specificato per il valore della stringa memorizzato nella chiave

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

Parametri di chiamata:

  • key: Buffer, Specificare la chiave da interrogare
  • offset: Intero, specifica l'offset di bit della query

Risultato di ritorno:

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

exists

Controlla se la chiave data esiste

1
Boolean Redis.exists(Buffer key);

Parametri di chiamata:

  • key: Buffer, Specificare la chiave da associare

Risultato di ritorno:

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

type

Restituisce il tipo del valore memorizzato nella chiave

1
String Redis.type(Buffer key);

Parametri di chiamata:

  • key: Buffer, Specificare la chiave da interrogare

Risultato di ritorno:

  • String, Restituisce il tipo del valore memorizzato nella chiave, il valore possibile è nessuno (la chiave non esiste) string (string) list (list) set (raccolta) zset (insieme ordinato) hash(tabella hash)

keys

Trova tutte le chiavi che corrispondono al modello dato

1
NArray Redis.keys(String pattern);

Parametri di chiamata:

  • pattern: Stringa, specifica la modalità di query

Risultato di ritorno:

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

del

Elimina una o più chiavi fornite, le chiavi inesistenti verranno ignorate

1
Integer Redis.del(Array keys);

Parametri di chiamata:

  • keys: Array, specifica l'array di chiavi da eliminare

Risultato di ritorno:

  • Integer, Il numero di chiavi cancellate

Elimina una o più chiavi fornite, le chiavi inesistenti verranno ignorate

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

Parametri di chiamata:

  • keys: ..., specificare l'elenco delle chiavi da eliminare

Risultato di ritorno:

  • Integer, Il numero di chiavi cancellate

expire

Imposta il tempo di vita 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, Specificare la chiave da impostare
  • ttl: Lungo, imposta il tempo di sopravvivenza per la chiave in millisecondi

Risultato di ritorno:

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

ttl

Restituisci il tempo di sopravvivenza rimanente della chiave data

1
Long Redis.ttl(Buffer key);

Parametri di chiamata:

  • key: Buffer, Specificare la chiave da interrogare

Risultato di ritorno:

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

persist

Rimuovi la durata di una determinata chiave e converti questa chiave da "volatile" (con una chiave a vita) a "persistente" (una chiave senza durata e non scade mai)

1
Boolean Redis.persist(Buffer key);

Parametri di chiamata:

  • key: Buffer, Specificare la chiave da impostare

Risultato di ritorno:

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

rename

Rinominare la chiave in nuovachiave. Quando la chiave e la nuovachiave coincidono o la chiave non esiste, verrà restituito un errore

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

Parametri di chiamata:

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

renameNX

Se e solo se newkey non esiste, rinomina la chiave in newkey e restituisce un errore quando la chiave non esiste

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

Parametri di chiamata:

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

Risultato di ritorno:

  • Boolean, Quando la modifica ha successo, restituisce True, se la nuova chiave esiste già, restituisce False

sub

Iscriviti alle informazioni di un determinato canale e chiama automaticamente func quando si verifica un messaggio.Func contiene due parametri, canale e messaggio a turno.La stessa funzione sullo stesso canale verrà richiamata solo una volta

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

Parametri di chiamata:

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

Iscriviti alle informazioni di un determinato insieme di canali e chiama automaticamente la funzione di richiamata corrispondente quando si verifica un messaggio.La stessa funzione dello stesso canale verrà richiamata solo una volta

1
Redis.sub(Object map);

Parametri di chiamata:

  • map: Oggetto, specifica la relazione di mappatura del canale, il nome dell'attributo dell'oggetto sarà il nome del canale e il valore dell'attributo sarà la funzione di callback

unsub

Annulla l'iscrizione a tutte le richiamate di un determinato canale

1
Redis.unsub(Buffer channel);

Parametri di chiamata:

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

Annulla l'iscrizione alla funzione di callback specificata del canale specificato

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

Parametri di chiamata:

  • channel: Buffer, Specificare il nome del canale non iscritto
  • func: Funzione, specifica la funzione di callback per la disiscrizione

Annulla l'iscrizione a tutte le richiamate di un determinato canale

1
Redis.unsub(Array channels);

Parametri di chiamata:

  • channels: Array, specifica un array di canali non iscritti

Annulla l'iscrizione alla funzione di callback specificata di un determinato insieme di canali

1
Redis.unsub(Object map);

Parametri di chiamata:

  • map: Oggetto, specifica la relazione di mappatura del canale, il nome dell'attributo dell'oggetto sarà il nome del canale e il valore dell'attributo sarà la funzione di callback

psub

Iscriviti alle informazioni di un gruppo di canali secondo il modello. Quando si verifica un messaggio, func viene chiamato automaticamente. Func contiene tre parametri, che sono a loro volta canale, messaggio e modello. La stessa funzione dello stesso modello verrà chiamata solo indietro una volta.

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

Parametri di chiamata:

  • pattern: Stringa, specifica il modello di canale sottoscritto
  • func: Funzione, specifica la funzione di callback

Iscriviti alle informazioni di un determinato set di modelli di canale e chiama automaticamente la funzione corrispondente quando si verifica un messaggio e la stessa funzione sullo stesso canale verrà richiamata solo una volta

1
Redis.psub(Object map);

Parametri di chiamata:

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

unpsub

Annulla l'iscrizione a tutte le richiamate dei canali con un determinato modello

1
Redis.unpsub(String pattern);

Parametri di chiamata:

  • pattern: Stringa, specifica il modello di canale per annullare l'iscrizione

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

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

Parametri di chiamata:

  • pattern: Stringa, specifica il modello di canale per annullare l'iscrizione
  • func: Funzione, specifica la funzione di callback per la disiscrizione

Annulla l'iscrizione a tutte le richiamate di un insieme di canali con un determinato modello

1
Redis.unpsub(Array patterns);

Parametri di chiamata:

  • patterns: Array, specifica l'array di modelli di canale da pubblicare

La funzione di callback specificata del canale che annulla l'iscrizione a una serie di modelli

1
Redis.unpsub(Object map);

Parametri di chiamata:

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

pub

Invia un messaggio informativo al canale del canale specificato

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

Parametri di chiamata:

  • channel: Buffer, Specificare il canale pubblicato
  • message: Buffer, Specificare il messaggio da pubblicare

Risultato di ritorno:

  • 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. Il database può essere utilizzato solo quando viene chiamato il suo metodo

1
RedisHash Redis.getHash(Buffer key);

Parametri di chiamata:

  • key: Buffer, Specificare la chiave da ottenere

Risultato di ritorno:

  • RedisHash, Restituisce un oggetto Hash contenente la chiave specificata

getList

Ottieni l'oggetto List della chiave specificata.Questo oggetto è il client che contiene la chiave specificata.Il database può essere utilizzato solo quando viene chiamato il suo metodo

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.Il database può essere utilizzato solo chiamando il suo metodo

1
RedisSet Redis.getSet(Buffer key);

Parametri di chiamata:

  • key: Buffer, Specificare la chiave da ottenere

Risultato di ritorno:

  • RedisSet, Restituisce un oggetto Set contenente la chiave specificata

getSortedSet

Ottieni l'oggetto SortedSet della chiave specificata.Questo oggetto è il client che contiene la chiave specificata.Il database può essere utilizzato solo quando viene chiamato il suo metodo

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

Serializza la chiave specificata e restituisce 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 serializzato, se la chiave non esiste, restituisce null

restore

Deserializzare il valore serializzato dato e associarlo alla chiave data

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

Parametri di chiamata:

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

close

Chiudi la connessione o la transazione al database corrente

1
Redis.close();

toString

Restituisce la rappresentazione in stringa dell'oggetto, generalmente restituisce "[Native Object]", l'oggetto può essere re-implementato secondo le proprie caratteristiche

1
String Redis.toString();

Risultato di ritorno:

  • String, Restituisce la rappresentazione di stringa dell'oggetto

toJSON

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

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

Parametri di chiamata:

  • key: Stringa, inutilizzata

Risultato di ritorno:

  • Value, Restituisce un valore contenente JSON serializzabile