--- schema_version: "1" id: a6818f0a51215c00137967c35f7aaf79010a7bc189db69e62df9b5439905bc87 title: Redis Connector リファレンス - Mule 4 collection: mulesoft version: current locale: ja-jp portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/redis-connector/5.1/redis-connector-reference.md canonical_url: https://docs.mulesoft.com/jp/redis-connector/5.1/redis-connector-reference source_site: docs.mulesoft.com content_type: documentation content_hash: d59ff8fb8ab9b4badd18904761887bfdab15062e0de7db9b4a6a10d8cc8a5b51 description: MuleSoft Documentation Site release: "5.1" latest: false --- # Redis Connector リファレンス - Mule 4 サポートカテゴリ: [選択](https://www.mulesoft.com/legal/versioning-back-support-policy#anypoint-connectors) Redis Connector v5.1 リリースノート: ​[Redis Connector リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/redis-connector-release-notes-mule-4)​ ## [](#設定)設定 * * * ### [](#redis)Redis #### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

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

x

Connection (接続)

この設定に指定する接続型。

x

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

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

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。ランタイムによって適切と判断されたときに、インスタンスがパージされます。
#### [](#接続種別)接続種別 ##### [](#redis_clustered)Clustered (クラスター) ###### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

Cluster Hosts (クラスターホスト)

String (文字列)

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

x

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

Number (数値)

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

2000

Entry TTL (エントリ TTL)

Number (数値)

コネクタを使用して保存されたキーに設定されるデフォルトの存続期間。

Reconnection (再接続)

Reconnection (再接続)

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

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 (文字列)
##### [](#redis_nonclustered)NonClustered ###### [](#パラメーター-3)パラメーター
名前 型 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

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

localhost

Port (ポート)

Number (数値)

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

6379

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

Number (数値)

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

2000

Password (パスワード)

String (文字列)

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

Entry TTL (エントリ TTL)

Number (数値)

コネクタを使用して保存されたキーに設定されるデフォルトの存続期間。

Reconnection (再接続)

Reconnection (再接続)

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

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](#addToSet)​ - [Add To Sorted Set](#addToSortedSet)​ - [Decrement](#decrement)​ - [Del](#del)​ - [Exists](#exists)​ - [Expire](#expire)​ - [Expire At](#expireAt)​ - [Get](#get)​ - [Get All From Hash](#getAllFromHash)​ - [Get From Hash](#getFromHash)​ - [Get Range By Index](#getRangeByIndex)​ - [Get Range By Score](#getRangeByScore)​ - [Get TTL](#getTtl)​ - [Increment](#increment)​ - [Increment Hash](#incrementHash)​ - [Increment Sorted Set](#incrementSortedSet)​ - [Persist](#persist)​ - [Pop From List](#popFromList)​ - [Pop From Set](#popFromSet)​ - [Publish](#publish)​ - [Push To List](#pushToList)​ - [Random Member From Set](#randomMemberFromSet)​ - [Set](#set)​ - [Set In Hash](#setInHash) ## [](#関連付けられたソース)関連付けられたソース - [Subscribe](#subscribe) ## [](#操作)操作 ### [](#addToSet)Add To Set ``​ メッセージのペイロードを、指定されたキーに格納されているセットに追加します。キーが存在しない場合は、セットを保持する新しいキーが作成されます。 #### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

SADD で使用するキー

x

Value (値)

String (文字列)

設定する値。

#[payload]

Must Succeed (成功必須)

Boolean (ブール)

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

false

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力)出力

型

String (文字列)
### [](#次の設定の場合)次の設定の場合 - [Redis](#redis) #### [](#スロー)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#addToSortedSet)Add To Sorted Set ``​ 希望するスコアのメッセージのペイロードを、指定されたキーに保存されている並び替え済みセットに追加します。キーが存在しない場合は、並び替え済みセットを保持する新しいキーが作成されます。 #### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

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]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-2)出力

型

String (文字列)
### [](#次の設定の場合-2)次の設定の場合 - [Redis](#redis) #### [](#スロー-2)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#decrement)Decrement ``​ キーに保存されている数値をステップ分だけ減らします。キーが存在しない場合は、操作の実行前に 0 に設定されます。違う型の値や、整数で表現できないデータがキーに含まれている場合はエラーが返されます。 #### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

