Class: SearchFlip::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/search_flip/connection.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Connection

Creates a new connection.

Examples:

SearchFlip::Connection.new(base_url: "http://elasticsearch.host:9200")

Parameters:

  • options (Hash) (defaults to: {}) —

    A hash containing the config options

Options Hash (options):

  • base_url (String) —

    The base url for the connection

  • http_client (SearchFlip::HTTPClient) —

    An optional http client instance

  • bulk_max_mb (Fixnum) —

    An optional MB limit for bulk requests



15
16
17
18
19
20
 
# File 'lib/search_flip/connection.rb', line 15

def initialize(options = {})
  @base_url = options[:base_url] || SearchFlip::Config[:base_url]
  @http_client = options[:http_client] || SearchFlip::HTTPClient.new
  @bulk_limit = options[:bulk_limit] || SearchFlip::Config[:bulk_limit]
  @version_mutex = Mutex.new
end

Instance Attribute Details

#base_url ⇒ Object (readonly)

Returns the value of attribute base_url.



3
4
5
 
# File 'lib/search_flip/connection.rb', line 3

def base_url
  @base_url
end

#bulk_limit ⇒ Object (readonly)

Returns the value of attribute bulk_limit.



3
4
5
 
# File 'lib/search_flip/connection.rb', line 3

def bulk_limit
  @bulk_limit
end

#bulk_max_mb ⇒ Object (readonly)

Returns the value of attribute bulk_max_mb.



3
4
5
 
# File 'lib/search_flip/connection.rb', line 3

def bulk_max_mb
  @bulk_max_mb
end

#http_client ⇒ Object (readonly)

Returns the value of attribute http_client.



3
4
5
 
# File 'lib/search_flip/connection.rb', line 3

def http_client
  @http_client
end

Instance Method Details

#alias_exists?(alias_name) ⇒ Boolean

Returns whether or not the associated Elasticsearch alias already exists.

Examples:

connection.alias_exists?("some_alias")

Returns:

  • (Boolean) —

    Whether or not the alias exists



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/search_flip/connection.rb', line 141

def alias_exists?(alias_name)
  http_client
    .headers(accept: "application/json", content_type: "application/json")
    .get("#{base_url}/_alias/#{alias_name}")

  true
rescue SearchFlip::ResponseError => e
  return false if e.code == 404

  raise e
end

#analyze(request, params = {}) ⇒ Hash

Sends an analyze request to Elasticsearch. Raises SearchFlip::ResponseError in case any errors occur.

Examples:

connection.analyze(analyzer: "standard", text: "this is a test")

Returns:

  • (Hash) —

    The raw response



107
108
109
110
111
112
 
# File 'lib/search_flip/connection.rb', line 107

def analyze(request, params = {})
  http_client
    .headers(accept: "application/json")
    .post("#{base_url}/_analyze", json: request, params: params)
    .parse
end

#close_index(index_name) ⇒ Boolean

Closes the specified index within Elasticsearch. Raises SearchFlip::ResponseError in case any errors occur

Parameters:

  • index_name (String) —

    The index name

Returns:

  • (Boolean) —

    Returns true or raises SearchFlip::ResponseError



193
194
195
196
197
 
# File 'lib/search_flip/connection.rb', line 193

def close_index(index_name)
  http_client.post("#{index_url(index_name)}/_close")

  true
end

#cluster_health ⇒ Hash

Queries and returns the Elasticsearch cluster health.

Examples:

connection.cluster_health # => { "status" => "green", ... }

Returns:

  • (Hash) —

    The raw response



42
43
44
 
# File 'lib/search_flip/connection.rb', line 42

def cluster_health
  http_client.headers(accept: "application/json").get("#{base_url}/_cluster/health").parse
end

#create_index(index_name, index_settings = {}, params = {}) ⇒ Boolean

Creates the specified index within Elasticsearch and applies index settings, if specified. Raises SearchFlip::ResponseError in case any errors occur.

Parameters:

  • index_name (String) —

    The index name

  • index_settings (Hash) (defaults to: {}) —

    The index settings

  • params (Hash) (defaults to: {}) —

    Optional url params

Returns:

  • (Boolean) —

    Returns true or raises SearchFlip::ResponseError



180
181
182
183
184
 
# File 'lib/search_flip/connection.rb', line 180

def create_index(index_name, index_settings = {}, params = {})
  http_client.put(index_url(index_name), params: params, json: index_settings)

  true
end

#delete_index(index_name) ⇒ Boolean

Deletes the specified index from Elasticsearch. Raises SearchFlip::ResponseError in case any errors occur.

Parameters:

  • index_name (String) —

    The index name

Returns:

  • (Boolean) —

    Returns true or raises SearchFlip::ResponseError



323
324
325
326
327
 
# File 'lib/search_flip/connection.rb', line 323

def delete_index(index_name)
  http_client.delete index_url(index_name)

  true
end

