ObjetRedis

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");

relation d'héritage

propriétés des membres

onsuberror

Fonctionner, interroger et définir la fonction de gestion des erreurs. Lorsque le sous-marin a une erreur ou que le réseau est interrompu, il sera rappelé. Lorsque le rappel se produit, tous les sous-marins de cet objet seront terminés.

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écifie la commande à envoyer
args: ..., précisez les paramètres à envoyer

Résultats de retour :

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

set

Associez la valeur de chaîne à la clé. Si la clé contient déjà une autre valeur, 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, précisez la clé à associer
value:Buffer, précisez les données à associer
ttl: Long, définit le temps de survie de la clé en millisecondes ; si ttl est 0, alors le temps de survie n'est pas défini

setNX

Définissez la valeur de key sur value si et seulement si key n’existe pas. Si la clé donnée existe déjà, SETNX ne prend aucune mesure.

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

Paramètres d'appel :

key:Buffer, précisez la clé à associer
value:Buffer, précisez les données à associer
ttl: Long, définit le temps de survie de la clé en millisecondes ; si ttl est 0, alors le temps de survie n'est pas défini

setXX

Définissez la valeur de key sur value et définissez la clé uniquement si la clé existe déjà.

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

Paramètres d'appel :

key:Buffer, précisez la clé à associer
value:Buffer, précisez les données à associer
ttl: Long, définit le temps de survie de la clé en millisecondes ; si ttl est 0, alors le temps de survie n'est pas défini

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: Objet, spécifie 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.

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

1
Redis.msetNX(Object kvs);

Paramètres d'appel :

kvs: Objet, spécifie 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, append définit simplement la clé donnée sur valeur.

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

Paramètres d'appel :

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

Résultats 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, en commençant par offset offset

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

Paramètres d'appel :

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

Résultats de retour :

Integer, la longueur de la chaîne après modification

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, précisez la clé à interroger
start: Entier, spécifie le décalage d'octet de départ de la requête
end: Entier, spécifie le décalage d'octet de fin de la requête

Résultats de retour :

Buffer, intercepte la sous-chaîne obtenue

strlen

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

1Integer Redis.strlen(Buffer key);

Paramètres d'appel :

key:Buffer, précisez la clé à calculer

Résultats de retour :

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

bitcount

Compte le nombre de bits mis à 1 dans la chaîne donnée

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

Paramètres d'appel :

key:Buffer, précisez la clé à calculer
start: Entier, spécifie l'octet de départ à calculer, vous pouvez utiliser des valeurs négatives, -1 représente le dernier octet et -2 représente l'avant-dernier octet, et ainsi de suite.
end: Entier, spécifie l'octet de fin à calculer, vous pouvez utiliser des valeurs négatives, -1 représente le dernier octet et -2 représente l'avant-dernier octet, et ainsi de suite.

Résultats 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.

1Buffer Redis.get(Buffer key);

Paramètres d'appel :

key:Buffer, précisez la clé à associer

Résultats 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 pour la clé donnée. Si une clé n'existe pas dans la clé donnée, alors cette clé renvoie la valeur spéciale nulle.

1
NArray Redis.mget(Array keys);

Paramètres d'appel :

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

Résultats de retour :

NArray, une liste contenant toutes les valeurs pour une clé donnée

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

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

Paramètres d'appel :

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

Résultats de retour :

NArray, une liste contenant toutes les valeurs pour une clé donnée

getset

Définit la valeur de la clé donnée sur value et renvoie l'ancienne valeur de la clé

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

Paramètres d'appel :

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

Résultats de retour :

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

decr

Soustrayez 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, précisez la clé à modifier
num: Long, précise la valeur à soustraire

Résultats de retour :

Long, après avoir soustrait num, la valeur de key

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, précisez la clé à modifier
num: Long, précise la valeur à ajouter

Résultats 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é.

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

Paramètres d'appel :

key:Buffer, précisez la clé à modifier
offset: Entier, spécifie le décalage de bit modifié
value: Entier, spécifie le paramètre à définir ou à effacer, qui peut être 0 ou 1

Résultats de retour :

Integer, spécifie le bit où le décalage a été initialement stocké

