vendor/bundle/jruby/2.3.0/gems/elasticsearch-api-5.0.4/lib/elasticsearch/api/actions/search.rb
# Return documents matching a query, as well as aggregations (facets), highlighted snippets, suggestions, etc.
#
# The search API is used to query one or more indices either using simple
# [query string queries](http://www.elasticsearch.org/guide/reference/api/search/uri-request/)
# as the `:q` argument , or by passing the
# [full request definition](http://www.elasticsearch.org/guide/reference/api/search/request-body/)
# in the [Query DSL](http://www.elasticsearch.org/guide/reference/query-dsl/) as the `:body` argument.
#
# @example Search with a simple query string query
#
#     client.search index: 'myindex', q: 'title:test'
#
# @example Passing a full request definition in the Elasticsearch's Query DSL as a `Hash`
#
#     client.search index: 'myindex',
#                   body: {
#                     query: { match: { title: 'test' } },
#                     aggregations: { tags: { terms: { field: 'tags' } } }
#                   }
#
# @example Paginating results: return 10 documents, beginning from the 10th
#
#     client.search index: 'myindex',
#                   body: {
#                     query: { match: { title: 'test' } },
#                     from: 10,
#                     size: 10
#                   }
#
# @example Passing the search definition as a `String`, built with a JSON builder
#
#     require 'jbuilder'
#
#     json = Jbuilder.encode do |json|
#       json.query do
#         json.match do
#           json.title do
#             json.query    'test 1'
#             json.operator 'and'
#           end
#         end
#       end
#     end
#
#     client.search index: 'myindex', body: json
#
# @example Wrapping the result in [`Hashie::Mash`](https://github.com/intridea/hashie) for easier access
#
#     response = client.search index: 'myindex',
#                              body: {
#                                query:  { match: { title: 'test' } },
#                                aggregations: { tags:  { terms: { field: 'tags' } } }
#                              }
#
#     response = Hashie::Mash.new response
#
#     response.hits.hits.first._source.title
#
#     response.aggregations.tags.terms.to_a.map { |f| "#{f.term} [#{f.count}]" }.join(', ')
#
# @option arguments [List] :index A comma-separated list of index names to search; use `_all`
#                                 or empty string to perform the operation on all indices
# @option arguments [List] :type A comma-separated list of document types to search;
#                                leave empty to perform the operation on all types
# @option arguments [Hash] :body The search definition using the Query DSL
# @option arguments [String] :analyzer The analyzer to use for the query string
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed
#                                               (default: false)
# @option arguments [String] :default_operator The default operator for query string query (AND or OR)
#                                              (options: AND, OR)
# @option arguments [String] :df The field to use as default where no field prefix is given in the query string
# @option arguments [Boolean] :explain Specify whether to return detailed information about score computation
#                                      as part of a hit
# @option arguments [List] :fields A comma-separated list of fields to return as part of a hit
# @option arguments [List] :fielddata_fields A comma-separated list of fields to return as the field data
#                                            representation of a field for each hit
# @option arguments [List] :docvalue_fields A comma-separated list of fields to return as the docvalue
#                                           representation of a field for each hit
# @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit
# @option arguments [Number] :from Starting offset (default: 0)
# @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
#                                            (options: none, missing)
# @option arguments [Boolean] :lenient Specify whether format-based query failures
#                                      (such as providing text to a numeric field) should be ignored
# @option arguments [Boolean] :lowercase_expanded_terms Specify whether query terms should be lowercased
# @option arguments [String] :preference Specify the node or shard the operation should be performed on
#                                        (default: random)
# @option arguments [String] :q Query in the Lucene query string syntax
# @option arguments [Boolean] :request_cache Specify if request cache should be used for this request
#                                            (defaults to index level setting)
# @option arguments [List] :routing A comma-separated list of specific routing values
# @option arguments [Duration] :scroll Specify how long a consistent view of the index should be maintained
#                                      for scrolled search
# @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch,
#                                         dfs_query_then_fetch, dfs_query_and_fetch, count, scan)
# @option arguments [Number] :size Number of hits to return (default: 10)
# @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
# @option arguments [String] :source The URL-encoded request definition using the Query DSL
#                                    (instead of using request body)
# @option arguments [String] :_source Specify whether the _source field should be returned,
#                                     or a list of fields to return
# @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
# @option arguments [String] :_source_include A list of fields to extract and return from the _source field
# @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
# @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
# @option arguments [String] :suggest_field Specify which field to use for suggestions
# @option arguments [String] :suggest_mode Specify suggest mode (options: missing, popular, always)
# @option arguments [Number] :suggest_size How many suggestions to return in response
# @option arguments [Text] :suggest_text The source text for which the suggestions should be returned
# @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
# @option arguments [Boolean] :version Specify whether to return document version as part of a hit
# @option arguments [Number] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
#
# @return [Hash]
#
# @see http://www.elasticsearch.org/guide/reference/api/search/
# @see http://www.elasticsearch.org/guide/reference/api/search/request-body/
#
Return documents matching a query, as well as aggregations (facets), highlighted snippets, suggestions, etc.
The search API is used to query one or more indices either using simple
[query string queries]
as the `:q` argument , or by passing the
[full request definition]
in the [Query DSL] as the `:body` argument.
Return documents matching a query as well as aggregations ( facets ) highlighted snippets suggestions etc . The search API is used to query one or more indices either using simple [ query string queries ] as the ` : q ` argument or by passing the [ full request definition ] in the [ Query DSL ] as the ` : body ` argument .
def search(arguments={})
        arguments[:index] = UNDERSCORE_ALL if ! arguments[:index] && arguments[:type]
        valid_params = [
          :analyzer,
          :analyze_wildcard,
          :default_operator,
          :df,
          :explain,
          :fielddata_fields,
          :docvalue_fields,
          :stored_fields,
          :fields,
          :from,
          :ignore_indices,
          :ignore_unavailable,
          :allow_no_indices,
          :expand_wildcards,
          :lenient,
          :lowercase_expanded_terms,
          :preference,
          :q,
          :query_cache,
          :request_cache,
          :routing,
          :scroll,
          :search_type,
          :size,
          :sort,
          :source,
          :_source,
          :_source_include,
          :_source_exclude,
          :stored_fields,
          :stats,
          :suggest_field,
          :suggest_mode,
          :suggest_size,
          :suggest_text,
          :terminate_after,
          :timeout,
          :typed_keys,
          :version,
          :batched_reduce_size ]
        method = HTTP_GET
        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), UNDERSCORE_SEARCH )
        params = Utils.__validate_and_extract_params arguments, valid_params
        body   = arguments[:body]
        params[:fields] = Utils.__listify(params[:fields], :escape => false) if params[:fields]
        params[:fielddata_fields] = Utils.__listify(params[:fielddata_fields], :escape => false) if params[:fielddata_fields]
        params[:filter_path] =  defined?(EscapeUtils) ? EscapeUtils.unescape_url(params[:filter_path]) : CGI.unescape(params[:filter_path]) if params[:filter_path]
        perform_request(method, path, params, body).body
      end