#freeze_index(index_name) ⇒ Boolean

Freezes the specified index within Elasticsearch. Raises SearchFlip::ResponseError in case any errors occur

Parameters:

  • index_name (String) —

    The index name

Returns:

  • (Boolean) —

    Returns true or raises SearchFlip::ResponseError



219
220
221
222
223
 
# File 'lib/search_flip/connection.rb', line 219

def freeze_index(index_name)
  http_client.post("#{index_url(index_name)}/_freeze")

  true
end

#get_aliases(index_name: "*", alias_name: "*") ⇒ Hash

Fetches information about the specified index aliases. Raises SearchFlip::ResponseError in case any errors occur.

Examples:

connection.get_aliases(alias_name: "some_alias")
connection.get_aliases(index_name: "index1,index2")

Parameters:

  • alias_name (String) (defaults to: "*") —

    The alias or comma separated list of alias names

  • index_name (String) (defaults to: "*") —

    The index or comma separated list of index names

Returns:

  • (Hash) —

    The raw response



126
127
128
129
130
131
 
# File 'lib/search_flip/connection.rb', line 126

def get_aliases(index_name: "*", alias_name: "*")
  http_client
    .headers(accept: "application/json", content_type: "application/json")
    .get("#{base_url}/#{index_name}/_alias/#{alias_name}")
    .parse
end

#get_index_settings(index_name) ⇒ Hash

Fetches the index settings for the specified index from Elasticsearch. Sends a GET request to index_url/_settings. Raises SearchFlip::ResponseError in case any errors occur.

Parameters:

  • index_name (String) —

    The index name

Returns:

  • (Hash) —

    The index settings



261
262
263
264
265
266
 
# File 'lib/search_flip/connection.rb', line 261

def get_index_settings(index_name)
  http_client
    .headers(accept: "application/json")
    .get("#{index_url(index_name)}/_settings")
    .parse
end

#get_indices(name = "*", params: {}) ⇒ Array Also known as: cat_indices

Fetches information about the specified indices. Raises SearchFlip::ResponseError in case any errors occur.

Examples:

connection.get_indices('prefix*')

Returns:

  • (Array) —

    The raw response



161
162
163
164
165
166
 
# File 'lib/search_flip/connection.rb', line 161

def get_indices(name = "*", params: {})
  http_client
    .headers(accept: "application/json", content_type: "application/json")
    .get("#{base_url}/_cat/indices/#{name}", params: params)
    .parse
end

#get_mapping(index_name, type_name: nil) ⇒ Hash

Retrieves the mapping for the specified index and type from Elasticsearch. Raises SearchFlip::ResponseError in case any errors occur.

Parameters:

  • index_name (String) —

    The index name

  • type_name (String) (defaults to: nil) —

    The type name. Starting with Elasticsearch 7, the type name is optional.

Returns:

  • (Hash) —

    The current type mapping



309
310
311
312
313
314
 
# File 'lib/search_flip/connection.rb', line 309

def get_mapping(index_name, type_name: nil)
  url = type_name ? type_url(index_name, type_name) : index_url(index_name)
  params = type_name && version.to_f >= 6.7 ? { include_type_name: true } : {}

  http_client.headers(accept: "application/json").get("#{url}/_mapping", params: params).parse
end

#index_exists?(index_name) ⇒ Boolean

Returns whether or not the specified index already exists.

Parameters:

  • index_name (String) —

    The index name

Returns:

  • (Boolean) —

    Whether or not the index exists



335
336
337
338
339
340
341
342
343
 
# File 'lib/search_flip/connection.rb', line 335

def index_exists?(index_name)
  http_client.headers(accept: "application/json").head(index_url(index_name))

  true
rescue SearchFlip::ResponseError => e
  return false if e.code == 404

  raise e
end

#index_url(index_name) ⇒ String

Returns the Elasticsearch index URL for the specified index name, ie base URL and index name with prefix.

Parameters:

  • index_name (String) —

    The index name

Returns:

  • (String) —

    The Elasticsearch index URL



364
365
366
 
# File 'lib/search_flip/connection.rb', line 364

def index_url(index_name)
  "#{base_url}/#{index_name}"
end

#msearch(criterias) ⇒ Array<SearchFlip::Response>

Uses the Elasticsearch Multi Search API to execute multiple search requests within a single request. Raises SearchFlip::ResponseError in case any errors occur.

Examples:

connection.msearch [ProductIndex.match_all, CommentIndex.match_all]

Parameters:

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/search_flip/connection.rb', line 58

def msearch(criterias)
  payload = criterias.flat_map do |criteria|
    [
      SearchFlip::JSON.generate(index: criteria.target.index_name_with_prefix, type: criteria.target.type_name),
      SearchFlip::JSON.generate(criteria.request)
    ]
  end

  payload = payload.join("\n")
  payload << "\n"

  raw_response =
    http_client
      .headers(accept: "application/json", content_type: "application/x-ndjson")
      .post("#{base_url}/_msearch", body: payload)

  raw_response.parse["responses"].map.with_index do |response, index|
    SearchFlip::Response.new(criterias[index], response)
  end
end

#open_index(index_name) ⇒ Boolean

Opens the specified index within Elasticsearch. Raises SearchFlip::ResponseError in case any errors occur

Parameters:

  • index_name (String) —

    The index name

Returns:

  • (Boolean) —

    Returns true or raises SearchFlip::ResponseError



206
207
208
209
210
 
# File 'lib/search_flip/connection.rb', line 206

def open_index(index_name)
  http_client.post("#{index_url(index_name)}/_open")

  true
end

#refresh(index_names = nil) ⇒ Boolean

Sends a refresh request to Elasticsearch. Raises SearchFlip::ResponseError in case any errors occur.

Parameters:

  • index_names (String, Array) (defaults to: nil) —

    The optional index names to refresh

Returns:

  • (Boolean) —

    Returns true or raises SearchFlip::ResponseError



274
275
276
277
278
 
# File 'lib/search_flip/connection.rb', line 274

def refresh(index_names = nil)
  http_client.post("#{index_names ? index_url(Array(index_names).join(",")) : base_url}/_refresh", json: {})

  true
end

#type_url(index_name, type_name) ⇒ String

Returns the full Elasticsearch type URL, ie base URL, index name with prefix and type name.

Parameters:

  • index_name (String) —

    The index name

  • type_name (String) —

    The type name

Returns:

  • (String) —

    The Elasticsearch type URL



353
354
355
 
# File 'lib/search_flip/connection.rb', line 353

def type_url(index_name, type_name)
  "#{index_url(index_name)}/#{type_name}"
end

#unfreeze_index(index_name) ⇒ Boolean

Unfreezes the specified index within Elasticsearch. Raises SearchFlip::ResponseError in case any errors occur

Parameters:

  • index_name (String) —

    The index name

Returns:

  • (Boolean) —

    Returns true or raises SearchFlip::ResponseError



232
233
234
235
236
 
# File 'lib/search_flip/connection.rb', line 232

def unfreeze_index(index_name)
  http_client.post("#{index_url(index_name)}/_unfreeze")

  true
end

#update_aliases(payload) ⇒ Hash

Used to manipulate, ie add and remove index aliases. Raises an SearchFlip::ResponseError in case any errors occur.

Examples:

connection.update_aliases(actions: [
  { remove: { index: "test1", alias: "alias1" }},
  { add: { index: "test2", alias: "alias1" }}
])

Parameters:

  • payload (Hash) —

    The raw request payload

Returns:

  • (Hash) —

    The raw response



92
93
94
95
96
97
 
# File 'lib/search_flip/connection.rb', line 92

def update_aliases(payload)
  http_client
    .headers(accept: "application/json", content_type: "application/json")
    .post("#{base_url}/_aliases", body: SearchFlip::JSON.generate(payload))
    .parse
end

#update_index_settings(index_name, index_settings) ⇒ Boolean

Updates the index settings within Elasticsearch according to the index settings specified. Raises SearchFlip::ResponseError in case any errors occur.

Parameters:

  • index_name (String) —

    The index name to update the settings for

  • index_settings (Hash) —

    The index settings

Returns:

  • (Boolean) —

    Returns true or raises SearchFlip::ResponseError



247
248
249
250
251
 
# File 'lib/search_flip/connection.rb', line 247

def update_index_settings(index_name, index_settings)
  http_client.put("#{index_url(index_name)}/_settings", json: index_settings)

  true
end

#update_mapping(index_name, mapping, type_name: nil) ⇒ Boolean

Updates the type mapping for the specified index and type within Elasticsearch according to the specified mapping. Raises SearchFlip::ResponseError in case any errors occur.

Parameters:

  • index_name (String) —

    The index name

  • mapping (Hash) —

    The mapping

  • type_name (String) (defaults to: nil) —

    The type name. Starting with Elasticsearch 7, the type name is optional.

Returns:

  • (Boolean) —

    Returns true or raises SearchFlip::ResponseError



291
292
293
294
295
296
297
298
 
# File 'lib/search_flip/connection.rb', line 291

def update_mapping(index_name, mapping, type_name: nil)
  url = type_name ? type_url(index_name, type_name) : index_url(index_name)
  params = type_name && version.to_f >= 6.7 ? { include_type_name: true } : {}

  http_client.put("#{url}/_mapping", params: params, json: mapping)

  true
end

#version ⇒ String

Queries and returns the Elasticsearch version used.

Examples:

connection.version # => e.g. 2.4.1

Returns:

  • (String) —

    The Elasticsearch version



29
30
31
32
33
 
# File 'lib/search_flip/connection.rb', line 29

def version
  @version_mutex.synchronize do
    @version ||= http_client.headers(accept: "application/json").get("#{base_url}/").parse["version"]["number"]
  end
end