Redis コネクタリファレンス

設定


Redis

パラメータ

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定に指定できる接続型。

x

Expiration Policy (有効期限ポリシー)

ランタイムで有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最小時間を設定します。これは、対象になった瞬間にプラットフォームでインスタンスの有効期限が切れるという意味ではありません。ランタイムによって適切と判断されたときに、インスタンスが実際にパージされます。

接続種別

Clustered (クラスタ)

パラメータ

名前 説明 デフォルト値 必須

Cluster Hosts (クラスタホスト)

String (文字列)

Redis クラスタホストを「ホスト:ポート」の形式でカンマで区切って指定します。コネクタ経由で Redis クラスタにアクセスする場合は、この項目を使用してください。

Connection Timeout (接続タイムアウト)

Number (数値)

接続タイムアウト (ミリ秒)。

2000

Entry TTL (エントリ TTL)

Number (数値)

コネクタ経由で格納されるキーで設定されるデフォルトの存続期間。

Reconnection (再接続)

アプリケーションがデプロイされたときに、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Max Total (最大合計)

Number (数値)

8

Max Idle (最大アイドル)

Number (数値)

8

Min Idle (最小アイドル)

Number (数値)

0

Lifo (LIFO)

Boolean (ブール)

true

Fairness (公平性)

Boolean (ブール)

false

Max Wait Millis (最大待機時間)

Number (数値)

-1

Min Evictable Idle Time Millis (最小除去可能アイドル時間)

Number (数値)

1800000

Soft Min Evictable Idle Time Millis (ソフトウェアと最小削除可能アイドル時間)

Number (数値)

1800000

Num Tests Per Eviction Run (除去実行あたりのテスト回数)

Number (数値)

3

Test On Create (作成時のテスト)

Boolean (ブール)

false

Test On Borrow (借用時のテスト)

Boolean (ブール)

false

Test On Return (戻り時のテスト)

Boolean (ブール)

false

Test While Idle (アイドル中のテスト)

Boolean (ブール)

false

Time Between Eviction Runs Millis (除去実行間隔)

Number (数値)

-1

Block When Exhausted (枯渇時にブロック)

Boolean (ブール)

true

Jmx Enabled (JMX 有効化)

Boolean (ブール)

true

Jmx Name Prefix (JMX 名プレフィックス)

String (文字列)

pool

Jmx Name Base (JMX 名ベース)

String (文字列)

NonClustered

パラメータ

名前 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

Redis ホスト。クラスタに属さない Redis サーバにコネクタ経由でアクセスする場合は、この項目を使用します。

localhost

Port (ポート)

Number (数値)

Redis ポート。非クラスタサーバが動作しているポート。

6379

Connection Timeout (接続タイムアウト)

Number (数値)

接続タイムアウト (ミリ秒)。

2000

Password (パスワード)

String (文字列)

Redis パスワード。サーバで認証が必要な場合に設定します。

Entry TTL (エントリ TTL)

Number (数値)

コネクタ経由で格納されるキーで設定されるデフォルトの存続期間。

Reconnection (再接続)

アプリケーションがデプロイされたときに、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Max Total (最大合計)

Number (数値)

8

Max Idle (最大アイドル)

Number (数値)

8

Min Idle (最小アイドル)

Number (数値)

0

Lifo (LIFO)

Boolean (ブール)

true

Fairness (公平性)

Boolean (ブール)

false

Max Wait Millis (最大待機時間)

Number (数値)

-1

Min Evictable Idle Time Millis (最小除去可能アイドル時間)

Number (数値)

1800000

Soft Min Evictable Idle Time Millis (ソフトウェアと最小削除可能アイドル時間)

Number (数値)

1800000

Num Tests Per Eviction Run (除去実行あたりのテスト回数)

Number (数値)

3

Test On Create (作成時のテスト)

Boolean (ブール)

false

Test On Borrow (借用時のテスト)

Boolean (ブール)

false

Test On Return (戻り時のテスト)

Boolean (ブール)

