Working with Search in Elasticsearch

Overview

The following operations allow you to work with search. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with searches, see Sample configuration.

Operation	Description
searchDocumentsByIndex	Performs a search on all documents across all types within a specified index.
searchDocumentByTypes	Performs a search on all documents within a specific type in a specified index.
searchByQuery	Performs a search across all indices and all types.
multiSearch	Executes multiple search requests within the same API.

Operation details

This section provides further details on the operations related to search.

Searching all documents across all types within a specified index

The searchDocumentsByIndex operation searches all documents across all types within a specified index.

searchDocumentsByIndex

<elasticsearch.searchDocumentsByIndex>
    <indexName>{$ctx:indexName}</indexName>
    <query>{$ctx:query}</query>
    <explain>{$ctx:explain}</explain>
    <fields>{$ctx:fields}</fields>
    <sort>{$ctx:sort}</sort>
    <timeout>{$ctx:timeout}</timeout>
    <terminateAfter>{$ctx:terminateAfter}</terminateAfter>
    <from>{$ctx:from}</from>
    <size>{$ctx:size}</size>
    <searchType>{$ctx:searchType}</searchType>
    <source>{$ctx:source}</source>
    <scriptFields>{$ctx:scriptFields}</scriptFields>
    <fieldDataFields>{$ctx:fieldDataFields}</fieldDataFields>
    <highlight>{$ctx:highlight}</highlight>
    <indicesBoost>{$ctx:indicesBoost}</indicesBoost>
    <minScore>{$ctx:minScore}</minScore>
    <trackScores>{$ctx:trackScores}</trackScores>
    <version>{$ctx:version}</version>
    <scroll>{$ctx:scroll}</scroll>
    <queryCache>{$ctx:queryCache}</queryCache>
    <partialFields>{$ctx:partialFields}</partialFields>
    <postFilter>{$ctx:postFilter}</postFilter>
    <aggregation>{$ctx:aggregation}</aggregation>
    <rescore>{$ctx:rescore}</rescore>
    <preference>{$ctx:preference}</preference>
    <innerHits>{$ctx:innerHits}</innerHits>
    <ignoreUnavailable>{$ctx:ignoreUnavailable}</ignoreUnavailable>
    <allowNoIndices>{$ctx:allowNoIndices}</allowNoIndices>
	<expandWildcards>{$ctx:expandWildcards}</expandWildcards>
</elasticsearch.searchDocumentsByIndex>

Properties

indexName: The name of the index.
query : The query string used to perform the search.
explain: If set to true, this provide an explanation of how scoring of the hits was computed for each hit.
fields: Specify the fields to return for each hit as a comma separated list. Not specifying a value will cause no fields to return.
sort: The type of sorting to perform. Can either be in the form of fieldName, or fieldName:asc/fieldName:desc. The fieldName can either be an actual field within the document, or the special score name to indicate sorting based on scores. There can be several sort parameters (order is important).
timeout: A timeout value for the search. This bounds the search request to be executed within the specified time value and returns the hits accumulated up to that point when expired. There is no value set for this by default.
terminateAfter: The maximum number of documents to collect for each shard, which upon reaching causes the query execution to terminate early. If set, the response will have a boolean field terminated_early to indicate that the query execution has terminated early. There is no value set for this by default.
from: The starting from index of the hits to return. Default value is 0.
size: The number of hits to return. Default value is 10.
searchType: The type of the search to perform. Possible values are: dfs_query_then_fetch, dfs_query_and_fetch, query_then_fetch, query_and_fetch, count, scan. The default value is: query_then_fetch. For more information on the different types of search that can be performed, see Search Type.
source: If set to true, this controls how the source is returned.
scriptFields: Allows to return a script evaluation for each hit based on the values taken from different fields.
fieldDataFields: Allows to return the field data representation of a field for each hit.
highlight: Specify the fields in which search results should be highlighted.
indicesBoost: Allows to configure different boost levels per index when searching across more than one index. This is useful when hits coming from a particular index have a higher priority over hits coming from another index (social graph where each user has an index).
minScore: Specify a value so that documents that have a score less than the value specified is excluded from the search.
trackScores: Set this to true to track scores and return them as part of each hit.
version: If set to true this returns a version for each hit.
scroll: Specify the duration that you want to keep the search context open. The duration should be specified in time units. For information on supported time units, see Time units.
queryCache: Set this to true to enable caching of search results for requests.
partialFields: Used to use wildcards to control what part of the source will be loaded.
postFilter: If you need to differentially filter search results, you can specify the search values here. Values other than what is specified here will be removed from the search results.
aggregation: Specify the document fields from which values should be extracted for aggregation.
rescuer: A second query to be executed on the results returned by the original query.
preference: Controls a preference of which shard replicas to execute the search request on.
innerHits: Specify a definition for this property so that for each search hit the search result returns additional nested hits that caused the search hit to satisfy a different scope.
ignoreUnavailable: Used to control whether to ignore if any specified indices are unavailable.
allowNoIndices: Used to control whether to fail if a wildcard indices expressions results into no concrete indices.
expandWildcards: Used to control to what kind of concrete indices wildcard indices expression expand to.

