Objekt eingebautes Objekt

Objekt Redis

Redis-Datenbank-Client-Objekt

Wird zum Erstellen und Verwalten der Redis-Datenbank verwendet: Die Erstellungsmethode:

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

Vererbung

Mitgliedsattribut

onsuberror

Funktion, Abfrage und Einstellung der Fehlerbehandlungsfunktion, Rückruf, wenn das Sub einen Fehler oder eine Netzwerkunterbrechung aufweist. Nach dem Rückruf werden alle Sub dieses Objekts abgebrochen

1
Function Redis.onsuberror;

Mitgliedsfunktion

command

Redis grundlegende Befehlsmethode

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

Parameter aufrufen:

  • cmd : String, geben Sie den gesendeten Befehl an
  • args : ..., geben Sie die gesendeten Parameter an

Ergebnis zurückgeben:

  • Value , gibt das vom Server zurückgegebene Ergebnis zurück

set

Verknüpfen Sie den Zeichenfolgenwert mit dem Schlüssel. Wenn der Schlüssel bereits andere Werte enthält, überschreibt SET den alten Wert unabhängig vom Typ

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

Parameter aufrufen:

  • key : Buffer , geben Sie den zuzuordnenden Schlüssel an
  • value : Buffer , geben Sie die zuzuordnenden Daten an
  • ttl : Lang, legen Sie die Überlebenszeit in Millisekunden als Schlüssel fest. Wenn ttl 0 ist, legen Sie die Überlebenszeit nicht fest

setNX

Setzen Sie den Wert des Schlüssels genau dann auf den Wert, wenn der Schlüssel nicht vorhanden ist. Wenn der angegebene Schlüssel bereits vorhanden ist, führt SETNX nichts aus.

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

Parameter aufrufen:

  • key : Buffer , geben Sie den zuzuordnenden Schlüssel an
  • value : Buffer , geben Sie die zuzuordnenden Daten an
  • ttl : Lang, legen Sie die Überlebenszeit in Millisekunden als Schlüssel fest. Wenn ttl 0 ist, legen Sie die Überlebenszeit nicht fest

setXX

Setzen Sie den Wert des Schlüssels auf Wert und setzen Sie den Schlüssel nur, wenn der Schlüssel bereits vorhanden ist.

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

Parameter aufrufen:

  • key : Buffer , geben Sie den zuzuordnenden Schlüssel an
  • value : Buffer , geben Sie die zuzuordnenden Daten an
  • ttl : Lang, legen Sie die Überlebenszeit in Millisekunden als Schlüssel fest. Wenn ttl 0 ist, legen Sie die Überlebenszeit nicht fest

mset

Stellen Sie ein oder mehrere Schlüssel-Wert-Paare gleichzeitig ein. Wenn ein bestimmter Schlüssel bereits vorhanden ist, überschreibt MSET den ursprünglichen alten Wert mit dem neuen Wert

1
Redis.mset(Object kvs);

Parameter aufrufen:

  • kvs : Objekt, geben Sie das zu kvs Schlüssel- / Wertobjekt an

Stellen Sie ein oder mehrere Schlüssel-Wert-Paare gleichzeitig ein. Wenn ein bestimmter Schlüssel bereits vorhanden ist, überschreibt MSET den ursprünglichen alten Wert mit dem neuen Wert

1
Redis.mset(...kvs);

Parameter aufrufen:

  • kvs : ... geben Sie die kvs Schlüssel- / kvs an

msetNX

Legen Sie genau dann ein oder mehrere Schlüssel-Wert-Paare gleichzeitig fest, wenn nicht alle angegebenen Schlüssel vorhanden sind

1
Redis.msetNX(Object kvs);

Parameter aufrufen:

  • kvs : Objekt, geben Sie das zu kvs 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

1
Redis.msetNX(...kvs);

Parameter aufrufen:

  • kvs : ... geben Sie die kvs Schlüssel- / kvs 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 2
Integer Redis.append(Buffer key, Buffer value);

Parameter aufrufen:

  • key : Buffer , geben Sie den Schlüssel an, der angehängt werden soll
  • value : Buffer , geben Sie die anzuhängenden Daten an

Ergebnis zurückgeben:

  • Integer , nach dem Hinzufügen von Wert, die Länge der Zeichenfolge im Schlüssel

setRange

Überschreiben Sie den im angegebenen Schlüssel gespeicherten Zeichenfolgenwert mit dem Parameter value, beginnend mit dem Offset

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

Parameter aufrufen:

  • key : Buffer , geben Sie den zu ändernden Schlüssel an
  • offset : Integer, geben Sie den geänderten Byte-Offset an
  • value : Buffer , geben Sie die zu überschreibenden Daten an

