OggettoRedis
Oggetto client del database Redis
Utilizzato per creare e gestire il database Redis, metodo di creazione:
1
2var db = require("db");
var test = new db.openRedis("redis-server");
rapporto ereditario
proprietà dei membri
onsuberror
Funzione, interroga e imposta la funzione di gestione degli errori. Quando il sub ha un errore o la rete viene interrotta, verrà richiamato. Quando si verifica la richiamata, tutti i sub di questo oggetto verranno terminati.
1Function Redis.onsuberror;
funzione membro
command
metodo di comando di base redis
1
2Value Redis.command(String cmd,
...args);
Parametri di chiamata:
- cmd: String, specifica il comando da inviare
- args: ..., specificare i parametri da inviare
Risultati restituiti:
- Value, restituisce il risultato restituito dal server
set
Associa il valore del valore stringa alla chiave. Se la chiave contiene già un altro valore, SET sovrascrive il vecchio valore, indipendentemente dal tipo.
1
2
3Redis.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: Lungo, imposta il tempo di sopravvivenza della chiave in millisecondi; se ttl è 0, allora il tempo di sopravvivenza non viene impostato
setNX
Imposta il valore della chiave su valore se e solo se la chiave non esiste. Se la chiave specificata esiste già, SETNX non esegue alcuna azione.
1
2
3Redis.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: Lungo, imposta il tempo di sopravvivenza della chiave in millisecondi; se ttl è 0, allora il tempo di sopravvivenza non viene impostato
setXX
Imposta il valore della chiave su valore e imposta la chiave solo se esiste già.
1
2
3Redis.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: Lungo, imposta il tempo di sopravvivenza della chiave in millisecondi; se ttl è 0, allora il tempo di sopravvivenza non viene impostato
mset
Imposta una o più coppie chiave-valore contemporaneamente. Se una determinata chiave esiste già, MSET sovrascriverà il vecchio valore con il nuovo valore.
1Redis.mset(Object kvs);
Parametri di chiamata:
- kvs: Oggetto, specifica 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.
1Redis.mset(...kvs);
Parametri di chiamata:
- kvs: ..., specificare 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
1Redis.msetNX(Object kvs);
Parametri di chiamata:
- kvs: Oggetto, specifica l'oggetto chiave/valore da impostare
Imposta una o più coppie chiave-valore contemporaneamente se e solo se tutte le chiavi fornite non esistono
1Redis.msetNX(...kvs);
Parametri di chiamata:
- kvs: ..., specificare l'elenco chiave/valore da impostare
append
Se key esiste già ed è una stringa, il comando append aggiunge valore alla fine del valore originale della chiave. Se la chiave non esiste, aggiungi semplicemente imposta la chiave specificata su valore.
1
2Integer Redis.append(Buffer key,
Buffer value);
Parametri di chiamata:
Risultati restituiti:
- Integer, dopo aver aggiunto valore, la lunghezza della stringa nella chiave
setRange
Utilizzare il parametro value per sovrascrivere il valore della stringa memorizzato nella chiave specificata, a partire da offset offset
1
2
3Integer 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
Risultati restituiti:
- Integer, la lunghezza della stringa dopo la modifica
getRange
Restituisce la sottostringa del valore stringa in chiave. L'intervallo di intercettazione della stringa è determinato dai due offset di inizio e fine (inclusi inizio e fine)
1
2
3Buffer Redis.getRange(Buffer key,
Integer start,
Integer end);
Parametri di chiamata:
- key:Buffer, specificare la chiave da interrogare
- start: numero intero, specifica l'offset di byte iniziale della query
- end: numero intero, specifica l'offset del byte finale della query
Risultati restituiti:
- Buffer, intercetta la sottostringa ottenuta
strlen
Restituisce la lunghezza del valore stringa memorizzato nella chiave. Quando la chiave memorizza un valore diverso da un valore stringa, viene restituito un errore.
1Integer Redis.strlen(Buffer key);
Parametri di chiamata:
- key:Buffer, specificare la chiave da calcolare
Risultati restituiti:
- Integer, la lunghezza del valore della stringa. Quando la chiave non esiste, restituisce 0
bitcount
Conta il numero di bit impostati a 1 nella stringa data
1
2
3Integer Redis.bitcount(Buffer key,
Integer start = 0,
Integer end = -1);
Parametri di chiamata:
- key:Buffer, specificare la chiave da calcolare
- start: intero, specifica il byte iniziale da calcolare, è possibile utilizzare valori negativi, -1 rappresenta l'ultimo byte e -2 rappresenta il penultimo byte e così via.
- end: Intero, specifica il byte finale da calcolare, è possibile utilizzare valori negativi, -1 rappresenta l'ultimo byte e -2 rappresenta il penultimo byte e così via.
Risultati restituiti:
- 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.
1Buffer Redis.get(Buffer key);
Parametri di chiamata:
- key:Buffer, specificare la chiave da associare
Risultati restituiti:
- Buffer, quando la chiave non esiste, restituisce Null, altrimenti restituisce il valore della chiave
mget
Restituisce tutti (uno o più) valori per la chiave specificata. Se una chiave non esiste nella chiave data, questa chiave restituisce il valore speciale nil.
1NArray Redis.mget(Array keys);
Parametri di chiamata:
- keys: Array, specifica l'array di chiavi da interrogare
Risultati restituiti:
- NArray, un elenco contenente tutti i valori per una determinata chiave
Restituisce tutti (uno o più) valori per la chiave specificata. Se una chiave non esiste nella chiave data, questa chiave restituisce il valore speciale nil.
1NArray Redis.mget(...keys);
Parametri di chiamata:
- keys: ..., specificare l'elenco delle chiavi da interrogare
Risultati restituiti:
- NArray, un elenco contenente tutti i valori per una determinata chiave
getset
Imposta il valore della chiave specificata su valore e restituisce il vecchio valore della chiave
1
2Buffer Redis.getset(Buffer key,
Buffer value);
Parametri di chiamata:
- key:Buffer, specificare la chiave da interrogare e modificare.
- value:Buffer, specificare il valore modificato
Risultati restituiti:
- Buffer, restituisce il vecchio valore della chiave specificata
decr
Sottrarre il decremento dal valore memorizzato nella chiave
1
2Long Redis.decr(Buffer key,
Long num = 1);
Parametri di chiamata:
- key:Buffer, specificare la chiave da modificare
- num: Lungo, specifica il valore da sottrarre
Risultati restituiti:
- Long, dopo aver sottratto num, il valore di key
incr
Aggiungere l'incremento al valore memorizzato nella chiave
1
2Long Redis.incr(Buffer key,
Long num = 1);
Parametri di chiamata:
- key:Buffer, specificare la chiave da modificare
- num: Lungo, specifica il valore da aggiungere
Risultati restituiti:
- 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.
1
2
3Integer Redis.setBit(Buffer key,
Integer offset,
Integer value);
Parametri di chiamata:
- key:Buffer, specificare la chiave da modificare
- offset: numero intero, specifica l'offset del bit modificato
- value: Numero intero, specifica il parametro da impostare o cancellare, che può essere 0 o 1
Risultati restituiti:
- Integer, specifica il bit in cui è stato originariamente memorizzato l'offset
getBit
Per il valore della stringa memorizzato nella chiave, ottenere il bit all'offset specificato
1
2Integer Redis.getBit(Buffer key,
Integer offset);
Parametri di chiamata:
- key:Buffer, specificare la chiave da interrogare
- offset: numero intero, specifica l'offset di bit della query
Risultati restituiti:
- Integer, il valore stringa specifica il bit in corrispondenza dell'offset
exists
Controlla se la chiave specificata esiste
1Boolean Redis.exists(Buffer key);
Parametri di chiamata:
- key:Buffer, specificare la chiave da associare
Risultati restituiti:
- Boolean, se la chiave esiste, restituisce True, altrimenti restituisce False
type
Restituisce il tipo di valore memorizzato nella chiave
1String Redis.type(Buffer key);
Parametri di chiamata:
- key:Buffer, specificare la chiave da interrogare
Risultati restituiti:
- String, restituisce il tipo di valore memorizzato nella chiave.I valori possibili sono none (la chiave non esiste) string (stringa) list (lista) set (set) zset (set ordinato)hash(tabella hash)
keys
Trova tutte le chiavi che corrispondono allo schema indicato
1NArray Redis.keys(String pattern);
Parametri di chiamata:
- pattern: Stringa, specifica la modalità di query
Risultati restituiti:
- NArray, un elenco di chiavi che corrispondono al modello specificato
del
Elimina una o più chiavi specificate. Le chiavi non esistenti verranno ignorate.
1Integer Redis.del(Array keys);
Parametri di chiamata:
- keys: Array, specifica l'array di chiavi da eliminare
Risultati restituiti:
- Integer, il numero di chiavi cancellate
Elimina una o più chiavi specificate. Le chiavi non esistenti verranno ignorate.
1Integer Redis.del(...keys);
Parametri di chiamata:
- keys: ..., specificare l'elenco delle chiavi da eliminare
Risultati restituiti:
- Integer, il numero di chiavi cancellate
expire
Imposta la durata di una determinata chiave. Quando la chiave scade, verrà automaticamente eliminata.
1
2Boolean Redis.expire(Buffer key,
Long ttl);
Parametri di chiamata:
- key:Buffer, specificare la chiave da impostare
- ttl: Lungo, imposta il tempo di sopravvivenza della chiave in millisecondi
Risultati restituiti:
- Boolean, se la chiave esiste, restituisce True, altrimenti restituisce False
ttl
Restituisce il tempo di sopravvivenza rimanente della chiave specificata
1Long Redis.ttl(Buffer key);
Parametri di chiamata:
- key:Buffer, specificare la chiave da interrogare
Risultati restituiti:
- 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" (chiave con durata) a "persistente" (una chiave senza durata e senza scadenza)
1Boolean Redis.persist(Buffer key);
Parametri di chiamata:
- key:Buffer, specificare la chiave da impostare
Risultati restituiti:
- Boolean, se la chiave esiste, restituisce True, altrimenti restituisce False
rename
Rinomina la chiave in newkey.Quando la chiave è uguale a newkey o la chiave non esiste, viene restituito un errore.
1
2Redis.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.Quando la chiave non esiste, restituisce un errore.
1
2Boolean 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
Risultati restituiti:
- Boolean, quando la modifica ha esito positivo, restituisce True, se newkey esiste già, restituisce False
sub
Sottoscrive le informazioni di un determinato canale e chiama automaticamente func quando si verifica un messaggio. func contiene due parametri, canale e messaggio in ordine. La stessa funzione sullo stesso canale verrà richiamata solo una volta.
1
2Redis.sub(Buffer channel,
Function func);
Parametri di chiamata:
- channel:Buffer, specificare il nome del canale sottoscritto
- func: Funzione, specifica la funzione di callback
Abbonarsi alle informazioni di un determinato insieme di canali e richiamare automaticamente la funzione di richiamata corrispondente quando si verifica un messaggio. La stessa funzione sullo stesso canale verrà richiamata una sola volta.
1Redis.sub(Object map);
Parametri di chiamata:
- map: Oggetto, 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 tutte le richiamate per il canale specificato
1Redis.unsub(Buffer channel);
Parametri di chiamata:
- channel:Buffer, specifica il nome del canale da cui annullare l'iscrizione
La funzione di callback specificata per annullare l'iscrizione al canale specificato
1
2Redis.unsub(Buffer channel,
Function func);
Parametri di chiamata:
- channel:Buffer, specifica il nome del canale da cui annullare l'iscrizione
- func: Funzione, specifica la funzione di callback per l'annullamento della sottoscrizione
Annulla l'iscrizione a tutte le richiamate per un determinato set di canali
1Redis.unsub(Array channels);
Parametri di chiamata:
- channels: Array, specifica l'array di canali da cui annullare l'iscrizione
Funzione di richiamata specificata per annullare l'iscrizione a un determinato insieme di canali
1Redis.unsub(Object map);
Parametri di chiamata:
- map: Oggetto, 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
Iscriviti a un gruppo di informazioni sul canale in base al modello e chiama automaticamente func quando si verifica un messaggio. func contiene tre parametri, canale, messaggio e modello in ordine. La stessa funzione nello stesso modello verrà richiamata solo una volta.
1
2Redis.psub(String pattern,
Function func);
Parametri di chiamata:
- pattern: stringa, specifica il modello del canale sottoscritto
- func: Funzione, specifica la funzione di callback
Sottoscrivi le informazioni di un determinato set di modelli di canale e chiama automaticamente la funzione corrispondente quando si verifica un messaggio. La stessa funzione sullo stesso canale verrà richiamata una sola volta.
1Redis.psub(Object map);
Parametri di chiamata:
- map: Oggetto, specifica la relazione di mappatura del canale, il nome dell'attributo dell'oggetto verrà utilizzato come modello di canale e il valore dell'attributo verrà utilizzato come funzione di callback
unpsub
Annulla l'iscrizione a tutte le richiamate dal canale del modello specificato
1Redis.unpsub(String pattern);
Parametri di chiamata:
- pattern: stringa, specifica il modello del canale di annullamento dell'iscrizione
Funzione di callback specificata per annullare l'iscrizione al canale del modello specificato
1
2Redis.unpsub(String pattern,
Function func);
Parametri di chiamata:
- pattern: stringa, specifica il modello del canale di annullamento dell'iscrizione
- func: Funzione, specifica la funzione di callback per l'annullamento della sottoscrizione
Annulla l'iscrizione a tutte le richiamate per un insieme di canali con un determinato modello
1Redis.unpsub(Array patterns);
Parametri di chiamata:
- patterns: Array, specifica l'array del modello di canale pubblicato
Funzione di richiamata specificata per annullare l'iscrizione a un gruppo di canali modello
1Redis.unpsub(Object map);
Parametri di chiamata:
- map: Oggetto, specifica la relazione di mappatura del canale, il nome dell'attributo dell'oggetto verrà utilizzato come modello di canale e il valore dell'attributo verrà utilizzato come funzione di callback
pub
Invia un messaggio informativo al canale specificato
1
2Integer Redis.pub(Buffer channel,
Buffer message);
Parametri di chiamata:
- channel:Buffer, specificare il canale di pubblicazione
- message:Buffer, specificare il messaggio da pubblicare
Risultati restituiti:
- Integer, il numero di client che ricevono questo messaggio
getHash
Ottieni l'oggetto Hash della chiave specificata. Questo oggetto è il client contenente la chiave specificata. Solo chiamando il suo metodo sarà possibile utilizzare il database.
1RedisHash Redis.getHash(Buffer key);
Parametri di chiamata:
- key:Buffer, specificare la chiave da ottenere
Risultati restituiti:
- RedisHash, restituisce un oggetto Hash contenente la chiave specificata
getList
Ottieni l'oggetto List della chiave specificata. Questo oggetto è il client contenente la chiave specificata. Solo chiamando il suo metodo sarà possibile utilizzare il database.
1RedisList Redis.getList(Buffer key);
Parametri di chiamata:
- key:Buffer, specificare la chiave da ottenere
Risultati restituiti:
- RedisList, restituisce un oggetto List contenente la chiave specificata
getSet
Ottieni l'oggetto Set della chiave specificata. Questo oggetto è il client contenente la chiave specificata. Solo chiamando il suo metodo sarà possibile utilizzare il database.
1RedisSet Redis.getSet(Buffer key);
Parametri di chiamata:
- key:Buffer, specificare la chiave da ottenere
Risultati restituiti:
- RedisSet, restituisce un oggetto Set contenente la chiave specificata
getSortedSet
Ottieni l'oggetto SortedSet della chiave specificata. Questo oggetto è il client contenente la chiave specificata. Solo chiamando il suo metodo sarà possibile utilizzare il database.
1RedisSortedSet Redis.getSortedSet(Buffer key);
Parametri di chiamata:
- key:Buffer, specificare la chiave da ottenere
Risultati restituiti:
- RedisSortedSet, restituisce l'oggetto SortedSet contenente la chiave specificata
dump
Serializza la chiave specificata e restituisce il valore serializzato. Utilizza il comando di ripristino per deserializzare questo valore in una chiave Redis.
1Buffer Redis.dump(Buffer key);
Parametri di chiamata:
- key:Buffer, specificare la chiave da serializzare
Risultati restituiti:
- Buffer, restituisce il valore dopo la serializzazione, se la chiave non esiste, restituisce null
restore
Deserializzare il valore serializzato fornito e associarlo alla chiave specificata
1
2
3Redis.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: Lungo, imposta il tempo di sopravvivenza della chiave in millisecondi; se ttl è 0, allora il tempo di sopravvivenza non viene impostato
close
Chiude la connessione o transazione corrente al database
1Redis.close();
toString
Restituisce la rappresentazione in formato stringa dell'oggetto. Generalmente viene restituito "[Oggetto nativo]". L'oggetto può essere reimplementato in base alle proprie caratteristiche.
1String Redis.toString();
Risultati restituiti:
- String, restituisce la rappresentazione di stringa dell'oggetto
toJSON
Restituisce una rappresentazione in formato JSON dell'oggetto, generalmente restituendo una raccolta di proprietà leggibili definite dall'oggetto.
1Value Redis.toJSON(String key = "");
Parametri di chiamata:
- key: Stringa, non utilizzata
Risultati restituiti:
- Value, restituisce un valore contenente JSON serializzabile