インターフェース RedisKeyCommands

メソッドの詳細

• copy

  @Nullable BooleanSE copy(byte[] sourceKey, byte[] targetKey, boolean replace)

  指定された sourceKey を targetKey にコピーします。

  パラメーター:

  sourceKey - null であってはなりません。

  targetKey - null であってはなりません。

  replace - 既存のキーを置き換えるかどうか。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  導入:

  2.6

  関連事項:

  • Redis ドキュメント: COPY

• exists

  @Nullable default BooleanSE exists(byte[] key)

  指定された key が存在するかどうかを判別します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  キーが存在する場合は true。パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: EXISTS

• exists

  @Nullable LongSE exists(byte[]... keys)

  指定された keys がいくつ存在するかを数えます。まったく同じ key を複数回提供することも、複数回カウントされます。

  パラメーター:

  keys - null であってはなりません。

  戻り値:

  引数として指定されたキーの中に存在するキーの数。パイプライン / トランザクションで使用される場合は null。

  導入:

  2.1

• del

  @Nullable LongSE del(byte[]... keys)

  指定された keys を削除します。

  パラメーター:

  keys - null であってはなりません。

  戻り値:

  削除されたキーの数。パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: DEL

• unlink

  @Nullable LongSE unlink(byte[]... keys)

  キースペースから keys のリンクを解除します。del(byte[]...) とは異なり、ここでの実際のメモリの再利用は非同期で行われます。

  パラメーター:

  keys - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  導入:

  2.1

  関連事項:

  • Redis ドキュメント: UNLINK

• type

  @Nullable DataType type(byte[] key)

  key に保存されている型を判別します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: TYPE

• touch

  @Nullable LongSE touch(byte[]... keys)

  指定された key(s) の最終アクセス時間を変更します。

  パラメーター:

  keys - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  導入:

  2.1

  関連事項:

  • Redis ドキュメント: TOUCH

• keys

  @Nullable SetSE<byte[]> keys(byte[] pattern)

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

  重要 : KEYS コマンドは中断不可能であり、キースペース全体をスキャンするため、パフォーマンスの問題が発生する可能性があります。大規模なデータセットの場合は scan(ScanOptions) の使用をご検討ください。

  パラメーター:

  pattern - null であってはなりません。

  戻り値:

  一致するものが見つからない場合は、SetSE を空にします。パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: KEYS

• scan

  default Cursor<byte[]> scan(KeyScanOptions options)

  Cursor を使用して、キーを繰り返し処理します。

  パラメーター:

  options - null であってはなりません。

  戻り値:

  決して null にはなりません。

  導入:

  2.4

  関連事項:

  • Redis ドキュメント: SCAN

• scan

  Cursor<byte[]> scan(ScanOptions options)

  Cursor を使用して、キーを繰り返し処理します。

  パラメーター:

  options - null であってはなりません。

  戻り値:

  決して null にはなりません。

  導入:

  1.4

  関連事項:

  • Redis ドキュメント: SCAN

• randomKey

  @Nullable byte[] randomKey()

  キースペースからランダムなキーを返します。

  戻り値:

  使用可能なキーがない場合、またはパイプラインまたはトランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: RANDOMKEY

• rename

  void rename(byte[] oldKey, byte[] newKey)

  キー oldKey の名前を newKey に変更します。

  パラメーター:

  oldKey - null であってはなりません。

  newKey - null であってはなりません。

  関連事項:

  • Redis ドキュメント: RENAME

• renameNX

  @Nullable BooleanSE renameNX(byte[] oldKey, byte[] newKey)

  newKey が存在しない場合にのみ、キー oldKey の名前を newKey に変更します。

  パラメーター:

  oldKey - null であってはなりません。

  newKey - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: RENAMENX

• applyExpiration

  @Nullable default BooleanSE applyExpiration(byte[] key, Expiration expiration, ExpirationOptions options)

  パラメーター:

  key - null であってはなりません。

  expiration - 適用する Expiration

  options - コマンドとともに送信される追加オプション。

  戻り値:

  パイプライン / トランザクションで使用する場合は null になります。タイムアウトが設定されている場合は true、タイムアウトが設定されていない場合は false になります。たとえば、キーが存在しないか、指定された引数のために操作がスキップされました。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: EXPIRE
  • Redis ドキュメント: PEXPIRE
  • Redis ドキュメント: EXPIREAT
  • Redis ドキュメント: PEXPIREAT
  • Redis ドキュメント: PERSIST

• expire

  @Nullable default BooleanSE expire(byte[] key, long seconds)

  指定された key の存続時間を秒単位で設定します。

  パラメーター:

  key - null であってはなりません。

  seconds -

  戻り値:

  パイプライン / トランザクションで使用する場合は null になります。タイムアウトが設定されている場合は true、タイムアウトが設定されていない場合は false になります。たとえば、キーが存在しないか、指定された引数のために操作がスキップされました。

  関連事項:

  • Redis ドキュメント: EXPIRE