DECR で使用するキー。

x

Step (ステップ)

Number (数値)

使用するステップ。

1

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-3)出力

型

Number (数値)
### [](#次の設定の場合-3)次の設定の場合 - [Redis](#redis) #### [](#スロー-3)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#del)Del ``​ 指定されたキーを削除します。存在しないキーは無視されます。 #### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

DEL で使用するキー

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-4)出力

型

Number (数値)
### [](#次の設定の場合-4)次の設定の場合 - [Redis](#redis) #### [](#スロー-4)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#exists)Exists ``​ 指定されたキーが存在するかどうかをテストします。 #### [](#パラメーター-8)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

EXISTS で使用するキー

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-5)出力

型

Boolean (ブール)
### [](#次の設定の場合-5)次の設定の場合 - [Redis](#redis) #### [](#スロー-5)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#expire)Expire ``​ 指定されたキーのタイムアウトを設定します。 #### [](#パラメーター-9)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

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

x

Seconds (秒)

Number (数値)

存続期間 (秒)。

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-6)出力

型

Boolean (ブール)
### [](#次の設定の場合-6)次の設定の場合 - [Redis](#redis) #### [](#スロー-6)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#expireAt)Expire At ``​ 指定されたキーのタイムアウトを UNIX タイムスタンプ (1970 年 1 月 1 日からの秒数) で設定します。 #### [](#パラメーター-10)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

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

x

Unix Time (UNIX 時間)

Number (数値)

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

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-7)出力

型

Boolean (ブール)
### [](#次の設定の場合-7)次の設定の場合 - [Redis](#redis) #### [](#スロー-7)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#get)Get ``​ 指定されたキーの値を取得します。キーが存在しない場合は、null が返されます。 #### [](#パラメーター-11)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

GET で使用するキー

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-8)出力

型

String (文字列)
### [](#次の設定の場合-8)次の設定の場合 - [Redis](#redis) #### [](#スロー-8)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#getAllFromHash)Get All From Hash ``​ 指定されたキーに保存されているハッシュのすべての項目と値を取得します。項目またはハッシュが存在しない場合は、null が返されます。 #### [](#パラメーター-12)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

HGETALL で使用するキー

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-9)出力

型

Object (オブジェクト)
### [](#次の設定の場合-9)次の設定の場合 - [Redis](#redis) #### [](#スロー-9)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#getFromHash)Get From Hash ``​ 指定されたキーにあるハッシュの指定された項目に保存されている値を取得します。項目またはハッシュが存在しない場合は、null が返されます。 #### [](#パラメーター-13)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

HGET で使用するキー

x

項目

String (文字列)

HGET で使用する項目

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-10)出力

型

String (文字列)
### [](#次の設定の場合-10)次の設定の場合 - [Redis](#redis) #### [](#スロー-10)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#getRangeByIndex)Get Range By Index ``​ 指定されたキーに保存されている並び替え済みセットから値の範囲を取得します。値の範囲は並び替え済みセットのインデックスによって定義され、必要に応じて並び替えられます。 #### [](#パラメーター-14)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

ZRANGE/ZREVRANGE で使用するキー

x

起動

Number (数値)

Range start index (範囲開始インデックス)

x

End (終了)

Number (数値)

Range end index (範囲終了インデックス)

x

Ascending Order (昇順)

Boolean (ブール)

範囲を並び替えるインデックス順序。パラメーターが true に設定されている場合、範囲は昇順に並べ替えられます。パラメーターが false に設定されている場合、範囲は降順に並べ替えられます。

true

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-11)出力

型

Array of String (文字列の配列)
### [](#次の設定の場合-11)次の設定の場合 - [Redis](#redis) #### [](#スロー-11)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#getRangeByScore)Get Range By Score ``​ 指定されたキーに保存されている並び替え済みセットから値の範囲を取得します。値の範囲は並び替え済みセットのスコアによって定義され、必要に応じて並び替えられます。 #### [](#パラメーター-15)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

ZRANGEBYSCORE と ZREVRANGEBYSCORE で使用するキー

x

Min (最小)

Number (数値)

Range start score (範囲開始スコア)

x

Max (最大)

Number (数値)

Range end score (範囲終了スコア)

x

