Define schema for elasticsaerch using Keyword lists and DSL.

DSL Example

defmodule MyApp.Blog do
  use ESx.Schema

  index_name    "blog"  # Optional
  document_type "blog"  # Optional

  mapping _all: [enabled: false], _ttl: [enabled: true, default: "180d"] do
    indexes :title, type: "string"
    indexes :content, type: "string"
    indexes :publish, type: "boolean"
  end

  settings number_of_shards: 10, number_of_replicas: 2 do
    analysis do
      filter :ja_posfilter,
        type: "kuromoji_neologd_part_of_speech",
        stoptags: ["助詞-格助詞-一般", "助詞-終助詞"]
      tokenizer :ja_tokenizer,
        type: "kuromoji_neologd_tokenizer"
      analyzer :default,
        type: "custom", tokenizer: "ja_tokenizer",
        filter: ["kuromoji_neologd_baseform", "ja_posfilter", "cjk_width"]
    end
  end

end

Keyword lists Example

defmodule Something.Schema do
  use ESx.Schema

  mapping [
    _ttl: [
      enabled: true,
      default: "180d"
    ],
    _all: [
      enabled: false
    ],
    properties: [
      title: [
        type: "string",
        analyzer: "ja_analyzer"
      ],
      publish: [
        type: "boolean"
      ],
      content: [
        type: "string",
        analyzer: "ja_analyzer"
      ]
    ]
  ]

  settings [
    number_of_shards:   1,
    number_of_replicas: 0,
    analysis: [
      analyzer: [
        ja_analyzer: [
          type:      "custom",
          tokenizer: "kuromoji_neologd_tokenizer",
          filter:    ["kuromoji_neologd_baseform", "cjk_width"],
        ]
      ]
    ]
  ]
end

Analysis

ESx.Schema.Analysis

Mapping

ESx.Schema.Mapping

Naming

ESx.Schema.Naming

Reflection

Any schema module will generate the __es_mapping__, __es_analysis__, __es_naming__ function that can be used for runtime introspection of the schema:

• __es_analysis__(:settings) - Returns the analysis settings

• __es_analysis__(:to_map) - Returns the analysis settings as map

• __es_analysis__(:as_json) - Returns the analysis settings as map that is the same as :to_map

• __es_analysis__(:types) - Returns the fields types, this is part of analysis settings

• __es_analysis__(:type, field) - Returns one of the type

• __es_mapping__(:settings) - Returns the properties mapping

• __es_mapping__(:to_map) - Returns the properties mapping as map

• __es_mapping__(:as_json) - Returns the properties mapping as map that is the same as :to_map

• __es_mapping__(:types) - Returns the fields types, this is part of properties mapping

• __es_mapping__(:type, field) - Returns one of the type

• __es_naming__(:index_name) - Returns a document index’s name

• __es_naming__(:document_type) - Returns a document type’s name