Ergebnis zurückgeben:

  • Integer , nach dem Ändern die Länge der Zeichenfolge

getRange

Gibt die Teilzeichenfolge des Zeichenfolgenwerts in key zurück. Der Abfangbereich der Zeichenfolge wird durch die beiden Offsets von Start und Ende (einschließlich Start und Ende) bestimmt.

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

Parameter aufrufen:

  • key : Buffer , geben Sie den abzufragenden Schlüssel an
  • start : Integer, geben Sie den Startbyte-Offset der Abfrage an
  • end : Integer, geben Sie den Endbyte-Offset der Abfrage an

Ergebnis zurückgeben:

  • Buffer , abgefangener Teilstring

strlen

Gibt die Länge des vom Schlüssel gespeicherten Zeichenfolgenwerts zurück. Wenn der Schlüssel keinen Zeichenfolgenwert speichert, wird ein Fehler zurückgegeben

1
Integer Redis.strlen(Buffer key);

Parameter aufrufen:

  • key : Buffer , geben Sie den zu berechnenden Schlüssel an

Ergebnis zurückgeben:

  • Integer , die Länge des Zeichenfolgenwerts. Wenn der Schlüssel nicht vorhanden ist, wird 0 zurückgegeben

bitcount

Zählen Sie die Anzahl der Bits, die in einer bestimmten Zeichenfolge auf 1 gesetzt sind

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

Parameter aufrufen:

  • key : Buffer , geben Sie den zu berechnenden Schlüssel an
  • start : Integer, geben Sie das zu berechnende Startbyte an, Sie können einen negativen Wert verwenden, -1 bedeutet das letzte Byte, -2 bedeutet das vorletzte Byte und so weiter
  • end : Integer, geben Sie das zu berechnende Endbyte an. Sie können einen negativen Wert verwenden. -1 bedeutet das letzte Byte, -2 bedeutet das vorletzte Byte und so weiter

Ergebnis zurückgeben:

  • Integer , die Anzahl der auf 1 gesetzten Bits

get

Gibt den dem Schlüssel zugeordneten Zeichenfolgenwert zurück oder gibt den Sonderwert Null zurück, wenn der Schlüssel nicht vorhanden ist

1
Buffer Redis.get(Buffer key);

Parameter aufrufen:

  • key : Buffer , geben Sie den zuzuordnenden Schlüssel an

Ergebnis zurückgeben:

  • Buffer , wenn der Schlüssel nicht existiert, geben Sie Null zurück, andernfalls geben Sie den Wert des Schlüssels zurück

mget

Gibt alle (einen oder mehrere) Werte des angegebenen Schlüssels zurück. Wenn im angegebenen Schlüssel kein Schlüssel vorhanden ist, gibt der Schlüssel den Sonderwert nil zurück.

1
NArray Redis.mget(Array keys);

Parameter aufrufen:

  • keys : Array, gibt das Schlüsselarray an, das abgefragt werden soll

Ergebnis zurückgeben:

  • NArray , eine Liste mit allen Werten des angegebenen Schlüssels

Gibt alle (einen oder mehrere) Werte des angegebenen Schlüssels zurück. Wenn im angegebenen Schlüssel kein Schlüssel vorhanden ist, gibt der Schlüssel den Sonderwert nil zurück.

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

Parameter aufrufen:

  • keys : ... geben Sie die Liste der keys an

Ergebnis zurückgeben:

  • NArray , eine Liste mit allen Werten des angegebenen Schlüssels

getset

Setzen Sie den Wert des angegebenen Schlüssels auf value und geben Sie den alten Wert des Schlüssels zurück

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

Parameter aufrufen:

  • key : Buffer , geben Sie den zu ändernden Schlüssel an
  • value : Buffer , geben Sie den geänderten Wert an

Ergebnis zurückgeben:

  • Buffer , gibt den alten Wert des angegebenen Schlüssels zurück

decr

Verringern Sie den durch den Schlüssel gespeicherten Wert

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

Parameter aufrufen:

  • key : Buffer , geben Sie den zu ändernden Schlüssel an
  • num : Long, geben Sie den zu subtrahierenden Wert an

Ergebnis zurückgeben:

  • Long nach dem Subtrahieren von num den Wert des Schlüssels

incr

Fügen Sie das Inkrement des durch den Schlüssel gespeicherten Werts hinzu

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

Parameter aufrufen:

  • key : Buffer , geben Sie den zu ändernden Schlüssel an
  • num : Long, geben Sie den Wert an, der hinzugefügt werden soll