Ascending Order (昇順)

Boolean (ブール)

範囲を並び替えるスコア順序。パラメーターが true に設定されている場合、範囲は昇順に並べ替えられます。パラメーターが false に設定されている場合、範囲は降順に並べ替えられます。

true

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-12)出力

型

Array of String (文字列の配列)
### [](#次の設定の場合-12)次の設定の場合 - [Redis](#redis) #### [](#スロー-12)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#getTtl)Get TTL ``​ 一時キーの残りの存続期間 (秒) を取得します。 #### [](#パラメーター-16)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

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

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-13)出力

型

Number (数値)
### [](#次の設定の場合-13)次の設定の場合 - [Redis](#redis) #### [](#スロー-13)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#increment)Increment ``​ キーに保存されている数値をステップ分だけ増やします。キーが存在しない場合は、操作の実行前に 0 に設定されます。違う型の値や、整数で表現できないデータがキーに含まれている場合はエラーが返されます。 #### [](#パラメーター-17)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

INCR で使用するキー。

x

Step (ステップ)

Number (数値)

使用するステップ。

1

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-14)出力

型

Number (数値)
### [](#次の設定の場合-14)次の設定の場合 - [Redis](#redis) #### [](#スロー-14)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#incrementHash)Increment Hash ``​ キーに保存されているハッシュ内の項目に保存されている数値をステップ分だけ増やします。キーが存在しない場合は、ハッシュを保持する新しいキーが作成されます。項目が存在しない場合は、操作の実行前に値が 0 に設定されます。 #### [](#パラメーター-18)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

HGET で使用するキー

x

項目

String (文字列)

HGET で使用する項目

x

Step (ステップ)

Number (数値)

使用するステップ。

1

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-15)出力

型

Number (数値)
### [](#次の設定の場合-15)次の設定の場合 - [Redis](#redis) #### [](#スロー-15)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#incrementSortedSet)Increment Sorted Set ``​ キーに保存されている並び替え済みセット内のメンバーのスコアをステップ分だけ増やします。並び替え済みセットにメンバーが存在しない場合は、ステップをスコアとして (以前のスコアが 0.0 であるものとして) メンバーが追加されます。キーが存在しない場合は、指定されたメンバーを唯一のメンバーとした並び替え済みセットが作成されます。 #### [](#パラメーター-19)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

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

x

Value (値)

String (文字列)

設定する値。

#[payload]

Step (ステップ)

Number (数値)

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

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-16)出力

型

Number (数値)
### [](#次の設定の場合-16)次の設定の場合 - [Redis](#redis) #### [](#スロー-16)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#persist)Persist ``​ Expire または Expire At の操作内容を取り消して、一時キーを通常キーに変更します。 #### [](#パラメーター-20)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

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

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-17)出力

型

Boolean (ブール)
### [](#次の設定の場合-17)次の設定の場合 - [Redis](#redis) #### [](#スロー-17)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#popFromList)Pop From List ``​ 指定されたキーに保存されているリストの希望する側から値をポップします。 #### [](#パラメーター-21)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

LPOP/RPOP で使用するキー

x

Pop Left (左からポップ)

boolean (ブール)

値をポップする側。パラメーターが true に設定されている場合、値は左側からポップされます。パラメーターが false に設定されている場合、値は右側からポップされます。

false

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-18)出力

型

String (文字列)
### [](#次の設定の場合-18)次の設定の場合 - [Redis](#redis) #### [](#スロー-18)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#popFromSet)Pop From Set ``​ 指定されたキーに保存されているセットから値をランダムにポップします。 #### [](#パラメーター-22)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

SPOP で使用するキー

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-19)出力

型

String (文字列)
### [](#次の設定の場合-19)次の設定の場合 - [Redis](#redis) #### [](#スロー-19)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#publish)Publish ``​ メッセージペイロードを指定されたチャネルにパブリッシュします。 #### [](#パラメーター-23)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Channel (チャネル)

String (文字列)

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

x

Message (メッセージ)

String (文字列)

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

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-20)出力

型

Boolean (ブール)
### [](#次の設定の場合-20)次の設定の場合 - [Redis](#redis) #### [](#スロー-20)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#pushToList)Push To List ``​ 指定されたキーに保存されているリスト (左または右) の希望する側にメッセージペイロードをプッシュします。キーが存在しない場合、If Exists (存在する場合) が true でなければ、リストを保持する新しいキーが作成されます。 #### [](#パラメーター-24)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

