Objet objet intégré

Objet Redis

Objet client de base de données Redis

Utilisé pour créer et gérer la base de données Redis, méthode de création:

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

Héritage

Attributs des membres

onsuberror

Fonction, interroger et définir la fonction de gestion des erreurs, rappeler lorsque la sous-erreur se produit ou que le réseau est interrompu, lorsque le rappel se produit, tous les sous de cet objet s'arrêteront

1
Function Redis.onsuberror;

Fonction membre

command

Méthode de commande de base Redis

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

Paramètres d'appel:

  • cmd : String, spécifiez la commande envoyée
  • args : ..., spécifiez les paramètres envoyés

Résultat de retour:

  • Value , renvoie le résultat renvoyé par le serveur

set

Associez la valeur de la chaîne à la clé, si la clé contient déjà d'autres valeurs, SET écrase l'ancienne valeur, quel que soit le type

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à associer
  • value : Buffer , spécifiez les données à associer
  • ttl : Long, définissez le temps de survie de la clé en millisecondes; si ttl est égal à 0, ne définissez pas le temps de survie

setNX

Définissez la valeur de la clé sur valeur si et seulement si la clé n'existe pas. Si la clé donnée existe déjà, SETNX ne fait rien.

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à associer
  • value : Buffer , spécifiez les données à associer
  • ttl : Long, définissez le temps de survie de la clé en millisecondes; si ttl est égal à 0, ne définissez pas le temps de survie

setXX

Définissez la valeur de la clé sur valeur et définissez la clé uniquement lorsque la clé existe déjà.

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à associer
  • value : Buffer , spécifiez les données à associer
  • ttl : Long, définissez le temps de survie de la clé en millisecondes; si ttl est égal à 0, ne définissez pas le temps de survie

mset

Définissez une ou plusieurs paires clé-valeur en même temps. Si une clé donnée existe déjà, MSET écrasera l'ancienne valeur par la nouvelle valeur

1
Redis.mset(Object kvs);

Paramètres d'appel:

  • kvs : Object, spécifiez l'objet clé / valeur à définir

Définissez une ou plusieurs paires clé-valeur en même temps. Si une clé donnée existe déjà, MSET écrasera l'ancienne valeur par la nouvelle valeur

1
Redis.mset(...kvs);

Paramètres d'appel:

  • kvs : ..., spécifiez la liste clé / valeur à définir

msetNX

Définissez une ou plusieurs paires clé-valeur en même temps, si et seulement si toutes les clés données n'existent pas

1
Redis.msetNX(Object kvs);

Paramètres d'appel:

  • kvs : Object, spécifiez l'objet clé / valeur à définir

Définissez une ou plusieurs paires clé-valeur en même temps, si et seulement si toutes les clés données n'existent pas

1
Redis.msetNX(...kvs);

Paramètres d'appel:

  • kvs : ..., spécifiez la liste clé / valeur à définir

append

Si la clé existe déjà et est une chaîne, la commande append ajoute la valeur à la fin de la valeur d'origine de la clé. Si la clé n'existe pas, ajouter définit simplement la clé donnée à valeur

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à ajouter
  • value : Buffer , spécifiez les données à ajouter

Résultat de retour:

  • Integer , après avoir ajouté la valeur, la longueur de la chaîne dans la clé

setRange

Utilisez le paramètre value pour remplacer la valeur de chaîne stockée dans la clé donnée, en commençant par le décalage de décalage

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à modifier
  • offset : Entier, spécifiez le décalage d'octet modifié
  • value : Buffer , spécifiez les données à écraser

Résultat de retour:

  • Integer , après avoir été modifié, la longueur de la chaîne

getRange

Renvoie la sous-chaîne de la valeur de chaîne dans la clé. La plage d'interception de la chaîne est déterminée par les deux décalages de début et de fin (y compris le début et la fin)

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à interroger
  • start : Integer, spécifiez le décalage d'octet de début de la requête
  • end : Integer, spécifiez le décalage d'octet de fin de la requête

Résultat de retour:

  • Buffer , intercepte la sous-chaîne

strlen

Renvoie la longueur de la valeur de chaîne stockée dans key. Lorsque la clé n'est pas une valeur de chaîne, une erreur est renvoyée

1
Integer Redis.strlen(Buffer key);

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à calculer

Résultat de retour:

  • Integer , la longueur de la valeur de chaîne. Lorsque la clé n'existe pas, renvoie 0

bitcount

Compter le nombre de bits mis à 1 dans une chaîne donnée

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à calculer
  • start : Entier, spécifiez l'octet de départ à calculer, des valeurs négatives peuvent être utilisées, -1 signifie le dernier octet et -2 signifie l'avant-dernier octet, et ainsi de suite
  • end : Entier, spécifiez l'octet de fin à calculer, des valeurs négatives peuvent être utilisées, -1 signifie le dernier octet et -2 signifie l'avant-dernier octet, et ainsi de suite

Résultat de retour:

  • Integer , le nombre de bits mis à 1

get

Renvoie la valeur de chaîne associée à la clé, si la clé n'existe pas, renvoie la valeur spéciale Null

1
Buffer Redis.get(Buffer key);

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à associer

Résultat de retour:

  • Buffer , lorsque la clé n'existe pas, retourne Null, sinon retourne la valeur de la clé

mget

Renvoie toutes (une ou plusieurs) valeurs de la clé donnée. Si une clé n'existe pas dans la clé donnée, cette clé renvoie la valeur spéciale nil.

1
NArray Redis.mget(Array keys);

Paramètres d'appel:

  • keys : Array, spécifiez le tableau de clés à interroger

Résultat de retour:

  • NArray , une liste contenant toutes les valeurs d'une clé donnée

Renvoie toutes (une ou plusieurs) valeurs de la clé donnée. Si une clé n'existe pas dans la clé donnée, cette clé renvoie la valeur spéciale nil.

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

Paramètres d'appel:

  • keys : ..., spécifiez la liste des keys à interroger

Résultat de retour:

  • NArray , une liste contenant toutes les valeurs d'une clé donnée

getset

Définissez la valeur de la clé donnée sur valeur et renvoyez l'ancienne valeur de la clé (ancienne valeur)

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à interroger et à modifier
  • value : Buffer , spécifiez la valeur modifiée

Résultat de retour:

  • Buffer , retourne l'ancienne valeur de la clé donnée

decr

Soustraire le décrément de la valeur stockée dans la clé

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à modifier
  • num : Long, spécifiez la valeur à soustraire

Résultat de retour:

  • Long , après avoir soustrait num, la valeur de la clé

incr

Ajouter l'incrément à la valeur stockée dans la clé

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à modifier
  • num : Long, spécifiez la valeur à ajouter

Résultat de retour:

  • Long , après avoir ajouté num, la valeur de la clé

setBit

Pour la valeur de chaîne stockée dans key, définissez ou effacez le bit au décalage spécifié (bit)

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à modifier
  • offset : Entier, spécifiez le décalage de bits pour la modification
  • value : Entier, spécifie le paramètre à définir ou à effacer, peut être 0 ou 1

Résultat de retour:

  • Integer , spécifiez le bit stocké d'origine du décalage

getBit

Récupère le bit au décalage spécifié pour la valeur de chaîne stockée dans la clé

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à interroger
  • offset : Entier, spécifiez le décalage en bits de la requête

Résultat de retour:

  • Integer , le bit à l'offset spécifié de la valeur de chaîne (bit)

exists

Vérifiez si la clé donnée existe

1
Boolean Redis.exists(Buffer key);

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à associer

Résultat de retour:

  • Boolean , si la clé existe, renvoie True, sinon renvoie False

type

Renvoie le type de valeur stockée dans la clé

1
String Redis.type(Buffer key);

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à interroger

