SSDB PHP プログラム API ドキュメント
SSDB PHP クライアント API ドキュメント
- @作成者: ideawu
- @更新: 2014-11-05
SSDB は、zset データ構造をサポートし、Redis の置き換えに使用される高性能 NoSQL データベースです。公式 Web サイトは http://ssdb.io. このドキュメントでは、SSDB の PHP クライアント API を紹介します。
注: SSDB で使用される名詞「hashmap」、「hash」、「map」は同じものを持ちます。 .
ClassSimpleSSDB
クイック スタート
<?php include_once('SSDB.php'); try{ $ssdb = new SimpleSSDB('127.0.0.1', 8888); }catch(SSDBException $e){ die(LINE . ' ' . $e->getMessage()); } $ret = $ssdb->set('key', 'value'); if($ret === false){ // error! } echo $ssdb->get('key');
エラー処理
SSDB サーバーに接続できない場合、SimpleSSDB は例外をスローします。ほとんどのメソッド (いくつかの例外を除く) は、false
を返すことによってエラーを示します。強制等価 (===) を使用して戻り値を決定します。
ネットワーク エラーが発生した場合、すべてのメソッドは SSDBException をスローします。
注:実装上の理由により、すべてのパラメータの合計サイズが 10MB を超えないようにしてください。
メソッド
SimpleSSDB::__construct
説明
SimpleSSDBのインスタンスを作成するを指定して、SSDB サーバーに接続します。サーバーに接続できない場合は、例外がスローされます。
Parameters
host
- SSDB サーバーのホスト名または IP。port
- SSDB サーバーのポート番号。timeout_ms
- オプション、接続タイムアウト、データの送受信のタイムアウト期間 (ミリ秒単位)。デフォルトは 2000 ミリ秒です。
戻り値
SimpleSSDB のインスタンス。
例
$ssdb = new SimpleSSDB('127.0.0.1', 8888);
auth
以降: 1.7.0.0
説明
パスワードを設定します。このパスワードは、後でサーバーで検証するために使用されます。この検証はすぐには実行されませんが、最初のコマンドを実行するときにサーバーに送信されます。パスワードに注意してください。クリアテキストで送信されます!
パラメータ
パスワード
-
戻り値
エラーが発生した場合は false
を返し、それ以外の場合は null
.
Example
$ssdb->auth('very-strong-password');# を返します。 ##set
Description
指定されたキーの値の内容を設定します。Parameters
- key
-
- value
-
戻り値
エラーの場合はfalse を返し、他の値は正常を示します。
例$ssdb->set('key', 'value');
setx説明
指定されたキーの値の内容を設定し、生存時間を設定します。パラメータ
キー
-値
-ttl
- 生存時間 (秒)
戻り値
エラーが発生した場合は false
が返され、それ以外は値は正常を意味します。
例
$ssdb->setx('key', 'value', 60);
setnx
説明
キーが存在しない場合は、指定したキーの値の内容を設定します既に存在する場合は設定されません。
#key -
- value
-
戻り値
# エラーが発生した場合は、
が返されます。1: 値が設定されています。0: キーはすでに存在しており、更新されません。
Example$ssdb->setnx('key', 'value');
expire
Descriptionキーの生存時間を設定します (KV のみ)タイプ)。####パラメータ
- key
-
- ttl
- 生存時間 (秒)
戻り値
エラーが発生した場合は
-
- 生存時間 (秒)
false が返され、キーが存在し、設定が成功した場合は 1 が返されます。存在しない場合は、0 が返されます。
Example$ssdb->expire('key', 60);
ttl説明
キーの生存時間を返します (KV タイプのみ)。パラメータ
- key
-
戻り値
エラーが発生した場合はfalse が返され、それ以外の場合はキーの生存時間が返されます。 -1は生存時間が設定されていないことを意味します。
Example$ssdb->ttl('key');
getDescription
指定されたキー値の内容を取得します。パラメータ
key
-
戻り値
キーが存在しない場合は null
を返し、エラーが発生した場合は false
を返し、それ以外の場合はキーに対応する値を返します。
例
$ssdb->get('key');#getset
Description
キーに対応する値を更新してリターン更新前の古い値 .Parameter
- key
-
- value
-
戻り値
キーが存在しない場合はnull を返し、エラーが発生した場合は
false を返します。 、それ以外の場合は、キー Content.
Example$ssdb->getset('key', 'value');
##del# に対応する値を返します。 ##説明
指定されたキーを削除します。パラメータ
key
-
戻り値
key
-エラーが発生した場合は false
が返され、それ以外の値は正常を示します。戻り値を使用して、削除されたキーが存在するかどうかを判断することはできません。
Example
$ssdb->del('key');
incr
1.7.0.1 以降、値を整数に変換できない場合、incr はerror.
手順
key
に対応する値を num
だけ増やします。 num
は負の数にすることができます。元の値が整数 (文字列形式の整数) でない場合は、最初に整数に変換されます。
key
-num
- オプション。符号付き整数である必要があります。デフォルトは 1.- です。
戻り値
エラーが発生した場合は false を返し、それ以外の場合は新しい値を返します。
例
$ssdb->incr('key', 1);##存在する
説明
有無の判断指定されたキーが存在します。パラメータ
- key
-
戻り値
存在する場合はtrue を返し、それ以外の場合は
false を返します。
Example$ssdb->exists('key');
getbit説明
文字列内の指定された位置のビット値 (BIT) を取得します。 Parameters- key
- -
- - ビット オフセット
ビット値 (0 または 1) を返します。キーが存在しない場合、またはオフセットがライブ文字列長の範囲を超えている場合は、0 が返されます。
例
$ssdb->getbit('key', 9);
setbit
説明
設定文字列内の指定された位置のビット値 (BIT)、文字列の長さは自動的に拡張されます。
-offset
- ビット オフセット、値の範囲 [0、1073741824]val
- 0 または 1戻り値
元のビット値を返します。val が 0 または 1 でない場合は、
false .
を返します。例
$ssdb->setbit('key', 9, 1);
説明
に含まれるビット数を計算します。文字列の部分文字列 値の数は 1 です。 start が負の数の場合は、文字列の末尾から数えます。end
が負の場合は、数値は、文字列の末尾から数えられます (両端を含む)。Parameters
key
-start
- オプション、部分文字列 Shift# のバイト オフセット- ##end
- オプション
#戻り値
#値が 1 であるビットの数を返します。エラー戻りfalse.
例$ssdb->bitcount('key', 2, 10);
countbit説明
文字列の部分文字列に含まれるビット値 1 の数を計算します。start が負の数の場合は、文字列の末尾から数えます。## の場合#size
は負の数であり、文字列の末尾から多くのバイトが無視されることを意味します。 -
start - オプション、部分文字列のバイト オフセット
- size
- - オプション、部分文字列の長さ ( bytes)、デフォルトは文字列の最後のバイトです
- 戻り値
- false
.
例
$ssdb->countbit('key', 2, 10);
substr
#説明
Get 文字列の部分文字列。
start
が負の数の場合、文字列の末尾から開始します。size
が負の数の場合、文字列の末尾から開始することを意味します。セクション (PHP の substr() に似ています).Parameters
key
-start
- オプション、int、部分文字列のバイト オフセットsize
- オプション、int、部分文字列の長さ (バイト数)、デフォルトは文字列の最後のバイトです。
戻り値
文字列の部分文字列。
例
$ssdb->substr('key', 2, 10);
strlen
説明
長さを計算します。文字列 (バイト数).
パラメータ
key
-
戻り値
文字列の長さを返します。キーが存在しない場合は、0 が返されます。
Example
$ssdb->strlen('key');
keys /rkeys
Description
間隔 (key_start, key_end] 内のキー リストをリストします。
("", ""] は全体を表します) interval.
Parameters
key_start
- 返された開始キー (含まれていません)、空の文字列は -inf. # を意味します- ##key_end
- 返される終了キー (両端を含む)、空の文字列は inf を表します。
- limit
- 返される要素の最大数。
戻り値
エラーが発生した場合はfalse
を返し、それ以外の場合はキーを含む配列を返します。
例
$ssdb->keys('a', 'z', 10);
scan
説明
列間隔のキーと値のリスト (key_start, key_end].
("", ""] は間隔全体を表します。
Parameters
key_start
- 返された開始キー (含まれていません)、空の文字列は -inf を示します。key_end
- 返された終了キー (含まれています)、空の文字列は inf を表します。limit
- 最大でこの数の要素を返すことができます。
#戻り値
エラーが発生した場合は
false
を返し、それ以外の場合はキーと値を含む数値関連グループを返します。Example
$ssdb->scan('a', 'z', 10);
キーを走査します。値ペアのリスト$start = ''; $limit = 1000; while(1){ $kvs = $ssdb->scan($start, '', $limit); if(!$kvs){ break; } // do something on key-value pairs... $keys = array_keys(array_slice($kvs, -1, 1, true)); $max_key = $keys[0]; $start = $max_key; }
rscan
Description
List は間隔 (key_start , key_end] のキーと値のリストの逆順。
("", ""] は間隔全体を表します。
パラメータ
key_start
- 返された開始キー (含まれていません)。空の文字列は inf.- # # を表します。 #key_end
- 返される終了キー (両端を含む)、空の文字列は -inf を意味します。
- limit
- 最大でこの数の要素を返します。
戻り値
エラーが発生した場合はfalse
を返し、それ以外の場合はキーと値を含む数値関連グループを返します。
例
multi_set$ssdb->rscan('a', 'z', 10);
Description
Key-Value のバッチを設定しますatches.Parameters
- ##kvs
- - キーと値を含む連想配列。
値は、エラーがある場合は
falseを返します。その他の値は正常を示します。
Example
multi_getDescription$ssdb->multi_set(array( 'a' => 1, 'b' => 2, ));
キーのバッチに対応する値の内容をバッチで取得します。
パラメータ
keys
- キーを含む配列
戻り値
エラーが発生した場合は
false
が返され、それ以外の場合はキーと値を含む連想配列が返されます。キーが存在しない場合は、返される配列には表示されません。例
$ssdb->multi_get(array('k1', 'k2'));
multi_del
説明
を削除しますバッチ内のバッチ キーとそれに対応する値 content.
Parameters
keys
- key を含む配列.
戻り値
エラーが発生した場合は
false
が返され、それ以外は正常を示します。
hset$ssdb->multi_del(array('k1', 'k2'));
Description
指定された値に対応する値の内容を設定しますハッシュマップ内のキー。
Parameters
name
- ハッシュマップの名前key
- ハッシュマップのキーvalue
- キーに対応する値の内容
戻り値
エラーの場合
#例
#hget説明##ハッシュマップ内の指定されたキーの値の内容を取得します。$ssdb->hset('h', 'key', 'value');
##パラメータ
#name- ハッシュマップの名前。
key- - ハッシュマップ内のキー。
キーが存在しない場合は
null
false を返し、それ以外の場合はキーに対応する値を返します。鍵。###
例
$ssdb->hget('h', 'key');
##hdel説明
入手ハッシュマップ内の指定されたキー。#パラメータ- name
- - ハッシュマップの名前。
- - ハッシュマップのキー
エラーが発生した場合は、
false、その他の値を返します。削除されたキーが存在するかどうかを戻り値から判断することは不可能です。
##hincr
1.7.0.1 以降、値を整数に変換できない場合、incr はエラーを返します。
手順ハッシュマップ ##keyで # を有効にします。対応する値は
numだけ増加します。パラメータ num には負の数を指定できます。元の値の場合、は整数 (文字列形式の整数) ではないため、Integer.
に変換されます。Parameters
name
- ハッシュマップの名前。key
-num
- オプション。符号付き整数である必要があります。デフォルトは 1 です。
戻り値
エラー
false
が発生します。それ以外の場合は、新しい値を返します。Example
$ssdb->hdel('h', 'key');
hexists
説明
指定されたキーがハッシュマップに存在するかどうかを確認します。
パラメータ
-
name
- ハッシュマップの名前。 key
-
戻り値
存在する場合は
true
を返し、存在しない場合はfalse
を返します。Example
$ssdb->hincr('h', 'key', 1);
hsize
説明
ハッシュマップ内の要素の数を返します。
パラメータ
name
- ハッシュマップの名前。
戻り値
エラーが発生した場合は、
false
が返されます。それ以外の場合は、要素の数が返されます。0 は、ハッシュマップがない (空) ことを意味します。例
$ssdb->hexists('h', 'key');
hlist, hrlist
Description
名前が含まれているハッシュマップをリストします。間隔 (name_start, name_end].
("", ""] は間隔全体を表します。
パラメータ
- # name_start
- 返された開始名 (含まれていません)、空の文字列は -inf を表します。
- name_end
- 返された終了名 (含まれていません)、空の文字列は inf を表します。
- limit
- 最大でこの数の要素を返します。
戻り値
エラーが発生した場合、false
が返されます。配列を含む名前を返します。
例
$ssdb->hsize('h');
##hkeys説明
列の出力間隔内のハッシュマップ内のキー リスト (key_start, key_end].("", ""] は間隔全体を表します。Parameters
- name
- ハッシュマップの名前。
- key_start
- 開始キー (含まれていません)、空の文字列は -inf を意味します。
- key_end
- 終了キー (両端を含む)、空の文字列は inf を表します。
- limit
- 最大でこの数の要素を返します。
戻り値
エラーが発生した場合はfalse
を返し、それ以外の場合はキーを含む配列を返します。
例
hgetall$ssdb->hlist('a', 'z', 10);
Description
ハッシュマップ全体を返します。パラメータ
name
- ハッシュマップの名前。
戻り値
エラーが発生した場合は
false
を返し、それ以外の場合はキーと値を含む連想配列を返します。Example
$ssdb->hkeys('h', 'a', 'z', 10);
hscan
#Description
ハッシュマップ内の間隔 (key_start, key_end] 内のキーと値のリストをリストします。 ("", ""] は範囲全体を表します。パラメータ
- name
- 名前
- key_start
- 返された開始キー (含まれていません)、空の文字列は -inf を意味します。
- key_end
- 返された終了キー (含まれます)、空の文字列表現 inf.
- limit
- 最大でこの数の要素を返します。
戻り値
If エラーが発生した場合はfalse
が返され、それ以外の場合はキーと値を含む連想配列が返されます。
Example
Traverseハッシュ:$ssdb->hgetall('h');
$ssdb->hscan('h', 'a', 'z', 10);
}hrscan
Description
間隔 (key_start, key_end] キー内のハッシュマップをリストします) -値のリスト、逆順。
##("", ""] は間隔全体を表します。#パラメータ
# # name- - ハッシュマップの名前。
key_start
- 返された開始キー (含まれていません)。空の文字列は inf.key_end を表します。
- 返される終了キー (両端を含む)、空の文字列は -inf を意味します。limit
- 最大でこの数の要素を返します。#戻り値
エラーが発生した場合は false を返し、それ以外の場合はキースコアを含む連想配列を返します。
例
$start = ''; while(1){ $kvs = $ssdb->hscan($name, $start, '', 10); if(!$kvs){ break; } // do sth on kvs here
#zrscan$keys = array_keys($kvs); $start = $keys[count($keys) - 1];
hclearDescription
ハッシュマップ内のすべてのキーを削除します。
パラメータ
name
- ハッシュマップの名前。
戻り値
エラーが発生した場合は
false
を返し、それ以外の場合は削除されたキーの数を返します。Example
$ssdb->hrscan('h', 'a', 'z', 10);
multi_hset
Description
ハッシュマップにキーと値をバッチ設定します。
パラメータ
name
- ハッシュマップの名前。kvs
- キーと値を含む連想配列。
戻り値
エラーが発生した場合は
false
を返し、それ以外は正常を示します。 #Example
multi_hget$ssdb->hclear('h');
説明
重量値を取得するハッシュマップ内の複数のキーにバッチで対応します。
Parameters
name
- ハッシュマップの名前keys
- を含む配列
戻り値
エラーが発生した場合は
false
を返し、それ以外の場合はキーと値を含む連想配列を返します。キーが存在しない場合、返される配列には表示されません。Example
$ssdb->multi_hset('h', array( 'a' => 1, 'b' => 2, ));
multi_hdel
手順
ハッシュマップ内のキーをバッチで削除します。
パラメータ
名前
- ハッシュマップの名前。keys
- キーを含む配列。
戻り値
エラーの場合は
false
を返し、他の値は正常を示します。例
$ssdb->multi_hget('h', array('k1', 'k2'));
zset
説明
指定されたキーに対応する重み値を zset.
に設定します。Parameters
name
- zset の名前key
- zset のキー.score
- 整数、キーに対応する重み値
戻り値
エラーの場合発生した場合は
false
が返され、その他の値は正常を示します。Example
$ssdb->multi_hdel('h', array('k1', 'k2'));
zget
説明
zset で指定されたキーの重み値を取得します。
Parameters
name
- zset の名前。key
- zset 内のキー。
戻り値
キーが存在しない場合は
null
を返し、エラーがある場合はfalse
を返し、それ以外の場合はキーに対応する重み値を返します。例
$ssdb->zset('z', 'key', 100);
##zdel説明
入手zset.Parameters
- name
で指定されたキー - zset.
- key の名前
- key.
戻り値
エラーが発生した場合は、false
、その他の値を返します。削除されたキーが存在するかどうかを戻り値から判断することは不可能です。
#Example
zincr$ssdb->zget('z', 'key');
Description
zset のkey
に対応する値を
numだけ増やします。パラメータ
numには負の数を指定できます。元の値が整数 (文字列形式の整数) でない場合は、最初に整数に変換されます。
Parameters
name
- zset の名前。key
-num
- 符号付き整数である必要があります。
戻り値
エラーが発生した場合は、
false
が返されます。それ以外の場合は、新しい値を返します。Example
$ssdb->zdel('hz, 'key');
##zexists説明
指定されたキーが zset に存在するかどうかを確認します。パラメータ
- name
- zset Name.
- key
-
戻り値
存在する場合は、true#を返します## 、それ以外の場合は
Examplefalse
.
##zsize## を返します。 #説明$ssdb->zincr('z', 'key', 1);
zset 内の要素の数を返します。
#パラメータ
- name
- zset の名前。
戻り値
エラーが発生した場合は、false
が返されます。それ以外の場合は、要素の数が返されます。0 は、zset がない (空) ことを意味します。
Example
zlist、zrlist$ssdb->zexists('z', 'key');
Description
zset.## の名前をリストします。間隔内にあります (name_start, name_end]#("", ""] は間隔全体を表します。
Parameters- name_start
- - 返された開始名 (含まれていません)、空の文字列は -inf を表します。
- - 返された終了名 (含まれていません)、空の文字列は inf を表します。
- - 最大でこの数の要素を返します。
エラーが発生した場合は、
falseが返されます。それ以外の場合は、Array.
という名前を含む名前が返されます。
例
$ssdb->zsize('z');
zkeys
説明
列zset でキーのリストを取得します。
zscan()
.parameter
name を参照してください。
- zset の名前。key_start
-zscan()
.を参照してください。 core_start
-zscan()
.score_end
-zscan()# を参照## .
- limit
- 最大でこの数の要素を返します。
戻り値
エラーfalse
が発生します。それ以外の場合は、key.
を含む配列を返します。例
$ssdb->zlist('a', 'z', 10);
##zscan説明
列の抽出間隔内にある zset 内のキースコアリスト (key_start スコア_スタート、スコア_エンド]。key_start が空の場合、score_start 以上の対応する重み値を持つキーが返されます。key_start が空でない場合、または、key_start より大きく、score_start に等しい対応する重み値を持つキーが返されます。つまり、返されるキーは次のとおりです。(key.score == スコア_スタート && キー > キー_スタート || キー.スコア > スコア_スタート)、および key.score <= スコア_エンド
("", ""] は間隔全体を表します。間隔.
最初にスコア_スタート、スコア_エンドを決定し、次にkey_start.Parameters
- name
- zset の名前。
- key_start
-score_start 対応するキー。
- score_start
- キーの最小重み値を返します (含まれない場合があります。key_start に依存します)、空の文字列は -inf.
- score_end
を意味します - キーの最大重み値 (これを含む) を返します、空の文字列は inf.## を示します
#limit - - 最大でこの数の要素を返します。
エラーが発生した場合は、## を返します。 #false
、それ以外の場合は、キースコアを含む連想配列を返します。Example
}$ssdb->zkeys('z', '', 1, 100, 10);
Traverse zset:$ssdb->zscan('z', '', 1, 100, 10);
Description
zset のキースコアリストを逆順でリストします。parameters
- ##name
- - zset Name.# を参照してください。
##key_start
- zkeys()
.
score_start を参照 - - ## を参照#zkeys()
.
score_end
- - zkeys()
.
## を参照してください。 #limit - 最大でこの数の要素を返します。
戻り値
false,それ以外の場合は、キースコアを含む連想配列を返します。
Example
$key_start = ''; $score_start = ''; while(1){ $items = $ssdb->zscan($zname, $key_start, $score_start, '', 10); if(!$items){ break; } foreach($items as $key=>$score){ // process($key, $score)...
// 记住最大的元素和它的权重 $key_start = $key; $score_start = $score; }
##zrank, zrrank
手順注意!この方法は非常に時間がかかる可能性があります!オフライン環境で使用してください。zset 内の指定されたキーのソート位置 (ランキング) を返します。ランキングは 0 から始まります。zrrank は逆順のランキングを取得します。
パラメータ
-
#name
- zset の名前 #key
-
戻り値
found .##エラーが発生した場合は、false
が返されます。
nullは、キーが zset に存在しないことを意味します。それ以外の場合は、ランキングが
Example
#zrange、zrrange手順$ssdb->zrscan('z', '', 100, 1, 10);
注 ! オフセットが大きくなると、このメソッドは遅くなります!
##添え字インデックス間隔に従ってキーとスコアのペアを取得します [offset,オフセット制限)、添字は 0 から始まります。zrrange は逆の順序で取得します。
Parameters
name
- zset の名前。offset
- 正の整数、これからインデックスで返し始めます。0 から開始します。limit
- 正の整数、最大でこの数のキーとスコアのペアを返します。
戻り値
エラーが発生した場合は
false
を返し、それ以外の場合はキースコアを含む連想配列を返します。例
$ssdb->zrank('z', 'k1');
zclear
Description
zset 内のすべてのキーを削除します。
パラメータ
name
- zset の名前。
戻り値
エラーが発生した場合は
false
を返し、それ以外の場合は削除されたキーの数を返します。Example
$ssdb->zrange('z', 0, 10);
zcount
説明
区間 [開始、終了] 内のキーの数を返します。
Parameters
name
- zset の名前score_start
- 最小重みキーの値 (包括的)、空の文字列は -inf.score_end
を表します - キーの最大重み値 (包括的)、空の文字列は inf. ## を表します
#戻り値##エラーが発生した場合は
falseを返し、それ以外の場合は条件を満たすキーの数を返します。
##例
$ssdb->zclear('z');
説明
次の合計を返します。区間 [start,end] のキーのスコア
Parameters
name
- - zset.## の名前
#score_start
- キー 最小重み値 (両端を含む)、空の文字列は -inf を表します。score_end
- キーの最大重み値(両端を含む)、空の文字列は inf を表します。戻り値
エラーが発生した場合は、false を返し、それ以外の場合は、条件を満たすスコアの合計。
例
$ssdb->zcount('z', 0, 100);
##zavg説明
返却key は、区間 [開始、終了] 内のスコアの平均値です。パラメータ
- name
- の名前zset.
- score_start
- キーの最小重み値 (両端を含む)。空の文字列は -inf.
- score_end
- 最大値を示します。 key の重み値 (両端を含む)、空の文字列は inf を表します。
戻り値
エラーが発生した場合は、false## を返します。 #、それ以外の場合は、条件を満たす平均スコアを返します。 Value.
Example
zremrangebyrank 説明$ssdb->zsum('z', 0, 100);
位置が [start,end] の範囲内にある要素を削除します。
Parameters
name
- zset.start
の名前 (これを含む)。end
-(包括的).
戻り値
エラーが発生した場合は、
false
が返されます。それ以外の場合は、削除された要素の数を返します。Example
$ssdb->zavg('z', 0, 100);
zremrangebyscore
説明
重みが [開始、終了] の範囲内にある要素を削除します。
##パラメータ
- name
- zset の名前。
- start
- (これを含む)。
- end
-(
戻り値
エラーが発生した場合はfalse
が返され、それ以外の場合は削除された要素の数が返されます。
例
$ssdb->zremrangebyrank('z', 1, 2);
zpop_front
説明
From zset ヘッダーは
limit
要素を削除して返します。Parameters
name
- zset の名前.limit
- 正の整数、削除されて返されるキーとスコアのペアの最大数。
戻り値
エラーが発生した場合は
false
を返し、それ以外の場合はキースコアを含む連想配列を返します。Example
$ssdb->zremrangebyscore('z', 1, 2);
zpop_back
Description
zset の末尾から
limit
要素を削除して返します。Parameters
name
- zset の名前limit
- 正の整数、最大でも多くのキーとスコアのペアを削除して返します。
戻り値
エラーが発生した場合は、
false
が返されます。それ以外の場合は、キーが返されます。 -score.Example
$ssdb->zpop_front('z', 3);
multi_zset
の連想配列説明
zset のキースコアをバッチ設定します。
パラメータ
name
- zset の名前 .kvs
- key-score を含む連想配列
戻り値
エラーが発生した場合は ##false
が返され、その他の値は正常を示します。
#Example
multi_zget$ssdb->zpop_back('z', 3);
手順##zset 内の複数のキーに対応する重み値をバッチで取得します。
Parameters
name
- zset の名前keys
- キーを含む配列.
戻り値
エラーが発生した場合は
false
を返し、それ以外の場合はキースコアを含む連想配列を返します。キーが存在しない場合、返される配列には表示されません。Example
$ssdb->multi_zset('z', array( 'a' => 1, 'b' => 2, ));
multi_zdel
手順
zset 内のキーをバッチで削除します。
パラメータ
名前
- zset の名前。keys
- キーを含む配列。
戻り値
エラー
false
の場合に返され、他の値は正常を示します。例
$ssdb->multi_zget('z', array('k1', 'k2'));
qsize
説明
キューの長さを返します。
パラメータ
名前
-
戻り値
エラーの場合は
false
を返し、それ以外の場合は整数を返します。0 はキューが存在しない (または空である) ことを意味します。Example
$ssdb->multi_zdel('z', array('k1', 'k2'));
qlist, qrlist
Description
名前が間隔 (name_start, name_end] 内にあるキュー/リストをリストします。
("", ""] は間隔全体を表します。
Parameters
name_start
- 返される開始名 (含まれない)、空の文字列は -inf.name_end
を表します - 返された終了名 (これを含む)、空の文字列は inf.- ## を表します#limit
- 最大でこの数の要素を返します。
戻り値
エラーが発生した場合は、false
が返されます。 、名前を含む配列が返されます。
例
$ssdb->qsize('q');
qclear
説明
クリアキュー。
パラメータ
名前
-
戻り値
エラーが返されました
false
.Example
$ssdb->qlist('a', 'z', 10);
##qfront説明
キューの最初の要素を返します。#パラメータ
- ## name
- -
エラーが発生した場合は、
falseが返されます。キューが存在しない場合は、 (または空の場合)、# が返されます。##null
、それ以外の場合は要素を返します。
例
$ssdb->qclear('q');
qback
説明
Returnキューの最後の要素。
パラメータ
name
-
Return値
エラーが発生した場合は、
false
が返されます。キューが存在しない (または空の) 場合は、null
が返されます。それ以外の場合は、要素が返されます。Example
$ssdb->qfront('q');
qget
Description
指定された位置にある要素を返します。0 は最初の要素を意味し、1 は 2 番目の要素を意味します... -1 は最後の要素を意味します。
パラメータ
name
-index
- 負の数値を渡すことができます。
##戻り値
Error returnfalse
、指定された位置に要素が存在しない場合は
nullを返し、それ以外の場合は要素を返します。
例
$ssdb->qback('q');
qset
以降: 1.7.0.0
説明
#インデックス位置にある要素を更新します。既存の要素の範囲を超える場合はエラーが返されます。
パラメータ
name
-index
- 負の数値を渡すことができます。val
-
戻り値
エラーが発生した場合は
false
を返し、それ以外は正常を示します。例
qrange$ssdb->qget('q', -2);
説明
添え字が含まれる要素を返します。領域 [オフセット、オフセット制限].
Parameters
name
- キューの名前。offset
- 整数。ここからは 0 から返し始めます。負の数も可能です。これは、最後から数えることを意味します。limit
- 正の整数。最大でこの数の要素を返すことができます。
戻り値
エラーが発生した場合は
false
を返し、それ以外の場合は配列を返します。例
$ssdb->qset('q', 0, 'new val');
qslice
説明
添え字が含まれる要素を返します。領域 [begin, end]. begin と end can 負の数です
Parameter
name
-begin
-end
-
戻り値
エラーの場合発生した場合は
false
が返され、それ以外の場合は要素を含む配列が返されます。例
$ssdb->qrange('q', 0, 10);
##qpush説明
これ関数はqpush_back()
##qpush_frontDescriptionのエイリアスです。
キューの先頭に 1 つ以上の要素を追加します
##パラメータ
name
-- #item
- 文字列または文字列配列。
戻り値
.
例$ssdb->qslice('q', 0, -1);
##qpush_back
説明1 つ以上の要素をキューの最後に追加しますパラメータ
name
-item
- 文字列または文字列配列。
戻り値
要素を追加した後、キューの長さ、エラーが返されます
false
.例
$ssdb->qpush_front('q', 'a');
qpop
説明
この関数は
qpop_front( ) です
alias.qpop_front
Description
先頭から 1 つポップします。キューまたは複数の要素。
Parameters
name
-size
- オプション、最大でこの数までポップできますキューからの要素
戻り値
Error returns
Examplefalse
.size
が指定されていない、または指定されている場合1 以下の場合、キューが存在しない (または空の) 場合はnull
を返し、それ以外の場合は削除して要素を返します。 、ポップされた要素を含む配列を返します。
qpop_back手順$ssdb->qpush_back('q', 'a');
#From キューの最後から 1 つ以上の要素をポップします。
#パラメータname
- -
size
- オプション、最大でこの数の要素をキューからポップできます
エラーは false
を返します。 ## の場合 #sizeが指定されていないか、1 以下の場合、キューが存在しない (または空の) 場合、
null
が返されます。それ以外の場合は、要素が削除されて返されます。size
が 2 以上の場合、ポップされた要素を含む配列を返します。例
$ssdb->qpop_front('q');
qtrim_front
手順
からキューの先頭から複数の要素を削除します。
Parameters
name
-size
- 最大でこの数の要素をキューから削除します
戻り値
エラー時に返される
false
。数値を返します。削除された要素の数。例
$ssdb->qpop_back('q');
qtrim_back
説明
キューの先頭から複数の要素を削除します。
#パラメータ
- #name
- -
- - キューから削除される要素の最大数
エラー戻り値
false. 削除された要素の数を返します。
例
$ssdb->qtrim_front('q', 3);
バッチ、実行
説明
# #一連のコマンドをバッチで実行します。バッチ コマンドを使用すると、クライアントとサーバー間の対話遅延が減少し、パフォーマンスと応答速度が向上します。
この機能はクライアント ssdb-server に実装されています。バッチ コマンドはサポートされていませんが、独立したコマンドとして 1 つずつ実行されます。すべてのコマンドとパラメーターのサイズは 10MB 未満である必要があります。
#パラメーター
戻り値
exec()
がエラーを起こした場合、false
を返します。それ以外の場合は 1 を返します。配列には、各コマンドに対応する結果が含まれます。Example
$ssdb->qtrim_back('q', 3);
dbsize
説明
データベースの 推定サイズをバイト単位で返します。サーバーで圧縮が有効になっている場合は、圧縮されたサイズを返します。
パラメータ
戻り値
エラー戻り値
false
データベースのサイズを返します。 .例
$ret = $ssdb->batch() ->set('a', 1) ->get('a') ->exec(); // 或者 $ssdb->batch(); $ssdb->set('a', 1); $ssdb->get('a'); $ret = $ssdb->exec();
情報
説明
サーバー情報を返します。
パラメータ
opt
- オプション。cmd、leveldb
戻り値
エラー戻り値
false
。サーバー情報の連想配列を返します。例
$ssdb->dbsize();