オブジェクト組み込みオブジェクト

オブジェクト Redis

Redis データベース クライアント オブジェクト

Redis データベースの作成と管理に使用されます。作成方法:

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

継承

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<this>Redis|onsuberror|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()] [object] <:- [Redis] Redis onsuberror 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() object toString() toJSON()

メンバーの属性

onsuberror

関数、クエリ、およびエラー処理関数を設定し、サブでエラーが発生したとき、またはネットワークが中断されたときにコールバックします。コールバックが発生すると、このオブジェクトのすべてのサブが中止されます。

1
Function Redis.onsuberror;

メンバー関数

command

Redisの基本的なコマンド方式

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

呼び出しパラメータ:

  • cmd: 文字列、送信するコマンドを指定します
  • args: ...、送信するパラメータを指定します

結果を返す:

  • Value、サーバーから返された結果を返す

set

文字列値の値をキーに関連付けます。キーがすでに他の値を保持している場合、SET はタイプに関係なく古い値を上書きします。

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

呼び出しパラメータ:

  • key: Buffer、関連付けるキーを指定します
  • value: Buffer、関連付けるデータを指定します
  • ttl: Long、キーの生存時間をミリ秒単位で設定します; ttl が 0 の場合、生存時間を設定しないでください

setNX

キーが存在しない場合にのみ、キーの値を value に設定します。指定されたキーが既に存在する場合、SETNX は何もしません。

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

呼び出しパラメータ:

  • key: Buffer、関連付けるキーを指定します
  • value: Buffer、関連付けるデータを指定します
  • ttl: Long、キーの生存時間をミリ秒単位で設定します; ttl が 0 の場合、生存時間を設定しないでください

setXX

key の値を value に設定し、キーがすでに存在する場合にのみキーを設定します。

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

呼び出しパラメータ:

  • key: Buffer、関連付けるキーを指定します
  • value: Buffer、関連付けるデータを指定します
  • ttl: Long、キーの生存時間をミリ秒単位で設定します; ttl が 0 の場合、生存時間を設定しないでください

mset

1 つ以上のキーと値のペアを同時に設定します。指定されたキーが既に存在する場合、MSET は古い値を新しい値で上書きします。

1
Redis.mset(Object kvs);

呼び出しパラメータ:

  • kvs: オブジェクト、設定するキー/値オブジェクトを指定します

1 つ以上のキーと値のペアを同時に設定します。指定されたキーが既に存在する場合、MSET は古い値を新しい値で上書きします。

1
Redis.mset(...kvs);

呼び出しパラメータ:

  • kvs: ...、設定するキーと値のリストを指定します

msetNX

指定されたすべてのキーが存在しない場合にのみ、1 つ以上のキーと値のペアを同時に設定します。

1
Redis.msetNX(Object kvs);

呼び出しパラメータ:

  • kvs: オブジェクト、設定するキー/値オブジェクトを指定します

指定されたすべてのキーが存在しない場合にのみ、1 つ以上のキーと値のペアを同時に設定します。

1
Redis.msetNX(...kvs);

呼び出しパラメータ:

  • kvs: ...、設定するキーと値のリストを指定します

append

キーが既に存在し、文字列である場合、append コマンドはキーの元の値の最後に値を追加します。キーが存在しない場合、append は単に指定されたキーを値に設定します

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

呼び出しパラメータ:

  • key: Buffer、追加するキーを指定
  • value: Buffer、追記するデータを指定

結果を返す:

  • Integer, 値を追加した後、キーの文字列の長さ

setRange

value パラメーターを使用して、オフセット オフセットから開始して、指定されたキーに格納されている文字列値を上書きします。

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

呼び出しパラメータ:

  • key: Buffer、変更するキーを指定
  • offset: 整数、変更されたバイト オフセットを指定します
  • value: Buffer、上書きするデータを指定

結果を返す:

  • Integer、変更後の文字列の長さ

getRange

キー内の文字列値の部分文字列を返します。文字列のインターセプト範囲は、開始と終了の 2 つのオフセット (開始と終了を含む) によって決定されます。

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

呼び出しパラメータ:

  • key: Buffer、照会するキーを指定します
  • start: 整数、クエリの開始バイト オフセットを指定します
  • end: 整数、クエリの終了バイト オフセットを指定します

結果を返す:

  • Buffer、部分文字列をインターセプト

strlen

key に格納されている文字列値の長さを返します。キーが文字列値でない場合はエラーが返されます

1
Integer Redis.strlen(Buffer key);

