Class: ElastomerClient::Client::Docs

Inherits:
Object
  • Object
show all
Defined in:
lib/elastomer_client/client/docs.rb

Constant Summary collapse

SPECIAL_KEYS = 
%i[
  index type id version version_type op_type routing parent
  consistency replication refresh wait_for_active_shards
].inject({}) { |h, k| h[k] = "_#{k}"; h }.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, name, type = nil) ⇒ Docs

Create a new document client for making API requests that pertain to the indexing and searching of documents in a search index.

client - ElastomerClient::Client used for HTTP requests to the server name - The name of the index as a String type - The document type as a String



27
28
29
30
31
 
# File 'lib/elastomer_client/client/docs.rb', line 27

def initialize(client, name, type = nil)
  @client = client
  @name   = @client.assert_param_presence(name, "index name") unless name.nil?
  @type   = @client.assert_param_presence(type, "document type") unless type.nil?
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



33
34
35
 
# File 'lib/elastomer_client/client/docs.rb', line 33

def client
  @client
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



33
34
35
 
# File 'lib/elastomer_client/client/docs.rb', line 33

def name
  @name
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



33
34
35
 
# File 'lib/elastomer_client/client/docs.rb', line 33

def type
  @type
end

Instance Method Details

#bulk(params = {}, &block) ⇒ Object

Perform bulk indexing and/or delete operations. The current index name and document type will be passed to the bulk API call as part of the request parameters.

params - Parameters Hash that will be passed to the bulk API call. block - Required block that is used to accumulate bulk API operations.

All the operations will be passed to the search cluster via a
single API request.

Yields a Bulk instance for building bulk API call bodies.

Examples

docs.bulk do |b|
  b.index( document1 )
  b.index( document2 )
  b.delete( document3 )
  ...
end

Returns the response body as a Hash



447
448
449
450
451
452
 
# File 'lib/elastomer_client/client/docs.rb', line 447

def bulk(params = {}, &block)
  raise "a block is required" if block.nil?

  params = {index: self.name, type: self.type}.merge params
  client.bulk params, &block
end

#count(query, params = nil) ⇒ Object

Executes a search query, but instead of returning results, returns the number of documents matched. This method supports both the “request body” query and the “URI request” query. When using the request body semantics, the query hash must contain the :query key. Otherwise we assume a URI request is being made.

query - The query body as a Hash params - Parameters Hash

Examples

# request body query
count({match_all: {}}, type: 'tweet')

# same thing but using the URI request method
count(q: '*:*', type: 'tweet')

See www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html

Returns the response body as a Hash



257
258
259
260
261
262
263
264
265
266
 
# File 'lib/elastomer_client/client/docs.rb', line 257

def count(query, params = nil)
  query, params = extract_params(query) if params.nil?

  if client.version_support.es_version_8_plus?
    response = client.get "/{index}/_count", update_params(params, {body: query, action: "docs.count", rest_api: "count"}, true)
  else
    response = client.get "/{index}{/type}/_count", update_params(params, body: query, action: "docs.count", rest_api: "count")
  end
  response.body
end

#defaults ⇒ Object

Internal: Returns a Hash containing default parameters.



612
613
614
 
# File 'lib/elastomer_client/client/docs.rb', line 612

def defaults
  { index: name, type: }
end

#delete(params = {}) ⇒ Object

Delete a document from the index based on the document ID. The :id is provided as part of the params hash.

params - Parameters Hash

:id - the ID of the document to delete

See www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html

Returns the response body as a Hash



103
104
105
106
 
# File 'lib/elastomer_client/client/docs.rb', line 103

def delete(params = {})
  response = client.delete "/{index}/{type}/{id}", update_params(params, action: "docs.delete", rest_api: "delete")
  response.body
end

#delete_by_query(query, params = nil) ⇒ Object

Delete documents by query



269
270
271
 
# File 'lib/elastomer_client/client/docs.rb', line 269

def delete_by_query(query, params = nil)
  send(:native_delete_by_query, query, params)
end

#exists?(params = {}) ⇒ Boolean Also known as: exist?

Check to see if a document exists. The :id is provided as part of the params hash.

params - Parameters Hash

:id - the ID of the document to check

See www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#docs-get

