Skip to content
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.

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

[DOCS] Removes incorrect nested datatype definition #827

Merged
merged 2 commits into from
Apr 24, 2020

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Apr 24, 2020

Removes an incorrect definition of the nested field datatype.

An object datatype, which is used by the Elastic Common Schema,
can also contain an array of objects as a value.

The primary difference between the object and nested datatypes is
that objects in a nested datatype can be queried independently.

However, that distinction isn't needed or relevant here.

Closes #826

Removes an incorrect definition of the [`nested` field datatype][0].

An [`object` datatype][1], which is used by the Elastic Common Schema,
can also contain an array of objects as a value.

The primary difference between the `object` and `nested` datatypes is
that objects in a `nested `datatype can be queried independently.

However, that distinction isn't needed or relevant here.

[0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/nested.html
[1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/object.html
Copy link

@astefan astefan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@webmat
Copy link
Contributor

webmat commented Apr 24, 2020

Thank you for opening this.

Would you mind completely removing the line instead? There's nothing inherently wrong with the nested data type, we may very well end up using it. So this statement is irrelevant.

@webmat
Copy link
Contributor

webmat commented Apr 24, 2020

We will should backport this to 1.5, which is the current version of the docs.

Not sure it's worth backporting to all past versions, though.

Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

Copy link
Contributor

@webmat webmat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you!

@jrodewig jrodewig merged commit e2d5286 into master Apr 24, 2020
@jrodewig jrodewig deleted the docs__fix-nested-datatype-error branch April 24, 2020 15:33
@webmat
Copy link
Contributor

webmat commented Apr 24, 2020

I can take care of the backport

@jrodewig
Copy link
Contributor Author

Thanks @webmat!

webmat pushed a commit to webmat/ecs that referenced this pull request Apr 24, 2020
Removes an incorrect definition of the [`nested` field datatype][0].

An [`object` datatype][1], which is used by the Elastic Common Schema,
can also contain an array of objects as a value.

The primary difference between the `object` and `nested` datatypes is
that objects in a `nested `datatype can be queried independently.

However, that distinction isn't needed or relevant here.

[0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/nested.html
[1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/object.html
webmat pushed a commit that referenced this pull request Apr 24, 2020
Removes an incorrect definition of the [`nested` field datatype][0].

An [`object` datatype][1], which is used by the Elastic Common Schema,
can also contain an array of objects as a value.

The primary difference between the `object` and `nested` datatypes is
that objects in a `nested `datatype can be queried independently.

However, that distinction isn't needed or relevant here.

[0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/nested.html
[1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/object.html

Co-authored-by: James Rodewig <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] nested field datatypes def in FAQ is incorrect
5 participants