false

Test While Idle (アイドル中のテスト)

Boolean (ブール)

false

Time Between Eviction Runs Millis (除去実行間隔)

Number (数値)

-1

Block When Exhausted (枯渇時にブロック)

Boolean (ブール)

true

Jmx Enabled (JMX 有効化)

Boolean (ブール)

true

Jmx Name Prefix (JMX 名プレフィックス)

String (文字列)

pool

Jmx Name Base (JMX 名ベース)

String (文字列)

関連付けられたソース

操作

Add To Set

<redis:add-to-set>

メッセージのペイロードを、指定されたキーに格納されているセットに追加します。キーが存在しない場合は、セットを保持する新しいキーが作成されます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

SADD で使用するキー

x

Value (値)

String (文字列)

設定する値。

#[payload]

Must Succeed (成功必須)

Boolean (ブール)

true の場合、セットへの追加が成功した (セットに同じ値が存在していなかった) ことを保証します。

false

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Add To Sorted Set

<redis:add-to-sorted-set>

希望するスコアのメッセージのペイロードを、指定されたキーに保存されている並び替え済みセットに追加します。キーが存在しない場合は、並び替え済みセットを保持する新しいキーが作成されます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

ZADD で使用するキー

x

Value (値)

String (文字列)

設定する値。

#[payload]

Score (スコア)

Number (数値)

値に対して使用するスコア

x

Must Succeed (成功必須)

Boolean (ブール)

true の場合、並び替え済みセットへの追加が成功した (セットに同じ値が存在していなかった) ことを保証します。

false

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Decrement

<redis:decrement>

キーに保存されている数値をステップ分だけ減らします。キーが存在しない場合は、操作の実行前に 0 に設定されます。違う型の値や、整数で表現できないデータがキーに含まれている場合はエラーが返されます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

DECR で使用するキー。

x

Step (ステップ)

Number (数値)

使用するステップ。

1

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Number (数値)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Del

<redis:del>

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

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

DEL で使用するキー

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Number (数値)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Exists

<redis:exists>

指定されたキーが存在するかどうかをテストします。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

EXISTS で使用するキー

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Boolean (ブール)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Expire

<redis:expire>

指定されたキーのタイムアウトを設定します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

並び替え済みセットのキー。

x

Seconds (秒)

Number (数値)

存続期間 (秒)。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Boolean (ブール)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Expire At

<redis:expire-at>

指定されたキーのタイムアウトを UNIX タイムスタンプ (1970 年 1 月 1 日からの秒数) で設定します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

並び替え済みセットのキー。

x

Unix Time (UNIX 時間)

Number (数値)

UNIX タイムスタンプ (秒)。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Boolean (ブール)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Get

<redis:get>

指定されたキーの値を取得します。キーが存在しない場合は、null が返されます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

GET で使用するキー

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Get All From Hash

<redis:get-all-from-hash>

指定されたキーに保存されているハッシュのすべての項目と値を取得します。項目またはハッシュが存在しない場合は、null が返されます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

HGETALL で使用するキー

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Object (オブジェクト)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Get From Hash

<redis:get-from-hash>

指定されたキーにあるハッシュの指定された項目に保存されている値を取得します。項目またはハッシュが存在しない場合は、null が返されます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

HGET で使用するキー

x

Field (項目)

String (文字列)

HGET で使用する項目

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Get Range By Index

<redis:get-range-by-index>

指定されたキーに保存されている並び替え済みセットから値の範囲を取得します。値の範囲は並び替え済みセットのインデックスによって定義され、必要に応じて並び替えられます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

ZRANGE/ZREVRANGE で使用するキー

x

Start (開始)

Number (数値)

範囲開始インデックス

x

End (終了)

Number (数値)

範囲終了インデックス

x

Ascending Order (昇順)

Boolean (ブール)

範囲を並び替えるインデックス順序、true = 昇順 / false = 降順

true

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Array of String (文字列の配列)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Get Range By Score

<redis:get-range-by-score>