getBit

Pour la valeur de chaîne stockée dans la clé, obtenez le bit au décalage spécifié

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

Paramètres d'appel :

key:Buffer, précisez la clé à interroger
offset: Entier, spécifie le décalage binaire de la requête

Résultats de retour :

Integer, la valeur de chaîne spécifie le bit au décalage

exists

Vérifiez si la clé donnée existe

1
Boolean Redis.exists(Buffer key);

Paramètres d'appel :

key:Buffer, précisez la clé à associer

Résultats 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, précisez la clé à interroger

Résultats de retour :

String, renvoie le type de valeur stockée dans la clé. Les valeurs possibles sont aucune (la clé n'existe pas) string (string) list (list) set (set) zset (ensemble ordonné)hash(table de hachage)

keys

Trouver toutes les clés correspondant au modèle donné

1
NArray Redis.keys(String pattern);

Paramètres d'appel :

pattern: Chaîne, spécifiez le mode de requête

Résultats de retour :

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

del

Supprimez une ou plusieurs clés données. Les clés non existantes seront ignorées.

1
Integer Redis.del(Array keys);

Paramètres d'appel :

keys: Array, spécifie le tableau de clés à supprimer

Résultats de retour :

Integer, le nombre de clés supprimées

Supprimez une ou plusieurs clés données. Les clés non existantes seront ignorées.

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

Paramètres d'appel :

keys: ..., précisez la liste de clés à supprimer

Résultats 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, précisez la clé à définir
ttl: Long, définissez le temps de survie de la clé en millisecondes

Résultats 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, précisez la clé à interroger

Résultats de retour :

Long, renvoie le temps de survie restant de la clé en millisecondes. Lorsque la clé n'existe pas, il renvoie -2. Lorsque la clé existe mais que le temps de survie restant n'est pas défini, il renvoie -1.

persist

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

1
Boolean Redis.persist(Buffer key);

Paramètres d'appel :

key:Buffer, précisez la clé à définir

Résultats de retour :

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

rename

Renommez la clé en newkey. Lorsque la clé est identique à la nouvelle clé 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, précisez la clé à renommer
newkey:Buffer, précisez la clé de destination à renommer

renameNX

Si et seulement si newkey n'existe pas, renommez la clé en newkey. Lorsque la clé n'existe pas, renvoie une erreur.

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

Paramètres d'appel :

key:Buffer, précisez la clé à renommer
newkey:Buffer, précisez la clé de destination à renommer

Résultats de retour :

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

sub

Abonnez-vous aux informations d'un canal donné et appelez automatiquement func lorsqu'un message apparaît. func contient deux paramètres, canal et message dans l'ordre. 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 à laquelle vous êtes abonné
func: Fonction, 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 apparaît. La même fonction sur le même canal ne sera appelée qu'une seule fois.

1
Redis.sub(Object map);

Paramètres d'appel :

map: Objet, spécifie la relation de mappage de canal, le nom de l'attribut de l'objet sera utilisé comme nom de canal et la valeur de l'attribut sera utilisée comme fonction de rappel

unsub

Désabonnez-vous de tous les rappels pour la chaîne donnée

1Redis.unsub(Buffer channel);

Paramètres d'appel :

channel:Buffer, spécifiez le nom de la chaîne dont vous souhaitez vous désabonner

La fonction de rappel spécifiée pour se désabonner du canal donné

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

Paramètres d'appel :

channel:Buffer, spécifiez le nom de la chaîne dont vous souhaitez vous désabonner
func: Fonction, précise la fonction de rappel pour le désabonnement

Désabonnez-vous de tous les rappels pour un ensemble de chaînes donné

1
Redis.unsub(Array channels);

Paramètres d'appel :

channels : Array, spécifie le tableau de chaînes dont vous souhaitez vous désabonner

Fonction de rappel spécifiée pour se désabonner d'un ensemble donné de chaînes

1
Redis.unsub(Object map);

Paramètres d'appel :

map: Objet, spécifie la relation de mappage de canal, le nom de l'attribut de l'objet sera utilisé comme nom de canal et la valeur de l'attribut sera utilisée comme fonction de rappel

psub

Abonnez-vous à un groupe d'informations de canal selon le modèle et appelez automatiquement func lorsqu'un message apparaît. func contient trois paramètres, canal, message et modèle dans l'ordre. La même fonction dans le 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écifie le modèle de chaîne abonnée
func: Fonction, spécifiez la fonction de rappel

Abonnez-vous aux informations d'un ensemble donné de modèles de canal 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écifie la relation de mappage de 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

Désabonnez-vous de tous les rappels du canal du modèle donné

1
Redis.unpsub(String pattern);

Paramètres d'appel :

pattern : String, spécifiez le modèle de chaîne de désabonnement

Fonction de rappel spécifiée pour se désabonner du 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 chaîne de désabonnement
func: Fonction, précise la fonction de rappel pour le désabonnement

Désabonnez-vous de tous les rappels pour un ensemble de chaînes avec un modèle donné

1
Redis.unpsub(Array patterns);

Paramètres d'appel :

patterns : Array, spécifie le tableau de modèles de canaux publiés

Fonction de rappel spécifiée pour se désabonner d'un groupe de chaînes modèles

1
Redis.unpsub(Object map);

Paramètres d'appel :

map: Objet, spécifie la relation de mappage de 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
2
Integer Redis.pub(Buffer channel,
    Buffer message);

Paramètres d'appel :

channel:Buffer, spécifiez le canal de publication
message:Buffer, précisez le message à publier

Résultats 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 contenant la clé spécifiée. Ce n'est qu'en appelant sa méthode que la base de données sera exploitée.

1RedisHash Redis.getHash(Buffer key);

Paramètres d'appel :

key:Buffer, précisez la clé à obtenir

Résultats de retour :

RedisHash, renvoie 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 contenant la clé spécifiée. Ce n'est qu'en appelant sa méthode que la base de données sera exploitée.

1RedisList Redis.getList(Buffer key);

Paramètres d'appel :

key:Buffer, précisez la clé à obtenir

Résultats 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 contenant la clé spécifiée. Ce n'est qu'en appelant sa méthode que la base de données sera exploitée.

1RedisSet Redis.getSet(Buffer key);

Paramètres d'appel :

key:Buffer, précisez la clé à obtenir

Résultats de retour :

RedisSet, renvoie 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 contenant la clé spécifiée. Ce n'est qu'en appelant sa méthode que la base de données sera exploitée.

1RedisSortedSet Redis.getSortedSet(Buffer key);

Paramètres d'appel :

key:Buffer, précisez la clé à obtenir

Résultats de retour :

RedisSortedSet, renvoie l'objet SortedSet contenant la clé spécifiée

dump

Sérialise la clé donnée et renvoie la valeur sérialisée. Utilisez la commande de restauration 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ésultats de retour :

Buffer, renvoie la valeur après sérialisation, si la clé n'existe pas, puis renvoie null

restore

Désérialisez la valeur sérialisée donnée et associez-la à 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, précisez les données à désérialiser
ttl: Long, définit le temps de survie de la clé en millisecondes ; si ttl est 0, alors le temps de survie n'est pas défini

close

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

1Redis.close();

toString

Renvoie la représentation sous forme de chaîne de l'objet. Généralement, "[Native Object]" est renvoyé. L'objet peut être réimplémenté en fonction de ses propres caractéristiques.

1
String Redis.toString();

Résultats de retour :

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

toJSON

Renvoie une représentation au format JSON de l'objet, renvoyant généralement une collection de propriétés lisibles définies par l'objet.

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

Paramètres d'appel :

key: Chaîne, non utilisée

Résultats de retour :

Value, renvoie une valeur contenant du JSON sérialisable

Guide de développement

Module de base

objets intégrés

module communautaire

ObjetRedis

relation d'héritage

propriétés des membres

onsuberror

fonction membre

command

set

setNX

setXX

mset

msetNX

append

setRange

getRange

strlen

bitcount

get

mget

getset

decr

incr

setBit

getBit

exists

type

keys

del

expire

ttl

persist

rename

renameNX

sub

unsub

psub

unpsub

pub

getHash

getList

getSet

getSortedSet

dump

restore

close

toString

toJSON