Objekt eingebautes Objekt

Objekt Redis

Redis-Datenbank-Client-Objekt

Erstellen Sie folgende Methoden, um die Redis-Datenbank zu erstellen und zu verwalten:

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

Vererbung

Mitgliedsattribute

onsuberror

Funktion, Abfrage und Einstellung der Fehlerbehandlungsfunktion, Rückruf, wenn ein Unterfehler oder eine Netzwerkunterbrechung auftritt. Wenn der Rückruf auftritt, werden alle Unter dieses Objekts abgebrochen

1
Function Redis.onsuberror;

Mitgliedsfunktion

command

Redis grundlegende Befehlsmethoden

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

Parameter aufrufen:

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

Gibt das Ergebnis zurück:

  • 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 einen anderen Wert 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 , gibt die Buffer Daten an
  • ttl : Long, stellen Sie die Lebenszeit in Millisekunden als Schlüssel ein. Wenn ttl 0 ist, ist keine Lebenszeit

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 , gibt die Buffer Daten an
  • ttl : Long, stellen Sie die Lebenszeit in Millisekunden als Schlüssel ein. Wenn ttl 0 ist, ist keine Lebenszeit

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 , gibt die Buffer Daten an
  • ttl : Long, stellen Sie die Lebenszeit in Millisekunden als Schlüssel ein. Wenn ttl 0 ist, ist keine Lebenszeit

mset

Stellen Sie ein oder mehrere Schlüssel-Wert-Paare gleichzeitig ein. Wenn bereits ein bestimmter Schlüssel vorhanden ist, überschreibt MSET den 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 bereits ein bestimmter Schlüssel vorhanden ist, überschreibt MSET den alten Wert mit dem neuen Wert

1
Redis.mset(...kvs);

Parameter aufrufen:

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

msetNX

Legen Sie ein oder mehrere Schlüssel-Wert-Paare gleichzeitig fest, genau dann, 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 ein oder mehrere Schlüssel-Wert-Paare gleichzeitig fest, genau dann, 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 anzuhängenden Schlüssel an
  • value : Buffer , gibt die Buffer Daten an

Gibt das Ergebnis zurück:

  • Integer nach dem Anhängen des Werts die Länge der Zeichenfolge im Schlüssel

setRange

Überschreiben Sie den vom angegebenen Schlüssel gespeicherten Zeichenfolgenwert mit dem Parameter value, beginnend mit 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, gibt den geänderten Byte-Offset an
  • value : Buffer , gibt die zu überschreibenden Daten an

Gibt das Ergebnis zurück:

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

getRange

Gibt die Teilzeichenfolge des Zeichenfolgenwerts in key zurück. Der Kürzungsbereich der Zeichenfolge wird durch die 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, gibt den Startbyte-Offset der Abfrage an
  • end : Integer, gibt den Endbyte-Offset der Abfrage an

Gibt das Ergebnis zurück:

  • Buffer , abgefangener Teilstring

strlen

Gibt die Länge des vom Schlüssel gespeicherten Zeichenfolgenwerts zurück. Wenn key kein Zeichenfolgenwert ist, wird ein Fehler zurückgegeben

1
Integer Redis.strlen(Buffer key);

Parameter aufrufen:

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

Gibt das Ergebnis zurück:

  • 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 negative Werte 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

Gibt das Ergebnis zurück:

  • Integer , die Anzahl der auf 1 gesetzten Bits

get

Gibt den dem Schlüssel zugeordneten Zeichenfolgenwert oder 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

Gibt das Ergebnis zurück:

  • Buffer , gibt Null zurück, wenn der Schlüssel nicht vorhanden ist, 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 der Schlüssel den Sonderwert nil zurück.

1
NArray Redis.mget(Array keys);

Parameter aufrufen:

  • keys : Array, geben Sie das Array der abzufragenden keys an

Gibt das Ergebnis zurück:

  • NArray , eine Liste mit allen Werten für den angegebenen 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 der Schlüssel den Sonderwert nil zurück.

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

Parameter aufrufen:

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

Gibt das Ergebnis zurück:

  • NArray , eine Liste mit allen Werten für den angegebenen Schlüssel

getset

Setzt den Wert des angegebenen Schlüssels auf value und gibt den alten Wert des Schlüssels zurück

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

Parameter aufrufen:

  • key : Buffer , geben Sie den Schlüssel an, der abgefragt und geändert werden soll
  • value : Buffer , geben Sie den geänderten Wert an

Gibt das Ergebnis zurück:

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

decr

Subtrahiert den vom 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

Gibt das Ergebnis zurück:

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

incr

Erhöhen Sie den durch den Schlüssel gespeicherten Wert

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

Gibt das Ergebnis zurück:

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

setBit

Setzt oder löscht das Bit auf den angegebenen Versatz für den durch den 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, gibt den geänderten Bit-Offset an
  • value : Integer, geben Sie den Parameter an, der gesetzt oder gelöscht werden soll

Gibt das Ergebnis zurück:

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

getBit

Ruft das Bit mit dem angegebenen Versatz von dem im Schlüssel gespeicherten Zeichenfolgenwert ab

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

Gibt das Ergebnis zurück:

  • Integer , der Zeichenfolgenwert gibt das Bit am Offset an

exists

Überprüft, ob der angegebene Schlüssel vorhanden ist

1
Boolean Redis.exists(Buffer key);

Parameter aufrufen:

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

Gibt das Ergebnis zurück:

  • Boolean , gibt true zurück, wenn der Schlüssel vorhanden ist, andernfalls false

type

Gibt den Wertetyp zurück, der im Schlüssel gespeichert ist

1
String Redis.type(Buffer key);

Parameter aufrufen:

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

Gibt das Ergebnis zurück:

  • String , gibt den vom Schlüssel gespeicherten Werttyp zurück, mögliche Werte sind keine (Schlüssel existiert nicht) String (String) Liste (Liste) set (Set) 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 : String, gibt das Abfragemuster an

Gibt das Ergebnis zurück:

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

del

Löschen Sie einen oder mehrere vorgegebene Schlüssel. Nicht vorhandene Schlüssel werden ignoriert

1
Integer Redis.del(Array keys);

Parameter aufrufen:

  • keys : Array, geben Sie das Array der zu löschenden keys an

Gibt das Ergebnis zurück:

  • Integer , Anzahl der gelöschten Schlüssel

Löschen Sie einen oder mehrere vorgegebene Schlüssel. Nicht vorhandene Schlüssel werden ignoriert

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

Parameter aufrufen:

  • keys : ... gibt die Liste der zu löschenden keys an

Gibt das Ergebnis zurück:

  • Integer , Anzahl der gelöschten Schlüssel

expire

Legt die Lebensdauer eines bestimmten Schlüssels fest. Wenn ein 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 : ttl die Zeit für den Schlüssel in Millisekunden ein

Gibt das Ergebnis zurück:

  • Boolean , gibt true zurück, wenn der Schlüssel vorhanden ist, 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

Gibt das Ergebnis zurück:

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

persist

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

1
Boolean Redis.persist(Buffer key);

Parameter aufrufen:

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

Gibt das Ergebnis zurück:

  • Boolean , gibt true zurück, wenn der Schlüssel vorhanden ist, 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 , gibt den newkey 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 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 , gibt den newkey an, der umbenannt werden soll

Gibt das Ergebnis zurück:

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

sub

Abonnieren Sie die Informationen eines bestimmten Kanals. Func wird automatisch aufgerufen, wenn eine Nachricht auftritt. Func enthält zwei Parameter, Kanal und Nachricht. Die gleiche 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 Kanals an, den Sie abonnieren möchten
  • func : Funktion, Rückruffunktion angeben

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 desselben Kanals wird nur einmal zurückgerufen

1
Redis.sub(Object map);

Parameter aufrufen:

  • map : Object, gibt die Kanalzuordnungsbeziehung an, der Name der Objekteigenschaft wird als Kanalname verwendet und der Wert der Eigenschaft 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, gibt 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, geben Sie ein Array von nicht abonnierten Kanälen an

Abbestellen der angegebenen Rückruffunktion für einen bestimmten Satz von Kanälen

1
Redis.unsub(Object map);

