honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/query-dsl/parent-id-query.asciidoc

88 lines
2.0 KiB
Plaintext
Raw Normal View History

Cleanup ParentFieldMapper: * Remove remaining 1.x bwc logic. * Stop storing stored fields and indexed terms. The _parent field's only purpose is to support joins between parent and child type and only storing doc values is sufficient. * In the mapping the parent field mapper is now known under '{parent}#{child}' key, because this is the field the parent/child join uses too. * Added new sub fetch phase to lookup that _parent field from doc values field if that is required (before this was fetched from stored _parent field) * Removed the ability to query directly on `_parent` in the query dsl. Instead the `{parent}#{child}` field should be used. Under the hood a doc values query is used instead of a term query, because only doc values fields are stored now. * Added a new `parent_id` query to easily query child documents with a specific parent id without having to know what join field to use * Also in aggregations `_parent` field can't be used any more and `{parent}#{child}` field name should be used instead to aggregate directly on the _parent join field.
2016-01-17 16:49:07 -05:00
[[query-dsl-parent-id-query]]
=== Parent Id Query
Bump Elasticsearch version to 5.0.0-SNAPSHOT This commit bumps the Elasticsearch version to 5.0.0-SNAPSHOT in line with the alignment of versions across the stack. Closes #16862
2016-02-29 10:21:39 -05:00
added[5.0.0]
Cleanup ParentFieldMapper: * Remove remaining 1.x bwc logic. * Stop storing stored fields and indexed terms. The _parent field's only purpose is to support joins between parent and child type and only storing doc values is sufficient. * In the mapping the parent field mapper is now known under '{parent}#{child}' key, because this is the field the parent/child join uses too. * Added new sub fetch phase to lookup that _parent field from doc values field if that is required (before this was fetched from stored _parent field) * Removed the ability to query directly on `_parent` in the query dsl. Instead the `{parent}#{child}` field should be used. Under the hood a doc values query is used instead of a term query, because only doc values fields are stored now. * Added a new `parent_id` query to easily query child documents with a specific parent id without having to know what join field to use * Also in aggregations `_parent` field can't be used any more and `{parent}#{child}` field name should be used instead to aggregate directly on the _parent join field.
2016-01-17 16:49:07 -05:00
Merge branch 'master' into docs/add_autosense_to_query_dsl
2016-05-17 15:12:06 -04:00
The `parent_id` query can be used to find child documents which belong to a particular parent.
Given the following mapping definition:
Cleanup ParentFieldMapper: * Remove remaining 1.x bwc logic. * Stop storing stored fields and indexed terms. The _parent field's only purpose is to support joins between parent and child type and only storing doc values is sufficient. * In the mapping the parent field mapper is now known under '{parent}#{child}' key, because this is the field the parent/child join uses too. * Added new sub fetch phase to lookup that _parent field from doc values field if that is required (before this was fetched from stored _parent field) * Removed the ability to query directly on `_parent` in the query dsl. Instead the `{parent}#{child}` field should be used. Under the hood a doc values query is used instead of a term query, because only doc values fields are stored now. * Added a new `parent_id` query to easily query child documents with a specific parent id without having to know what join field to use * Also in aggregations `_parent` field can't be used any more and `{parent}#{child}` field name should be used instead to aggregate directly on the _parent join field.
2016-01-17 16:49:07 -05:00
Docs: Clarified the purpose of the parent_id query
2016-04-14 05:25:26 -04:00
[source,js]
Merge branch 'master' into docs/add_autosense_to_query_dsl
2016-05-17 15:12:06 -04:00
--------------------------------------------
Convert rest of query-dsl docs to be run in tests
2016-05-11 08:37:19 -04:00
PUT /my_index
Docs: Clarified the purpose of the parent_id query
2016-04-14 05:25:26 -04:00
{
Only allow one type on 7.0 indices (#24317) This adds the `index.mapping.single_type` setting, which enforces that indices have at most one type when it is true. The default value is true for 6.0+ indices and false for old indices. Relates #15613
2017-04-27 02:43:20 -04:00
"settings": {
"mapping.single_type": false
},
Fix test failures.
2016-05-12 06:29:18 -04:00
"mappings": {
"blog_post": {
"properties": {
"name": {
"type": "keyword"
}
}
},
"blog_tag": {
"_parent": {
"type": "blog_post"
},
"_routing": {
"required": true
}
}
Adds ignore_unmapped option to nested and P/C queries The change adds a new option to the `nested`, `has_parent`, `has_children` and `parent_id` queries: `ignore_unmapped`. If this option is set to false, the `toQuery` method on the QueryBuilder will throw an exception if the type/path specified in the query is unmapped. If the option is set to true, the `toQuery` method on the QueryBuilder will return a MatchNoDocsQuery. The default value is `false`so the queries work how they do today (throwing an exception on unmapped paths/types)
2016-04-14 04:37:18 -04:00
}
Docs: Clarified the purpose of the parent_id query
2016-04-14 05:25:26 -04:00
}
Add a wait_for_stats=yellow to a docs snippet It was making unstable tests.
2016-05-18 15:10:01 -04:00
Made the same length of opening and closing lines (#23583)
2017-06-09 03:50:43 -04:00
--------------------------------------------
Convert rest of query-dsl docs to be run in tests
2016-05-11 08:37:19 -04:00
// CONSOLE
// TESTSETUP
Docs: Clarified the purpose of the parent_id query
2016-04-14 05:25:26 -04:00
Fix test failures.
2016-05-12 06:29:18 -04:00
[source,js]
--------------------------------------------------
Fix occasional build error.
2016-05-17 09:40:53 -04:00
GET /my_index/_search
Fix test failures.
2016-05-12 06:29:18 -04:00
{
"query": {
"parent_id" : {
"type" : "blog_tag",
Fix parent_id example in docs And fix some indentation I noticed while looking up the query.
2017-01-10 10:01:31 -05:00
"id" : "1"
Fix test failures.
2016-05-12 06:29:18 -04:00
}
}
}
--------------------------------------------------
// CONSOLE
Docs: Clarified the purpose of the parent_id query
2016-04-14 05:25:26 -04:00
The above is functionally equivalent to using the following
<<query-dsl-has-parent-query, `has_parent`>> query, but performs
better as it does not need to do a join:
Cleanup ParentFieldMapper: * Remove remaining 1.x bwc logic. * Stop storing stored fields and indexed terms. The _parent field's only purpose is to support joins between parent and child type and only storing doc values is sufficient. * In the mapping the parent field mapper is now known under '{parent}#{child}' key, because this is the field the parent/child join uses too. * Added new sub fetch phase to lookup that _parent field from doc values field if that is required (before this was fetched from stored _parent field) * Removed the ability to query directly on `_parent` in the query dsl. Instead the `{parent}#{child}` field should be used. Under the hood a doc values query is used instead of a term query, because only doc values fields are stored now. * Added a new `parent_id` query to easily query child documents with a specific parent id without having to know what join field to use * Also in aggregations `_parent` field can't be used any more and `{parent}#{child}` field name should be used instead to aggregate directly on the _parent join field.
2016-01-17 16:49:07 -05:00
[source,js]
--------------------------------------------------
Add back doc execution to query dsl. Relates to #18211 This reverts commit 20aafb1196192d4f9f7faea8ce9a36b278e501a1.
2016-05-24 05:58:43 -04:00
GET /my_index/_search
Cleanup ParentFieldMapper: * Remove remaining 1.x bwc logic. * Stop storing stored fields and indexed terms. The _parent field's only purpose is to support joins between parent and child type and only storing doc values is sufficient. * In the mapping the parent field mapper is now known under '{parent}#{child}' key, because this is the field the parent/child join uses too. * Added new sub fetch phase to lookup that _parent field from doc values field if that is required (before this was fetched from stored _parent field) * Removed the ability to query directly on `_parent` in the query dsl. Instead the `{parent}#{child}` field should be used. Under the hood a doc values query is used instead of a term query, because only doc values fields are stored now. * Added a new `parent_id` query to easily query child documents with a specific parent id without having to know what join field to use * Also in aggregations `_parent` field can't be used any more and `{parent}#{child}` field name should be used instead to aggregate directly on the _parent join field.
2016-01-17 16:49:07 -05:00
{
Add back doc execution to query dsl. Relates to #18211 This reverts commit 20aafb1196192d4f9f7faea8ce9a36b278e501a1.
2016-05-24 05:58:43 -04:00
"query": {
"has_parent": {
Fail yaml tests and docs snippets that get unexpected warnings Adds `warnings` syntax to the yaml test that allows you to expect a `Warning` header that looks like: ``` - do: warnings: - '[index] is deprecated' - quotes are not required because yaml - but this argument is always a list, never a single string - no matter how many warnings you expect get: index: test type: test id: 1 ``` These are accessible from the docs with: ``` // TEST[warning:some warning] ``` This should help to force you to update the docs if you deprecate something. You *must* add the warnings marker to the docs or the build will fail. While you are there you *should* update the docs to add deprecation warnings visible in the rendered results.
2016-08-02 17:35:31 -04:00
"parent_type": "blog_post",
Add back doc execution to query dsl. Relates to #18211 This reverts commit 20aafb1196192d4f9f7faea8ce9a36b278e501a1.
2016-05-24 05:58:43 -04:00
"query": {
"term": {
"_id": "1"
}
Revert "Add Autosense annotation for query dsl testing"
2016-05-17 14:55:56 -04:00
}
Cleanup ParentFieldMapper: * Remove remaining 1.x bwc logic. * Stop storing stored fields and indexed terms. The _parent field's only purpose is to support joins between parent and child type and only storing doc values is sufficient. * In the mapping the parent field mapper is now known under '{parent}#{child}' key, because this is the field the parent/child join uses too. * Added new sub fetch phase to lookup that _parent field from doc values field if that is required (before this was fetched from stored _parent field) * Removed the ability to query directly on `_parent` in the query dsl. Instead the `{parent}#{child}` field should be used. Under the hood a doc values query is used instead of a term query, because only doc values fields are stored now. * Added a new `parent_id` query to easily query child documents with a specific parent id without having to know what join field to use * Also in aggregations `_parent` field can't be used any more and `{parent}#{child}` field name should be used instead to aggregate directly on the _parent join field.
2016-01-17 16:49:07 -05:00
}
Revert "Add Autosense annotation for query dsl testing"
2016-05-17 14:55:56 -04:00
}
Cleanup ParentFieldMapper: * Remove remaining 1.x bwc logic. * Stop storing stored fields and indexed terms. The _parent field's only purpose is to support joins between parent and child type and only storing doc values is sufficient. * In the mapping the parent field mapper is now known under '{parent}#{child}' key, because this is the field the parent/child join uses too. * Added new sub fetch phase to lookup that _parent field from doc values field if that is required (before this was fetched from stored _parent field) * Removed the ability to query directly on `_parent` in the query dsl. Instead the `{parent}#{child}` field should be used. Under the hood a doc values query is used instead of a term query, because only doc values fields are stored now. * Added a new `parent_id` query to easily query child documents with a specific parent id without having to know what join field to use * Also in aggregations `_parent` field can't be used any more and `{parent}#{child}` field name should be used instead to aggregate directly on the _parent join field.
2016-01-17 16:49:07 -05:00
}
--------------------------------------------------
Add back doc execution to query dsl. Relates to #18211 This reverts commit 20aafb1196192d4f9f7faea8ce9a36b278e501a1.
2016-05-24 05:58:43 -04:00
// CONSOLE
Cleanup ParentFieldMapper: * Remove remaining 1.x bwc logic. * Stop storing stored fields and indexed terms. The _parent field's only purpose is to support joins between parent and child type and only storing doc values is sufficient. * In the mapping the parent field mapper is now known under '{parent}#{child}' key, because this is the field the parent/child join uses too. * Added new sub fetch phase to lookup that _parent field from doc values field if that is required (before this was fetched from stored _parent field) * Removed the ability to query directly on `_parent` in the query dsl. Instead the `{parent}#{child}` field should be used. Under the hood a doc values query is used instead of a term query, because only doc values fields are stored now. * Added a new `parent_id` query to easily query child documents with a specific parent id without having to know what join field to use * Also in aggregations `_parent` field can't be used any more and `{parent}#{child}` field name should be used instead to aggregate directly on the _parent join field.
2016-01-17 16:49:07 -05:00
==== Parameters
This query has two required parameters:
[horizontal]
Docs: Clarified the purpose of the parent_id query
2016-04-14 05:25:26 -04:00
`type`:: The **child** type. This must be a type with `_parent` field.
Cleanup ParentFieldMapper: * Remove remaining 1.x bwc logic. * Stop storing stored fields and indexed terms. The _parent field's only purpose is to support joins between parent and child type and only storing doc values is sufficient. * In the mapping the parent field mapper is now known under '{parent}#{child}' key, because this is the field the parent/child join uses too. * Added new sub fetch phase to lookup that _parent field from doc values field if that is required (before this was fetched from stored _parent field) * Removed the ability to query directly on `_parent` in the query dsl. Instead the `{parent}#{child}` field should be used. Under the hood a doc values query is used instead of a term query, because only doc values fields are stored now. * Added a new `parent_id` query to easily query child documents with a specific parent id without having to know what join field to use * Also in aggregations `_parent` field can't be used any more and `{parent}#{child}` field name should be used instead to aggregate directly on the _parent join field.
2016-01-17 16:49:07 -05:00
Adds ignore_unmapped option to nested and P/C queries The change adds a new option to the `nested`, `has_parent`, `has_children` and `parent_id` queries: `ignore_unmapped`. If this option is set to false, the `toQuery` method on the QueryBuilder will throw an exception if the type/path specified in the query is unmapped. If the option is set to true, the `toQuery` method on the QueryBuilder will return a MatchNoDocsQuery. The default value is `false`so the queries work how they do today (throwing an exception on unmapped paths/types)
2016-04-14 04:37:18 -04:00
`id`:: The required parent id select documents must referrer to.
Add a wait_for_stats=yellow to a docs snippet It was making unstable tests.
2016-05-18 15:10:01 -04:00
`ignore_unmapped`:: When set to `true` this will ignore an unmapped `type` and will not match any
Adds ignore_unmapped option to nested and P/C queries The change adds a new option to the `nested`, `has_parent`, `has_children` and `parent_id` queries: `ignore_unmapped`. If this option is set to false, the `toQuery` method on the QueryBuilder will throw an exception if the type/path specified in the query is unmapped. If the option is set to true, the `toQuery` method on the QueryBuilder will return a MatchNoDocsQuery. The default value is `false`so the queries work how they do today (throwing an exception on unmapped paths/types)
2016-04-14 04:37:18 -04:00
documents for this query. This can be useful when querying multiple indexes
which might have different mappings. When set to `false` (the default value)
the query will throw an exception if the `type` is not mapped.