def search ( arguments = { } ) arguments [ :index ] = UNDERSCORE_ALL if ! arguments [ :index ] && arguments [ :type ] valid_params = [ :analyzer , :analyze_wildcard , :default_operator , :df , :explain , :fielddata_fields , :docvalue_fields , :stored_fields , :fields , :from , :ignore_indices , :ignore_unavailable , :allow_no_indices , :expand_wildcards , :lenient , :lowercase_expanded_terms , :preference , :q , :query_cache , :request_cache , :routing , :scroll , :search_type , :size , :sort , :source , :_source , :_source_include , :_source_exclude , :stored_fields , :stats , :suggest_field , :suggest_mode , :suggest_size , :suggest_text , :terminate_after , :timeout , :typed_keys , :version , :batched_reduce_size ] method = HTTP_GET path = Utils . __pathify ( Utils . __listify ( arguments [ :index ] ) , Utils . __listify ( arguments [ :type ] ) , UNDERSCORE_SEARCH ) params = Utils . __validate_and_extract_params arguments , valid_params body = arguments [ :body ] params [ :fields ] = Utils . __listify ( params [ :fields ] , :escape => false ) if params [ :fields ] params [ :fielddata_fields ] = Utils . __listify ( params [ :fielddata_fields ] , :escape => false ) if params [ :fielddata_fields ] params [ :filter_path ] = defined? ( EscapeUtils ) ? EscapeUtils . unescape_url ( params [ :filter_path ] ) : CGI . unescape ( params [ :filter_path ] ) if params [ :filter_path ] perform_request ( method , path , params , body ) . body end
Return documents matching a query, as well as aggregations (facets), highlighted snippets, suggestions, etc.
Return documents matching a query as well as aggregations ( facets ) highlighted snippets suggestions etc .
# FIX: Unescape the `filter_path` parameter due to __listify default behavior. Investigate.
None
Hash
arguments
:batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
: batched_reduce_size The number of shard results that should be reduced at once on the coordinating node . This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large .
example
Search with a simple query string query client.search index: 'myindex', q: 'title:test'
Search with a simple query string query client . search index : ' myindex ' q : ' title : test '
example
Passing a full request definition in the Elasticsearch's Query DSL as a `Hash` client.search index: 'myindex', body: { query: { match: { title: 'test' } }, aggregations: { tags: { terms: { field: 'tags' } } } }
Passing a full request definition in the Elasticsearch ' s Query DSL as a ` Hash ` client . search index : ' myindex ' body : { query : { match : { title : ' test ' } } aggregations : { tags : { terms : { field : ' tags ' } } } }
example
Paginating results: return 10 documents, beginning from the 10th client.search index: 'myindex', body: { query: { match: { title: 'test' } }, from: 10, size: 10 }
Paginating results : return 10 documents beginning from the 10th client . search index : ' myindex ' body : { query : { match : { title : ' test ' } } from : 10 size : 10 }
example
Passing the search definition as a `String`, built with a JSON builder require 'jbuilder' json = Jbuilder.encode do |json| json.query do json.match do json.title do json.query 'test 1' json.operator 'and' end end end end client.search index: 'myindex', body: json
Passing the search definition as a ` String ` built with a JSON builder require ' jbuilder ' json = Jbuilder . encode do |json| json . query do json . match do json . title do json . query ' test 1 ' json . operator ' and ' end end end end client . search index : ' myindex ' body : json
example
Wrapping the result in [`Hashie::Mash`] for easier access response = client.search index: 'myindex', body: { query: { match: { title: 'test' } }, aggregations: { tags: { terms: { field: 'tags' } } } } response = Hashie::Mash.new response response.hits.hits.first._source.title response.aggregations.tags.terms.to_a.map { |f| "#{f.term} [#{f.count}]" }.join(', ')
Wrapping the result in [ ` Hashie :: Mash ` ] for easier access response = client . search index : ' myindex ' body : { query : { match : { title : ' test ' } } aggregations : { tags : { terms : { field : ' tags ' } } } } response = Hashie :: Mash . new response response . hits . hits . first . _source . title response . aggregations . tags . terms . to_a . map { |f| " # { f . term } [ # { f . count } ] " } . join ( ' ' )
see
None
see
None