指定されたキーに保存されている並び替え済みセットから値の範囲を取得します。値の範囲は並び替え済みセットのスコアによって定義され、必要に応じて並び替えられます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

ZRANGEBYSCORE/ZREVRANGEBYSCORE で使用するキー

x

Min (最小)

Number (数値)

範囲開始スコア

x

Max (最大)

Number (数値)

範囲終了スコア

x

Ascending Order (昇順)

Boolean (ブール)

範囲を並び替えるスコア順序、true = 昇順 / false = 降順

true

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Array of String (文字列の配列)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Get Ttl

<redis:get-ttl>

一時キーの残りの存続期間 (秒) を取得します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

並び替え済みセットのキー。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Number (数値)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Increment

<redis:increment>

キーに保存されている数値をステップ分だけ増やします。キーが存在しない場合は、操作の実行前に 0 に設定されます。違う型の値や、整数で表現できないデータがキーに含まれている場合はエラーが返されます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

INCR で使用するキー。

x

Step (ステップ)

Number (数値)

使用するステップ。

1

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Number (数値)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Increment Hash

<redis:increment-hash>

キーに保存されているハッシュ内の項目に保存されている数値をステップ分だけ増やします。キーが存在しない場合は、ハッシュを保持する新しいキーが作成されます。項目が存在しない場合は、操作の実行前に値が 0 に設定されます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

HGET で使用するキー

x

Field (項目)

String (文字列)

HGET で使用する項目

x

Step (ステップ)

Number (数値)

使用するステップ。

1

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Number (数値)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Increment Sorted Set

<redis:increment-sorted-set>

キーに保存されている並び替え済みセット内のメンバーのスコアをステップ分だけ増やします。並び替え済みセットにメンバーが存在しない場合は、ステップをスコアとして (以前のスコアが 0.0 であるものとして) メンバーが追加されます。キーが存在しない場合は、指定されたメンバーを唯一のメンバーとした並び替え済みセットが作成されます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

並び替え済みセットのキー。

x

Value (値)

String (文字列)

設定する値。

#[payload]

Step (ステップ)

Number (数値)

スコアを増やすステップ。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Number (数値)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Persist

<redis:persist>

Expire または Expire At の操作内容を取り消して、一時キーを通常キーに変更します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

並び替え済みセットのキー。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Boolean (ブール)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Pop From List

<redis:pop-from-list>

指定されたキーに保存されているリストの希望する側から値をポップします。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

LPOP/RPOP で使用するキー

x

Pop Left (左からポップ)

Boolean (ブール)

値をポップする側、true = 左

false = 右

false

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Pop From Set

<redis:pop-from-set>

指定されたキーに保存されているセットから値をランダムにポップします。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

SPOP で使用するキー

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Publish

<redis:publish>

メッセージペイロードを指定されたチャネルにパブリッシュします。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Channel (チャネル)

String (文字列)

Destination of the published message (パブリッシュしたメッセージの宛先)

x

Message (メッセージ)

String (文字列)

パブリッシュするメッセージ。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Boolean (ブール)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Push To List

<redis:push-to-list>

指定されたキーに保存されているリスト (左または右) の希望する側にメッセージペイロードをプッシュします。キーが存在しない場合、If Exists (存在する場合) が true でなければ、リストを保持する新しいキーが作成されます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

LPUSH/RPUSH/LPUSHX/RPUSH で使用するキー

x

Value (値)

String (文字列)

プッシュする値。

#[payload]

Push Left (左にプッシュ)

Boolean (ブール)

ペイロードをプッシュする側 (左または右)

false

If Exists (存在する場合)

Boolean (ブール)

true であれば LPUSHX/RPUSH を実行し、false であれば LPUSH/RPUSH を実行します。

false

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Random Member From Set

<redis:random-member-from-set>

指定されたキーに保存されているセットから値をランダムに読み出します。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

SRANDMEMBER で使用するキー

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Set

<redis:set>