Returns true if the document exists

Returns:

  • (Boolean) 


131
132
133
134
 
# File 'lib/elastomer_client/client/docs.rb', line 131

def exists?(params = {})
  response = client.head "/{index}/{type}/{id}", update_params(params, action: "docs.exists", rest_api: "exists")
  response.success?
end

#explain(query, params = nil) ⇒ Object

Compute a score explanation for a query and a specific document. This can give useful feedback about why a document matched or didn’t match a query. The document :id is provided as part of the params hash.

query - The query body as a Hash params - Parameters Hash

:id - the ID of the document

Examples

explain({query: {term: {"message" => "search"}}}, id: 1)

explain(q: "message:search", id: 1)

See www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html

Returns the response body as a hash



390
391
392
393
394
395
396
397
398
399
 
# File 'lib/elastomer_client/client/docs.rb', line 390

def explain(query, params = nil)
  query, params = extract_params(query) if params.nil?

  if client.version_support.es_version_8_plus?
    response = client.get "/{index}/_explain/{id}", update_params(params, {body: query, action: "docs.explain", rest_api: "explain"}, true)
  else
    response = client.get "/{index}/{type}/{id}/_explain", update_params(params, body: query, action: "docs.explain", rest_api: "explain")
  end
  response.body
end

#extract_params(query, params = nil) ⇒ Object

Internal: Allow params to be passed as the first argument to methods that take both an optional query hash and params.

query - query hash OR params hash params - params hash OR nil if no query

Returns an array of the query (possibly nil) and params Hash.



623
624
625
626
627
628
629
630
631
632
 
# File 'lib/elastomer_client/client/docs.rb', line 623

def extract_params(query, params = nil)
  if params.nil?
    if query.key? :query
      params = {}
    else
      params, query = query, nil
    end
  end
  [query, params]
end

#from_document(document) ⇒ Object

Internal: Given a ‘document` generate an options hash that will override parameters based on the content of the document. The document will be returned as the value of the :body key.

We only extract information from the document if it is given as a Hash. We do not parse JSON encoded Strings.

document - A document Hash or JSON encoded String.

Returns an options Hash extracted from the document.

Raises ElastomerClient::Client::IllegalArgument if an unsupported indexing directive is used.



582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/elastomer_client/client/docs.rb', line 582

def from_document(document)
  opts = {body: document}

  if document.is_a? Hash
    SPECIAL_KEYS.each do |key, field|
      opts[key] = document.delete field if document.key? field
      opts[key] = document.delete field.to_sym if document.key? field.to_sym
    end
  end

  opts
end

#get(params = {}) ⇒ Object

Retrieve a document from the index based on its ID. The :id is provided as part of the params hash.

params - Parameters Hash

:id - the ID of the document to get

See www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#docs-get

Returns the response body as a Hash



117
118
119
120
 
# File 'lib/elastomer_client/client/docs.rb', line 117

def get(params = {})
  response = client.get "/{index}/{type}/{id}", update_params(params, action: "docs.get", rest_api: "get")
  response.body
end

#index(document, params = {}) ⇒ Object

Adds or updates a document in the index, making it searchable. If the document contains an ‘:_id` attribute then PUT semantics will be used to create (or update) a document with that ID. If no ID is provided then a new document will be created using POST semantics.

There are several other document attributes that control how Elasticsearch will index the document. They are listed below. Please refer to the Elasticsearch documentation for a full explanation of each and how it affects the indexing process. These indexing directives vary by Elasticsearch version. Attempting to use a directive not supported by the Elasticsearch server will raise an exception.

:_id
:_type
:_version
:_version_type
:_op_type
:_routing
:_parent
:_refresh

Elasticsearch 2.X only:

:_consistency

Elasticsearch 5.x only:

:_wait_for_active_shards

If any of these attributes are present in the document they will be removed from the document before it is indexed. This means that the document will be modified by this method.

document - The document (as a Hash or JSON encoded String) to add to the index params - Parameters Hash

See www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html

Returns the response body as a Hash

Raises ElastomerClient::Client::IllegalArgument if an unsupported indexing directive is used.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/elastomer_client/client/docs.rb', line 77

