オブジェクトRedis

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

Redis データベースの作成と管理に使用されます。作成方法は次のとおりです。

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

相続関係

メンバーのプロパティ

onsuberror

エラー処理関数のクエリと設定を行います。サブルーチンにエラーが発生したり、ネットワークが中断されたりすると、コールバックされます。コールバックが発生すると、このオブジェクトのすべてのサブルーチンが終了します。

1
Function Redis.onsuberror;

メンバー関数

command

redisの基本的なコマンド方法

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

呼び出しパラメータ:

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

返される結果:

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

set

文字列値 value をキーに関連付けます。キーがすでに別の値を保持している場合、タイプに関係なく、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 は古い値を新しい値で上書きします。

1Redis.mset(...kvs);

呼び出しパラメータ:

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

msetNX

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

1
Redis.msetNX(Object kvs);

呼び出しパラメータ:

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

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

1Redis.msetNX(...kvs);

呼び出しパラメータ:

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

append

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

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

呼び出しパラメータ:

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

返される結果:

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

setRange

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

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 に格納されている文字列値の長さを返します。 key に文字列値以外の値が格納されている場合、エラーが返されます。

1Integer 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 を返します。

1Buffer Redis.get(Buffer key);

呼び出しパラメータ:

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

返される結果:

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

mget

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

1
NArray Redis.mget(Array keys);

呼び出しパラメータ:

keys: 配列。クエリするキー配列を指定します。

返される結果:

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

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

1NArray 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、numを減算した後、キーの値

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, key に格納されている値の型を返します。取り得る値は none (キーが存在しない)、string (文字列)、list (リスト)、set (セット)、zset (順序付きセット) です。hash（ハッシュ表）

keys

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

1
NArray Redis.keys(String pattern);

呼び出しパラメータ:

pattern: 文字列、クエリモードを指定します

返される結果:

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

del

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

1
Integer Redis.del(Array keys);

呼び出しパラメータ:

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

返される結果:

Integer、削除されたキーの数

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

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

呼び出しパラメータ:

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

返される結果:

Integer、削除されたキーの数

expire

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

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

呼び出しパラメータ:

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

返される結果:

Boolean、キーが存在する場合は True を返し、それ以外の場合は False を返します

ttl

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

1Long Redis.ttl(Buffer key);

呼び出しパラメータ:

key:Buffer、クエリするキーを指定します

返される結果:

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

persist

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

1
Boolean Redis.persist(Buffer key);

呼び出しパラメータ:

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

返される結果:

Boolean、キーが存在する場合は True を返し、それ以外の場合は False を返します

rename

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

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
2Redis.sub(Buffer channel,
    Function func);

呼び出しパラメータ:

channel:Buffer、登録したチャンネル名を指定します
func: 関数、コールバック関数を指定します

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

1
Redis.sub(Object map);

呼び出しパラメータ:

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

unsub

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

1Redis.unsub(Buffer channel);

呼び出しパラメータ:

channel:Buffer、登録を解除するチャンネル名を指定します

指定されたチャネルからのサブスクライブを解除するために指定されたコールバック関数

1
2Redis.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 回だけ呼び出されます。

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 オブジェクトを取得します。このオブジェクトは指定されたキーを含むクライアントであり、そのメソッドを呼び出すだけでデータベースが操作されます。

1RedisHash Redis.getHash(Buffer key);

呼び出しパラメータ:

key:Buffer、取得するキーを指定します

返される結果:

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

getList

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

1RedisList Redis.getList(Buffer key);

呼び出しパラメータ:

key:Buffer、取得するキーを指定します

返される結果:

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

getSet

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

1RedisSet Redis.getSet(Buffer key);

呼び出しパラメータ:

key:Buffer、取得するキーを指定します

返される結果:

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

getSortedSet

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

1RedisSortedSet Redis.getSortedSet(Buffer key);

呼び出しパラメータ:

key:Buffer、取得するキーを指定します

返される結果:

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

dump

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

1Buffer 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

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

1Redis.close();

toString

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

1
String Redis.toString();

返される結果:

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

toJSON

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

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

呼び出しパラメータ:

key: 文字列、使用されません

返される結果:

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

開発ガイド

基本モジュール

組み込みオブジェクト

コミュニティモジュール

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

toString

toJSON