Résultat de retour:

  • String , renvoie le type de la valeur stockée par la clé, la valeur possible est aucune (la clé n'existe pas) string (chaîne) liste (liste) set (collection) zset (ensemble ordonné) hash (table de hachage)

keys

Trouvez toutes les clés qui correspondent au modèle donné

1
NArray Redis.keys(String pattern);

Paramètres d'appel:

  • pattern : chaîne, spécifiez le modèle de requête

Résultat de retour:

  • NArray , une liste de clés correspondant au modèle donné

del

Supprimer une ou plusieurs clés données, les clés inexistantes seront ignorées

1
Integer Redis.del(Array keys);

Paramètres d'appel:

  • keys : tableau, spécifiez le tableau de clés à supprimer

Résultat de retour:

  • Integer , le nombre de clés supprimées

Supprimer une ou plusieurs clés données, les clés inexistantes seront ignorées

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

Paramètres d'appel:

  • keys : ..., spécifiez la liste de clés à supprimer

Résultat de retour:

  • Integer , le nombre de clés supprimées

expire

Définissez la durée de vie d'une clé donnée, lorsque la clé expire, elle sera automatiquement supprimée

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à définir
  • ttl : Long, définissez le temps de survie de la clé en millisecondes

Résultat de retour:

  • Boolean , si la clé existe, renvoie True, sinon renvoie False

ttl

Renvoie le temps de survie restant de la clé donnée

1
Long Redis.ttl(Buffer key);

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à interroger

Résultat de retour:

  • Long , renvoie la Long survie restante de la clé en millisecondes. Lorsque la clé n'existe pas, elle renvoie -2. Lorsque la clé existe mais que la durée de survie restante n'est pas définie, elle renvoie -1

persist

Supprimez la durée de vie d'une clé donnée et convertissez cette clé de "volatile" (avec clé à vie) à "persistante" (une clé sans durée de vie et n'expire jamais)

1
Boolean Redis.persist(Buffer key);

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à définir

Résultat de retour:

  • Boolean , si la clé existe, renvoie True, sinon renvoie False

rename

Renommez la clé en newkey. Lorsque la clé et la nouvelle clé sont identiques ou que la clé n'existe pas, une erreur est renvoyée

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à renommer
  • newkey : Buffer , spécifiez la clé de destination à renommer

renameNX

Si et seulement si newkey n'existe pas, renommez la clé en newkey et renvoyez une erreur lorsque la clé n'existe pas

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à renommer
  • newkey : Buffer , spécifiez la clé de destination à renommer

Résultat de retour:

  • Boolean , lorsque la modification est réussie, elle renvoie True, si la nouvelle clé existe déjà, elle retourne False

sub

Abonnez-vous aux informations d'un canal donné et appelez automatiquement func lorsqu'un message se produit. Func contient deux paramètres, canal et message tour à tour. La même fonction sur le même canal ne sera rappelée qu'une seule fois

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

Paramètres d'appel:

  • channel : Buffer , spécifiez le nom du canal abonné
  • func : Function, spécifiez la fonction de rappel

Abonnez-vous aux informations d'un ensemble de canaux donné et appelez automatiquement la fonction de rappel correspondante lorsqu'un message se produit. La même fonction du même canal ne sera rappelée qu'une seule fois

1
Redis.sub(Object map);

Paramètres d'appel:

  • map : Objet, spécifiez la relation de mappage de canal, le nom d'attribut d'objet sera le nom de canal et la valeur d'attribut sera la fonction de rappel

unsub

Se désabonner de tous les rappels d'une chaîne donnée

1
Redis.unsub(Buffer channel);

Paramètres d'appel:

  • channel : Buffer , spécifiez le nom du canal désabonné

Se désabonner de la fonction de rappel spécifiée du canal donné

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

Paramètres d'appel:

  • channel : Buffer , spécifiez le nom du canal désabonné
  • func : Function, spécifiez la fonction de rappel pour la désinscription

Se désabonner de tous les rappels pour une chaîne donnée

1
Redis.unsub(Array channels);

Paramètres d'appel:

  • channels : tableau, spécifiez le tableau de canaux désabonné

Se désabonner de la fonction de rappel spécifiée d'un ensemble donné de canaux

1
Redis.unsub(Object map);

Paramètres d'appel:

  • map : Objet, spécifiez la relation de mappage de canal, le nom d'attribut d'objet sera le nom de canal et la valeur d'attribut sera la fonction de rappel

psub

Abonnez-vous aux informations d'un groupe de canaux selon le modèle et appelez automatiquement func lorsqu'un message apparaît. Func contient trois paramètres, qui sont tour à tour canal, message et modèle. La même fonction du même modèle ne sera rappelée qu'une seule fois

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

Paramètres d'appel:

  • pattern : String, spécifiez le modèle de canal abonné
  • func : Function, spécifiez la fonction de rappel

Abonnez-vous aux informations d'un ensemble donné de modèles de canaux et appelez automatiquement la fonction correspondante lorsqu'un message apparaît. La même fonction sur le même canal ne sera rappelée qu'une seule fois

1
Redis.psub(Object map);