def index(document, params = {})
  overrides = from_document document
  params = update_params(params, overrides)
  params.merge!(action: "docs.index", rest_api: "index")

  params.delete(:id) if params[:id].nil? || params[:id].to_s =~ /\A\s*\z/

  response =
      if params[:id]
        client.put "/{index}/{type}/{id}", params
      else
        client.post "/{index}/{type}", params
      end

  response.body
end

#multi_get(body, params = {}) ⇒ Object Also known as: mget

Allows you to get multiple documents based on an index, type, and id (and possibly routing).

body - The request body as a Hash or a JSON encoded String params - Parameters Hash

See www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html

Returns the response body as a Hash



159
160
161
162
163
164
165
 
# File 'lib/elastomer_client/client/docs.rb', line 159

def multi_get(body, params = {})
  overrides = from_document body
  overrides.merge!(action: "docs.multi_get", rest_api: "mget")

  response = client.get "{/index}{/type}/_mget", update_params(params, overrides, client.version_support.es_version_8_plus?)
  response.body
end

#multi_percolate(params = {}, &block) ⇒ Object

Execute an array of percolate actions in bulk. Results are returned in an array in the order the actions were sent. The current index name and type will be passed to the API call as part of the request parameters.

See www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html#_multi_percolate_api

params - Optional request parameters as a Hash block - Passed to a MultiPercolate instance which assembles the

percolate actions into a single request.

Examples

# block form
multi_percolate do |m|
  m.percolate(author: "pea53")
  m.count(author: "grantr")
  ...
end

Returns the response body as a Hash



559
560
561
562
 
# File 'lib/elastomer_client/client/docs.rb', line 559

def multi_percolate(params = {}, &block)
  params = defaults.merge params
  client.multi_percolate(params, &block)
end

#multi_search(params = {}, &block) ⇒ Object

Execute an array of searches in bulk. Results are returned in an array in the order the queries were sent. The current index name and document type will be passed to the multi_search API call as part of the request parameters.

params - Parameters Hash that will be passed to the API call. block - Required block that is used to accumulate searches.

All the operations will be passed to the search cluster
via a single API request.

Yields a MultiSearch instance for building multi_search API call bodies.

Examples