Sample request

Following is a sample REST/JSON request that can be handled by the searchDocumentsByIndex operation.

Sample Request for searchDocumentsByIndex

{
  "apiUrl": "http://172.22.217.169:9200",
  "indexName": "twitter",
  "query": {
    "term": {
      "tag": "something"
    }
  },
  "explain": "true",
  "fields": [
    "message"
  ],
  "sort": [
    {
      "_type": "asc"
    }
  ],
  "timeout": "12",
  "terminateAfter": "12",
  "from": "12",
  "size": "1",
  "searchType": "count",
  "source": "false",
  "scriptFields": {
    "my_field": {
      "script": "1 + my_var",
      "params": {
        "my_var": 2
      }
    }
  },
  "fieldDataFields": [
    "user"
  ],
  "highlight": {
    "fields": {
      "content": {}
    }
  },
  "indicesBoost": {
    "index1": "1.4",
    "index2": "1.3"
  },
  "minScore": "1",
  "trackScores": "true",
  "version": "true",
  "scroll": "1m",
  "queryCache": "true",
  "partialFields": {
    "partial1": {
      "include": "obj1"
    }
  },
  "postFilter": {
    "term": {
      "tag": "something"
    }
  },
  "aggregation": {
    "tag": {
      "terms": {
        "field": "tag"
      }
    }
  },
  "rescore": {
    "window_size": "10",
    "query": {
      "rescore_query": {
        "match": {
          "tag": {
            "query": "something"
          }
        }
      },
      "query_weight": 0.7,
      "rescore_query_weight": 1.2
    }
  },
  "preference": "_shards:2",
  "innerHits": {
    "comment": {
      "path": {
        "comments": {
          "query": {
            "match": {
              "comments.message": "[different query]"
            }
          }
        }
      }
    }
  },  
  "pretty":"true",
  "format":"yaml",
  "human":"true",
  "filterPath":"_index,_type",
  "flatSettings":"true",
  "callback":"true",
  "case":"camelCase",
  "ignoreUnavailable":"true",
  "allowNoIndices":"true",
  "expandWildcards":"true"
}

Searching all documents within a specific type in a specified index

The searchDocumentByTypes operation performs a search on all documents within a specific type in a specified index.

searchDocumentByTypes

<elasticsearch.searchDocumentByTypes>
    <indexName>{$ctx:indexName}</indexName>
    <query>{$ctx:query}</query>
    <explain>{$ctx:explain}</explain>
    <fields>{$ctx:fields}</fields>
    <sort>{$ctx:sort}</sort>
    <timeout>{$ctx:timeout}</timeout>
    <terminateAfter>{$ctx:terminateAfter}</terminateAfter>
    <from>{$ctx:from}</from>
    <size>{$ctx:size}</size>
    <searchType>{$ctx:searchType}</searchType>
    <source>{$ctx:source}</source>
    <scriptFields>{$ctx:scriptFields}</scriptFields>
    <fieldDataFields>{$ctx:fieldDataFields}</fieldDataFields>
    <highlight>{$ctx:highlight}</highlight>
    <indicesBoost>{$ctx:indicesBoost}</indicesBoost>
    <minScore>{$ctx:minScore}</minScore>
    <trackScores>{$ctx:trackScores}</trackScores>
    <version>{$ctx:version}</version>
    <scroll>{$ctx:scroll}</scroll>
    <type>{$ctx:type}</type>
    <queryCache>{$ctx:queryCache}</queryCache>
    <partialFields>{$ctx:partialFields}</partialFields>
    <postFilter>{$ctx:postFilter}</postFilter>
    <aggregation>{$ctx:aggregation}</aggregation>
    <rescore>{$ctx:rescore}</rescore>
    <preference>{$ctx:preference}</preference>
    <innerHits>{$ctx:innerHits}</innerHits>
    <ignoreUnavailable>{$ctx:ignoreUnavailable}</ignoreUnavailable>
    <allowNoIndices>{$ctx:allowNoIndices}</allowNoIndices>
	<expandWildcards>{$ctx:expandWildcards}</expandWildcards>