LPUSH または RPUSH、または LPUSHX または RPUSHX で使用する項目。

x

Value (値)

String (文字列)

プッシュする値。

#[payload]

Push Left (左にプッシュ)

Boolean (ブール)

ペイロードをプッシュする側。パラメーターが true に設定されている場合、左側のペイロードをプッシュします。パラメーターが false に設定されている場合、右側のペイロードをプッシュします。

false

If Exists (存在する場合)

Boolean (ブール)

パラメーターが true に設定されている場合、LPUSHX または RPUSHX を実行します。パラメーターが false に設定されている場合、LPUSH または RPUSH を実行します。

false

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-21)出力

型

String (文字列)
### [](#次の設定の場合-21)次の設定の場合 - [Redis](#redis) #### [](#スロー-21)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#randomMemberFromSet)Random Member From Set ``​ 指定されたキーに保存されているセットから値をランダムに読み出します。 #### [](#パラメーター-25)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

SRANDMEMBER で使用するキー

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-22)出力

型

String (文字列)
### [](#次の設定の場合-22)次の設定の場合 - [Redis](#redis) #### [](#スロー-22)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#set)Set ``​ ペイロードを保持するキーを設定します。すでにキーが値を保持している場合は、If Not Exists (存在しない場合) が false であれば、値の型に関係なく上書きされます。 #### [](#パラメーター-26)パラメーター
名前 型 説明 デフォルト値 必須

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]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-23)出力

型

String (文字列)
### [](#次の設定の場合-23)次の設定の場合 - [Redis](#redis) #### [](#スロー-23)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ### [](#setInHash)Set In Hash ``​ メッセージのペイロードに指定されたハッシュ項目を設定します。キーが存在しない場合、If Not Exists (存在しない場合) が true であれば、ハッシュを保持する新しいキーが作成されます。 #### [](#パラメーター-27)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Key (キー)

String (文字列)

HSET で使用するキー

x

Value (値)

String (文字列)

設定する値。

#[payload]

項目

String (文字列)

HSET で使用する項目

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

Boolean (ブール)

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

false

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

#[payload]

接続エラーが発生した場合の再試行戦略。
#### [](#出力-24)出力

型

String (文字列)
### [](#次の設定の場合-24)次の設定の場合 - [Redis](#redis) #### [](#スロー-24)スロー - REDIS:CONNECTIVITY - REDIS:​INVALID\_REQUEST\_DATA​ - REDIS:​INVALID\_STRUCTURE\_FOR\_INPUT\_DATA​ - REDIS:​RETRY\_EXHAUSTED​ - REDIS:UNKNOWN - REDIS:​UNABLE\_TO\_UNSUBSCRIBE ## [](#ソース)ソース ### [](#subscribe)Subscribe ``​ #### [](#パラメーター-28)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Channels (チャネル)

Array of String (文字列の配列)

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

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

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

反復可能なストリームを使用するように設定します。

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

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

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
#### [](#出力-25)出力

型

String (文字列)

Attributes Type (属性型)

Subscribe Channel Attributes (サブスクライブチャネル属性)​
### [](#次の設定の場合-25)次の設定の場合 - [Redis](#redis) ## [](#型)型 ### [](#Reconnection)Reconnection (再接続)
項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean (ブール)

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。
### [](#reconnect)Reconnect (再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true
### [](#reconnect-forever)Reconnect Forever (繰り返し再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true
### [](#ExpirationPolicy)Expiration Policy (有効期限ポリシー)
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位
### [](#SubscribeChannelAttributes)Subscribe Channel Attributes (サブスクライブチャネル属性)
項目 型 説明 デフォルト値 必須

Channel (チャネル)

String (文字列)
### [](#repeatable-in-memory-stream)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)Repeatable File Store Stream (反復可能なファイルストアストリーム)
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位
### [](#RedeliveryPolicy)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 (オブジェクトストア)

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

各メッセージの再配信カウンターが保存されるオブジェクトストア。
## [](#関連情報)関連情報 [MuleSoft ヘルプセンター](https://help.mulesoft.com)