ObjectRedis
Redis-Datenbank-Clientobjekt
Wird zum Erstellen und Verwalten der Redis-Datenbank verwendet. Erstellungsmethode:
1
2var db = require("db");
var test = new db.openRedis("redis-server");
Erbschaftsverhältnis
Mitgliedereigenschaften
onsuberror
Funktion, Abfrage und Festlegung der Fehlerbehandlungsfunktion. Wenn das Sub einen Fehler hat oder das Netzwerk unterbrochen ist, wird es zurückgerufen. Wenn der Rückruf erfolgt, werden alle Subs dieses Objekts beendet.
1Function Redis.onsuberror;
Mitgliedsfunktion
command
Redis grundlegende Befehlsmethode
1
2Value Redis.command(String cmd,
...args);
Aufrufparameter:
- cmd: String, gibt den zu sendenden Befehl an
- args: ..., geben Sie die zu sendenden Parameter an
Rückgabeergebnisse:
- Value, gibt das vom Server zurückgegebene Ergebnis zurück
set
Ordnen Sie dem Schlüssel den Zeichenfolgenwert value zu. Wenn der Schlüssel bereits einen anderen Wert enthält, überschreibt SET den alten Wert, unabhängig vom Typ.
1
2
3Redis.set(Buffer key,
Buffer value,
Long ttl = 0);
Aufrufparameter:
- key:BufferGeben Sie den zuzuordnenden Schlüssel an
- value:BufferGeben Sie die zuzuordnenden Daten an
- ttl: Long, legt die Überlebenszeit des Schlüssels in Millisekunden fest; wenn ttl 0 ist, wird die Überlebenszeit nicht festgelegt
setNX
Setzen Sie den Wert von key genau dann auf value, wenn der Schlüssel nicht vorhanden ist. Wenn der angegebene Schlüssel bereits vorhanden ist, ergreift SETNX keine Aktion.
1
2
3Redis.setNX(Buffer key,
Buffer value,
Long ttl = 0);
Aufrufparameter:
- key:BufferGeben Sie den zuzuordnenden Schlüssel an
- value:BufferGeben Sie die zuzuordnenden Daten an
- ttl: Long, legt die Überlebenszeit des Schlüssels in Millisekunden fest; wenn ttl 0 ist, wird die Überlebenszeit nicht festgelegt
setXX
Setzen Sie den Wert von key auf value und legen Sie den Schlüssel nur fest, wenn der Schlüssel bereits vorhanden ist.
1
2
3Redis.setXX(Buffer key,
Buffer value,
Long ttl = 0);
Aufrufparameter:
- key:BufferGeben Sie den zuzuordnenden Schlüssel an
- value:BufferGeben Sie die zuzuordnenden Daten an
- ttl: Long, legt die Überlebenszeit des Schlüssels in Millisekunden fest; wenn ttl 0 ist, wird die Überlebenszeit nicht festgelegt
mset
Legen Sie ein oder mehrere Schlüssel-Wert-Paare gleichzeitig fest. Wenn ein bestimmter Schlüssel bereits vorhanden ist, überschreibt MSET den alten Wert mit dem neuen Wert.
1Redis.mset(Object kvs);
Aufrufparameter:
- kvs: Objekt, gibt das festzulegende Schlüssel-/Wertobjekt an
Legen Sie ein oder mehrere Schlüssel-Wert-Paare gleichzeitig fest. Wenn ein bestimmter Schlüssel bereits vorhanden ist, überschreibt MSET den alten Wert mit dem neuen Wert.
1Redis.mset(...kvs);
Aufrufparameter:
- kvs: ..., geben Sie die festzulegende Schlüssel-/Wertliste an
msetNX
Legen Sie genau dann ein oder mehrere Schlüssel-Wert-Paare gleichzeitig fest, wenn nicht alle angegebenen Schlüssel vorhanden sind
1Redis.msetNX(Object kvs);
Aufrufparameter:
- kvs: Objekt, gibt das festzulegende Schlüssel-/Wertobjekt an
Legen Sie genau dann ein oder mehrere Schlüssel-Wert-Paare gleichzeitig fest, wenn nicht alle angegebenen Schlüssel vorhanden sind
1Redis.msetNX(...kvs);
Aufrufparameter:
- kvs: ..., geben Sie die festzulegende Schlüssel-/Wertliste an
append
Wenn der Schlüssel bereits vorhanden ist und eine Zeichenfolge ist, hängt der Befehl „append“ den Wert an das Ende des ursprünglichen Werts des Schlüssels an. Wenn der Schlüssel nicht vorhanden ist, setzt append einfach den angegebenen Schlüssel auf value.
1
2Integer Redis.append(Buffer key,
Buffer value);
Aufrufparameter:
- key:BufferGeben Sie den Schlüssel an, der angehängt werden soll
- value:BufferGeben Sie die anzufügenden Daten an
Rückgabeergebnisse:
- Integer, nach dem Anhängen des Werts, die Länge der Zeichenfolge im Schlüssel
setRange
Verwenden Sie den Wertparameter, um den im angegebenen Schlüssel gespeicherten Zeichenfolgenwert zu überschreiben, beginnend mit dem Offset-Offset
1
2
3Integer Redis.setRange(Buffer key,
Integer offset,
Buffer value);
Aufrufparameter:
- key:BufferGeben Sie den zu ändernden Schlüssel an
- offset: Ganzzahl, gibt den geänderten Byte-Offset an
- value:BufferGeben Sie die zu überschreibenden Daten an
Rückgabeergebnisse:
- Integer, die Länge der Zeichenfolge nach der Änderung
getRange
Gibt den Teilstring des String-Werts im Schlüssel zurück. Der Abfangbereich des Strings wird durch die beiden Offsets von Start und Ende (einschließlich Start und Ende) bestimmt.
1
2
3Buffer Redis.getRange(Buffer key,
Integer start,
Integer end);
Aufrufparameter:
- key:BufferGeben Sie den Schlüssel an, der abgefragt werden soll
- start: Ganzzahl, gibt den Startbyte-Offset der Abfrage an
- end: Ganzzahl, gibt den Endbyte-Offset der Abfrage an
Rückgabeergebnisse:
- Buffer, den erhaltenen Teilstring abfangen
strlen
Gibt die Länge des im Schlüssel gespeicherten Zeichenfolgenwerts zurück. Wenn der Schlüssel einen anderen Wert als einen Zeichenfolgenwert speichert, wird ein Fehler zurückgegeben.
1Integer Redis.strlen(Buffer key);
Aufrufparameter:
- key:BufferGeben Sie den zu berechnenden Schlüssel an
Rückgabeergebnisse:
- Integer, die Länge des Zeichenfolgenwerts. Wenn der Schlüssel nicht vorhanden ist, geben Sie 0 zurück
bitcount
Zählt die Anzahl der Bits, die in der angegebenen Zeichenfolge auf 1 gesetzt sind
1
2
3Integer Redis.bitcount(Buffer key,
Integer start = 0,
Integer end = -1);
Aufrufparameter:
- key:BufferGeben Sie den zu berechnenden Schlüssel an
- start: Ganzzahl, gibt das zu berechnende Startbyte an, Sie können negative Werte verwenden, -1 stellt das letzte Byte dar, -2 stellt das vorletzte Byte dar und so weiter.
- end: Ganzzahl, gibt das zu berechnende Endbyte an, Sie können negative Werte verwenden, -1 stellt das letzte Byte dar, -2 stellt das vorletzte Byte dar und so weiter.
Rückgabeergebnisse:
- Integer, die Anzahl der auf 1 gesetzten Bits
get
Gibt den mit dem Schlüssel verknüpften Zeichenfolgenwert zurück. Wenn der Schlüssel nicht vorhanden ist, wird der Sonderwert Null zurückgegeben.
1Buffer Redis.get(Buffer key);
Aufrufparameter:
- key:BufferGeben Sie den zuzuordnenden Schlüssel an
Rückgabeergebnisse:
- BufferWenn der Schlüssel nicht vorhanden ist, wird Null zurückgegeben. Andernfalls wird der Wert des Schlüssels zurückgegeben
mget
Gibt alle (einen oder mehrere) Werte für den angegebenen Schlüssel zurück. Wenn im angegebenen Schlüssel kein Schlüssel vorhanden ist, gibt dieser Schlüssel den Sonderwert Null zurück.
1NArray Redis.mget(Array keys);
Aufrufparameter:
- keys: Array, gibt das abzufragende Schlüsselarray an
Rückgabeergebnisse:
- NArray, eine Liste mit allen Werten für einen bestimmten Schlüssel
Gibt alle (einen oder mehrere) Werte für den angegebenen Schlüssel zurück. Wenn im angegebenen Schlüssel kein Schlüssel vorhanden ist, gibt dieser Schlüssel den Sonderwert Null zurück.
1NArray Redis.mget(...keys);
Aufrufparameter:
- keys: ..., geben Sie die abzufragende Schlüsselliste an
Rückgabeergebnisse:
- NArray, eine Liste mit allen Werten für einen bestimmten Schlüssel
getset
Setzt den Wert des angegebenen Schlüssels auf value und gibt den alten Wert des Schlüssels zurück
1
2Buffer Redis.getset(Buffer key,
Buffer value);
Aufrufparameter:
- key:BufferGeben Sie den Schlüssel an, der abgefragt und geändert werden soll.
- value:BufferGeben Sie den geänderten Wert an
Rückgabeergebnisse:
- Buffer, gibt den alten Wert des angegebenen Schlüssels zurück
decr
Subtrahieren Sie das Dekrement vom im Schlüssel gespeicherten Wert
1
2Long Redis.decr(Buffer key,
Long num = 1);
Aufrufparameter:
- key:BufferGeben Sie den zu ändernden Schlüssel an
- num: Long, gibt den zu subtrahierenden Wert an
Rückgabeergebnisse:
- Long, nach Subtraktion von num, dem Wert des Schlüssels
incr
Addieren Sie das Inkrement zum im Schlüssel gespeicherten Wert
1
2Long Redis.incr(Buffer key,
Long num = 1);
Aufrufparameter:
- key:BufferGeben Sie den zu ändernden Schlüssel an
- num: Long, gibt den hinzuzufügenden Wert an
Rückgabeergebnisse:
- Long, nach dem Hinzufügen von num, dem Wert des Schlüssels
setBit
Setzen oder löschen Sie für den im Schlüssel gespeicherten Zeichenfolgenwert das Bit am angegebenen Offset.
1
2
3Integer Redis.setBit(Buffer key,
Integer offset,
Integer value);
Aufrufparameter:
- key:BufferGeben Sie den zu ändernden Schlüssel an
- offset: Ganzzahl, gibt den geänderten Bit-Offset an
- value: Ganzzahl, gibt den zu setzenden oder zu löschenden Parameter an, der 0 oder 1 sein kann
Rückgabeergebnisse:
- Integer, gibt das Bit an, in dem der Offset ursprünglich gespeichert wurde
getBit
Rufen Sie für den im Schlüssel gespeicherten Zeichenfolgenwert das Bit am angegebenen Offset ab
1
2Integer Redis.getBit(Buffer key,
Integer offset);
Aufrufparameter:
- key:BufferGeben Sie den Schlüssel an, der abgefragt werden soll
- offset: Ganzzahl, gibt den Bit-Offset der Abfrage an
Rückgabeergebnisse:
- Integer, der String-Wert gibt das Bit am Offset an
exists
Überprüfen Sie, ob der angegebene Schlüssel existiert
1Boolean Redis.exists(Buffer key);
Aufrufparameter:
- key:BufferGeben Sie den zuzuordnenden Schlüssel an
Rückgabeergebnisse:
- Boolean, wenn der Schlüssel vorhanden ist, geben Sie True zurück, andernfalls geben Sie False zurück
type
Gibt den im Schlüssel gespeicherten Werttyp zurück
1String Redis.type(Buffer key);
Aufrufparameter:
- key:BufferGeben Sie den Schlüssel an, der abgefragt werden soll
Rückgabeergebnisse:
- String, gibt den Typ des im Schlüssel gespeicherten Werts zurück. Mögliche Werte sind none (Schlüssel existiert nicht) string (string) list (list) set (set) zset (ordered set)hash(Hash-tabelle)
keys
Finden Sie alle Schlüssel, die dem angegebenen Muster entsprechen
1NArray Redis.keys(String pattern);
Aufrufparameter:
- pattern: String, Abfragemodus angeben
Rückgabeergebnisse:
- NArray, eine Liste von Schlüsseln, die dem angegebenen Muster entsprechen
del
Löschen Sie einen oder mehrere angegebene Schlüssel. Nicht vorhandene Schlüssel werden ignoriert.
1Integer Redis.del(Array keys);
Aufrufparameter:
- keys: Array, gibt das zu löschende Schlüsselarray an
Rückgabeergebnisse:
- Integer, die Anzahl der gelöschten Schlüssel
Löschen Sie einen oder mehrere angegebene Schlüssel. Nicht vorhandene Schlüssel werden ignoriert.
1Integer Redis.del(...keys);
Aufrufparameter:
- keys: ..., geben Sie die zu löschende Schlüsselliste an
Rückgabeergebnisse:
- Integer, die Anzahl der gelöschten Schlüssel
expire
Legen Sie die Lebensdauer für einen bestimmten Schlüssel fest. Wenn der Schlüssel abläuft, wird er automatisch gelöscht.
1
2Boolean Redis.expire(Buffer key,
Long ttl);
Aufrufparameter:
- key:BufferGeben Sie den festzulegenden Schlüssel an
- ttl: Lang, legen Sie die Überlebenszeit des Schlüssels in Millisekunden fest
Rückgabeergebnisse:
- Boolean, wenn der Schlüssel vorhanden ist, geben Sie True zurück, andernfalls geben Sie False zurück
ttl
Gibt die verbleibende Überlebenszeit des angegebenen Schlüssels zurück
1Long Redis.ttl(Buffer key);
Aufrufparameter:
- key:BufferGeben Sie den Schlüssel an, der abgefragt werden soll
Rückgabeergebnisse:
- Long, gibt die verbleibende Überlebenszeit des Schlüssels in Millisekunden zurück. Wenn der Schlüssel nicht vorhanden ist, wird -2 zurückgegeben. Wenn der Schlüssel vorhanden ist, aber die verbleibende Überlebenszeit nicht festgelegt ist, wird -1 zurückgegeben.
persist
Entfernen Sie die Lebensdauer eines bestimmten Schlüssels und konvertieren Sie diesen Schlüssel von „flüchtig“ (Schlüssel mit Lebensdauer) in „persistent“ (ein Schlüssel ohne Lebensdauer, der nie abläuft).
1Boolean Redis.persist(Buffer key);
Aufrufparameter:
- key:BufferGeben Sie den festzulegenden Schlüssel an
Rückgabeergebnisse:
- Boolean, wenn der Schlüssel vorhanden ist, geben Sie True zurück, andernfalls geben Sie False zurück
rename
Benennen Sie den Schlüssel in „newkey“ um. Wenn der Schlüssel mit „newkey“ übereinstimmt oder nicht vorhanden ist, wird ein Fehler zurückgegeben.
1
2Redis.rename(Buffer key,
Buffer newkey);
Aufrufparameter:
- key:BufferGeben Sie den Schlüssel an, der umbenannt werden soll
- newkey:BufferGeben Sie den Zielschlüssel an, der umbenannt werden soll
renameNX
Nur wenn newkey nicht vorhanden ist, benennen Sie den Schlüssel in newkey um. Wenn der Schlüssel nicht vorhanden ist, wird ein Fehler zurückgegeben.
1
2Boolean Redis.renameNX(Buffer key,
Buffer newkey);
Aufrufparameter:
- key:BufferGeben Sie den Schlüssel an, der umbenannt werden soll
- newkey:BufferGeben Sie den Zielschlüssel an, der umbenannt werden soll
Rückgabeergebnisse:
- BooleanWenn die Änderung erfolgreich ist, geben Sie True zurück. Wenn der neue Schlüssel bereits vorhanden ist, geben Sie False zurück
sub
Abonnieren Sie die Informationen eines bestimmten Kanals und rufen Sie automatisch func auf, wenn eine Nachricht auftritt. func enthält zwei Parameter, Kanal und Nachricht, der Reihe nach. Dieselbe Funktion auf demselben Kanal wird nur einmal zurückgerufen.
1
2Redis.sub(Buffer channel,
Function func);
Aufrufparameter:
- channel:BufferGeben Sie den Namen des abonnierten Kanals an
- func: Funktion, geben Sie die Rückruffunktion an
Abonnieren Sie die Informationen eines bestimmten Satzes von Kanälen und rufen Sie automatisch die entsprechende Rückruffunktion auf, wenn eine Nachricht auftritt. Dieselbe Funktion auf demselben Kanal wird nur einmal aufgerufen.
1Redis.sub(Object map);
Aufrufparameter:
- map: Objekt, gibt die Kanalzuordnungsbeziehung an, der Objektattributname wird als Kanalname und der Wert des Attributs als Rückruffunktion verwendet
unsub
Alle Rückrufe für den angegebenen Kanal abbestellen
1Redis.unsub(Buffer channel);
Aufrufparameter:
- channel:BufferGeben Sie den Namen des Kanals an, von dem Sie sich abmelden möchten
Die angegebene Rückruffunktion zum Abbestellen des angegebenen Kanals
1
2Redis.unsub(Buffer channel,
Function func);
Aufrufparameter:
- channel:BufferGeben Sie den Namen des Kanals an, von dem Sie sich abmelden möchten
- func: Funktion, spezifiziert die Callback-Funktion zur Abmeldung
Alle Rückrufe für eine bestimmte Gruppe von Kanälen abbestellen
1Redis.unsub(Array channels);
Aufrufparameter:
- channels: Array, gibt das Kanal-Array an, von dem abgemeldet werden soll
Spezifizierte Rückruffunktion zum Abmelden von einer bestimmten Gruppe von Kanälen
1Redis.unsub(Object map);
Aufrufparameter:
- map: Objekt, gibt die Kanalzuordnungsbeziehung an, der Objektattributname wird als Kanalname und der Wert des Attributs als Rückruffunktion verwendet
psub
Abonnieren Sie eine Gruppe von Kanalinformationen gemäß der Vorlage und rufen Sie automatisch func auf, wenn eine Nachricht auftritt. func enthält drei Parameter: Kanal, Nachricht und Muster der Reihe nach. Dieselbe Funktion in derselben Vorlage wird nur einmal zurückgerufen.
1
2Redis.psub(String pattern,
Function func);
Aufrufparameter:
- pattern: String, gibt die abonnierte Kanalvorlage an
- func: Funktion, geben Sie die Rückruffunktion an
Abonnieren Sie die Informationen eines bestimmten Satzes von Kanalvorlagen und rufen Sie automatisch die entsprechende Funktion auf, wenn eine Nachricht auftritt. Dieselbe Funktion auf demselben Kanal wird nur einmal zurückgerufen.
1Redis.psub(Object map);
Aufrufparameter:
- map: Objekt, gibt die Kanalzuordnungsbeziehung an, der Objektattributname wird als Kanalvorlage und der Attributwert als Rückruffunktion verwendet
unpsub
Alle Rückrufe vom Kanal der angegebenen Vorlage abbestellen
1Redis.unpsub(String pattern);
Aufrufparameter:
- pattern: String, geben Sie die Kanalabmeldevorlage an
Angegebene Rückruffunktion zum Abmelden vom Kanal der angegebenen Vorlage
1
2Redis.unpsub(String pattern,
Function func);
Aufrufparameter:
- pattern: String, geben Sie die Kanalabmeldevorlage an
- func: Funktion, spezifiziert die Callback-Funktion zur Abmeldung
Alle Rückrufe für eine Reihe von Kanälen mit einer bestimmten Vorlage abbestellen
1Redis.unpsub(Array patterns);
Aufrufparameter:
- patterns: Array, gibt das veröffentlichte Kanalvorlagen-Array an
Spezifizierte Rückruffunktion zum Abmelden von einer Gruppe von Vorlagenkanälen
1Redis.unpsub(Object map);
Aufrufparameter:
- map: Objekt, gibt die Kanalzuordnungsbeziehung an, der Objektattributname wird als Kanalvorlage und der Attributwert als Rückruffunktion verwendet
pub
Informationsnachricht an den angegebenen Kanal senden
1
2Integer Redis.pub(Buffer channel,
Buffer message);
Aufrufparameter:
- channel:BufferGeben Sie den Veröffentlichungskanal an
- message:BufferGeben Sie die zu veröffentlichende Nachricht an
Rückgabeergebnisse:
- Integer, die Anzahl der Clients, die diese Nachricht erhalten
getHash
Holen Sie sich das Hash-Objekt des angegebenen Schlüssels. Dieses Objekt ist der Client, der den angegebenen Schlüssel enthält. Nur durch Aufrufen seiner Methode wird die Datenbank betrieben.
1RedisHash Redis.getHash(Buffer key);
Aufrufparameter:
- key:BufferGeben Sie den zu erhaltenden Schlüssel an
Rückgabeergebnisse:
- RedisHash, gibt ein Hash-Objekt zurück, das den angegebenen Schlüssel enthält
getList
Rufen Sie das Listenobjekt des angegebenen Schlüssels ab. Dieses Objekt ist der Client, der den angegebenen Schlüssel enthält. Nur durch Aufrufen seiner Methode wird die Datenbank bedient.
1RedisList Redis.getList(Buffer key);
Aufrufparameter:
- key:BufferGeben Sie den zu erhaltenden Schlüssel an
Rückgabeergebnisse:
- RedisList, gibt ein List-Objekt zurück, das den angegebenen Schlüssel enthält
getSet
Rufen Sie das Set-Objekt des angegebenen Schlüssels ab. Dieses Objekt ist der Client, der den angegebenen Schlüssel enthält. Nur durch Aufrufen seiner Methode wird die Datenbank bedient.
1RedisSet Redis.getSet(Buffer key);
Aufrufparameter:
- key:BufferGeben Sie den zu erhaltenden Schlüssel an
Rückgabeergebnisse:
- RedisSet, gibt ein Set-Objekt zurück, das den angegebenen Schlüssel enthält
getSortedSet
Rufen Sie das SortedSet-Objekt des angegebenen Schlüssels ab. Dieses Objekt ist der Client, der den angegebenen Schlüssel enthält. Nur durch Aufrufen seiner Methode wird die Datenbank betrieben.
1RedisSortedSet Redis.getSortedSet(Buffer key);
Aufrufparameter:
- key:BufferGeben Sie den zu erhaltenden Schlüssel an
Rückgabeergebnisse:
- RedisSortedSet, gibt das SortedSet-Objekt zurück, das den angegebenen Schlüssel enthält
dump
Serialisiert den angegebenen Schlüssel und gibt den serialisierten Wert zurück. Verwenden Sie den Wiederherstellungsbefehl, um diesen Wert in einen Redis-Schlüssel zu deserialisieren.
1Buffer Redis.dump(Buffer key);
Aufrufparameter:
- key:BufferGeben Sie den zu serialisierenden Schlüssel an
Rückgabeergebnisse:
- Buffer, gibt den Wert nach der Serialisierung zurück. Wenn der Schlüssel nicht vorhanden ist, wird null zurückgegeben
restore
Deserialisieren Sie den angegebenen serialisierten Wert und verknüpfen Sie ihn mit dem angegebenen Schlüssel
1
2
3Redis.restore(Buffer key,
Buffer data,
Long ttl = 0);
Aufrufparameter:
- key:BufferGeben Sie den Schlüssel an, der deserialisiert werden soll
- data:BufferGeben Sie die Daten an, die deserialisiert werden sollen
- ttl: Long, legt die Überlebenszeit des Schlüssels in Millisekunden fest; wenn ttl 0 ist, wird die Überlebenszeit nicht festgelegt
close
Schließen Sie die aktuelle Datenbankverbindung oder Transaktion
1Redis.close();
toString
Gibt die Zeichenfolgendarstellung des Objekts zurück. Im Allgemeinen wird „[Native Object]“ zurückgegeben. Das Objekt kann gemäß seinen eigenen Eigenschaften neu implementiert werden.
1String Redis.toString();
Rückgabeergebnisse:
- String, gibt die Zeichenfolgendarstellung des Objekts zurück
toJSON
Gibt eine Darstellung des Objekts im JSON-Format zurück und gibt im Allgemeinen eine Sammlung lesbarer Eigenschaften zurück, die vom Objekt definiert werden.
1Value Redis.toJSON(String key = "");
Aufrufparameter:
- key: Zeichenfolge, nicht verwendet
Rückgabeergebnisse:
- Value, gibt einen Wert zurück, der JSON serialisierbar enthält