</elasticsearch.searchDocumentByTypes>

Properties

indexName: The name of the index.
query: The query string used to perform the search.
explain: If set to true, this provide an explanation of how scoring of the hits was computed for each hit.
fields: Specify the fields to return for each hit as a comma separated list. Not specifying a value will cause no fields to return.
sort: The type of sorting to perform. Can either be in the form of fieldName, or fieldName:asc/fieldName:desc. The fieldName can either be an actual field within the document, or the special score name to indicate sorting based on scores. There can be several sort parameters (order is important).
timeout: A timeout value for the search. This bounds the search request to be executed within the specified time value and returns the hits accumulated up to that point when expired. There is no value set for this by default.
terminateAfter: The maximum number of documents to collect for each shard, which upon reaching causes the query execution to terminate early. If set, the response will have a boolean field terminated_early to indicate whether the query execution has actually terminated early. There is no value set for this by default.
from: The starting from index of the hits to return. Default value is 0.
size: The number of hits to return. Default value is 10.
searchType: The type of the search to perform. Possible values are: dfs_query_then_fetch, dfs_query_and_fetch, query_then_fetch, query_and_fetch, count, scan. The default value is: query_then_fetch. For more information on the different types of search that can be performed, see Search Type.
source: If set to true, this controls how the source is returned.
scriptFields: Allows to return a script evaluation for each hit based on the values taken from different fields.
fieldDataFields: Allows to return the field data representation of a field for each hit.
highlight: Specify the fields in which search results should be highlighted.
indicesBoost: Allows to configure different boost levels per index when searching across more than one index. This is useful when hits coming from a particular index have a higher priority over hits coming from another index (social graph where each user has an index).
minScore: Specify a value so that documents that have a score less than the value specified is excluded from the search.
trackScores: Set this to true to track scores and return them as part of each hit.
version: Returns a version for each search hit.
scroll: While a search request returns a single page of results, the scroll API can be used to retrieve large numbers of results (or even all results) from a single search request, in much the same way as you would use a cursor on a traditional database.
type: The type inside which the search would be performed.
queryCache: To enable or disable the caching of search results for requests.
partialFields: Used to use wildcards to control what part of the source will be loaded.
postFilter: Remove results from response that have values other than this.
aggregation: Aggregate data within a document set context.
rescore: Used to improve precision by reordering just the top (e.g. 100 - 500) documents returned by the query and postFilter phases.
preference: Controls a preference of which shard replicas to execute the search request on.
innerHits: Used to return per search hit in the search response additional nested hits that caused a search hit to match in a different scope.
ignoreUnavailable: Used to control whether to ignore if any specified indices are unavailable.
allowNoIndices: Used to control whether to fail if a wildcard indices expressions results into no concrete indices.
expandWildcards: Used to control to what kind of concrete indices wildcard indices expression expand to.

Sample request

Following is a sample REST/JSON request that can be handled by the searchDocumentByTypes operation.

Sample Request for searchDocumentByTypes

