Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/driebit/mod_elasticsearch
Zotonic Elasticsearch module
https://github.com/driebit/mod_elasticsearch
elasticsearch erlang zotonic
Last synced: 8 days ago
JSON representation
Zotonic Elasticsearch module
- Host: GitHub
- URL: https://github.com/driebit/mod_elasticsearch
- Owner: driebit
- License: mit
- Created: 2014-10-01T12:16:56.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-03-15T07:08:08.000Z (11 months ago)
- Last Synced: 2024-03-15T08:26:31.459Z (11 months ago)
- Topics: elasticsearch, erlang, zotonic
- Language: Erlang
- Size: 248 KB
- Stars: 1
- Watchers: 17
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: support/elasticsearch.erl
Awesome Lists containing this project
README
mod_elasticsearch
=================
[](https://travis-ci.com/driebit/mod_elasticsearch)
This [Zotonic](https://github.com/zotonic/zotonic) module gives you more relevant search results
by making resources searchable through
[Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html).
Note
----
This module uses Elastic Search 5.x, which has support for _Types_.
For Elastic 7+, use https://github.com/driebit/mod_elasticsearch2
Installation
------------
mod_elasticsearch acts as a bridge between Zotonic and the [tsloughter/erlastic_search](https://github.com/tsloughter/erlastic_search)
Erlang library, so install that and its dependencies first by adding them to `deps` in `zotonic.config`:
```erlang
{deps, [
%% ...
{erlastic_search, ".*", {git, "https://github.com/tsloughter/erlastic_search.git", {tag, "master"}}},
{hackney, ".*", {git, "https://github.com/benoitc/hackney.git", {tag, "1.6.1"}}},
{jsx, ".*", {git, "https://github.com/talentdeficit/jsx.git", {tag, "2.8.0"}}}
]}
```
Configuration
-------------
To configure the Elasticsearch host and port, edit your
[erlang.config](http://docs.zotonic.com/en/latest/ref/configuration/zotonic-configuration.html)
file:
```erlang
[
%% ...
{erlastic_search, [
{host, <<"elasticsearch">>}, %% Defaults to 127.0.0.1
{port, 9200} %% Defaults to 9200
]},
%% ...
].
```
Search queries
--------------
When mod_elasticsearch is enabled, it will direct all search operations of the
‘query’ type to Elasticsearch:
```erlang
z_search:search({query, Args}, Context).
```
For `Args`, you can pass all regular Zotonic [query arguments](http://docs.zotonic.com/en/latest/developer-guide/search.html#query-arguments),
such as:
```erlang
z_search:search({query, [{hasobject, 507}]}, Context).
````
### Query context filters
The `filter` search argument that you know from Zotonic will be used in
Elasticsearch’s [filter context](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html).
To add filters that influence score (ranking), use the `query_context_filter`
instead. The syntax is identical to that of `filter`:
```erlang
z_search:search({query, [{query_context_filter, [["some_field", "value"]]}]}, Context).
```
### Extra query arguments
This module adds some extra query arguments on top of Zotonic’s default ones.
To find documents that have a field, whatever its value (make sure to pass
`exists` as atom):
```erlang
{filter, [<<"some_field">>, exists]}
```
To find documents that do not have a field (make sure to pass `missing` as
atom):
```erlang
{filter, [<<"some_field">>, missing]}
````
For a [match phrase prefix query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase-prefix.html),
use the `prefix` argument:
```erlang
z_search:search({query, [{prefix, <<"Match this pref">>}]}, Context).
```
To exclude a document:
```erlang
{exclude_document, [Type, Id]}
```
To supply a custom [`function_score`](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html)
clause, supply one or more `score_function`s. For instance, to rank recent
articles above older ones:
```erlang
z_search:search(
{query, [
{text, "Search this"},
{score_function, #{
<<"filter">> => [{cat, "article"}],
<<"exp">> => #{
<<"publication_start">> => #{
<<"scale">> => <<"30d">>
}
}
}}
]},
Context
).
```
Notifications
-------------
### elasticsearch_fields
Observe this foldr notification to change the document fields that are queried.
You can use Elasticsearch [multi_match syntax](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html)
for boosting fields:
```erlang
%% your_site.erl
-export([
% ...
observe_elasticsearch_fields/3
]).
observe_elasticsearch_fields({elasticsearch_fields, QueryText}, Fields, Context) ->
%% QueryText is the search query text
%% Add or remove fields:
[<<"some_field">>, <<"boosted_field^2">>|Fields].
```
### elasticsearch_put
Observe this notification to change the resource properties before they are
stored in Elasticsearch. For instance, to store their zodiac sign alongside
person resources:
```erlang
%% your_site.erl
-include_lib("mod_elasticsearch/include/elasticsearch.hrl").
-export([
% ...
observe_elasticsearch_put/3
]).
-spec observe_elasticsearch_put(#elasticsearch_put{}, map(), z:context()) -> map().
observe_elasticsearch_put(#elasticsearch_put{id = Id}, Props, Context) ->
case m_rsc:is_a(Id, person, Context) of
true ->
Props#{zodiac => calculate_zodiac(Id, Context)};
false ->
Props
end.
```
Logging
-------
By default, mod_elasticsearch logs outgoing queries at the debug log level. To
see them in your Zotonic console, change the minimum log level to debug:
```erlang
lager:set_loglevel(lager_console_backend, debug).
```
How resources are indexed
-------------------------
Content in all languages is stored in the index, following the
[one language per field](https://www.elastic.co/guide/en/elasticsearch/guide/current/one-lang-fields.html)
strategy:
> Each translation is stored in a separate field, which is analyzed according to
> the language it contains. At query time, the user’s language is used to boost
> fields in that particular language.