Parameter aufrufen:

  • map : Object, gibt die Kanalzuordnungsbeziehung an, der Name der Objekteigenschaft wird als Kanalname verwendet und der Wert der Eigenschaft wird als Rückruffunktion verwendet

psub

Abonnieren Sie eine Reihe von Kanalinformationen gemäß der Vorlage. Func wird automatisch aufgerufen, wenn eine Nachricht auftritt. Func enthält drei Parameter: Kanal, Nachricht und Muster.

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

Parameter aufrufen:

  • pattern : String, die angegebene Kanalvorlage
  • func : Funktion, Rückruffunktion angeben

Abonnieren Sie die Informationen eines bestimmten Satzes von Kanalvorlagen und rufen Sie automatisch die entsprechende Funktion auf, wenn eine Nachricht auftritt. Dieselbe Funktion desselben Kanals wird nur einmal zurückgerufen

1
Redis.psub(Object map);

Parameter aufrufen:

  • map : Object, gibt die Kanalzuordnungsbeziehung an, der Name der Objekteigenschaft wird als Kanalvorlage verwendet und der Wert der Eigenschaft wird als Rückruffunktion verwendet

unpsub

Machen Sie alle Rückrufe für den Kanal der angegebenen Vorlage rückgängig

1
Redis.unpsub(String pattern);

Parameter aufrufen:

  • pattern : String, gibt die nicht abonnierte Kanalvorlage an

Die angegebene Rückruffunktion des Kanals, der sich von der angegebenen Vorlage abmeldet

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

Parameter aufrufen:

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

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

1
Redis.unpsub(Array patterns);

Parameter aufrufen:

  • patterns : Array, gibt ein Array von Kanalvorlagen an, die veröffentlicht werden sollen

Angegebene Rückruffunktion für Kanäle, die sich von einer Reihe von Vorlagen abmelden

1
Redis.unpsub(Object map);

Parameter aufrufen:

  • map : Object, gibt die Kanalzuordnungsbeziehung an, der Name der Objekteigenschaft wird als Kanalvorlage verwendet und der Wert der Eigenschaft 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 zu veröffentlichenden Kanal an
  • message : Buffer , geben Sie die Nachricht an, die gesendet werden soll

Gibt das Ergebnis zurück:

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

getHash

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

1
RedisHash Redis.getHash(Buffer key);

Parameter aufrufen:

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

Gibt das Ergebnis zurück:

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

getList

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

1
RedisList Redis.getList(Buffer key);

Parameter aufrufen:

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

Gibt das Ergebnis zurück:

  • RedisList gibt 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 ein Client, der den angegebenen Schlüssel enthält. Die Datenbank wird nur betrieben, wenn ihre Methode aufgerufen wird.

1
RedisSet Redis.getSet(Buffer key);

Parameter aufrufen:

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

Gibt das Ergebnis zurück:

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

getSortedSet

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

1
RedisSortedSet Redis.getSortedSet(Buffer key);

Parameter aufrufen:

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

Gibt das Ergebnis zurück:

  • RedisSortedSet gibt ein 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 , gibt den zu serialisierenden Schlüssel an

Gibt das Ergebnis zurück:

  • Buffer , geben Sie den serialisierten Wert zurück oder null, wenn der Schlüssel nicht vorhanden ist

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 , gibt den zu deserialisierenden Schlüssel an
  • data : Buffer , gibt die zu deserialisierenden Daten an
  • ttl : Long, stellen Sie die Lebenszeit in Millisekunden als Schlüssel ein. Wenn ttl 0 ist, ist keine Lebenszeit

close

Schließen Sie die aktuelle Datenbankverbindung oder Transaktion

1
Redis.close();

toString

Gibt eine Zeichenfolgendarstellung des Objekts zurück, normalerweise "[Native Object]". Objekte können gemäß ihren eigenen Merkmalen neu implementiert werden

1
String Redis.toString();

Gibt das Ergebnis zurück:

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

toJSON

Gibt eine JSON-Darstellung des Objekts zurück, die normalerweise eine Sammlung lesbarer Eigenschaften zurückgibt, die vom Objekt definiert wurden

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

Parameter aufrufen:

  • key : String, unbenutzt

Gibt das Ergebnis zurück:

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