Pack plasticsearch -- prolog/plasticsearch/plasticsearch.pl

This is basically a Prolog version of Elasticsearch Python APIs.

author: - Hongxin Liang
See also: - https://github.com/elastic/elasticsearch-py
license: - Apache License Version 2.0
To be done: - Sniffing is not supported.

plasticsearch(-Ps) is det

plasticsearch(-Ps, +Options) is det

plasticsearch(-Ps, +Hosts, +Options) is det

Create a new Plasticsearch instance.

Default options are:

dead_timeout(60)
retry_on_timeout(false)
max_retries(3)
timeout_cutoff(5)
random_selector(false)
retry_on_status([503, 504])

If no Hosts are given, http://localhost:9200 will be used by default. If only hostname is provided, port 9200 will be used and http will be assumed. Otherwise = uri_components(Scheme, Authority, Path, Search, Fragment) = can be used for fine-grained configuration.

destroy(+Ps) is det

Destory a Plasticsearch instance.

ping(+Ps) is semidet

ping(+Ps, +Params) is semidet

Returns True if the cluster is up, False otherwise.

info(+Ps, -Reply) is semidet

info(+Ps, +Params, -Reply) is semidet

Get the basic info from the current cluster.

create(+Ps, +Index, +DocType, +ID, +Body, -Reply) is semidet

create(+Ps, +Index, +DocType, +ID, +Params, +Body, -Reply) is semidet

Adds a typed document in a specific index, making it searchable. Behind the scenes this predicate calls index/7 with = op_type=create = as additional parameter. See here.

index(+Ps, +Index, +DocType, +ID, +Body, -Reply) is semidet

index(+Ps, +Index, +DocType, +ID, +Params, +Body, -Reply) is semidet

Adds or updates a typed document in a specific index, making it searchable. See here.

exists(+Ps, +Index, +DocType, +ID) is semidet

exists(+Ps, +Index, +DocType, +ID, +Params) is semidet

Returns a boolean indicating whether or not given document exists in Elasticsearch. See here.

get(+Ps, +Index, +DocType, +ID, -Reply) is semidet

get(+Ps, +Index, +DocType, +ID, +Params, -Reply) is semidet

Get a typed document from the index based on its id. See here.

get_source(+Ps, +Index, +DocType, +ID, -Reply) is semidet

get_source(+Ps, +Index, +DocType, +ID, +Params, -Reply) is semidet

Get the source of a document by it's index, type and id. See here.

mget(+Ps, +Index, +DocType, +Body, -Reply) is semidet

mget(+Ps, +Index, +DocType, +Params, +Body, -Reply) is semidet

Get multiple documents based on an index, type (optional) and ids. See here.

update(+Ps, +Index, +DocType, +ID, +Body, -Reply) is semidet

update(+Ps, +Index, +DocType, +ID, +Params, +Body, -Reply) is semidet

Update a document based on a script or partial data provided. See here.

search(+Ps, +Index, +DocType, +Body, -Reply) is semidet

search(+Ps, +Index, +DocType, +Params, +Body, -Reply) is semidet

Execute a search query and get back search hits that match the query. See here.

search_shards(+Ps, +Index, +DocType, -Reply) is semidet

search_shards(+Ps, +Index, +DocType, +Params, -Reply) is semidet

The search shards api returns the indices and shards that a search request would be executed against. This can give useful feedback for working out issues or planning optimizations with routing and shard preferences. See here.

search_template(+Ps, +Index, +DocType, +Body, -Reply) is semidet

search_template(+Ps, +Index, +DocType, +Params, +Body, -Reply) is semidet

A query that accepts a query template and a map of key/value pairs to fill in template parameters. See here.

explain(+Ps, +Index, +DocType, +ID, +Body, -Reply) is semidet

explain(+Ps, +Index, +DocType, +ID, +Params, +Body, -Reply) is semidet

The explain api computes a score explanation for a query and a specific document. This can give useful feedback whether a document matches or didn't match a specific query. See here.

scroll(+Ps, +ID, -Reply) is semidet

scroll(+Ps, +ID, +Params, -Reply) is semidet

Scroll a search request created by specifying the scroll parameter. See here.

clear_scroll(+Ps, +ID, +Body, -Reply) is semidet

clear_scroll(+Ps, +ID, +Params, +Body, -Reply) is semidet

Clear the scroll request created by specifying the scroll parameter to search. See here.

delete(+Ps, +Index, +DocType, +ID, -Reply) is semidet

delete(+Ps, +Index, +DocType, +ID, +Params, -Reply) is semidet

Delete a typed JSON document from a specific index based on its id. See here.

count(+Ps, +Index, +DocType, +Body, -Reply) is semidet

count(+Ps, +Index, +DocType, +Params, +Body, -Reply) is semidet

Execute a query and get the number of matches for that query. See here.

bulk(+Ps, +Index, +DocType, +Body, -Reply) is semidet

bulk(+Ps, +Index, +DocType, +Params, +Body, -Reply) is semidet

Perform many index/delete operations in a single API call. See here.

msearch(+Ps, +Index, +DocType, +Body, -Reply) is semidet

msearch(+Ps, +Index, +DocType, +Params, +Body, -Reply) is semidet

Execute several search requests within the same API. See here.

delete_by_query(+Ps, +Index, +DocType, +Body, -Reply) is semidet

delete_by_query(+Ps, +Index, +DocType, +Params, +Body, -Reply) is semidet

Delete documents from one or more indices and one or more types based on a query. See here.

suggest(+Ps, +Index, +Body, -Reply) is semidet

suggest(+Ps, +Index, +Params, +Body, -Reply) is semidet

The suggest feature suggests similar looking terms based on a provided text by using a suggester. See here.

percolate(+Ps, +Index, +DocType, +ID, +Body, -Reply) is semidet

percolate(+Ps, +Index, +DocType, +ID, +Params, +Body, -Reply) is semidet

The percolator allows to register queries against an index, and then send percolate requests which include a doc, and getting back the queries that match on that doc out of the set of registered queries. See here.

mpercolate(+Ps, +Index, +DocType, +Body, -Reply) is semidet

mpercolate(+Ps, +Index, +DocType, +Params, +Body, -Reply) is semidet

count_percolate(+Ps, +Index, +DocType, +ID, +Body, -Reply) is semidet

count_percolate(+Ps, +Index, +DocType, +ID, +Params, +Body, -Reply) is semidet

mlt(+Ps, +Index, +DocType, +ID, +Body, -Reply) is semidet

mlt(+Ps, +Index, +DocType, +ID, +Params, +Body, -Reply) is semidet

Get documents that are "like" a specified document. See here.

termvectors(+Ps, +Index, +DocType, +ID, +Body, -Reply) is semidet

termvectors(+Ps, +Index, +DocType, +ID, +Params, +Body, -Reply) is semidet

Returns information and statistics on terms in the fields of a particular document. The document could be stored in the index or artificially provided by the user (Added in 1.4). Note that for documents stored in the index, this is a near realtime API as the term vectors are not available until the next refresh. See here.

termvector(+Ps, +Index, +DocType, +ID, +Body, -Reply) is semidet

termvector(+Ps, +Index, +DocType, +ID, +Params, +Body, -Reply) is semidet

mtermvectors(+Ps, +Index, +DocType, +Body, -Reply) is semidet

mtermvectors(+Ps, +Index, +DocType, +Params, +Body, -Reply) is semidet