{
  "apiUrl": "http://localhost:9200",
  "indexName": "twitter",
  "type": "tweet",
  "query": {
    "term": {
      "tag": "something"
    }
  },
  "explain": "true",
  "fields": [
    "message"
  ],
  "sort": [
    {
      "_type": "asc"
    }
  ],
  "timeout": "12",
  "terminateAfter": "1",
  "from": "2",
  "size": "1",
  "searchType": "count",
  "source": "false",
  "scriptFields": {
    "my_field": {
      "script": "1 + my_var",
      "params": {
        "my_var": 2
      }
    }
  },
  "fielddataFields": [
    "user"
  ],
  "highlight": {
    "fields": {
      "content": {}
    }
  },
  "indicesBoost": {
    "index1": "1.4",
    "index2": "1.3"
  },
  "trackScore": "true",
  "minScore": "6",
  "version": "false",
  "scroll": "1m",
  "queryCache": "true",
  "partialFields": {
    "partial1": {
      "include": "obj1"
    }
  },
  "postFilter": {
    "term": {
      "tag": "something"
    }
  },
  "aggregation": {
    "tag": {
      "terms": {
        "field": "tag"
      }
    }
  },
  "rescore": {
    "window_size": "10",
    "query": {
      "rescore_query": {
        "match": {
          "tag": {
            "query": "something"
          }
        }
      },
      "query_weight": 0.7,
      "rescore_query_weight": 1.2
    }
  },
  "preference": "_shards:2",
  "innerHits": {
    "comment": {
      "path": {
        "comments": {
          "query": {
            "match": {
              "comments.message": "[different query]"
            }
          }
        }
      }
    }
  },
  "pretty":"true",
  "format":"yaml",
  "human":"true",
  "filterPath":"_index,_type",
  "flatSettings":"true",
  "callback":"true",
  "case":"camelCase",
  "ignoreUnavailable":"true",
  "allowNoIndices":"true",
  "expandWildcards":"true"
}

Searching across all indices and all types

The searchByQuery operation performs a search across all indices and all types.

searchByQuery

<elasticsearch.searchByQuery>
    <query>{$ctx:query}</query>
    <explain>{$ctx:explain}</explain>
    <fields>{$ctx:fields}</fields>
    <sort>{$ctx:sort}</sort>
    <timeout>{$ctx:timeout}</timeout>
    <terminateAfter>{$ctx:terminateAfter}</terminateAfter>
    <from>{$ctx:from}</from>
    <size>{$ctx:size}</size>
    <searchType>{$ctx:searchType}</searchType>
    <source>{$ctx:source}</source>
    <scriptFields>{$ctx:scriptFields}</scriptFields>
    <fieldDataFields>{$ctx:fieldDataFields}</fieldDataFields>
    <highlight>{$ctx:highlight}</highlight>
    <indicesBoost>{$ctx:indicesBoost}</indicesBoost>
    <minScore>{$ctx:minScore}</minScore>
    <trackScores>{$ctx:trackScores}</trackScores>
    <version>{$ctx:version}</version>
    <scroll>{$ctx:scroll}</scroll>
    <queryCache>{$ctx:queryCache}</queryCache>
    <partialFields>{$ctx:partialFields}</partialFields>
    <postFilter>{$ctx:postFilter}</postFilter>
    <aggregation>{$ctx:aggregation}</aggregation>
    <rescore>{$ctx:rescore}</rescore>
    <preference>{$ctx:preference}</preference>
	<innerHits>{$ctx:innerHits}</innerHits>
</elasticsearch.searchByQuery>

Properties

query: The query string used to perform the search.
explain: If set to true, this provide an explanation of how scoring of the hits was computed for each hit.
fields: Specify the fields to return for each hit as a comma separated list. Not specifying a value will cause no fields to return.
sort: The type of sorting to perform. Can either be in the form of fieldName, or fieldName:asc/fieldName:desc. The fieldName can either be an actual field within the document, or the special score name to indicate sorting based on scores. There can be several sort parameters (order is important).
timeout: A timeout value for the search. This bounds the search request to be executed within the specified time value and returns the hits accumulated up to that point when expired. There is no value set for this by default.
terminateAfter: The maximum number of documents to collect for each shard, which upon reaching causes the query execution to terminate early. If set, the response will have a boolean field terminated_early to indicate whether the query execution has actually terminated early. There is no value set for this by default.
from: The starting from index of the hits to return. Default value is 0.
size: The number of hits to return. Default value is 10.
searchType: The type of the search to perform. Possible values are: dfs_query_then_fetch, dfs_query_and_fetch, query_then_fetch, query_and_fetch, count, scan. The default value is: query_then_fetch. For more information on the different types of search that can be performed, see Search Type.
source: If set to true, this controls how the source is returned.
scriptFields: Allows to return a script evaluation for each hit based on the values taken from different fields.
fieldDataFields: Allows to return the field data representation of a field for each hit.
highlight: Specify the fields in which search results should be highlighted.
indicesBoost: Allows to configure different boost levels per index when searching across more than one index. This is useful when hits coming from a particular index have a higher priority over hits coming from another index (social graph where each user has an index).
minScore: Specify a value so that documents that have a score less than the value specified is excluded from the search.
trackScores: Set this to true to track scores and return them as part of each hit.
version: Returns a version for each search hit.
scroll: While a search request returns a single page of results, the scroll API can be used to retrieve large numbers of results (or even all results) from a single search request, in much the same way as you would use a cursor on a traditional database.
queryCache: To enable or disable the caching of search results for requests.
partialFields: Used to use wildcards to control what part of the source will be loaded.
postFilter: Remove results from response that have values other than this.
aggregation: Aggregate data within a document set context.
rescore: Used to improve precision by reordering just the top (e.g. 100 - 500) documents returned by the query and postFilter phases.
preference: Controls a preference of which shard replicas to execute the search request on.
innerHits: Used to return per search hit in the search response additional nested hits that caused a search hit to match in a different scope.