Ergebnis zurückgeben:

  • Long nach dem Hinzufügen von num den Wert des Schlüssels

setBit

Setzen oder löschen Sie das Bit am angegebenen Versatz für den im Schlüssel gespeicherten Zeichenfolgenwert

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

Parameter aufrufen:

  • key : Buffer , geben Sie den zu ändernden Schlüssel an
  • offset : Integer, geben Sie den geänderten Bit-Offset an
  • value : Integer, geben Sie den Parameter an, der festgelegt oder gelöscht werden soll

Ergebnis zurückgeben:

  • Integer , geben Sie das Bit an, in dem der Offset ursprünglich gespeichert wurde

getBit

Holen Sie sich für den im Schlüssel gespeicherten Zeichenfolgenwert das Bit mit dem angegebenen Offset

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

Parameter aufrufen:

  • key : Buffer , geben Sie den abzufragenden Schlüssel an
  • offset : Integer, gibt den Bitoffset der Abfrage an

Ergebnis zurückgeben:

  • Integer , der Zeichenfolgenwert gibt das Bit am Offset an

exists

Überprüfen Sie, ob der angegebene Schlüssel vorhanden ist

1
Boolean Redis.exists(Buffer key);

Parameter aufrufen:

  • key : Buffer , geben Sie den zuzuordnenden Schlüssel an

Ergebnis zurückgeben:

  • Boolean , wenn der Schlüssel vorhanden ist, geben Sie True zurück, andernfalls False

type

Gibt den vom Schlüssel gespeicherten Werttyp zurück

1
String Redis.type(Buffer key);

Parameter aufrufen:

  • key : Buffer , geben Sie den abzufragenden Schlüssel an

Ergebnis zurückgeben:

  • String , gibt den vom Schlüssel gespeicherten Werttyp zurück, mögliche Werte sind keine (Schlüssel existiert nicht) String (String) Liste (Liste) set (Sammlung) zset (geordneter Satz) hash (Hash-Tabelle)

keys

Finden Sie alle Schlüssel, die dem angegebenen Muster entsprechen

1
NArray Redis.keys(String pattern);

Parameter aufrufen:

  • pattern : Zeichenfolge, geben Sie den Abfragemodus an

Ergebnis zurückgeben:

  • NArray , eine Liste von Schlüsseln, die dem angegebenen Muster entsprechen

del

Löschen Sie den oder die angegebenen Schlüssel. Nicht vorhandene Schlüssel werden ignoriert

1
Integer Redis.del(Array keys);

Parameter aufrufen:

  • keys : Array, gibt das zu löschende Schlüsselarray an

Ergebnis zurückgeben:

  • Integer , die Anzahl der gelöschten Schlüssel

Löschen Sie den oder die angegebenen Schlüssel. Nicht vorhandene Schlüssel werden ignoriert

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

Parameter aufrufen:

  • keys : ..., geben Sie die Liste der zu löschenden keys an

Ergebnis zurückgeben:

  • Integer , die Anzahl der gelöschten Schlüssel

expire

Legen Sie die Überlebenszeit für einen bestimmten Schlüssel fest. Wenn der Schlüssel abläuft, wird er automatisch gelöscht

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

Parameter aufrufen:

  • key : Buffer , geben Sie den einzustellenden Schlüssel an
  • ttl : Lang, legen Sie die Überlebenszeit in Millisekunden als Schlüssel fest

Ergebnis zurückgeben:

  • Boolean , wenn der Schlüssel vorhanden ist, geben Sie True zurück, andernfalls False

ttl

Gibt die verbleibende Lebensdauer für einen bestimmten Schlüssel zurück

1
Long Redis.ttl(Buffer key);

Parameter aufrufen:

  • key : Buffer , geben Sie den abzufragenden Schlüssel an

Ergebnis zurückgeben:

  • Long gibt in Millisekunden die verbleibende Lebensdauer des Schlüssels zurück. Wenn der Schlüssel nicht vorhanden ist, wird -2 zurückgegeben.

persist

Entfernen Sie die Überlebenszeit eines bestimmten Schlüssels und konvertieren Sie diesen Schlüssel von "flüchtig" (mit Überlebenszeitschlüssel) in "persistent" (ein Schlüssel ohne Überlebenszeit, der niemals abläuft).

1
Boolean Redis.persist(Buffer key);

Parameter aufrufen:

  • key : Buffer , geben Sie den einzustellenden Schlüssel an

Ergebnis zurückgeben:

  • Boolean , wenn der Schlüssel vorhanden ist, geben Sie True zurück, andernfalls False

rename