• expire

  @Nullable BooleanSE expire(byte[] key, long seconds, ExpirationOptions.Condition condition)

  指定された key の存続時間を秒単位で設定します。

  パラメーター:

  key - null であってはなりません。

  seconds -

  戻り値:

  パイプライン / トランザクションで使用する場合は null になります。タイムアウトが設定されている場合は true、タイムアウトが設定されていない場合は false になります。たとえば、キーが存在しないか、指定された引数のために操作がスキップされました。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: EXPIRE

• expire

  @Nullable default BooleanSE expire(byte[] key, DurationSE duration)

  seconds 精度を使用して、指定された key の有効期間を設定します。

  パラメーター:

  key - null であってはなりません。

  duration -

  戻り値:

  パイプライン / トランザクションで使用する場合は null になります。タイムアウトが設定されている場合は true、タイムアウトが設定されていない場合は false になります。たとえば、キーが存在しないか、指定された引数のために操作がスキップされました。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: EXPIRE

• pExpire

  @Nullable default BooleanSE pExpire(byte[] key, long millis)

  特定の key の存続時間をミリ秒単位で設定します。

  パラメーター:

  key - null であってはなりません。

  millis -

  戻り値:

  パイプライン / トランザクションで使用する場合は null になります。タイムアウトが設定されている場合は true、タイムアウトが設定されていない場合は false になります。たとえば、キーが存在しないか、指定された引数のために操作がスキップされました。

  関連事項:

  • Redis ドキュメント: PEXPIRE

• pExpire

  @Nullable BooleanSE pExpire(byte[] key, long millis, ExpirationOptions.Condition condition)

  特定の key の存続時間をミリ秒単位で設定します。

  パラメーター:

  key - null であってはなりません。

  millis -

  戻り値:

  パイプライン / トランザクションで使用する場合は null になります。タイムアウトが設定されている場合は true、タイムアウトが設定されていない場合は false になります。たとえば、キーが存在しないか、指定された引数のために操作がスキップされました。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: PEXPIRE

• pExpire

  @Nullable default BooleanSE pExpire(byte[] key, DurationSE duration)

  milliseconds 精度を使用して、指定された key の有効期間を設定します。

  パラメーター:

  key - null であってはなりません。

  duration -

  戻り値:

  パイプライン / トランザクションで使用する場合は null になります。タイムアウトが設定されている場合は true、タイムアウトが設定されていない場合は false になります。たとえば、キーが存在しないか、指定された引数のために操作がスキップされました。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: PEXPIRE

• expireAt

  @Nullable default BooleanSE expireAt(byte[] key, long unixTime)

  指定された key の有効期限を UNIX タイムスタンプとして設定します。

  パラメーター:

  key - null であってはなりません。

  unixTime -

  戻り値:

  パイプライン / トランザクションで使用する場合は null になります。タイムアウトが設定されている場合は true、タイムアウトが設定されていない場合は false になります。たとえば、キーが存在しないか、指定された引数のために操作がスキップされました。

  関連事項:

  • Redis ドキュメント: EXPIREAT

• expireAt

  @Nullable BooleanSE expireAt(byte[] key, long unixTime, ExpirationOptions.Condition condition)

  指定された key の有効期限を UNIX タイムスタンプとして設定します。

  パラメーター:

  key - null であってはなりません。

  unixTime -

  戻り値:

  パイプライン / トランザクションで使用する場合は null になります。タイムアウトが設定されている場合は true、タイムアウトが設定されていない場合は false になります。たとえば、キーが存在しないか、指定された引数のために操作がスキップされました。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: EXPIREAT

• expireAt

  @Nullable default BooleanSE expireAt(byte[] key, InstantSE unixTime)

  指定された key の有効期限を、seconds 精度の UNIX タイムスタンプとして設定します。

  パラメーター:

  key - null であってはなりません。

  unixTime -

  戻り値:

  パイプライン / トランザクションで使用する場合は null になります。タイムアウトが設定されている場合は true、タイムアウトが設定されていない場合は false になります。たとえば、キーが存在しないか、指定された引数のために操作がスキップされました。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: EXPIREAT

• pExpireAt

  @Nullable default BooleanSE pExpireAt(byte[] key, long unixTimeInMillis)

  指定された key の有効期限を UNIX タイムスタンプとしてミリ秒単位で設定します。

  パラメーター:

  key - null であってはなりません。

  unixTimeInMillis -

  戻り値:

  パイプライン / トランザクションで使用する場合は null になります。タイムアウトが設定されている場合は true、タイムアウトが設定されていない場合は false になります。たとえば、キーが存在しないか、指定された引数のために操作がスキップされました。

  関連事項:

  • Redis ドキュメント: PEXPIREAT

