mirror of
https://github.com/philomena-dev/philomena.git
synced 2024-11-24 04:27:59 +01:00
13 lines
395 B
Elixir
13 lines
395 B
Elixir
|
defmodule Philomena.ElasticsearchIndex do
|
||
|
|
# Returns the index name for the index.
|
||
|
|
# This is usually a collection name like "images".
|
||
|
|
@callback index_name() :: String.t()
|
||
|
|
|
||
|
|
# Returns the mapping and settings for the index.
|
||
|
|
@callback mapping() :: map()
|
||
|
|
|
||
|
|
# Returns the JSON representation of the given struct
|
||
|
|
# for indexing in Elasticsearch.
|
||
|
|
@callback as_json(struct()) :: map()
|
||
|
|
end
|