Module: ROM::Elasticsearch::QueryMethods

Included in:

Dataset

Defined in:

lib/rom/elasticsearch/query_methods.rb

Overview

Dataset’s query methods

See Also:

• Dataset

Instance Method Summary

• #get(id) ⇒ Dataset

  Return a new dataset configured to search by :id.

• #query(query) ⇒ Dataset

  Return a new dataset configured to search via :query body option.

• #query_string(expression) ⇒ Dataset

  Return a new dataset configured to search via :query_string body option.

• #search(options) ⇒ Dataset

  Return a new dataset configured to search via new body options.

Instance Method Details

#get(id) ⇒ Dataset

Return a new dataset configured to search by :id

Parameters:

• id (Integer)

Returns:

• (Dataset)

See Also:

• Relation#get

# File 'lib/rom/elasticsearch/query_methods.rb', line 22

def get(id)
  params(id: id)
end

#query(query) ⇒ Dataset

Return a new dataset configured to search via :query body option

Parameters:

• query (Hash) —

  A query hash

Returns:

• (Dataset)

See Also:

• Relation#query

# File 'lib/rom/elasticsearch/query_methods.rb', line 61

def query(query)
  body(query: query)
end

#query_string(expression) ⇒ Dataset

Return a new dataset configured to search via :query_string body option

Parameters:

• expression (String) —

  A string query

Returns:

• (Dataset)

See Also:

• Relation#query_string

# File 'lib/rom/elasticsearch/query_methods.rb', line 48

def query_string(expression)
  query(query_string: {query: expression})
end

#search(options) ⇒ Dataset

Return a new dataset configured to search via new body options

Parameters:

• options (Hash) —

  Body options

Returns:

• (Dataset)

See Also:

• Relation#search

# File 'lib/rom/elasticsearch/query_methods.rb', line 35

def search(options)
  body(options)
end