Paramètres d'appel:

  • map : objet, spécifiez la relation de mappage de canal, le nom d'attribut d'objet sera utilisé comme modèle de canal et la valeur d'attribut sera utilisée comme fonction de rappel

unpsub

Se désabonner de tous les rappels de chaînes avec un modèle donné

1
Redis.unpsub(String pattern);

Paramètres d'appel:

  • pattern : String, spécifiez le modèle de canal pour vous désabonner

La fonction de rappel spécifiée pour désabonner le canal du modèle donné

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

Paramètres d'appel:

  • pattern : String, spécifiez le modèle de canal pour vous désabonner
  • func : Function, spécifiez la fonction de rappel pour la désinscription

Se désabonner de tous les rappels d'un ensemble de chaînes avec un modèle donné

1
Redis.unpsub(Array patterns);

Paramètres d'appel:

  • patterns : tableau, spécifiez le tableau de modèles de canal à publier

La fonction de rappel spécifiée pour les canaux non abonnés d'un ensemble de modèles

1
Redis.unpsub(Object map);

Paramètres d'appel:

  • map : objet, spécifiez la relation de mappage de canal, le nom d'attribut d'objet sera utilisé comme modèle de canal et la valeur d'attribut sera utilisée comme fonction de rappel

pub

Envoyer un message d'information au canal spécifié

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

Paramètres d'appel:

  • channel : Buffer , spécifiez le canal publié
  • message : Buffer , spécifiez le message à publier

Résultat de retour:

  • Integer , le nombre de clients recevant ce message

getHash

Récupère l'objet Hash de la clé spécifiée. Cet objet est le client qui contient la clé spécifiée. La base de données ne peut être exploitée qu'en appelant sa méthode

1
RedisHash Redis.getHash(Buffer key);

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à obtenir

Résultat de retour:

  • RedisHash , retourne un objet Hash contenant la clé spécifiée

getList

Récupère l'objet List de la clé spécifiée. Cet objet est le client qui contient la clé spécifiée. La base de données ne peut être exploitée qu'en appelant sa méthode

1
RedisList Redis.getList(Buffer key);

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à obtenir

Résultat de retour:

  • RedisList , renvoie un objet List contenant la clé spécifiée

getSet

Récupère l'objet Set de la clé spécifiée. Cet objet est le client qui contient la clé spécifiée. La base de données ne peut être exploitée qu'en appelant sa méthode

1
RedisSet Redis.getSet(Buffer key);

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à obtenir

Résultat de retour:

  • RedisSet , retourne un objet Set contenant la clé spécifiée

getSortedSet

Récupère l'objet SortedSet de la clé spécifiée. Cet objet est le client qui contient la clé spécifiée. La base de données ne peut être exploitée qu'en appelant sa méthode

1
RedisSortedSet Redis.getSortedSet(Buffer key);

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à obtenir

Résultat de retour:

  • RedisSortedSet , retourne un objet SortedSet contenant la clé spécifiée

dump

Sérialisez la clé donnée et renvoyez la valeur sérialisée. Utilisez la commande restore pour désérialiser cette valeur en une clé Redis

1
Buffer Redis.dump(Buffer key);

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à sérialiser

Résultat de retour:

  • Buffer , retourne la valeur sérialisée, si la clé n'existe pas, retourne null

restore

Désérialiser la valeur sérialisée donnée et l'associer à la clé donnée

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

Paramètres d'appel:

  • key : Buffer , spécifiez la clé à désérialiser
  • data : Buffer , spécifiez les données à désérialiser
  • ttl : Long, définissez le temps de survie de la clé en millisecondes; si ttl est égal à 0, ne définissez pas le temps de survie

close

Fermer la connexion ou la transaction à la base de données actuelle

1
Redis.close();

toString

Renvoie la représentation sous forme de chaîne de l'objet, renvoie généralement "[Native Object]", l'objet peut être réimplémenté selon ses propres caractéristiques

1
String Redis.toString();

Résultat de retour:

  • String , renvoie la représentation sous forme de chaîne de l'objet

toJSON

Renvoie la représentation au format JSON de l'objet, renvoie généralement une collection d'attributs lisibles définis par l'objet

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

Paramètres d'appel:

  • key : chaîne, inutilisée

Résultat de retour:

  • Value , renvoie une valeur contenant JSON sérialisable