ペイロードを保持するキーを設定します。すでにキーが値を保持している場合は、If Not Exists (存在しない場合) が false であれば、値の型に関係なく上書きされます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

ペイロードを保存するキー

x

Value (値)

String (文字列)

設定する値。

#[payload]

Expire (期限切れ)

Number (数値)

指定されたキーのタイムアウトを設定します。タイムアウト後、キーは自動的にサーバによって削除されます。Redis では、タイムアウトが関連付けられているキーを「一時キー」と呼びます。

If Not Exists (存在しない場合)

Boolean (ブール)

true の場合は Redis サーバで SETNX を実行し、false の場合は SET を実行します。

false

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Set In Hash

<redis:set-in-hash>

メッセージのペイロードに指定されたハッシュ項目を設定します。キーが存在しない場合、If Not Exists (存在しない場合) が true であれば、ハッシュを保持する新しいキーが作成されます。

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

HSET で使用するキー

x

Value (値)

String (文字列)

設定する値。

#[payload]

Field (項目)

String (文字列)

HSET で使用する項目

x

If Not Exists (存在しない場合)

Boolean (ブール)

true の場合は HSETNX を実行し、false の場合は HSET を実行します。

false

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

次の設定の場合

スロー

  • REDIS:UNKNOWN

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:UNABLE_TO_UNSUBSCRIBE

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:CONNECTIVITY

Sources (ソース)

Subscribe

<redis:subscribe>

パラメータ

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Channels (チャネル)

Array of String (文字列の配列)

チャネル名またはワイルドカードパターンのリスト。

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力するペイロードの MIME タイプ。

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシーを定義します。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するかどうかと、それらの動作を設定します。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

Reconnection (再接続)

項目 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean

アプリケーションがデプロイされたときに、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (カウント)

Number (数値)

再接続の試行回数。

Reconnect Forever (繰り返し再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Expiration Policy (有効期限ポリシー)

項目 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれか:

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時)

  • DAYS (日)

maxIdleTime 属性に使用できる時間単位。

Subscribe Channel Attributes (サブスクライブチャネル属性)

項目 説明 デフォルト値 必須

Channel (チャネル)

String (文字列)

Redelivery Policy (再配信ポリシー)

項目 説明 デフォルト値 必須

Max Redelivery Count (最大再配信数)

Number (数値)

正常に処理されずにプロセス失敗メッセージがトリガされるまでにメッセージを再配信できる最大回数。

Use Secure Hash (セキュアハッシュを使用)

Boolean (ブール)

再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用するかどうか。

Message Digest Algorithm (メッセージダイジェストアルゴリズム)

String (文字列)

使用するセキュアハッシュアルゴリズム。設定しない場合、デフォルトの SHA-256 になります。

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されたのかを判断するために使用する 1 つ以上の式を定義します。このプロパティは、useSecureHash が false の場合にのみ設定できます。

Object Store (オブジェクトストア)

各メッセージの再配信カウンタが保存されるオブジェクトストア。

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

項目 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームを使用してランダムアクセスを可能にするために割り当てるメモリ量。ストリームに含まれているデータがこのバッファに適合できる量を超えている場合、bufferSizeIncrement 属性に従って拡張され、上限は maxInMemorySize となります。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。0 以下の値を設定すると、バッファは拡張されません。つまり、バッファがいっぱいになると STREAM_MAXIMUM_SIZE_EXCEEDED エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これより大きい値が使用されると、STREAM_MAXIMUM_SIZE_EXCEEDED エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれか:

  • BYTE (バイト)

  • KB (キロバイト)

  • MB (メガバイト)

  • GB (ギガバイト)

これらのすべての属性の単位。

Repeatable File Store Stream (反復可能なファイルストアストリーム)

項目 説明 デフォルト値 必須

Max In Memory Size (最大メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれか:

  • BYTE (バイト)

  • KB (キロバイト)

  • MB (メガバイト)

  • GB (ギガバイト)

maxInMemorySize で表される単位。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub