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
2var db = require("db");
var test = new db.openRedis("redis-server");
Héritage
Attributs des membres
onsuberror
Fonction, requête et définition de la fonction de gestion des erreurs, rappel lorsqu'il y a une erreur dans le sous ou que le réseau est interrompu, lorsque le rappel se produit, tous les sous de cet objet seront abandonnés
1Function Redis.onsuberror;
Fonction membre
command
Méthode de commande de base Redis
1
2Value Redis.command(String cmd,
...args);
Paramètres d'appel :
- cmd: String, spécifiez la commande envoyée
- args: ..., précisez les paramètres à envoyer
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
3Redis.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éfinit le temps de survie de la clé en millisecondes ; si ttl est égal à 0, alors ne définissez pas le temps de survie
setNX
Définissez la valeur de key sur value si et seulement si la clé n'existe pas. Si la clé donnée existe déjà, SETNX ne fait rien.
1
2
3Redis.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éfinit le temps de survie de la clé en millisecondes ; si ttl est égal à 0, alors ne définissez pas le temps de survie
setXX
Définissez la valeur de key sur value et définissez la clé uniquement lorsque la clé existe déjà.
1
2
3Redis.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éfinit le temps de survie de la clé en millisecondes ; si ttl est égal à 0, alors 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 avec la nouvelle valeur
1Redis.mset(Object kvs);
Paramètres d'appel :
- kvs: Objet, 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 avec la nouvelle valeur
1Redis.mset(...kvs);
Paramètres d'appel :
- kvs: ..., spécifiez la liste clé/valeur à définir
msetNX
Définir une ou plusieurs paires clé-valeur en même temps, si et seulement si toutes les clés données n'existent pas
1Redis.msetNX(Object kvs);
Paramètres d'appel :
- kvs: Objet, spécifiez l'objet clé/valeur à définir
Définir une ou plusieurs paires clé-valeur en même temps, si et seulement si toutes les clés données n'existent pas
1Redis.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, l'ajout définit simplement la clé donnée à la valeur
1
2Integer Redis.append(Buffer key,
Buffer value);
Paramètres d'appel :
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 écraser la valeur de chaîne stockée dans la clé donnée, à partir du décalage de décalage
1
2
3Integer Redis.setRange(Buffer key,
Integer offset,
Buffer value);
Paramètres d'appel :
- key: Buffer, Spécifiez la clé à modifier
- offset: Entier, spécifiez l'offset d'octet modifié
- value: Buffer, Spécifiez les données à écraser
Résultat de retour :
- Integer, Après avoir été modifiée, 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 début et fin)
1
2
3Buffer Redis.getRange(Buffer key,
Integer start,
Integer end);
Paramètres d'appel :
- key: Buffer, Spécifiez la clé à interroger
- start: Entier, spécifiez l'offset de l'octet de début de la requête
- end: Entier, spécifiez l'offset de l'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
1Integer 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, retournez 0
bitcount
Compter le nombre de bits mis à 1 dans une chaîne donnée
1
2
3Integer 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
Retourne la valeur de chaîne associée à la clé, si la clé n'existe pas, retourne la valeur spéciale Null
1Buffer 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, renvoie Null, sinon, renvoie 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, alors cette clé renvoie la valeur spéciale nil.
1NArray 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, alors cette clé renvoie la valeur spéciale nil.
1NArray Redis.mget(...keys);
Paramètres d'appel :
- keys: ..., spécifiez la liste de clés à 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 value et retournez l'ancienne valeur de la clé (ancienne valeur)
1
2Buffer 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, Renvoie l'ancienne valeur de la clé donnée
decr
Soustraire le décrément de la valeur stockée dans la clé
1
2Long 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
2Long 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 la clé, définissez ou effacez le bit au décalage spécifié (bit)
1
2
3Integer 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 bit modifié
- value: Entier, spécifiez le paramètre à définir ou à effacer, il peut être 0 ou 1
Résultat de retour :
- Integer, Spécifiez le bit stocké d'origine du décalage
getBit
Obtient le bit à l'offset spécifié pour la valeur de chaîne stockée dans la clé
1
2Integer Redis.getBit(Buffer key,
Integer offset);
Paramètres d'appel :
- key: Buffer, Spécifiez la clé à interroger
- offset: Entier, spécifiez le décalage de bit de la requête
Résultat de retour :
- Integer, La valeur de chaîne spécifie le bit à l'offset (bit)
exists
Vérifier si la clé donnée existe
1Boolean 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 la valeur stockée dans la clé
1String 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 dans la clé, la valeur possible est none (la clé n'existe pas) string (string) list (list) set (collection) zset (set ordonné) hash(Table de hachage)
keys
Trouver toutes les clés qui correspondent au modèle donné
1NArray Redis.keys(String pattern);
Paramètres d'appel :
- pattern: chaîne, spécifiez le mode 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
1Integer Redis.del(Array keys);
Paramètres d'appel :
- keys: Array, 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
1Integer 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
2Boolean Redis.expire(Buffer key,
Long ttl);
Paramètres d'appel :
- key: Buffer, Spécifiez la clé à définir
- ttl: Long, définit 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
1Long Redis.ttl(Buffer key);
Paramètres d'appel :
- key: Buffer, Spécifiez la clé à interroger
Résultat de retour :
- Long, Renvoie la durée de 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
Supprimer la durée de vie d'une clé donnée et convertir cette clé de "volatile" (avec une clé à vie) en "persistante" (une clé sans durée de vie et n'expire jamais)
1Boolean 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 sera renvoyée
1
2Redis.rename(Buffer key,
Buffer newkey);
Paramètres d'appel :
renameNX
Si et seulement si newkey n'existe pas, renommez la clé en newkey et retournez une erreur lorsque la clé n'existe pas
1
2Boolean Redis.renameNX(Buffer key,
Buffer newkey);
Paramètres d'appel :
Résultat de retour :
- Boolean, Lorsque la modification est réussie, elle renvoie True, si la nouvelle clé existe déjà, elle renvoie False
sub
Abonnez-vous aux informations d'un canal donné, et appelez automatiquement func lorsqu'un message survient. Func contient deux paramètres, canal et message à tour de rôle. La même fonction sur le même canal ne sera rappelée qu'une seule fois
1
2Redis.sub(Buffer channel,
Function func);
Paramètres d'appel :
- channel: Buffer, Spécifiez le nom de la chaîne abonnée
- func: Fonction, spécifiez la fonction de rappel
Abonnez-vous aux informations d'un ensemble donné de chaînes, et appelez automatiquement la fonction de rappel correspondante lorsqu'un message survient. La même fonction d'un même canal ne sera rappelée qu'une seule fois
1Redis.sub(Object map);
Paramètres d'appel :
- map: Objet, spécifiez la relation de mappage du canal, le nom de l'attribut de l'objet sera le nom du canal et la valeur de l'attribut sera la fonction de rappel
unsub
Se désabonner de tous les rappels d'une chaîne donnée
1Redis.unsub(Buffer channel);
Paramètres d'appel :
- channel: Buffer, Spécifiez le nom de la chaîne désabonnée
Se désabonner de la fonction de rappel spécifiée du canal donné
1
2Redis.unsub(Buffer channel,
Function func);
Paramètres d'appel :
- channel: Buffer, Spécifiez le nom de la chaîne désabonnée
- func: Fonction, spécifiez la fonction de rappel pour le désabonnement
Se désabonner de tous les rappels d'une chaîne donnée
1Redis.unsub(Array channels);
Paramètres d'appel :
- channels: tableau, spécifiez le tableau de canaux non souscrits
Désabonner la fonction de rappel spécifiée d'un ensemble donné de canaux
1Redis.unsub(Object map);
Paramètres d'appel :
- map: Objet, spécifiez la relation de mappage du canal, le nom de l'attribut de l'objet sera le nom du canal et la valeur de l'attribut sera la fonction de rappel
psub
Abonnez-vous aux informations d'un groupe de canaux selon le modèle. Lorsqu'un message se produit, func est automatiquement appelé. Func contient trois paramètres, qui sont tour à tour canal, message et modèle. La même fonction du même modèle sera uniquement appelée de retour une fois.
1
2Redis.psub(String pattern,
Function func);
Paramètres d'appel :
- pattern: chaîne, spécifiez le modèle de canal abonné
- func: Fonction, 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 se produit, et la même fonction sur le même canal ne sera rappelée qu'une seule fois
1Redis.psub(Object map);
Paramètres d'appel :
- map: Objet, spécifiez la relation de mappage du canal, le nom de l'attribut de l'objet sera utilisé comme modèle de canal et la valeur de l'attribut sera utilisée comme fonction de rappel
unpsub
Se désabonner de tous les rappels de chaînes avec un modèle donné
1Redis.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 se désabonner au canal du modèle donné
1
2Redis.unpsub(String pattern,
Function func);
Paramètres d'appel :
- pattern: String, spécifiez le modèle de canal pour vous désabonner
- func: Fonction, spécifiez la fonction de rappel pour le désabonnement
Se désabonner de tous les rappels d'un ensemble de chaînes avec un modèle donné
1Redis.unpsub(Array patterns);
Paramètres d'appel :
- patterns: Tableau, spécifiez le tableau de modèles de canaux à publier
La fonction de rappel spécifiée du canal qui désabonne un ensemble de modèles
1Redis.unpsub(Object map);
Paramètres d'appel :
- map: Objet, spécifiez la relation de mappage du canal, le nom de l'attribut de l'objet sera utilisé comme modèle de canal et la valeur de l'attribut sera utilisée comme fonction de rappel
pub
Envoyer un message d'information au canal spécifié
1
2Integer Redis.pub(Buffer channel,
Buffer message);
Paramètres d'appel :
Résultat de retour :
- Integer, Le nombre de clients recevant ce message
getHash
Obtient 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 que lorsque sa méthode est appelée
1RedisHash Redis.getHash(Buffer key);
Paramètres d'appel :
- key: Buffer, Spécifiez la clé à obtenir
Résultat de retour :
- RedisHash, Renvoie un objet Hash contenant la clé spécifiée
getList
Obtient 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 que lorsque sa méthode est appelée
1RedisList 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
Obtient 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
1RedisSet Redis.getSet(Buffer key);
Paramètres d'appel :
- key: Buffer, Spécifiez la clé à obtenir
Résultat de retour :
- RedisSet, Renvoie un objet Set contenant la clé spécifiée
getSortedSet
Obtient 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 que lorsque sa méthode est appelée
1RedisSortedSet Redis.getSortedSet(Buffer key);
Paramètres d'appel :
- key: Buffer, Spécifiez la clé à obtenir
Résultat de retour :
- RedisSortedSet, Renvoie l'objet SortedSet contenant la clé spécifiée
dump
Sérialiser la clé donnée et renvoyer la valeur sérialisée. Utilisez la commande restore pour désérialiser cette valeur dans une clé Redis
1Buffer Redis.dump(Buffer key);
Paramètres d'appel :
- key: Buffer, Spécifiez la clé à sérialiser
Résultat de retour :
- Buffer, Renvoie la valeur sérialisée, si la clé n'existe pas, renvoie null
restore
Désérialiser la valeur sérialisée donnée et l'associer à la clé donnée
1
2
3Redis.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éfinit le temps de survie de la clé en millisecondes ; si ttl est égal à 0, alors ne définissez pas le temps de survie
close
Fermer la connexion ou la transaction à la base de données en cours
1Redis.close();
toString
Renvoie la représentation sous forme de chaîne de l'objet, renvoie généralement "[Objet natif]", l'objet peut être ré-implémenté selon ses propres caractéristiques
1String 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
1Value Redis.toJSON(String key = "");
Paramètres d'appel :
- key: chaîne, inutilisé
Résultat de retour :
- Value, Renvoie une valeur contenant JSON sérialisable