Configuration

Example configuration in a processor:

{
  "name": "Open Hydrator",
  "active": true,
  "type": "opensearch-hydrator",
  "servers": [
    {
      "hostname": "localhost",
      "port": 9202
    }
  ],
  "index": "test-index",
  "multiDocumentPath": "path"
}

Configuration parameters:

servers.host

(Required, String) The host where the instance of the Staging Repository is located.

servers.port

(Required, Integer) The port in which the OpenSearch instance is running.

index

(Required, String) The index where to hydrate.

multiDocumentPath

(Optional, String) The path in the document that splits it into sub-documents. The value in the document must be an array.

multiDocumentKeepSiblings

(Optional, Boolean) When given a multiDocumentPath, keep sibling fields in every subdocument. Default is false.

Example:

{
  "siblingField": "keep me! or not",
  "multiPath": [
    {
      "text": "Sample text."
    },
    {
      "text": "More Text"
    }
  ]
}

With multiPath as the multiDocumentPath if the value is false the generated subdocuments would be similar to:

{
  "text": "Sample text."
}

When the value is true the sibling fields will still be in the subdocuments:

{
  "siblingField": "keep me! or not",
  "multiPath":  {
    "text": "Sample text."
  }
}

multiDocumentCleanup

(Optional, Boolean) When given a multiDocumentPath, delete documents that weren't indexed on the current execution. Default is true.