ductile.index — threatgrid/ductile 0.4.8

cat-indices clj

(cat-indices {:keys [uri request-fn] :as conn})

Inputs: [{:keys [uri request-fn], :as conn} :- ESConn] Returns: (s/maybe CatIndices)

perform a _cat/indices request

close! clj

(close! {:keys [uri request-fn] :as conn} index-name)

Inputs: [{:keys [uri request-fn], :as conn} :- ESConn index-name :- s/Str]

close an index

coerce clj

(coerce st)

create! clj

(create! {:keys [uri request-fn] :as conn} index-name settings)

Inputs: [{:keys [uri request-fn], :as conn} :- ESConn index-name :- s/Str settings :- s/Any]

create an index

create-data-stream! clj

(create-data-stream! {:keys [uri version request-fn] :as conn} data-stream-name)

Inputs: [{:keys [uri version request-fn], :as conn} :- ESConn data-stream-name :- s/Str]

create-index-template! clj

(create-index-template! {:keys [uri request-fn version] :as conn}
                        template-name
                        template)

Inputs: [{:keys [uri request-fn version], :as conn} :- ESConn template-name :- s/Str template]

create an index template, update if already exists

create-policy! clj

(create-policy! {:keys [uri version request-fn] :as conn} policy-name policy)

Inputs: [{:keys [uri version request-fn], :as conn} :- ESConn policy-name :- s/Str policy :- Policy]

create-template! clj

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

(create-template! {:keys [uri request-fn version] :as conn}
                  template-name
                  index-config
                  index-patterns)

Inputs: ([{:keys [uri request-fn version], :as conn} :- ESConn template-name :- s/Str index-config index-patterns :- [s/Str]] [conn :- ESConn template-name :- s/Str index-config])

create an index template, update if already exists

data-stream-uri clj

(data-stream-uri uri data-stream-name)

Inputs: [uri :- s/Str data-stream-name :- s/Str]

make a datastral uri from a host, and a data stream name

deep-merge clj

(deep-merge m1 m2)

delete! clj

(delete! {:keys [uri request-fn] :as conn} index-wildcard)

Inputs: [{:keys [uri request-fn], :as conn} :- ESConn index-wildcard :- s/Str]

delete indexes using a wildcard

delete-data-stream! clj

(delete-data-stream! {:keys [uri version request-fn] :as conn} data-stream-name)

Inputs: [{:keys [uri version request-fn], :as conn} :- ESConn data-stream-name :- s/Str]

delete-index-template! clj

(delete-index-template! {:keys [uri request-fn version] :as conn} index-name)

Inputs: [{:keys [uri request-fn version], :as conn} :- ESConn index-name :- s/Str]

delete a template

delete-policy! clj

(delete-policy! {:keys [uri version request-fn] :as conn} policy-name)

Inputs: [{:keys [uri version request-fn], :as conn} :- ESConn policy-name :- s/Str]

delete-template! clj

(delete-template! {:keys [uri request-fn] :as conn} index-name)

Inputs: [{:keys [uri request-fn], :as conn} :- ESConn index-name :- s/Str]

delete a template

get clj

(get {:keys [uri request-fn] :as conn} index-name)

Inputs: [{:keys [uri request-fn], :as conn} :- ESConn index-name :- s/Str]

get an index

get-data-stream clj

(get-data-stream {:keys [uri version request-fn] :as conn} data-stream-name)

Inputs: [{:keys [uri version request-fn], :as conn} :- ESConn data-stream-name :- s/Str]

get-index-template clj

(get-index-template {:keys [uri request-fn version] :as conn} index-name)

Inputs: [{:keys [uri request-fn version], :as conn} :- ESConn index-name :- s/Str]

get an index template

get-policy clj

(get-policy {:keys [uri version request-fn] :as conn} policy-name)

Inputs: [{:keys [uri version request-fn], :as conn} :- ESConn policy-name :- s/Str]

get-settings clj

(get-settings conn)

(get-settings {:keys [uri request-fn] :as conn} index)

Inputs: ([conn :- ESConn] [{:keys [uri request-fn], :as conn} :- ESConn index :- s/Str]) Returns: ESSettings

Extract settings of an index from ES cluster. If explicit index is not provided - uses "_all" as a target. Result is a hash map of index -> settings, including defaults.

get-template clj

(get-template {:keys [uri request-fn] :as conn} index-name)

Inputs: [{:keys [uri request-fn], :as conn} :- ESConn index-name :- s/Str]

get an index template

index-exists? clj

(index-exists? {:keys [uri request-fn] :as conn} index-name)

Inputs: [{:keys [uri request-fn], :as conn} :- ESConn index-name :- s/Str] Returns: s/Bool

check if the supplied ES index exists

index-template-uri clj

(index-template-uri uri template-name)

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

make an index template uri from a host and a template name

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

merge-defaults clj

(merge-defaults settings)

open! clj

(open! {:keys [uri request-fn] :as conn} index-name)

Inputs: [{:keys [uri request-fn], :as conn} :- ESConn index-name :- s/Str]

open an index

policy-uri clj

(policy-uri uri policy-name)

Inputs: [uri :- s/Str policy-name :- s/Str]

make a policy uri from a host, and a policy name

refresh! clj

(refresh! es-conn)

(refresh! {:keys [uri request-fn] :as conn} index-name)

Inputs: ([es-conn] [{:keys [uri request-fn], :as conn} :- 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 request-fn] :as conn}
           alias
           conditions
           {:keys [dry_run new-index-settings new-index-name]})

Inputs: ([es-conn alias conditions] [{:keys [uri request-fn], :as conn} :- ESConn alias :- s/Str conditions :- RolloverConditions {:keys [dry_run new-index-settings new-index-name]} :- (st/open-schema (st/optional-keys {:new-index-settings (s/pred map?), :new-index-name (s/maybe s/Str), :dry_run 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/maybe 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 request-fn] :as conn}
                  index-name
                  doc-type
                  mappings)

Inputs: ([{:keys [uri request-fn], :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 request-fn] :as conn} index-name settings)

Inputs: [{:keys [uri request-fn], :as conn} :- ESConn index-name :- s/Str settings :- s/Any]

update an ES index settings