Benennen Sie den Schlüssel in newkey um. Wenn der Schlüssel und der newkey identisch sind oder der Schlüssel nicht vorhanden ist, wird ein Fehler zurückgegeben

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

Parameter aufrufen:

  • key : Buffer , geben Sie den Schlüssel an, der umbenannt werden soll
  • newkey : Buffer , geben Sie den Zielschlüssel an, der umbenannt werden soll

renameNX

Wenn und nur wenn kein neuer Schlüssel vorhanden ist, benennen Sie den Schlüssel in einen neuen Schlüssel um und geben Sie einen Fehler zurück, wenn der Schlüssel nicht vorhanden ist

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

Parameter aufrufen:

  • key : Buffer , geben Sie den Schlüssel an, der umbenannt werden soll
  • newkey : Buffer , geben Sie den Zielschlüssel an, der umbenannt werden soll

Ergebnis zurückgeben:

  • Boolean , True, wenn die Änderung erfolgreich ist, False, wenn der neue Schlüssel bereits vorhanden ist

sub

Abonnieren Sie die Informationen eines bestimmten Kanals und rufen Sie func automatisch auf, wenn die Nachricht auftritt. Func enthält zwei Parameter, Kanal und Nachricht, und dieselbe Funktion desselben Kanals wird nur einmal zurückgerufen

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

Parameter aufrufen:

  • channel : Buffer , geben Sie den Namen des abonnierten Kanals an
  • func : Funktion, geben Sie die Rückruffunktion an

Abonnieren Sie die Informationen einer bestimmten Gruppe von Kanälen und rufen Sie automatisch die entsprechende Rückruffunktion auf, wenn die Nachricht auftritt. Dieselbe Funktion desselben Kanals wird nur einmal zurückgerufen

1
Redis.sub(Object map);

Parameter aufrufen:

  • map : Object, gibt die Kanalzuordnungsbeziehung an, der Objekteigenschaftsname wird als Kanalname verwendet und der Eigenschaftswert wird als Rückruffunktion verwendet

unsub

Deaktivieren Sie alle Rückrufe für einen bestimmten Kanal

1
Redis.unsub(Buffer channel);

Parameter aufrufen:

  • channel : Buffer , geben Sie den Namen des nicht abonnierten Kanals an

Deaktivieren Sie die angegebene Rückruffunktion für den angegebenen Kanal

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

Parameter aufrufen:

  • channel : Buffer , geben Sie den Namen des nicht abonnierten Kanals an
  • func : Funktion, geben Sie die Rückruffunktion zum Abbestellen an

Deaktivieren Sie alle Rückrufe für einen bestimmten Satz von Kanälen

1
Redis.unsub(Array channels);

Parameter aufrufen:

  • channels : Array, gibt das nicht abonnierte Kanalarray an

Deaktivieren Sie die angegebene Rückruffunktion für einen bestimmten Satz von Kanälen

1
Redis.unsub(Object map);

Parameter aufrufen:

  • map : Object, gibt die Kanalzuordnungsbeziehung an, der Objekteigenschaftsname wird als Kanalname verwendet und der Eigenschaftswert wird als Rückruffunktion verwendet

psub

Abonnieren Sie eine Gruppe von Kanälen gemäß der Vorlage. Wenn eine Nachricht auftritt, wird func automatisch aufgerufen. Func enthält drei Parameter: Kanal, Nachricht und Muster.

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

Parameter aufrufen:

  • pattern : Zeichenfolge, geben Sie 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 die Nachricht auftritt.

1
Redis.psub(Object map);

Parameter aufrufen:

  • map : Object, gibt die Kanalzuordnungsbeziehung an, der Objektattributname wird als Kanalvorlage verwendet und der Attributwert wird als Rückruffunktion verwendet

unpsub

Deaktivieren Sie alle Rückrufe für Kanäle einer bestimmten Vorlage

1
Redis.unpsub(String pattern);

Parameter aufrufen:

  • pattern : String, geben Sie die nicht abonnierte Kanalvorlage an

Die angegebene Rückruffunktion zum Abbestellen des Kanals der angegebenen Vorlage

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

Parameter aufrufen:

  • pattern : String, geben Sie die nicht abonnierte Kanalvorlage an
  • func : Funktion, geben Sie die Rückruffunktion zum Abbestellen an

Deaktivieren Sie alle Rückrufe für eine Gruppe von Kanälen einer bestimmten Vorlage

1
Redis.unpsub(Array patterns);

Parameter aufrufen:

  • patterns : Array, Array angegebener Kanalvorlagen

Die angegebene Rückruffunktion zum Abbestellen einer Reihe von Vorlagenkanälen

1
Redis.unpsub(Object map);

