Page Comparison

...

Code Block

language	xml
title	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 Anchor query query : The query string used to perform the search.
explain: Set this to true if you want detailed information about score computation returned as part of a hit
fields: A comma separated list of fields to return for each hit.
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: An operation timeout value for the search. This causes the search to execute within the specified time and returns the hits accumulated within that period of time.
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.
from: The starting offset. Default value is 0.
size: The number of hits to return. Default value is 10.
searchType: The search operation type. 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: Set this to true if you want the source fields returned in the response.
scriptFields: Provide a script that can work on fields that are not stored, and return custom values for each hit based on the script evaluation.
fieldDataFields: A comma separated list of fields to return as the field data representation of a field for each hit
highlight: Specify the fields that should be highlighted in each search hit .
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 with a score less than the specified value are excluded from the search.
trackScores: Set this to true if you want to calculate and return scores even if they are not used for sorting.
version: Set this to true if you want the document version returned for each hit.
scroll: Specify how long a consistent view of the index should be maintained for scrolled search. The duration should be specified in time units. For information on supported time units, see Time units.
queryCache: Set this to true if you want to enable caching of search results for requests.
partialFields: Specify wildcards to based on what part which parts of the source original document you want loadedreturned for each hit.
postFilter: If you need to differentially filter search hits, you can specify the search values here. Values other than what is specified here will be removed from the search hits.
aggregation: Specify the document fields from which the values should be extracted for aggregation.
rescore: A second query to be executed on the results returned by the original query.
preference: Specify the shard on which the search operation should be performed.
innerHits: Specify a definition that returns additional nested hits that caused a search hit to satisfy a different scope, for each search hit in the search response.
ignoreUnavailable: Set this to true if you want to ignore any index that is unavailable.
allowNoIndices: Set this to true if you want to ignore an index when a wildcard index expression results in no concrete index.
expandWildcards: Set this to true if you want to expand wildcard expression to concrete indices.

...

Code Block

language	xml
title	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: Set this to true if you want detailed information about score computation returned as part of a hit.
fields: A comma separated list of fields to return for each hit.
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: An operation timeout value for the search. This causes the search to execute within the specified time and returns the hits accumulated within that period of time.
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.
from: The starting offset. Default value is 0.
size: The number of hits to return. Default value is 10.
searchType: The search operation type. 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: Set this to true if you want the source fields returned in the response.
scriptFields: Provide a script that can work on fields that are not stored, and return custom values for each hit based on the script evaluation.
fieldDataFields: A comma separated list of fields to return as the field data representation of a field for each hit
highlight: Specify the fields that should be highlighted in each search hit .
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 with a score less than the specified value are excluded from the search.
trackScores: Set this to true if you want to calculate and return scores even if they are not used for sorting.
version: Set this to true if you want the document version returned for each hit.
scroll: Specify how long a consistent view of the index should be maintained for scrolled search. The duration should be specified in time units. For information on supported time units, see Time units.
type: A comma separated list of document types to search.
queryCache: Set this to true if you want to enable caching of search results for requests.
partialFields: Specify wildcards to based on what part which parts of the source original document you want loadedreturned for each hit.
postFilter: If you need to differentially filter search hits, you can specify the search values here. Values other than what is specified here will be removed from the search hits.
aggregation: Specify the document fields from which the values should be extracted for aggregation.
rescore: A second query to be executed on the results returned by the original query.
preference: Specify the shard on which the search operation should be performed.
innerHits: Specify a definition that returns additional nested hits that caused a search hit to satisfy a different scope, for each search hit in the search response.
ignoreUnavailable: Set this to true if you want to ignore any index that is unavailable.
allowNoIndices: Set this to true if you want to ignore an index when a wildcard index expression results in no concrete index.
expandWildcards: Set this to true if you want to expand wildcard expression to concrete indices.

...

Code Block

language	xml
title	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: Set this to true if you want detailed information about score computation returned as part of a hit
fields: A comma separated list of fields to return for each hit.
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: An operation timeout value for the search. This causes the search to execute within the specified time and returns the hits accumulated within that period of time.
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.
from: The starting offset. Default value is 0.
size: The number of hits to return. Default value is 10.
searchType: The search operation type. 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: Set this to true if you want the source fields returned in the response.
scriptFields: Provide a script that can work on fields that are not stored, and return custom values for each hit based on the script evaluation.
fieldDataFields: A comma separated list of fields to return as the field data representation of a field for each hit
highlight: Specify the fields that should be highlighted in each search hit .
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 with a score less than the specified value are excluded from the search.
trackScores: Set this to true if you want to calculate and return scores even if they are not used for sorting.
version: Set this to true if you want the document version returned for each hit.
scroll: Specify how long a consistent view of the index should be maintained for scrolled search. The duration should be specified in time units. For information on supported time units, see Time units.
queryCache: Set this to true if you want to enable caching of search results for requests.
partialFields: Specify wildcards to based on what part which parts of the source original document you want loadedreturned for each hit.
postFilter: If you need to differentially filter search hits, you can specify the search values here. Values other than what is specified here will be removed from the search hits.
aggregation: Specify the document fields from which the values should be extracted for aggregation.
rescore: A second query to be executed on the results returned by the original query.
preference: Specify the shard on which the search operation should be performed.
innerHits: Specify a definition that returns additional nested hits that caused a search hit to satisfy a different scope, for each search hit in the search response.

...

Versions Compared

Old Version 12

New Version 13

Key

Properties

Properties

Properties