-
Notifications
You must be signed in to change notification settings - Fork 24.9k
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
Add documentation around field aliases. #31538
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
[[alias]] | ||
=== Alias datatype | ||
|
||
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>>. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/select/selected? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oops, thanks! |
||
|
||
[source,js] | ||
-------------------------------- | ||
PUT trips | ||
{ | ||
"mappings": { | ||
"_doc": { | ||
"properties": { | ||
"distance": { | ||
"type": "long" | ||
}, | ||
"route_length_miles": { | ||
"type": "alias", | ||
"path": "distance" // <1> | ||
}, | ||
"transit_mode": { | ||
"type": "keyword" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
|
||
GET _search | ||
{ | ||
"query": { | ||
"range" : { | ||
"route_length_miles" : { | ||
"gte" : 39 | ||
} | ||
} | ||
} | ||
} | ||
-------------------------------- | ||
// CONSOLE | ||
|
||
<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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Feels weird to say "all" when source filtering is an exception? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Will fix, I could see this being misleading. |
||
used in queries, aggregations, and sort fields, as well as when requesting `docvalue_fields`, | ||
`stored_fields`, suggestions, and highlights. Scripts also support aliases when accessing | ||
field values. | ||
|
||
In some parts of the search request and when requesting field capabilities, field wildcard patterns can be | ||
provided. In these cases, the wildcard pattern will match field aliases in addition to concrete fields: | ||
|
||
[source,js] | ||
-------------------------------- | ||
GET /_search | ||
{ | ||
"query" : { | ||
"match_all": {} | ||
}, | ||
"docvalue_fields": ["route_*", "transit_mode"] | ||
} | ||
-------------------------------- | ||
// CONSOLE | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. let's add There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
|
||
[[alias-targets]] | ||
==== Alias targets | ||
|
||
There are a few restrictions on the target of an alias: | ||
|
||
* The target must be a concrete field, and not an object or another field alias. | ||
* The target field must exist at the time the alias is created. | ||
* If nested objects are defined, a field alias must have the same nested scope as its target. | ||
|
||
Additionally, a field alias can only have one target. This means that it is not possible to use a | ||
field alias to query over multiple target fields in a single clause. | ||
|
||
[[unsupported-apis]] | ||
==== Unsupported APIs | ||
|
||
Writes to field aliases are not supported: attempting to use an alias in an index or update request | ||
will result in a failure. | ||
|
||
Because alias names are not present in the document source, aliases cannot be used when performing | ||
source filtering. For example, the following request will return an empty result for `_source`: | ||
|
||
[source,js] | ||
-------------------------------- | ||
GET /_search | ||
{ | ||
"query" : { | ||
"match_all": {} | ||
}, | ||
"_source": "route_length_miles" | ||
} | ||
-------------------------------- | ||
// CONSOLE | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. let's add There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
|
||
Finally, currently only the search and field capabilities APIs will accept and resolve | ||
field aliases. Other APIs that accept field names, such as <<docs-termvectors, term vectors>>, | ||
cannot be used with field aliases. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll check -- thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.