ductile.index — threatgrid/ductile 0.2.0

close! clj

(close! {:keys [uri cm]} index-name)

Inputs: [{:keys [uri cm]} :- ESConn index-name :- s/Str]

close an index

create! clj

(create! {:keys [uri cm]} index-name settings)

Inputs: [{:keys [uri cm]} :- ESConn index-name :- s/Str settings :- s/Any]

create an index

create-template! clj

(create-template! es-conn template-name index-config)

(create-template! {:keys [uri cm version]}
                  template-name
                  index-config
                  index-patterns)

Inputs: ([{:keys [uri cm version]} :- ESConn template-name :- s/Str index-config index-patterns :- [s/Str]] [es-conn :- ESConn template-name :- s/Str index-config])

create an index template, update if already exists

delete! clj

(delete! {:keys [uri cm]} index-wildcard)

Inputs: [{:keys [uri cm]} :- ESConn index-wildcard :- s/Str]

delete indexes using a wildcard

delete-template! clj

(delete-template! {:keys [uri cm]} index-name)

Inputs: [{:keys [uri cm]} :- ESConn index-name :- s/Str]

delete a template

get clj

(get {:keys [uri cm]} index-name)

Inputs: [{:keys [uri cm]} :- ESConn index-name :- s/Str]

get an index

get-template clj

(get-template {:keys [uri cm]} index-name)

Inputs: [{:keys [uri cm]} :- ESConn index-name :- s/Str]

get an index template

index-exists? clj

(index-exists? {:keys [uri cm]} index-name)

Inputs: [{:keys [uri cm]} :- ESConn index-name :- s/Str] Returns: s/Bool

check if the supplied ES index exists

index-uri clj

(index-uri uri index-name)

Inputs: [uri :- s/Str index-name :- s/Str] Returns: s/Str

make an index uri from a host and an index name

open! clj

(open! {:keys [uri cm]} index-name)

Inputs: [{:keys [uri cm]} :- ESConn index-name :- s/Str]

open an index

refresh! clj

(refresh! es-conn)

(refresh! {:keys [uri cm]} index-name)

Inputs: ([es-conn] [{:keys [uri cm]} :- ESConn index-name :- (s/maybe s/Str)])

refresh an index

refresh-uri clj

(refresh-uri uri index-name)

Inputs: [uri :- s/Str index-name :- (s/maybe s/Str)] Returns: s/Str

make a refresh uri from a host, and optionally an index name

rollover! clj

(rollover! es-conn alias conditions)

(rollover! {:keys [uri cm]}
           alias
           conditions
           new-index-settings
           new-index-name
           dry_run)

Inputs: ([es-conn alias conditions] [{:keys [uri cm]} :- ESConn alias :- s/Str conditions :- RolloverConditions new-index-settings :- #:s{Any s/Any} new-index-name :- (s/maybe s/Str) dry_run :- (s/maybe s/Bool)])

run a rollover query on an alias with given conditions

rollover-uri clj

(rollover-uri uri alias)

(rollover-uri uri alias new-index-name dry_run)

Inputs: ([uri alias] [uri :- s/Str alias :- s/Str new-index-name :- (s/maybe s/Str) dry_run :- s/Bool]) Returns: s/Str

make a rollover uri from a host and an index name

template-uri clj

(template-uri uri template-name)

Inputs: [uri :- s/Str template-name :- s/Str] Returns: s/Str

make a template uri from a host and a template name

update-mappings! clj

(update-mappings! conn index-name mappings)

(update-mappings! {:keys [uri cm] :as conn} index-name doc-type mappings)

Inputs: ([{:keys [uri cm], :as conn} :- ESConn index-name :- s/Str doc-type :- (s/maybe s/Str) mappings :- (s/pred map?)] [conn :- ESConn index-name :- s/Str mappings :- (s/pred map?)])

Update an ES index mapping. takes a mappings map from field names to mapping types.

update-settings! clj

(update-settings! {:keys [uri cm]} index-name settings)

Inputs: [{:keys [uri cm]} :- ESConn index-name :- s/Str settings :- s/Any]

update an ES index settings