clojurewerkz.elastisch.rest.index — org.clojars.sergeyminaev/elastisch 6.0.1

clear-cache clj

(clear-cache conn)

(clear-cache conn index-name)

(clear-cache conn index-name opts)

Clears index caches.

• 0-arity clears caches for all indexes and may be a very expensive operation. Use it carefully.
• 1-arity clears caches for a single index.

Accepted options:

• :filter: should filter caches be cleared?
• :field_data: should field data caches be cleared?
• :bloom: should Bloom filter caches be cleared?

close clj

(close conn index-name)

Closes an index.

create clj

(create conn index-name)

(create conn index-name opts)

Creates an index.

Accepted options are :mappings and :settings. Both accept maps with the same structure as in the REST API.

Examples:

(require '[clojurewerkz.elastisch.rest.index :as idx])

(idx/create conn "myapp_development")
(idx/create conn "myapp_development" {:settings {"number_of_shards" 1}})

(let [mapping-types {:person {:properties {:username   {:type "string" :store "yes"}
                                           :first-name {:type "string" :store "yes"}
                                           :last-name  {:type "string"}
                                           :age        {:type "integer"}
                                           :title      {:type "string" :analyzer "snowball"}
                                           :planet     {:type "string"}
                                           :biography  {:type "string" :analyzer "snowball" :term_vector "with_positions_offsets"}}}}]
  (idx/create conn "myapp_development" {:mappings mapping-types}))

create-template clj

(create-template conn template-name)

(create-template conn template-name opts)

Creates or updates a new index template.

Accepted options:

• :template: a pattern of index name that this template will be applied to
• :settings: the same as for create
• :mappings: the same as for create
• :aliases: template aliases configuration

delete clj

(delete conn)

(delete conn index-name)

Deletes an existing index.

delete-template clj

(delete-template conn template-name)

exists? clj

(exists? conn index-name)

Used to check if the index (indices) exists or not.

flush clj

(flush conn)

(flush conn index-name)

(flush conn index-name opts)

Flushes an index.

This causes the index by flushing data to the index storage and clearing the internal transaction log. Typically it is sufficient to let Elasticsearch when to periodically flush indexes.

• 0-arity flushes all indexes and may be a very expensive operation. Use it carefully.
• 1-arity flushes a single index.

Accepted options:

• :refresh: should a refresh be performed after the flush?

get-aliases clj

(get-aliases conn index-name)

Fetches and returns aliases for an index or multiple indexes.

get-mapping clj

(get-mapping conn index-name)

(get-mapping conn index-name type-name)

The get mapping API allows to retrieve mapping definition of index or index/type.

get-settings clj

(get-settings conn)

(get-settings conn index-name)

The get settings API allows to retrieve settings of an index or multiple indices.

get-template clj

(get-template conn template-name)

open clj

(open conn index-name)

Opens an index.

optimize clj

(optimize conn)

(optimize conn index-name)

(optimize conn index-name opts)

Optimizes an index.

Optimization makes searches over the index faster and also reclaims some disk space used by deleted documents. Optionally you can optimize and refresh an index in a single request.

• 0-arity optimizes all indexes and may be a very expensive operation. Use it carefully.
• 1-arity optimizes a single index.

Accepted options:

• :max_num_segments: the number of segments to optimize to.
• :only_expunge_deletes: should the optimize process only expunge segments with deleted documents in it?
• :refresh: when set to true, refreshes the index
• :flush: when set to true, flushes the index
• :wait_for_merge: should the request wait for the merge to end?

recovery clj

(recovery conn index-name)

TODO refine description AND resolve the above issue

refresh clj

(refresh conn)

(refresh conn index-name)

Refreshes an index manually.

Refreshing an index makes all changes (added, modified and deleted documents) since the last refresh available for search. In other words, index changes become "visible" to clients. Elasticsearch periodically refreshes indexes, the period is configurable via index settings.

• 0-arity updates all indexes and may be a very expensive operation. Use it carefully.
• 1-arity refreshes a single index.

segments clj

(segments conn)

(segments conn index-name)

Returns segments information for an index or multiple indexes.

snapshot clj

(snapshot conn index-name)

Takes a snapshot of an index or multiple indexes.

stats clj

(stats conn index-name)

(stats conn index-name opts)

Returns statistics about an index or multiple indexes

Accepted options define what exactly will be contained in the response:

• :stats: the specific stat(s) to return (defaults to all)
• :types: combined with index stats to provide document type level stats
• :groups: search statistics can be associated with one or more groups
• :fields: fields to be included in the statistics by default where applicable
• :completion_fields: fields to be included in the completion suggest statistics
• :fielddata_fields: fields to be included in the fielddata statistics

API Reference: https://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-stats.html

type-exists? clj

(type-exists? conn index-name type-name)

Used to check if a type/types exists in an index/indices.

update-aliases clj

(update-aliases conn & actions)

Performs a batch of alias operations. Takes a collection of actions in the form of

{ :add    { :index "test1" :alias "alias1" } }
{ :remove { :index "test1" :alias "alias1" } }

update-mapping clj

(update-mapping conn index-name-or-names type-name opts)

The put mapping API allows to register or modify specific mapping definition for a specific type.

update-settings clj

(update-settings conn settings)

(update-settings conn index-name settings)

Change specific index level settings in real time.