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

オブジェクト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

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

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

呼び出しパラメーター:

  • keyBuffer、関連付けるキーを指定します
  • valueBuffer、関連付けるデータを指定します
  • ttl:長い、キーの存続時間をミリ秒単位で設定します。ttlが0の場合、存続時間を設定しないでください。

setNX

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

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

呼び出しパラメーター:

  • keyBuffer、関連付けるキーを指定します
  • valueBuffer、関連付けるデータを指定します
  • ttl:長い、キーの存続時間をミリ秒単位で設定します。ttlが0の場合、存続時間を設定しないでください。

setXX

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

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

呼び出しパラメーター:

  • keyBuffer、関連付けるキーを指定します
  • valueBuffer、関連付けるデータを指定します
  • ttl:長い、キーの存続時間をミリ秒単位で設定します。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);

呼び出しパラメーター:

  • keyBuffer、追加するキーを指定します
  • valueBuffer、追加するデータを指定します

戻り結果:

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

setRange

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

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

呼び出しパラメーター:

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

戻り結果:

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

getRange

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

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

呼び出しパラメーター:

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

戻り結果:

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

strlen

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

1
Integer Redis.strlen(Buffer key);

呼び出しパラメーター:

  • keyBuffer、計算するキーを指定します

戻り結果:

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

bitcount

特定の文字列で1に設定されたビット数をカウントします

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

呼び出しパラメーター:

  • keyBuffer、計算するキーを指定します
  • start:整数、計算する開始バイトを指定します。負の値を使用できます。-1は最後のバイトを意味し、-2は最後から2番目のバイトを意味します。
  • end:整数、計算する終了バイトを指定します。負の値を使用できます。-1は最後のバイトを意味し、-2は最後から2番目のバイトを意味します。

戻り結果:

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

get

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

1
Buffer Redis.get(Buffer key);

呼び出しパラメーター:

  • keyBuffer、関連付けるキーを指定します

戻り結果:

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

呼び出しパラメーター:

  • keyBuffer、照会および変更するキーを指定します
  • valueBuffer、変更した値を指定します

戻り結果:

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

decr

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

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

呼び出しパラメーター:

  • keyBuffer、変更するキーを指定します
  • num:長い、減算する値を指定します

戻り結果:

  • Long、numを引いた後、キーの値

incr

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

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

呼び出しパラメーター:

  • keyBuffer、変更するキーを指定します
  • num:長い、追加する値を指定します

戻り結果:

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

setBit

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

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

呼び出しパラメーター:

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

戻り結果:

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

getBit

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

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

呼び出しパラメーター:

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

戻り結果:

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

exists

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

1
Boolean Redis.exists(Buffer key);

呼び出しパラメーター:

  • keyBuffer、関連付けるキーを指定します

戻り結果:

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

type

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

1
String Redis.type(Buffer key);

呼び出しパラメーター:

  • keyBuffer、照会するキーを指定します

戻り結果:

  • String、キーに格納されている値のタイプを返します。可能な値はnone(キーが存在しません)string(string)list(list)set(collection)zset(ordered set) 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);

呼び出しパラメーター:

  • keyBuffer、設定するキーを指定します
  • ttl:長い、キーの存続時間をミリ秒単位で設定します

戻り結果:

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

ttl

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

1
Long Redis.ttl(Buffer key);

呼び出しパラメーター:

  • keyBuffer、照会するキーを指定します

戻り結果:

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

persist

特定のキーの有効期間を削除し、このキーを「揮発性」(有効期間キーあり)から「永続的」(有効期間がなく、期限切れにならないキー)に変換します。

1
Boolean Redis.persist(Buffer key);

呼び出しパラメーター:

  • keyBuffer、設定するキーを指定します

戻り結果:

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

rename

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

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

呼び出しパラメーター:

  • keyBuffer、名前を変更するキーを指定します
  • newkeyBuffer、名前を変更する宛先キーを指定します

renameNX

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

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

呼び出しパラメーター:

  • keyBuffer、名前を変更するキーを指定します
  • newkeyBuffer、名前を変更する宛先キーを指定します

戻り結果:

  • Boolean、変更が成功するとTrueを返し、新しいキーがすでに存在する場合はFalseを返します。

sub

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

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

呼び出しパラメーター:

  • channelBuffer、サブスクライブしているチャンネルの名前を指定します
  • func:関数、コールバック関数を指定します

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

1
Redis.sub(Object map);

呼び出しパラメーター:

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

unsub

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

1
Redis.unsub(Buffer channel);

呼び出しパラメーター:

  • channelBuffer、登録されていないチャネルの名前を指定します

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

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

呼び出しパラメーター:

  • channelBuffer、登録されていないチャネルの名前を指定します
  • 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);

呼び出しパラメーター:

  • channelBuffer、公開チャンネルを指定します
  • messageBuffer、公開するメッセージを指定します

戻り結果:

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

getHash

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

1
RedisHash Redis.getHash(Buffer key);

呼び出しパラメーター:

  • keyBuffer、取得するキーを指定します

戻り結果:

  • RedisHash、指定されたキーを含むハッシュオブジェクトを返します

getList

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

1
RedisList Redis.getList(Buffer key);

呼び出しパラメーター:

  • keyBuffer、取得するキーを指定します

戻り結果:

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

getSet

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

1
RedisSet Redis.getSet(Buffer key);

呼び出しパラメーター:

  • keyBuffer、取得するキーを指定します

戻り結果:

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

getSortedSet

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

1
RedisSortedSet Redis.getSortedSet(Buffer key);

呼び出しパラメーター:

  • keyBuffer、取得するキーを指定します

戻り結果:

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

dump

指定されたキーをシリアル化し、シリアル化された値を返します。restoreコマンドを使用して、この値をRedisキーに逆シリアル化します。

1
Buffer Redis.dump(Buffer key);

呼び出しパラメーター:

  • keyBuffer、シリアル化するキーを指定します

戻り結果:

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

restore

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

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

呼び出しパラメーター:

  • keyBuffer、逆シリアル化するキーを指定します
  • dataBuffer、逆シリアル化するデータを指定します
  • ttl:長い、キーの存続時間をミリ秒単位で設定します。ttlが0の場合、存続時間を設定しないでください。

close

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

1
Redis.close();

toString

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

1
String Redis.toString();

戻り結果:

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

toJSON

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

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

呼び出しパラメーター:

  • key:文字列、未使用

戻り結果:

  • Value、シリアル化可能なJSONを含む値を返します