Foreach processor

配列またはオブジェクトの各要素に対してインジェストプロセッサを実行します。

すべてのインジェストプロセッサは、配列またはオブジェクトの要素で実行できます。ただし、要素の数が不明な場合、各要素を同じ方法で処理するのは面倒です。 

  2.  [](#foreach-options)   
  3. **表 20. Foreach オプション**  
  6. | 名前 | 必須 | デフォルト | 説明 |
  7. | :-- | :-- | :-- | :-- |
  8. | `````field````` | はい | - | 配列またはオブジェクトの値を含むフィールド。<br> |
  9. | `````processor````` | はい | - | 各要素に対して実行するインジェストプロセッサ。<br> |
  10. | `````ignore_missing````` | いいえ | false | `````true`````の場合、`````field`````が`````null`````または欠落している場合、プロセッサは静かに終了します。<br> |
  11. | `````description````` | いいえ | - | プロセッサの説明。プロセッサの目的や構成を説明するのに便利です。 |
  12. | `````if````` | いいえ | - | プロセッサを条件付きで実行します。[プロセッサを条件付きで実行する](32bff6811baf1efc.md#conditionally-run-processor "プロセッサを条件付きで実行する")を参照してください。 |
  13. | `````ignore_failure````` | いいえ | `````false````` | プロセッサの失敗を無視します。[パイプラインの失敗を処理する](32bff6811baf1efc.md#handling-pipeline-failures "パイプラインの失敗を処理する")を参照してください。 |
  14. | `````on_failure````` | いいえ | - | プロセッサの失敗を処理します。[パイプラインの失敗を処理する](32bff6811baf1efc.md#handling-pipeline-failures "パイプラインの失敗を処理する")を参照してください。 |
  15. | `````tag````` | いいえ | - | プロセッサの識別子。デバッグやメトリクスに便利です。 |
  18. ## Access keys and values
  20. 配列またはオブジェクトを反復処理する際、`````foreach`````プロセッサは現在の要素の値を`````_ingest._value````` [インジェストメタデータ](32bff6811baf1efc.md#access-ingest-metadata)フィールドに格納します。`````_ingest._value`````は、子フィールドを含む要素全体の値を含みます。`````_ingest._value`````フィールドのドット表記を使用して、子フィールドの値にアクセスできます。  
  22. オブジェクトを反復処理する際、`````foreach`````プロセッサは現在の要素のキーを文字列として`````_ingest._key`````に格納します。  
  24. `````_ingest._key`````と`````_ingest._value`````は`````processor`````でアクセスおよび変更できます。例については、[オブジェクトの例](da2162b5f61a400b.md#foreach-object-ex)を参照してください。
  27. ## Failure handling
  29. もし`````foreach`````プロセッサが要素を処理できず、`````on_failure`````プロセッサが指定されていない場合、`````foreach`````プロセッサは静かに終了します。これにより、配列またはオブジェクトの値全体は変更されません。
  32. ## Examples
  34. 以下の例は、`````foreach`````プロセッサをさまざまなデータ型とオプションで使用する方法を示しています：  
  36. -  [配列](da2162b5f61a400b.md#foreach-array-ex)  
  37. -  [オブジェクトの配列](da2162b5f61a400b.md#foreach-array-objects-ex)  
  38. -  [オブジェクト](da2162b5f61a400b.md#foreach-object-ex)  
  39. -  [失敗処理](da2162b5f61a400b.md#failure-handling-ex)
  42. ### Array
  44. 次のドキュメントを仮定します：
  47. #### Js
  49. ``````js
  50. {
  51.   "values" : ["foo", "bar", "baz"]
  52. }
  53. `

このforeachプロセッサがこのサンプルドキュメントで動作するとき：

Js

  1. {
  2.   "foreach" : {
  3.    "field" : "values",
  4.    "processor" : {
  5.    "uppercase" : {
  6.    "field" : "_ingest._value"
  7.    }
  8.    }
  9.   }
  10. }

処理後、ドキュメントは次のようになります：

Js

  1. {
  2.   "values" : ["FOO", "BAR", "BAZ"]
  3. }

Array of objects

次のドキュメントを仮定します：

Js

  1. {
  2.   "persons" : [
  3.    {
  4.    "id" : "1",
  5.    "name" : "John Doe"
  6.    },
  7.    {
  8.    "id" : "2",
  9.    "name" : "Jane Doe"
  10.    }
  11.   ]
  12. }

この場合、idフィールドを削除する必要があるため、次のforeachプロセッサが使用されます：

Js

  1. {
  2.   "foreach" : {
  3.    "field" : "persons",
  4.    "processor" : {
  5.    "remove" : {
  6.    "field" : "_ingest._value.id"
  7.    }
  8.    }
  9.   }
  10. }

処理後の結果は：

Js

  1. {
  2.   "persons" : [
  3.    {
  4.    "name" : "John Doe"
  5.    },
  6.    {
  7.    "name" : "Jane Doe"
  8.    }
  9.   ]
  10. }

別のオブジェクトの配列の例については、添付プロセッサのドキュメントを参照してください。

Object

  3. #### Js
  5. ``````js
  6. {
  7.   "products" : {
  8.    "widgets" : {
  9.    "total_sales" : 50,
  10.    "unit_price": 1.99,
  11.    "display_name": ""
  12.    },
  13.    "sprockets" : {
  14.    "total_sales" : 100,
  15.    "unit_price": 9.99,
  16.    "display_name": "Super Sprockets"
  17.    },
  18.    "whizbangs" : {
  19.    "total_sales" : 200,
  20.    "unit_price": 19.99,
  21.    "display_name": "Wonderful Whizbangs"
  22.    }
  23.   }
  24. }
  25. `

次のforeachプロセッサはproducts.display_nameの値を大文字に変更します。

Js

  1. {
  2.   "foreach": {
  3.    "field": "products",
  4.    "processor": {
  5.    "uppercase": {
  6.    "field": "_ingest._value.display_name"
  7.    }
  8.    }
  9.   }
  10. }

ドキュメントで実行すると、foreachプロセッサは次のように返します：

Js

  1. {
  2.   "products" : {
  3.    "widgets" : {
  4.    "total_sales" : 50,
  5.    "unit_price" : 1.99,
  6.    "display_name" : ""
  7.    },
  8.    "sprockets" : {
  9.    "total_sales" : 100,
  10.    "unit_price" : 9.99,
  11.    "display_name" : "SUPER SPROCKETS"
  12.    },
  13.    "whizbangs" : {
  14.    "total_sales" : 200,
  15.    "unit_price" : 19.99,
  16.    "display_name" : "WONDERFUL WHIZBANGS"
  17.    }
  18.   }
  19. }

次のforeachプロセッサは各要素のキーをproducts.display_nameの値に設定します。products.display_nameが空の文字列を含む場合、プロセッサは要素を削除します。

Js

  1. {
  2.   "foreach": {
  3.    "field": "products",
  4.    "processor": {
  5.    "set": {
  6.    "field": "_ingest._key",
  7.    "value": "{{_ingest._value.display_name}}"
  8.    }
  9.    }
  10.   }
  11. }

前のドキュメントで実行すると、foreachプロセッサは次のように返します：

Js

  1. {
  2.   "products" : {
  3.    "Wonderful Whizbangs" : {
  4.    "total_sales" : 200,
  5.    "unit_price" : 19.99,
  6.    "display_name" : "Wonderful Whizbangs"
  7.    },
  8.    "Super Sprockets" : {
  9.    "total_sales" : 100,
  10.    "unit_price" : 9.99,
  11.    "display_name" : "Super Sprockets"
  12.    }
  13.   }
  14. }

Failure handling

ラップされたプロセッサにはon_failure定義がある場合があります。たとえば、idフィールドはすべての人オブジェクトに存在しない場合があります。インデックスリクエストを失敗させる代わりに、on_failureブロックを使用してドキュメントをfailure_indexインデックスに送信し、後で検査できます：

Js

  1. {
  2.   "foreach" : {
  3.    "field" : "persons",
  4.    "processor" : {
  5.    "remove" : {
  6.    "field" : "_value.id",
  7.    "on_failure" : [
  8.    {
  9.    "set" : {
  10.    "field": "_index",
  11.    "value": "failure_index"
  12.    }
  13.    }
  14.    ]
  15.    }
  16.    }
  17.   }
  18. }

この例では、removeプロセッサが失敗した場合、これまでに処理された配列要素は更新されます。