docs.multi_search do |m|
  m.search({query: {match_all: {}}, size: 0)
  m.search({query: {field: {"foo" => "bar"}}})
  ...
end

See www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html

Returns the response body as a Hash



531
532
533
534
535
536
537
 
# File 'lib/elastomer_client/client/docs.rb', line 531

def multi_search(params = {}, &block)
  raise "a block is required" if block.nil?

  params = {index: self.name, type: self.type}.merge params
  params.delete(:type) if client.version_support.es_version_8_plus?
  client.multi_search params, &block
end

#multi_termvectors(body, params = {}) ⇒ Object Also known as: multi_term_vectors

Multi termvectors API allows you to get multiple termvectors based on an index, type and id. The response includes a docs array with all the fetched termvectors, each element having the structure provided by the ‘termvector` API.

params - Parameters Hash

See www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html

Returns the response body as a hash



365
366
367
368
 
# File 'lib/elastomer_client/client/docs.rb', line 365

def multi_termvectors(body, params = {})
  response = client.get "{/index}{/type}/_mtermvectors", update_params(params, {body:, action: "docs.multi_termvectors", rest_api: "mtermvectors"}, client.version_support.es_version_8_plus?)
  response.body
end

#native_delete_by_query(query, params = {}) ⇒ Object

Delete documents from one or more indices and one or more types based on a query using Elasticsearch’s _delete_by_query API.

See Client#native_delete_by_query for more information.

Returns a Hash of statistics about the delete operations as returned by _delete_by_query.

Raises ElastomerClient::Client::IncompatibleVersionException if this version of Elasticsearch does not support _delete_by_query.



283
284
285
286
287
 
# File 'lib/elastomer_client/client/docs.rb', line 283

def native_delete_by_query(query, params = {})
  query, params = extract_params(query) if params.nil?

  @client.native_delete_by_query(query, update_params(params))
end

#percolate(body, params = {}) ⇒ Object

Matches a provided or existing document to the stored percolator queries. To match an existing document, pass ‘nil` as the body and include `:id` in the params.

Examples

index.percolator(1).create query: { match: { author: "pea53" } }
docs.percolate doc: { author: "pea53" }
docs.percolate nil, id: 3

Returns the response body as a Hash



312
313
314
315
 
# File 'lib/elastomer_client/client/docs.rb', line 312

def percolate(body, params = {})
  response = client.get "/{index}/{type}{/id}/_percolate", update_params(params, body:, action: "percolator.percolate", rest_api: "percolate")
  response.body
end

#percolate_count(body, params = {}) ⇒ Object

Counts the queries that match a provided or existing document. To count matches for an existing document, pass ‘nil` as the body and include `:id` in the params.

Examples

index.register_percolator_query 1, query: { match: { author: "pea53" } }
docs.percolate_count doc: { author: "pea53" }
docs.percolate_count nil, id: 3

Returns the count



328
329
330
331
 
# File 'lib/elastomer_client/client/docs.rb', line 328

def percolate_count(body, params = {})
  response = client.get "/{index}/{type}{/id}/_percolate/count", update_params(params, body:, action: "percolator.percolate_count", rest_api: "count_percolate")
  response.body["total"]
end

#scan(query, opts = {}) ⇒ Object

Create a new Scroller instance for scanning all results from a ‘query`. The Scroller will be scoped to the current index and document type. The Scroller is configured to use `scan` semantics which are more efficient than a standard scroll query; the caveat is that the returned documents cannot be sorted.

query - The query to scan as a Hash or a JSON encoded String opts - Options Hash

:index  - the name of the index to search
:type   - the document type to search
:scroll - the keep alive time of the scrolling request (5 minutes by default)
:size   - the number of documents per shard to fetch per scroll

Examples

scan = docs.scan('{"query":{"match_all":{}}}')
scan.each_document do |document|
  document['_id']
  document['_source']
end

Returns a new Scroller instance



502
503
504
505
 
# File 'lib/elastomer_client/client/docs.rb', line 502

def scan(query, opts = {})
  opts = {index: name, type:}.merge opts
  client.scan query, opts
end

#scroll(query, opts = {}) ⇒ Object

Create a new Scroller instance for scrolling all results from a ‘query`. The Scroller will be scoped to the current index and document type.

query - The query to scroll as a Hash or a JSON encoded String opts - Options Hash

:index  - the name of the index to search
:type   - the document type to search
:scroll - the keep alive time of the scrolling request (5 minutes by default)
:size   - the number of documents per shard to fetch per scroll

Examples

scroll = index.scroll('{"query":{"match_all":{}},"sort":{"date":"desc"}}')
scroll.each_document do |document|
  document['_id']
  document['_source']
end

See www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html

Returns a new Scroller instance



475
476
477
478
 
# File 'lib/elastomer_client/client/docs.rb', line 475

def scroll(query, opts = {})
  opts = {index: name, type:}.merge opts
  client.scroll query, opts
end

#search(query, params = nil) ⇒ Object

Allows you to execute a search query and get back search hits that match the query. This method supports both the “request body” query and the “URI request” query. When using the request body semantics, the query hash must contain the :query key. Otherwise we assume a URI request is being made.

query - The query body as a Hash params - Parameters Hash

Examples

# request body query
search({query: {match_all: {}}}, type: 'tweet')

# same thing but using the URI request method
search(q: '*:*', type: 'tweet')

See www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html See www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html See www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html

Returns the response body as a hash



210
211
212
213
214
215
 
# File 'lib/elastomer_client/client/docs.rb', line 210

def search(query, params = nil)
  query, params = extract_params(query) if params.nil?

  response = client.get "/{index}{/type}/_search", update_params(params, {body: query, action: "docs.search", rest_api: "search"}, client.version_support.es_version_8_plus?)
  response.body
end

#search_shards(params = {}) ⇒ Object

The search shards API returns the indices and shards that a search request would be executed against. This can give useful feedback for working out issues or planning optimizations with routing and shard preferences.

params - Parameters Hash

:routing    - routing values
:preference - which shard replicas to execute the search request on
:local      - boolean value to use local cluster state

See www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html

Returns the response body as a hash



230
231
232
233
234
235
 
# File 'lib/elastomer_client/client/docs.rb', line 230

def search_shards(params = {})
  updated_params = update_params(params, { action: "docs.search_shards", rest_api: "search_shards" }, true)

  response = client.get "/{index}/_search_shards", updated_params
  response.body
end

#source(params = {}) ⇒ Object

Retrieve the document source from the index based on the ID and type. The :id is provided as part of the params hash.

params - Parameters Hash

:id - the ID of the document

See www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#_source

Returns the response body as a Hash



146
147
148
149
 
# File 'lib/elastomer_client/client/docs.rb', line 146

def source(params = {})
  response = client.get "/{index}/{type}/{id}/_source", update_params(params, action: "docs.source", rest_api: "get_source")
  response.body
end

#termvector(params = {}) ⇒ Object Also known as: termvectors, term_vector, term_vectors

Returns information and statistics on terms in the fields of a particular document as stored in the index. The :id is provided as part of the params hash.

params - Parameters Hash

:id - the ID of the document to get

See www.elastic.co/guide/en/elasticsearch/reference/current/docs-termvectors.html

Returns the response body as a hash



343
344
345
346
347
348
349
350
 
# File 'lib/elastomer_client/client/docs.rb', line 343

def termvector(params = {})
  if client.version_support.es_version_8_plus?
    response = client.get "/{index}/_termvectors/{id}", update_params(params, {action: "docs.termvector", rest_api: "termvectors"}, true)
  else
    response = client.get "/{index}/{type}/{id}/_termvectors", update_params(params, action: "docs.termvector", rest_api: "termvectors")
  end
  response.body
end

#update(script, params = {}) ⇒ Object

Update a document based on a script provided.

script - The script (as a Hash) used to update the document in place params - Parameters Hash

See www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html

Returns the response body as a Hash



176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/elastomer_client/client/docs.rb', line 176

def update(script, params = {})
  overrides = from_document script
  overrides.merge!(action: "docs.update", rest_api: "update")

  if client.version_support.es_version_8_plus?
    response = client.post "/{index}/_update/{id}", update_params(params, overrides, true)
  else
    response = client.post "/{index}/{type}/{id}/_update", update_params(params, overrides)
  end
  response.body
end

#update_by_query(query, params = nil) ⇒ Object

Update documents by query using Elasticsearch’s _update_by_query API.

See Client#update_by_query for more information.

Returns a Hash of statistics about the update operations as returned by _update_by_query.



295
296
297
298
299
 
# File 'lib/elastomer_client/client/docs.rb', line 295

def update_by_query(query, params = nil)
  query, params = extract_params(query) if params.nil?

  @client.update_by_query(query, update_params(params))
end

#update_params(params, overrides = nil, delete_type = false) ⇒ Object

Internal: Add default parameters to the ‘params` Hash and then apply `overrides` to the params if any are given.

params - Parameters Hash overrides - Optional parameter overrides as a Hash

Returns a new params Hash.



602
603
604
605
606
607
608
609
 
# File 'lib/elastomer_client/client/docs.rb', line 602

def update_params(params, overrides = nil, delete_type = false)
  h = defaults.update params
  h.update overrides unless overrides.nil?
  h[:routing] = h[:routing].join(",") if h[:routing].is_a?(Array)
  h[:type] = "_doc" if client.version_support.es_version_8_plus? && !delete_type
  h.delete(:type) if delete_type
  h
end

#validate(query, params = nil) ⇒ Object

Validate a potentially expensive query before running it. The :explain parameter can be used to get detailed information about why a query failed.

query - The query body as a Hash params - Parameters Hash

Examples

# request body query
validate({query: {query_string: {query: "*:*"}}}, explain: true)

# same thing but using the URI query parameter
validate(q: "post_date:foo", explain: true)

See www.elastic.co/guide/en/elasticsearch/reference/current/search-validate.html

Returns the response body as a hash



419
420
421
422
423
424
 
# File 'lib/elastomer_client/client/docs.rb', line 419

def validate(query, params = nil)
  query, params = extract_params(query) if params.nil?

  response = client.get "/{index}{/type}/_validate/query", update_params(params, {body: query, action: "docs.validate", rest_api: "indices.validate_query"}, client.version_support.es_version_8_plus?)
  response.body
end