Parameter aufrufen:

  • map : Object, gibt die Kanalzuordnungsbeziehung an, der Objektattributname wird als Kanalvorlage verwendet und der Attributwert wird als Rückruffunktion verwendet

pub

Nachricht an den angegebenen Kanal senden

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

Parameter aufrufen:

  • channel : Buffer , geben Sie den veröffentlichten Kanal an
  • message : Buffer , geben Sie die veröffentlichte Nachricht an

Ergebnis zurückgeben:

  • Integer , die Anzahl der Clients, die diese Nachricht empfangen

getHash

Ruft das Hash-Objekt des angegebenen Schlüssels ab. Dieses Objekt ist der Client, der den angegebenen Schlüssel enthält. Nur wenn seine Methode aufgerufen wird, wird die Datenbank betrieben.

1
RedisHash Redis.getHash(Buffer key);

Parameter aufrufen:

  • key : Buffer , geben Sie den abzurufenden Schlüssel an

Ergebnis zurückgeben:

  • RedisHash gibt das Hash-Objekt zurück, das den angegebenen Schlüssel enthält

getList

Ruft das List-Objekt des angegebenen Schlüssels ab. Dieses Objekt ist der Client, der den angegebenen Schlüssel enthält. Nur wenn seine Methode aufgerufen wird, wird die Datenbank betrieben.

1
RedisList Redis.getList(Buffer key);

Parameter aufrufen:

  • key : Buffer , geben Sie den abzurufenden Schlüssel an

Ergebnis zurückgeben:

  • RedisList , geben Sie ein List-Objekt zurück, das den angegebenen Schlüssel enthält

getSet

Ruft das Set-Objekt des angegebenen Schlüssels ab. Dieses Objekt ist der Client, der den angegebenen Schlüssel enthält. Nur wenn seine Methode aufgerufen wird, wird die Datenbank betrieben.

1
RedisSet Redis.getSet(Buffer key);

Parameter aufrufen:

  • key : Buffer , geben Sie den abzurufenden Schlüssel an

Ergebnis zurückgeben:

  • RedisSet gibt das Set-Objekt zurück, das den angegebenen Schlüssel enthält

getSortedSet

Ruft das SortedSet-Objekt des angegebenen Schlüssels ab. Dieses Objekt ist der Client, der den angegebenen Schlüssel enthält. Nur wenn seine Methode aufgerufen wird, wird die Datenbank betrieben.

1
RedisSortedSet Redis.getSortedSet(Buffer key);

Parameter aufrufen:

  • key : Buffer , geben Sie den abzurufenden Schlüssel an

Ergebnis zurückgeben:

  • RedisSortedSet gibt das SortedSet-Objekt zurück, das den angegebenen Schlüssel enthält

dump

Serialisieren Sie den angegebenen Schlüssel und geben Sie den serialisierten Wert zurück. Verwenden Sie den Befehl restore, um diesen Wert in einen Redis-Schlüssel zu deserialisieren

1
Buffer Redis.dump(Buffer key);

Parameter aufrufen:

  • key : Buffer , geben Sie den zu serialisierenden Schlüssel an

Ergebnis zurückgeben:

  • Buffer , geben Sie den Wert nach der Serialisierung zurück. Wenn der Schlüssel nicht vorhanden ist, geben Sie null zurück

restore

Deserialisieren Sie den angegebenen serialisierten Wert und ordnen Sie ihn dem angegebenen Schlüssel zu

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

Parameter aufrufen:

  • key : Buffer , geben Sie den Schlüssel an, der deserialisiert werden soll
  • data : Buffer , geben Sie die zu deserialisierenden Daten an
  • ttl : Lang, legen Sie die Überlebenszeit in Millisekunden als Schlüssel fest. Wenn ttl 0 ist, legen Sie die Überlebenszeit nicht fest

close

Schließen Sie die aktuelle Datenbankverbindung oder Transaktion

1
Redis.close();

toString

Gibt die Zeichenfolgendarstellung des Objekts zurück, gibt im Allgemeinen "[Native Object]" zurück. Das Objekt kann gemäß seinen eigenen Merkmalen neu implementiert werden

1
String Redis.toString();

Ergebnis zurückgeben:

  • String , gibt eine String-Darstellung des Objekts zurück

toJSON

Gibt die JSON-Darstellung des Objekts zurück und gibt im Allgemeinen eine Sammlung lesbarer Attribute zurück, die vom Objekt definiert wurden

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

Parameter aufrufen:

  • key : String, unbenutzt

Ergebnis zurückgeben:

  • Value , gibt einen Wert zurück, der serialisierbares JSON enthält