メタデータフィールド - _doc_countフィールド（_doc_count field）

_doc_count フィールド
例

_doc_count フィールド

バケット集約は常に doc_count というフィールドを返し、各バケットで集約され、分割されたドキュメントの数を示します。 doc_count の値の計算は非常に簡単です。各バケットで収集されたドキュメントごとに doc_count が 1 増加します。

この単純なアプローチは、個々のドキュメントに対する集約を計算する際には効果的ですが、事前に集約されたデータ（histogram や aggregate_metric_double フィールドなど）を格納するドキュメントを正確に表現することには失敗します。なぜなら、1 つの要約フィールドが複数のドキュメントを表す可能性があるからです。

事前に集約されたデータを扱う際にドキュメントの数を正しく計算できるように、_doc_count というメタデータフィールドタイプを導入しました。 _doc_count は常に、単一の要約フィールドに集約されたドキュメントの数を表す正の整数でなければなりません。

フィールド _doc_count がドキュメントに追加されると、すべてのバケット集約はその値を尊重し、バケット doc_count をフィールドの値だけ増加させます。ドキュメントに _doc_count フィールドが含まれていない場合、_doc_count = 1 はデフォルトで暗黙的に設定されます。

_doc_count フィールドは、ドキュメントごとに単一の正の整数のみを格納できます。ネストされた配列は許可されていません。
ドキュメントに _doc_count フィールドが含まれていない場合、集約器は 1 増加します。これはデフォルトの動作です。

例

次の create index API リクエストは、次のフィールドマッピングを持つ新しいインデックスを作成します:

my_histogram、パーセンタイルデータを格納するために使用される histogram フィールド
my_text、ヒストグラムのタイトルを格納するために使用される keyword フィールド

Python

resp = client.indices.create(
   index="my_index",
   mappings={
   "properties": {
   "my_histogram": {
   "type": "histogram"
   },
   "my_text": {
   "type": "keyword"
   }
   }
   },
)
print(resp)

Ruby

response = client.indices.create(
  index: 'my_index',
  body: {
   mappings: {
   properties: {
   my_histogram: {
   type: 'histogram'
   },
   my_text: {
   type: 'keyword'
   }
   }
   }
  }
)
puts response

Js

const response = await client.indices.create({
  index: "my_index",
  mappings: {
   properties: {
   my_histogram: {
   type: "histogram",
   },
   my_text: {
   type: "keyword",
   },
   },
  },
});
console.log(response);

コンソール

PUT my_index
{
  "mappings" : {
   "properties" : {
   "my_histogram" : {
   "type" : "histogram"
   },
   "my_text" : {
   "type" : "keyword"
   }
   }
  }
}

次の index API リクエストは、2 つのヒストグラムのために事前に集約されたデータを格納します: histogram_1 と histogram_2。

Python

resp = client.index(
   index="my_index",
   id="1",
   document={
   "my_text": "histogram_1",
   "my_histogram": {
   "values": [
                0.1,
                0.2,
                0.3,
                0.4,
                0.5
   ],
   "counts": [
   3,
   7,
   23,
   12,
   6
   ]
   },
   "_doc_count": 45
   },
)
print(resp)
resp1 = client.index(
   index="my_index",
   id="2",
   document={
   "my_text": "histogram_2",
   "my_histogram": {
   "values": [
                0.1,
                0.25,
                0.35,
                0.4,
                0.45,
                0.5
   ],
   "counts": [
   8,
   17,
   8,
   7,
   6,
   2
   ]
   },
   "_doc_count": 62
   },
)
print(resp1)

Ruby

response = client.index(
  index: 'my_index',
  id: 1,
  body: {
   my_text: 'histogram_1',
   my_histogram: {
   values: [
        0.1,
        0.2,
        0.3,
        0.4,
        0.5
   ],
   counts: [
   3,
   7,
   23,
   12,
   6
   ]
   },
   _doc_count: 45
  }
)
puts response
response = client.index(
  index: 'my_index',
  id: 2,
  body: {
   my_text: 'histogram_2',
   my_histogram: {
   values: [
        0.1,
        0.25,
        0.35,
        0.4,
        0.45,
        0.5
   ],
   counts: [
   8,
   17,
   8,
   7,
   6,
   2
   ]
   },
   _doc_count: 62
  }
)
puts response

Js

const response = await client.index({
  index: "my_index",
  id: 1,
  document: {
   my_text: "histogram_1",
   my_histogram: {
   values: [0.1, 0.2, 0.3, 0.4, 0.5],
   counts: [3, 7, 23, 12, 6],
   },
   _doc_count: 45,
  },
});
console.log(response);
const response1 = await client.index({
  index: "my_index",
  id: 2,
  document: {
   my_text: "histogram_2",
   my_histogram: {
   values: [0.1, 0.25, 0.35, 0.4, 0.45, 0.5],
   counts: [8, 17, 8, 7, 6, 2],
   },
   _doc_count: 62,
  },
});
console.log(response1);

コンソール

PUT my_index/_doc/1
{
  "my_text" : "histogram_1",
  "my_histogram" : {
   "values" : [0.1, 0.2, 0.3, 0.4, 0.5],
   "counts" : [3, 7, 23, 12, 6]
   },
  "_doc_count": 45
}
PUT my_index/_doc/2
{
  "my_text" : "histogram_2",
  "my_histogram" : {
   "values" : [0.1, 0.25, 0.35, 0.4, 0.45, 0.5],
   "counts" : [8, 17, 8, 7, 6, 2]
   },
  "_doc_count": 62
}


	フィールド `_doc_count` は、各ヒストグラムを生成するために集約されたドキュメントの数を格納する正の整数でなければなりません。

次の terms aggregation を my_index に対して実行すると:

Python

resp = client.search(
   aggs={
   "histogram_titles": {
   "terms": {
   "field": "my_text"
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  body: {
   aggregations: {
   histogram_titles: {
   terms: {
   field: 'my_text'
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  aggs: {
   histogram_titles: {
   terms: {
   field: "my_text",
   },
   },
  },
});
console.log(response);

コンソール

GET /_search
{
   "aggs" : {
   "histogram_titles" : {
   "terms" : { "field" : "my_text" }
   }
   }
}

次の応答が得られます:

コンソール-結果

{
   ...
   "aggregations" : {
   "histogram_titles" : {
   "doc_count_error_upper_bound": 0,
   "sum_other_doc_count": 0,
   "buckets" : [
   {
   "key" : "histogram_2",
   "doc_count" : 62
   },
   {
   "key" : "histogram_1",
   "doc_count" : 45
   }
   ]
   }
   }
}