• pExpireAt

  @Nullable BooleanSE pExpireAt(byte[] key, long unixTimeInMillis, ExpirationOptions.Condition condition)

  指定された key の有効期限を UNIX タイムスタンプとしてミリ秒単位で設定します。

  パラメーター:

  key - null であってはなりません。

  unixTimeInMillis -

  戻り値:

  パイプライン / トランザクションで使用する場合は null になります。タイムアウトが設定されている場合は true、タイムアウトが設定されていない場合は false になります。たとえば、キーが存在しないか、指定された引数のために操作がスキップされました。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: PEXPIREAT

• pExpireAt

  @Nullable default BooleanSE pExpireAt(byte[] key, InstantSE unixTime)

  指定された key の有効期限を、milliseconds 精度の UNIX タイムスタンプとして設定します。

  パラメーター:

  key - null であってはなりません。

  unixTime -

  戻り値:

  パイプライン / トランザクションで使用する場合は null になります。タイムアウトが設定されている場合は true、タイムアウトが設定されていない場合は false になります。たとえば、キーが存在しないか、指定された引数のために操作がスキップされました。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: PEXPIREAT

• persist

  @Nullable BooleanSE persist(byte[] key)

  指定された key から有効期限を削除します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: PERSIST

• move

  @Nullable BooleanSE move(byte[] key, int dbIndex)

  指定された key を index を使用してデータベースに移動します。

  パラメーター:

  key - null であってはなりません。

  dbIndex -

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: MOVE

• ttl

  @Nullable LongSE ttl(byte[] key)

  key の存続時間を数秒で取得します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: TTL

• ttl

  @Nullable LongSE ttl(byte[] key, TimeUnitSE timeUnit)

  key の存続時間を取得し、指定された TimeUnitSE に変換します。

  パラメーター:

  key - null であってはなりません。

  timeUnit - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  導入:

  1.8

  関連事項:

  • Redis ドキュメント: TTL

• pTtl

  @Nullable LongSE pTtl(byte[] key)

  key の正確な存続時間をミリ秒単位で取得します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: PTTL

• pTtl

  @Nullable LongSE pTtl(byte[] key, TimeUnitSE timeUnit)

  key の正確な存続時間を取得し、指定された TimeUnitSE に変換します。

  パラメーター:

  key - null であってはなりません。

  timeUnit - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  導入:

  1.8

  関連事項:

  • Redis ドキュメント: PTTL

• sort

  @Nullable ListSE<byte[]> sort(byte[] key, SortParameters params)

  key の要素を並べ替えます。

  パラメーター:

  key - null であってはなりません。

  params - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: SORT

• sort

  @Nullable LongSE sort(byte[] key, SortParameters params, byte[] storeKey)

  key の要素を並べ替え、結果を storeKey に保存します。

  パラメーター:

  key - null であってはなりません。

  params - null であってはなりません。

  storeKey - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: SORT

• dump

  @Nullable byte[] dump(byte[] key)

  key に格納されている値の直列化されたバージョンを取得します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  キーが存在しない場合、またはパイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: DUMP

• restore

  default void restore(byte[] key, long ttlInMillis, byte[] serializedValue)

  以前に dump(byte[]) を使用して取得した serializedValue を使用して key を作成します。

  パラメーター:

  key - null であってはなりません。

  ttlInMillis -

  serializedValue - null であってはなりません。

  関連事項:

  • Redis ドキュメント: RESTORE

• restore

  void restore(byte[] key, long ttlInMillis, byte[] serializedValue, boolean replace)

  以前に dump(byte[]) を使用して取得した serializedValue を使用して key を作成します。

  パラメーター:

  key - null であってはなりません。

  ttlInMillis -

  serializedValue - null であってはなりません。

  replace - エラーの代わりに true を使用して、存在する可能性のある値を置き換えます。

  導入:

  2.1

  関連事項:

  • Redis ドキュメント: RESTORE

• encodingOf

  @Nullable ValueEncoding encodingOf(byte[] key)

  指定された key で値を格納するために使用される内部表現の型を取得します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  キーが存在しない場合は ValueEncoding.RedisValueEncoding.VACANT、パイプライン / トランザクションで使用される場合は null。

  例外:

  IllegalArgumentExceptionSE - key が null の場合。

  導入:

  2.1

  関連事項:

  • Redis ドキュメント: OBJECT ENCODING

• idletime

  @Nullable DurationSE idletime(byte[] key)

  指定された key に格納されているオブジェクトがアイドル状態であるため、DurationSE を取得します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  キーが存在しない場合、またはパイプライン / トランザクションで使用される場合は null。

  例外:

  IllegalArgumentExceptionSE - key が null の場合。

  導入:

  2.1

  関連事項:

  • Redis ドキュメント: OBJECT IDLETIME

• refcount

  @Nullable LongSE refcount(byte[] key)

  指定された key に関連付けられた値の参照の数を取得します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  キーが存在しない場合、またはパイプライン / トランザクションで使用される場合は null。

  例外:

  IllegalArgumentExceptionSE - key が null の場合。

  導入:

  2.1

  関連事項:

  • Redis ドキュメント: OBJECT REFCOUNT