Skip to content

Add another parent value option to join documentation #25609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jbaiera merged 1 commit into from
Jul 11, 2017
Merged

Add another parent value option to join documentation #25609

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion docs/reference/mapping/types/parent-join.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,32 @@ To index a document with a join, the name of the relation and the optional paren
of the document must be provided in the `source`.
For instance the following creates two parent documents in the `my_parent` context:

[source,js]
--------------------------------------------------
PUT my_index/doc/1?refresh
{
"text": "This is a parent document",
"my_join_field": {
"name": "my_parent" <1>
}
}

PUT my_index/doc/2?refresh
{
"text": "This is a another parent document",
"my_join_field": {
"name": "my_parent"
}
}
--------------------------------------------------
// CONSOLE
// TEST[continued]

<1> This document is a `my_parent` document.

When indexing parent documents, you can choose to specify just the name of the relation
as a shortcut instead of encapsulating it in the normal object notation:

[source,js]
--------------------------------------------------
PUT my_index/doc/1?refresh
Expand All @@ -51,7 +77,7 @@ PUT my_index/doc/2?refresh
// CONSOLE
// TEST[continued]

<1> This document is a `my_parent` document.
<1> Simpler notation for a parent document just uses the relation name.

When indexing a child, the name of the relation as well as the parent id of the document
must be added in the `_source`.
Expand Down