【Elasticsearch】インデックス設定とマッピングの定義・確認

インデックス設定 (Index Settings)

インデックス設定では、シャードの数や圧縮タイプ、更新間隔など様々な設定できます。

インデックス設定には、次の 2 種類があります。

インデックス設定	説明
Static index settings	インデックス作成時 or Close しているインデックスに設定可能※
Dynamic index settings	作成済みのインデックスで設定可能

※ただし index.number_of_shards は close しても変更できない

Static index settings を設定

インデックス作成時に Static index settings (index.number_of_shards) を設定してみます。

PUT my-index-000001
{
  "settings": {
    "index.number_of_shards":2
  }
}

GET my-index-000001/_settings

{
  "my-index-000001": {
    "settings": {
      "index": {
        "number_of_shards": "2",

Dynamic index settings の変更

既存のインデックスの Dynamic index settings (index.number_of_replicas) を変更してみます

GET /my-index-000001/_settings

        (中略)
        "number_of_replicas" : "1",

PUT my-index-000001/_settings
{
  "index.number_of_replicas":3
}

GET /my-index-000001/_settings

        (中略)
        "number_of_replicas" : "3",

index.number_of_replicas が 3 に変更できています。

Elastic Stack実践ガイド[Elasticsearch/Kibana編] impress top gearシリーズ

インプレス

Amazonの商品レビュー・口コミを見る

検索システム実務者のための開発改善ガイドブック

ラムダノート

Amazonの商品レビュー・口コミを見る

マッピングとは

マッピングとはマッピングとは、インデックスに保存するフィールドのデータ型の定義です。(データ型一覧)

マッピングを定義する方法は次の 3 つです。

Dynamic mapping
Explicit mapping
Index templates

なお、一度作成したマッピングは変更 (更新) できません。(追加はできます)

マッピングを修正するには、インデックスを作成し直す必要があります。

Dynamic mapping

Dynamic mappingは、ドキュメントを追加する時に、自動でマッピングします。

PUT dynamic-mapping-test/_doc/1
{
  "field1":"2020/11/01 09:00:00+0900"
}

GET dynamic-mapping-test/_mapping

{
  "dynamic-mapping-test": {
    "mappings": {
      "properties": {
        "field1": {
          "type": "text",
          "fields": {
            "keyword": {
              "type": "keyword"

結果を見ると、次のマッピングが定義されていることがわかります。

フィールドのキー	マッピングしたデータ型
field1	text
field1.keyword	keyword

text = 全文検索用、keyword = 完全一致検索用

自分でデータ型を指定したい場合は、手動でマッピングを作成します。

Explicit-mapping

Explicit-mappingは、インデックス作成時に手動でマッピングを定義します。

Explicit-mapping でマッピングを定義

PUT explicit-mapping-test
{
  "mappings": {
    "properties": {
      "field1":    {
        "type": "date",
        "format": "yyyy/MM/dd HH:mm:ssZ"
      }
    }
  }
}

GET explicit-mapping-test/_mapping

{
  "explicit-mapping-test": {
    "mappings": {
      "properties": {
        "field1": {
          "type": "date",
          "format": "yyyy/MM/dd HH:mm:ssZ"

field1 キーが date 型でマッピングされていることがわかります。

マッピングで指定したフォーマットと異なるドキュメントを作成するとどうなる？

マッピングで指定したフォーマットと異なるドキュメントを作成するにエラーとなります。

試しに設定したフォーマットと異なるフォーマットでドキュメントを作成します。

設定したフォーマット = yyyy/MM/dd HH:mm:ssZ
検証するフォーマット = yyyy/MM/dd HH:mm:Z

PUT explicit-mapping-test/_doc/1
{
  "field1":"2020/11/01 09:00+0900"
}

      "reason" : "failed to parse date field [2020/11/01 09:00+0900] with format [yyyy/MM/dd HH:mm:ssZ]",

設定したフォーマットと異なるので、パースエラーが発生します。

次にマッピングで指定したフォーマットに従ってドキュメントを作成

PUT explicit-mapping-test/_doc/1
{
  "field1":"2020/11/01 09:00:00+0900"
}

ドキュメントの作成に成功しました。

既存のマッピングにフィールドを追加

PUT explicit-mapping-test/_mapping
{
  "properties":{
    "additional_field":{
      "type":"text"
    }
  }
}

GET explicit-mapping-test/_mapping

{
  "explicit-mapping-test": {
    "mappings": {
      "properties": {
        "additional_field": {
          "type": "text"
        },
        "field1": {
          "type": "date",
          "format": "yyyy/MM/dd HH:mm:ssZ"

text 型の additional_field フィールドが追加されました。

［増補改訂］ビッグデータを支える技術 ——ラップトップ1台で学ぶデータ基盤のしくみ WEB+DB PRESS plus

技術評論社

Amazonの商品レビュー・口コミを見る

Elastic Stack実践ガイド［Logstash/Beats編］ impress top gearシリーズ

インプレス

Amazonの商品レビュー・口コミを見る

インデックステンプレート

インデックステンプレートインデックステンプレートは、インデックス作成前に設定やマッピングを定義する方法です。

インデックステンプレートは、複数のインデックスに同じ設定やマッピングをする際に便利です。

インデックステンプレートを作成

PUT _index_template/test_template
{
  "index_patterns": "test*",
  "template":{
    "mappings": {
      "properties": {
        "field1":    {
          "type": "date",
          "format": "yyyy/MM/dd HH:mm:ssZ"
        }
      }
    } 
  }
}

インデックステンプレートにインデックス設定も含める場合

PUT _index_template/test_template
{
  "index_patterns": "test*",
  "template":{
    "settings": {
      "number_of_shards": 2,
      "number_of_replicas": 1
    },
    "mappings": {
      "properties": {
        "field1":    {
          "type": "date",
          "format": "yyyy/MM/dd HH:mm:ssZ"
        }
      }
    } 
  }
}

上記のテンプレートでは、"field1" キーを date 型にマッピングしています。

インデックステンプレートの動作確認

PUT test-template

GET test-template/_mapping

{
  "test-template": {
    "mappings" : {
      "properties" : {
        "date" : {
          "type" : "date",
          "format" : "yyyy/MM/dd HH:mm:ssZ"
        }
      }
    }

テンプレートと同じマッピングでインデックスが作成できました。