呼び出しパラメータ:

  • key: Buffer、計算するキーを指定

結果を返す:

  • Integer、文字列値の長さ。キーが存在しない場合は0を返す

bitcount

指定された文字列で 1 に設定されているビットの数を数える

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

呼び出しパラメータ:

  • key: Buffer、計算するキーを指定
  • start: 整数、計算する開始バイトを指定、負の値も使用可能、-1 は最後のバイト、-2 は最後から 2 番目のバイトなどを意味します
  • end: 整数、計算する終了バイトを指定、負の値も使用可能、-1は最後のバイト、-2は最後から2番目のバイトなどを意味します

結果を返す:

  • Integer, 1 に設定されたビット数

get

キーに関連付けられた文字列値を返します。キーが存在しない場合は、特殊な値 Null を返します。

1
Buffer Redis.get(Buffer key);

呼び出しパラメータ:

  • key: Buffer、関連付けるキーを指定します

結果を返す:

  • Buffer、キーが存在しない場合はNullを返し、存在しない場合はキーの値を返します

mget

指定されたキーのすべて (1 つ以上) の値を返します。指定されたキーにキーが存在しない場合、このキーは特殊な値 nil を返します。

1
NArray Redis.mget(Array keys);

呼び出しパラメータ:

  • keys: 配列、照会するキー配列を指定します

結果を返す:

  • NArray、指定されたキーのすべての値を含むリスト

指定されたキーのすべて (1 つ以上) の値を返します。指定されたキーにキーが存在しない場合、このキーは特殊な値 nil を返します。

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

呼び出しパラメータ:

  • keys: ...、照会するキー リストを指定します

結果を返す:

  • NArray、指定されたキーのすべての値を含むリスト

getset

指定されたキーの値を value に設定し、キーの古い値 (古い値) を返します

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

呼び出しパラメータ:

  • key: Buffer、照会および変更するキーを指定します
  • value: Buffer、変更した値を指定

結果を返す:

  • Buffer, 指定されたキーの古い値を返します

decr

キーに格納されている値からデクリメントを減算します

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

呼び出しパラメータ:

  • key: Buffer、変更するキーを指定
  • num: Long、減算する値を指定

結果を返す:

  • Long, num を引いた後の key の値

incr

キーに格納されている値に増分を追加します

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

呼び出しパラメータ:

  • key: Buffer、変更するキーを指定
  • num: Long、加算する値を指定

結果を返す:

  • Long, num を追加した後、キーの値

setBit

key に格納されている文字列値に対して、指定されたオフセット (ビット) のビットを設定またはクリアします。

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

呼び出しパラメータ:

  • key: Buffer、変更するキーを指定
  • offset: 整数、変更されたビット オフセットを指定します
  • value: 整数。設定またはクリアするパラメータを指定します。0 または 1 を指定できます。

結果を返す:

  • Integer, オフセットの元の格納ビットを指定します

getBit

key に格納されている文字列値の指定されたオフセットにあるビットを取得します

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

呼び出しパラメータ:

  • key: Buffer、照会するキーを指定します
  • offset: 整数、クエリのビット オフセットを指定します

結果を返す:

  • Integer, 文字列値は、オフセット (ビット) のビットを指定します

exists

指定されたキーが存在するかどうかを確認します

1
Boolean Redis.exists(Buffer key);

呼び出しパラメータ:

  • key: Buffer、関連付けるキーを指定します

結果を返す:

  • Boolean、キーが存在する場合はTrueを返し、そうでない場合はFalseを返します

type

キーに格納されている値の型を返します

1
String Redis.type(Buffer key);

呼び出しパラメータ:

  • key: Buffer、照会するキーを指定します

結果を返す:

  • String, キーに格納されている値のタイプを返します。可能な値は none (キーが存在しない) 文字列 (文字列) リスト (リスト) セット (コレクション) zset (順序集合) hash(ハッシュ表)

keys

指定されたパターンに一致するすべてのキーを検索します

1
NArray Redis.keys(String pattern);

呼び出しパラメータ:

  • pattern: 文字列、クエリモードを指定

結果を返す:

  • NArray、指定されたパターンに一致するキーのリスト

del

指定された 1 つ以上のキーを削除します。存在しないキーは無視されます

1
Integer Redis.del(Array keys);

呼び出しパラメータ:

  • keys: 配列、削除するキー配列を指定します

結果を返す:

  • Integer、削除されたキーの数

指定された 1 つ以上のキーを削除します。存在しないキーは無視されます

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

呼び出しパラメータ:

  • keys: ...、削除するキーリストを指定します

