Add documentation around field aliases. #31538
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jtibshirani
added
>docs
|
Pinging @elastic/es-search-aggs |
9 tasks
jtibshirani
force-pushed
the
field-alias-docs
branch
from
34ea8bb to
da55544
Compare
cbuescher
approved these changes
Jun 25, 2018
|
|
||
| An `alias` mapping defines an alternate name for a field in the index. | ||
| The alias can be used in place of the target field in <<search, search>> requests, | ||
| and select other APIs like <<search-field-caps, field capabilities>>. |
jpountz
approved these changes
Jun 25, 2018
| documents. Instead, you should create a new index with the correct mappings | ||
| and <<docs-reindex,reindex>> your data into that index. If you only wish | ||
| to rename a field and not change its mappings, it may make sense to introduce | ||
| an <<alias, `alias`>> field. |
There was a problem hiding this comment.
I've noticed that we usually don't put spaces after the comma, not sure whether it has rendering implications.
There was a problem hiding this comment.
I'll check -- thanks.
There was a problem hiding this comment.
Update: I couldn't observe any rendering difference. I'll plan to keep it as-is, I think the space makes this read more clearly.
| <1> The path to the target field. Note that this must be the full path, including any parent | ||
| objects (e.g. `object1.object2.field`). | ||
|
|
||
| All relevant components of the search request accept field aliases. In particular, aliases can be |
There was a problem hiding this comment.
Feels weird to say "all" when source filtering is an exception?
There was a problem hiding this comment.
Will fix, I could see this being misleading.
| "_source": "route_length_miles" | ||
| } | ||
| -------------------------------- | ||
| // CONSOLE |
There was a problem hiding this comment.
let's add TEST[continued]?
| "docvalue_fields": ["route_*", "transit_mode"] | ||
| } | ||
| -------------------------------- | ||
| // CONSOLE |
There was a problem hiding this comment.
let's add TEST[continued]?
jtibshirani
force-pushed
the
field-alias-docs
branch
from
b039e37 to
c40fd9b
Compare
jtibshirani
force-pushed
the
field-alias-docs
branch
from
c40fd9b to
f8f613d
Compare
jtibshirani
added a commit
that referenced
this pull request
Jun 26, 2018
jtibshirani
added a commit
that referenced
this pull request
Jul 4, 2018
jtibshirani
added a commit
to jtibshirani/elasticsearch
that referenced
this pull request
Jul 16, 2018
jtibshirani
added a commit
that referenced
this pull request
Jul 17, 2018
jtibshirani
added a commit
that referenced
this pull request
Jul 18, 2018
jtibshirani
added a commit
that referenced
this pull request
Jul 18, 2018
* Add basic support for field aliases in index mappings. (#31287) * Allow for aliases when fetching stored fields. (#31411) * Add tests around accessing field aliases in scripts. (#31417) * Add documentation around field aliases. (#31538) * Add validation for field alias mappings. (#31518) * Return both concrete fields and aliases in DocumentFieldMappers#getMapper. (#31671) * Make sure that field-level security is enforced when using field aliases. (#31807) * Add more comprehensive tests for field aliases in queries + aggregations. (#31565) * Remove the deprecated method DocumentFieldMappers#getFieldMapper. (#32148)
jtibshirani
added a commit
to jtibshirani/elasticsearch
that referenced
this pull request
Jul 24, 2018
jtibshirani
added a commit
that referenced
this pull request
Jul 24, 2018
* Add basic support for field aliases in index mappings. (#31287) * Allow for aliases when fetching stored fields. (#31411) * Add tests around accessing field aliases in scripts. (#31417) * Return both concrete fields and aliases in DocumentFieldMappers#getMapper. (#31671) * Add documentation around field aliases. (#31538) * Add validation for field alias mappings. (#31518) * Make sure that field-level security is enforced when using field aliases. (#31807) * Add more comprehensive tests for field aliases in queries + aggregations. (#31565) * Remove the deprecated method DocumentFieldMappers#getFieldMapper. (#32148) * Ensure that field aliases cannot be used in multi-fields. (#32219) * Make sure that field aliases count towards the total fields limit. (#32222) * Fix a test bug around nested aggregations and field aliases. (#32287) * Make sure the _uid field is correctly loaded in scripts. * Fix the failing test case FieldLevelSecurityTests#testParentChild_parentField. * Enforce that field aliases can only be specified on indexes with a single type.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.