Sample request

Following is a sample REST/JSON request that can be handled by the searchByQuery operation.

Sample Request for searchByQuery

{
  "apiUrl": "http://172.22.217.169:9200",
  "query": {
    "term": {
      "tag": "something"
    }
  },
  "explain": "true",
  "fields": [
    "name"
  ],
  "sort": [
    {
      "_type": "asc"
    }
  ],
  "timeout": "12",
  "terminateAfter": "12",
  "from": "12",
  "size": "1",
  "searchType": "count",
  "source": "false",
  "scriptFields": {
    "my_field": {
      "script": "1 + my_var",
      "params": {
        "my_var": 2
      }
    }
  },
  "fieldDataFields": [
    "user"
  ],
  "highlight": {
    "fields": {
      "content": {}
    }
  },
  "indicesBoost": {
    "index1": "1.4",
    "index2": "1.3"
  },
  "minScore": "1",
  "trackScores": "true",
  "version": "true",
  "scroll": "1m",
  "queryCache": "true",
  "partialFields": {
    "partial1": {
      "include": "obj1"
    }
  },
  "postFilter": {
    "term": {
      "tag": "something"
    }
  },
  "aggregation": {
    "tag": {
      "terms": {
        "field": "tag"
      }
    }
  },
  "rescore": {
    "window_size": "10",
    "query": {
      "rescore_query": {
        "match": {
          "tag": {
            "query": "something"
          }
        }
      },
      "query_weight": 0.7,
      "rescore_query_weight": 1.2
    }
  },
  "preference": "_shards:2",
  "innerHits": {
    "comment": {
      "path": {
        "comments": {
          "query": {
            "match": {
              "comments.message": "[different query]"
            }
          }
        }
      }
    }
  },
  "pretty":"true",
  "format":"yaml",
  "human":"true",
  "filterPath":"_index,_type",
  "flatSettings":"true",
  "callback":"true",
  "case":"camelCase"
}

Executing multiple search requests

The multiSearch operation executes multiple search requests within the same API.

multiSearch

<elasticsearch.multiSearch>
</elasticsearch.multiSearch>

Sample request

Following is a sample REST/JSON request that can be handled by the multiSearch operation.

Sample Request for multiSearch

http://CD-DJAYAWICKRAM:8280/services/elasticsearch_multiSearch?
apiUrl=http://172.22.217.169:9200&pretty=true&case=camelCase

Sample configuration

Following is a sample proxy service that illustrates how to connect to Elasticsearch with the init operation and use the searchDocumentsByIndex operation. The sample request for this proxy can be found in the searchDocumentsByIndex sample request. You can use this sample as a template for using other operations in this category.

Sample Proxy