結果を返す:

  • Integer、削除されたキーの数

expire

指定されたキーの存続時間を設定します。キーの有効期限が切れると、キーは自動的に削除されます

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

呼び出しパラメータ:

  • key: Buffer、設定するキーを指定
  • ttl: Long、キーの生存時間をミリ秒単位で設定します

結果を返す:

  • Boolean、キーが存在する場合はTrueを返し、そうでない場合はFalseを返します

ttl

指定されたキーの残りの生存時間を返します

1
Long Redis.ttl(Buffer key);

呼び出しパラメータ:

  • key: Buffer、照会するキーを指定します

結果を返す:

  • Long, キーの残り生存時間をミリ秒単位で返します キーが存在しない場合は-2を返します キーは存在するが残り生存時間が設定されていない場合は-1を返します

persist

指定されたキーの有効期間を削除し、このキーを「揮発性」(有効期間キーを使用) から「永続的」(有効期間がなく、期限切れになることのないキー) に変換します。

1
Boolean Redis.persist(Buffer key);

呼び出しパラメータ:

  • key: Buffer、設定するキーを指定

結果を返す:

  • Boolean、キーが存在する場合はTrueを返し、そうでない場合はFalseを返します

rename

キーの名前をnewkeyに変更します。キーとnewkeyが同じか、存在しない場合はエラーが返されます

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

呼び出しパラメータ:

  • key: Buffer、リネームするキーを指定
  • newkey: Buffer、リネームする宛先キーを指定

renameNX

newkey が存在しない場合のみ、キーの名前を newkey に変更し、キーが存在しない場合はエラーを返します。

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

呼び出しパラメータ:

  • key: Buffer、リネームするキーを指定
  • newkey: Buffer、リネームする宛先キーを指定

結果を返す:

  • Boolean、変更が成功した場合は True を返し、newkey がすでに存在する場合は False を返します。

sub

指定されたチャネルの情報をサブスクライブし、メッセージが発生したときに自動的に func を呼び出します. Func には、チャネルとメッセージの 2 つのパラメータが順番に含まれています. 同じチャネル上の同じ関数は 1 回だけ呼び出されます

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

呼び出しパラメータ:

  • channel: Buffer、サブスクライブしたチャンネルの名前を指定
  • func: 関数、コールバック関数を指定

特定のチャネル セットの情報をサブスクライブし、メッセージが発生したときに対応するコールバック関数を自動的に呼び出します。同じチャネルの同じ関数は 1 回だけ呼び出されます。

1
Redis.sub(Object map);

呼び出しパラメータ:

  • map: オブジェクト、チャネル マッピング関係を指定します。オブジェクトの属性名はチャネル名になり、属性値はコールバック関数になります

unsub

指定されたチャネルのすべてのコールバックのサブスクライブを解除します

1
Redis.unsub(Buffer channel);

呼び出しパラメータ:

  • channel: Buffer, 登録解除したチャンネルの名前を指定します

指定されたチャネルの指定されたコールバック関数のサブスクライブを解除します

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

呼び出しパラメータ:

  • channel: Buffer, 登録解除したチャンネルの名前を指定します
  • func: 関数、購読解除のコールバック関数を指定します

指定されたチャネルのすべてのコールバックのサブスクライブを解除します

1
Redis.unsub(Array channels);

呼び出しパラメータ:

  • channels: 配列、サブスクライブされていないチャネル配列を指定します

指定された一連のチャネルの指定されたコールバック関数のサブスクライブを解除します

1
Redis.unsub(Object map);

呼び出しパラメータ:

  • map: オブジェクト、チャネル マッピング関係を指定します。オブジェクトの属性名はチャネル名になり、属性値はコールバック関数になります

psub

テンプレートに応じたチャネル群の情報を購読する メッセージが発生すると、funcが自動的に呼び出される Funcには、チャネル、メッセージ、パターンの3つのパラメータが順番に含まれる 同じテンプレートの同じ関数だけが呼び出される一度戻って。

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

呼び出しパラメータ:

  • pattern: 文字列、サブスクライブされたチャネル テンプレートを指定します
  • func: 関数、コールバック関数を指定

チャネル テンプレートの特定のセットの情報をサブスクライブし、メッセージが発生したときに対応する関数を自動的に呼び出します。同じチャネルの同じ関数は 1 回だけ呼び出されます。

1
Redis.psub(Object map);

呼び出しパラメータ:

  • map: オブジェクト、チャネル マッピング関係を指定します。オブジェクトの属性名はチャネル テンプレートとして使用され、属性値はコールバック関数として使用されます

