【Elasticsearch 入門２】マッピングとテンプレートの設定/確認

本記事は Elasticsearch 入門記事の第２回「マッピング管理とテンプレート」です。

その他の Elasticsearch の使い方は以下の記事をご覧ください。

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

インプレス

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

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

ラムダノート

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

マッピングとは

マッピングとはマッピングとは、フィールドの格納方法を定義したものです。(データ型の一覧はこちら)

マッピングを作成、追加する方法は以下の４つです。

自動でマッピングを作成
手動でマッピングを作成
既存のマッピングにフィールドを追加
テンプレートでマッピングを作成

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

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

自動でマッピングを作成

Elasticsearch は、インデックスにドキュメントを作成する時、自動でマッピングを作成します。

PUT /mapping_test/_doc/1
{
  "date":"2020/11/01 09:00:00+0900"
}

GET /mapping_test

   "mappings" : {
      "properties" : {
        "date" : {
          "type" : "text",
          "fields" : {
            "keyword" : {
              "type" : "keyword",
              "ignore_above" : 256

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

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

text = 単語ごとに分けた転置インデックスを持つ全文検索用
keyword = 完全一致検索用

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

手動でマッピングを作成

手動でマッピングで、date キーを date 型にマッピングしてみます。

PUT /mapping_test2
{
  "mappings": {
    "properties": {
      "date":    {
        "type": "date",
        "format": "yyyy/MM/dd HH:mm:ssZ"
      }
    }
  }
}

GET /mapping_test2

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

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

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

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

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

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

PUT /mapping_test2/_doc/1
{
  "date":"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 /mapping_test2/_doc/2
{
  "date":"2020/11/01 09:00:00+0900"
}

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

既存のマッピングに追加

既存のマッピングに新しいフィールドを追加したい場合は、mapping API を利用します。

mapping_test2 インデックスのマッピングに additional_field フィールドを追加してみます。

GET /mapping_test2

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

PUT /mapping_test2/_mapping
{
  "properties":{
    ""additional_field":{
      ""type":"text"
    }
  }
}

GET /mapping_test2

    "mappings" : {
      "properties" : {
        "additional_field" : {
          "type" : "text"
        },
        "date" : {
          "type" : "date",
          "format" : "yyyy/MM/dd HH:mm:ssZ"

additional_field フィールドが追加されています。

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

インデックステンプレートインデックステンプレートとは、インデックスの設定 (マッピングなど) の雛形です。
これにより、今後作成する複数のインデックスでマッピングの設定を使いまわせます。

"test" から始まるインデックス名を対象としたテンプレートを作成します。

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

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

それでは、テンプレートの動作を確認してみます。

PUT /test1

GET /test1

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

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