<?xml version="1.0" encoding="UTF-8"?>
<proxy name="elasticsearch_searchDocumentsByIndex" startOnLoad="true" statistics="disable" trace="disable" transports="https,http" xmlns="http://ws.apache.org/ns/synapse">
   <target>
      <inSequence onError="faultHandlerSeq">
         <property name="apiUrl" expression="json-eval($.apiUrl)"/>
         <property name="indexName" expression="json-eval($.indexName)"/>
         <property name="query" expression="json-eval($.query)"/>
         <property name="explain" expression="json-eval($.explain)"/>
         <property name="fields" expression="json-eval($.fields)"/>
         <property name="sort" expression="json-eval($.sort)"/>
         <property name="timeout" expression="json-eval($.timeout)"/>
         <property name="terminateAfter" expression="json-eval($.terminateAfter)"/>
         <property name="from" expression="json-eval($.from)"/>
         <property name="size" expression="json-eval($.size)"/>
         <property name="searchType" expression="json-eval($.searchType)"/>
         <property name="source" expression="json-eval($.source)"/>
         <property name="scriptFields" expression="json-eval($.scriptFields)"/>
         <property name="fieldDataFields" expression="json-eval($.fieldDataFields)"/>
         <property name="highlight" expression="json-eval($.highlight)"/>
         <property name="indicesBoost" expression="json-eval($.indicesBoost)"/>
         <property name="minScore" expression="json-eval($.minScore)"/>
         <property name="trackScores" expression="json-eval($.trackScores)"/>
         <property name="version" expression="json-eval($.version)"/>
         <property name="scroll" expression="json-eval($.scroll)"/>
         <property name="queryCache" expression="json-eval($.queryCache)"/>
         <property name="partialFields" expression="json-eval($.partialFields)"/>
         <property name="postFilter" expression="json-eval($.postFilter)"/>
         <property name="aggregation" expression="json-eval($.aggregation)"/>
         <property name="rescore" expression="json-eval($.rescore)"/>
         <property name="preference" expression="json-eval($.preference)"/>
         <property name="innerHits" expression="json-eval($.innerHits)"/>
         <property name="pretty" expression="json-eval($.pretty)"/>
         <property name="format" expression="json-eval($.format)"/>
         <property name="human" expression="json-eval($.human)"/>
         <property name="filterPath" expression="json-eval($.filterPath)"/>
         <property name="flatSettings" expression="json-eval($.flatSettings)"/>
         <property name="callback" expression="json-eval($.callback)"/>
         <property name="case" expression="json-eval($.case)"/>
         <property name="ignoreUnavailable" expression="json-eval($.ignoreUnavailable)"/>
         <property name="allowNoIndices" expression="json-eval($.allowNoIndices)"/>
         <property name="expandWildcards" expression="json-eval($.expandWildcards)"/>
         <elasticsearch.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <pretty>{$ctx:pretty}</pretty>
            <format>{$ctx:format}</format>
            <human>{$ctx:human}</human>
            <filterPath>{$ctx:filterPath}</filterPath>
            <flatSettings>{$ctx:flatSettings}</flatSettings>
            <callback>{$ctx:callback}</callback>
            <case>{$ctx:case}</case>
         </elasticsearch.init>
         <elasticsearch.searchDocumentsByIndex>
            <indexName>{$ctx:indexName}</indexName>
            <query>{$ctx:query}</query>
            <explain>{$ctx:explain}</explain>
            <fields>{$ctx:fields}</fields>
            <sort>{$ctx:sort}</sort>
            <timeout>{$ctx:timeout}</timeout>
            <terminateAfter>{$ctx:terminateAfter}</terminateAfter>
            <from>{$ctx:from}</from>
            <size>{$ctx:size}</size>
            <searchType>{$ctx:searchType}</searchType>
            <source>{$ctx:source}</source>
            <scriptFields>{$ctx:scriptFields}</scriptFields>
            <fieldDataFields>{$ctx:fieldDataFields}</fieldDataFields>
            <highlight>{$ctx:highlight}</highlight>
            <indicesBoost>{$ctx:indicesBoost}</indicesBoost>
            <minScore>{$ctx:minScore}</minScore>
            <trackScores>{$ctx:trackScores}</trackScores>
            <version>{$ctx:version}</version>
            <scroll>{$ctx:scroll}</scroll>
            <queryCache>{$ctx:queryCache}</queryCache>
            <partialFields>{$ctx:partialFields}</partialFields>
            <postFilter>{$ctx:postFilter}</postFilter>
            <aggregation>{$ctx:aggregation}</aggregation>
            <rescore>{$ctx:rescore}</rescore>
            <preference>{$ctx:preference}</preference>
            <innerHits>{$ctx:innerHits}</innerHits>
            <ignoreUnavailable>{$ctx:ignoreUnavailable}</ignoreUnavailable>
            <allowNoIndices>{$ctx:allowNoIndices}</allowNoIndices>
            <expandWildcards>{$ctx:expandWildcards}</expandWildcards>
         </elasticsearch.searchDocumentsByIndex>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>

Overview

Operation details

Searching all documents across all types within a specified index

Properties

Sample request

Related Elasticsearch documentation

Searching all documents within a specific type in a specified index

Properties

Sample request

Related ElasticSearch documentation

Searching across all indices and all types

Properties

Sample request

Related Elasticsearch documentation

Executing multiple search requests

Sample request

Related ElasticSearch documentation

Sample configuration