unpsub

指定されたテンプレートを使用して、チャネルのすべてのコールバックを登録解除します

1
Redis.unpsub(String pattern);

呼び出しパラメータ:

  • pattern: 文字列、登録解除するチャンネル テンプレートを指定します

指定されたテンプレートのチャネルのサブスクライブを解除するための指定されたコールバック関数

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

呼び出しパラメータ:

  • pattern: 文字列、登録解除するチャンネル テンプレートを指定します
  • func: 関数、購読解除のコールバック関数を指定します

指定されたテンプレートを使用して、一連のチャネルのすべてのコールバックのサブスクライブを解除します

1
Redis.unpsub(Array patterns);

呼び出しパラメータ:

  • patterns: 配列、公開するチャネル テンプレートの配列を指定します

テンプレートのセットを登録解除するチャネルの指定されたコールバック関数

1
Redis.unpsub(Object map);

呼び出しパラメータ:

  • map: オブジェクト、チャネル マッピング関係を指定します。オブジェクトの属性名はチャネル テンプレートとして使用され、属性値はコールバック関数として使用されます

pub

指定されたチャネル チャネルに情報メッセージを送信します

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

呼び出しパラメータ:

  • channel: Buffer、公開チャンネルを指定
  • message: Buffer、公開するメッセージを指定

結果を返す:

  • Integer、このメッセージを受信したクライアントの数

getHash

指定されたキーのHashオブジェクトを取得 このオブジェクトは指定されたキーを含むクライアントであり、そのメソッドが呼び出された場合にのみデータベースを操作できます

1
RedisHash Redis.getHash(Buffer key);

呼び出しパラメータ:

  • key: Buffer、取得する鍵を指定

結果を返す:

  • RedisHash, 指定されたキーを含む Hash オブジェクトを返します

getList

指定されたキーのListオブジェクトを取得します.このオブジェクトは指定されたキーを含むクライアントです.データベースはそのメソッドが呼び出された時のみ操作できます.

1
RedisList Redis.getList(Buffer key);

呼び出しパラメータ:

  • key: Buffer、取得する鍵を指定

結果を返す:

  • RedisList, 指定されたキーを含むリスト オブジェクトを返します

getSet

指定されたキーの Set オブジェクトを取得します.このオブジェクトは指定されたキーを含むクライアントです.データベースはそのメソッドを呼び出すことによってのみ操作できます.

1
RedisSet Redis.getSet(Buffer key);

呼び出しパラメータ:

  • key: Buffer、取得する鍵を指定

結果を返す:

  • RedisSet, 指定されたキーを含む Set オブジェクトを返します

getSortedSet

指定されたキーのSortedSetオブジェクトを取得します.このオブジェクトは指定されたキーを含むクライアントです.データベースはそのメソッドが呼び出された時のみ操作できます.

1
RedisSortedSet Redis.getSortedSet(Buffer key);

呼び出しパラメータ:

  • key: Buffer、取得する鍵を指定

結果を返す:

  • RedisSortedSet, 指定されたキーを含むSortedSetオブジェクトを返します

dump

指定されたキーをシリアライズし、シリアライズされた値を返します.restoreコマンドを使用して、この値をRedisキーにデシリアライズします

1
Buffer Redis.dump(Buffer key);

呼び出しパラメータ:

  • key: Buffer、シリアル化するキーを指定

結果を返す:

  • Buffer、シリアル化された値を返し、キーが存在しない場合は null を返します

restore

指定されたシリアル化された値を逆シリアル化し、指定されたキーに関連付けます

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

呼び出しパラメータ:

  • key: Buffer、デシリアライズするキーを指定
  • data: Buffer、デシリアライズするデータを指定
  • ttl: Long、キーの生存時間をミリ秒単位で設定します; ttl が 0 の場合、生存時間を設定しないでください

close

現在のデータベース接続またはトランザクションを閉じます

1
Redis.close();

toString

オブジェクトの文字列表現を返します。通常は「[ネイティブ オブジェクト]」を返します。オブジェクトは独自の特性に従って再実装できます。

1
String Redis.toString();

結果を返す:

  • String、オブジェクトの文字列表現を返します

toJSON

オブジェクトの JSON 形式の表現を返します。通常は、オブジェクトによって定義された読み取り可能な属性のコレクションを返します。

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

呼び出しパラメータ:

  • key: ストリング、未使用

結果を返す:

  • Value、シリアライズ可能なJSONを含む値を返します