[DOCS] Make field datatype titles consistent (#43933)
* [DOCS] Make field datatype titles consistent * Add titleabbrev for array
This commit is contained in:
parent
972a49312c
commit
8d7392de35
|
@ -81,14 +81,14 @@ include::types/array.asciidoc[]
|
|||
|
||||
include::types/binary.asciidoc[]
|
||||
|
||||
include::types/range.asciidoc[]
|
||||
|
||||
include::types/boolean.asciidoc[]
|
||||
|
||||
include::types/date.asciidoc[]
|
||||
|
||||
include::types/date_nanos.asciidoc[]
|
||||
|
||||
include::types/dense-vector.asciidoc[]
|
||||
|
||||
include::types/flattened.asciidoc[]
|
||||
|
||||
include::types/geo-point.asciidoc[]
|
||||
|
@ -97,6 +97,8 @@ include::types/geo-shape.asciidoc[]
|
|||
|
||||
include::types/ip.asciidoc[]
|
||||
|
||||
include::types/parent-join.asciidoc[]
|
||||
|
||||
include::types/keyword.asciidoc[]
|
||||
|
||||
include::types/nested.asciidoc[]
|
||||
|
@ -105,20 +107,18 @@ include::types/numeric.asciidoc[]
|
|||
|
||||
include::types/object.asciidoc[]
|
||||
|
||||
include::types/text.asciidoc[]
|
||||
|
||||
include::types/token-count.asciidoc[]
|
||||
|
||||
include::types/percolator.asciidoc[]
|
||||
|
||||
include::types/parent-join.asciidoc[]
|
||||
include::types/range.asciidoc[]
|
||||
|
||||
include::types/rank-feature.asciidoc[]
|
||||
|
||||
include::types/rank-features.asciidoc[]
|
||||
|
||||
include::types/dense-vector.asciidoc[]
|
||||
include::types/search-as-you-type.asciidoc[]
|
||||
|
||||
include::types/sparse-vector.asciidoc[]
|
||||
|
||||
include::types/search-as-you-type.asciidoc[]
|
||||
include::types/text.asciidoc[]
|
||||
|
||||
include::types/token-count.asciidoc[]
|
|
@ -1,5 +1,8 @@
|
|||
[[alias]]
|
||||
=== Alias datatype
|
||||
++++
|
||||
<titleabbrev>Alias</titleabbrev>
|
||||
++++
|
||||
|
||||
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,
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[binary]]
|
||||
=== Binary datatype
|
||||
++++
|
||||
<titleabbrev>Binary</titleabbrev>
|
||||
++++
|
||||
|
||||
The `binary` type accepts a binary value as a
|
||||
https://en.wikipedia.org/wiki/Base64[Base64] encoded string. The field is not
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[boolean]]
|
||||
=== Boolean datatype
|
||||
++++
|
||||
<titleabbrev>Boolean</titleabbrev>
|
||||
++++
|
||||
|
||||
Boolean fields accept JSON `true` and `false` values, but can also accept
|
||||
strings which are interpreted as either true or false:
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[date]]
|
||||
=== Date datatype
|
||||
++++
|
||||
<titleabbrev>Date</titleabbrev>
|
||||
++++
|
||||
|
||||
JSON doesn't have a date datatype, so dates in Elasticsearch can either be:
|
||||
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[date_nanos]]
|
||||
=== date_nanos datatype
|
||||
=== Date nanoseconds datatype
|
||||
++++
|
||||
<titleabbrev>Date nanoseconds</titleabbrev>
|
||||
++++
|
||||
|
||||
This datatype is an addition to the `date` datatype. However there is an
|
||||
important distinction between the two. The existing `date` datatype stores
|
||||
|
|
|
@ -2,6 +2,9 @@
|
|||
[testenv="basic"]
|
||||
[[dense-vector]]
|
||||
=== Dense vector datatype
|
||||
++++
|
||||
<titleabbrev>Dense vector</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental[]
|
||||
|
||||
|
|
|
@ -3,6 +3,9 @@
|
|||
|
||||
[[flattened]]
|
||||
=== Flattened datatype
|
||||
++++
|
||||
<titleabbrev>Flattened</titleabbrev>
|
||||
++++
|
||||
|
||||
By default, each subfield in an object is mapped and indexed separately. If
|
||||
the names or types of the subfields are not known in advance, then they are
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[geo-point]]
|
||||
=== Geo-point datatype
|
||||
++++
|
||||
<titleabbrev>Geo-point</titleabbrev>
|
||||
++++
|
||||
|
||||
Fields of type `geo_point` accept latitude-longitude pairs, which can be used:
|
||||
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[geo-shape]]
|
||||
=== Geo-Shape datatype
|
||||
=== Geo-shape datatype
|
||||
++++
|
||||
<titleabbrev>Geo-shape</titleabbrev>
|
||||
++++
|
||||
|
||||
The `geo_shape` datatype facilitates the indexing of and searching
|
||||
with arbitrary geo shapes such as rectangles and polygons. It should be
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[ip]]
|
||||
=== IP datatype
|
||||
++++
|
||||
<titleabbrev>IP</titleabbrev>
|
||||
++++
|
||||
|
||||
An `ip` field can index/store either https://en.wikipedia.org/wiki/IPv4[IPv4] or
|
||||
https://en.wikipedia.org/wiki/IPv6[IPv6] addresses.
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[keyword]]
|
||||
=== Keyword datatype
|
||||
++++
|
||||
<titleabbrev>Keyword</titleabbrev>
|
||||
++++
|
||||
|
||||
A field to index structured content such as email addresses, hostnames, status
|
||||
codes, zip codes or tags.
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[nested]]
|
||||
=== Nested datatype
|
||||
++++
|
||||
<titleabbrev>Nested</titleabbrev>
|
||||
++++
|
||||
|
||||
The `nested` type is a specialised version of the <<object,`object`>> datatype
|
||||
that allows arrays of objects to be indexed in a way that they can be queried
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[number]]
|
||||
=== Numeric datatypes
|
||||
++++
|
||||
<titleabbrev>Numeric</titleabbrev>
|
||||
++++
|
||||
|
||||
The following numeric types are supported:
|
||||
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[object]]
|
||||
=== Object datatype
|
||||
++++
|
||||
<titleabbrev>Object</titleabbrev>
|
||||
++++
|
||||
|
||||
JSON documents are hierarchical in nature: the document may contain inner
|
||||
objects which, in turn, may contain inner objects themselves:
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[parent-join]]
|
||||
=== `join` datatype
|
||||
=== Join datatype
|
||||
++++
|
||||
<titleabbrev>Join</titleabbrev>
|
||||
++++
|
||||
|
||||
The `join` datatype is a special field that creates
|
||||
parent/child relation within documents of the same index.
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[percolator]]
|
||||
=== Percolator type
|
||||
++++
|
||||
<titleabbrev>Percolator</titleabbrev>
|
||||
++++
|
||||
|
||||
The `percolator` field type parses a json structure into a native query and
|
||||
stores that query, so that the <<query-dsl-percolate-query,percolate query>>
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[range]]
|
||||
=== Range datatypes
|
||||
++++
|
||||
<titleabbrev>Range</titleabbrev>
|
||||
++++
|
||||
|
||||
The following range types are supported:
|
||||
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[rank-feature]]
|
||||
=== Rank feature datatype
|
||||
++++
|
||||
<titleabbrev>Rank feature</titleabbrev>
|
||||
++++
|
||||
|
||||
A `rank_feature` field can index numbers so that they can later be used to boost
|
||||
documents in queries with a <<query-dsl-rank-feature-query,`rank_feature`>> query.
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[rank-features]]
|
||||
=== Rank features datatype
|
||||
++++
|
||||
<titleabbrev>Rank features</titleabbrev>
|
||||
++++
|
||||
|
||||
A `rank_features` field can index numeric feature vectors, so that they can
|
||||
later be used to boost documents in queries with a
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[search-as-you-type]]
|
||||
=== Search as you type datatype
|
||||
=== Search-as-you-type datatype
|
||||
++++
|
||||
<titleabbrev>Search-as-you-type</titleabbrev>
|
||||
++++
|
||||
|
||||
The `search_as_you_type` field type is a text-like field that is optimized to
|
||||
provide out-of-the-box support for queries that serve an as-you-type completion
|
||||
|
|
|
@ -2,6 +2,9 @@
|
|||
[testenv="basic"]
|
||||
[[sparse-vector]]
|
||||
=== Sparse vector datatype
|
||||
++++
|
||||
<titleabbrev>Sparse vector</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental[]
|
||||
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[text]]
|
||||
=== Text datatype
|
||||
++++
|
||||
<titleabbrev>Text</titleabbrev>
|
||||
++++
|
||||
|
||||
A field to index full-text values, such as the body of an email or the
|
||||
description of a product. These fields are `analyzed`, that is they are passed through an
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
[[token-count]]
|
||||
=== Token count datatype
|
||||
++++
|
||||
<titleabbrev>Token count</titleabbrev>
|
||||
++++
|
||||
|
||||
A field of type `token_count` is really an <<number,`integer`>> field which
|
||||
accepts string values, analyzes them, then indexes the number of tokens in the
|
||||
|
|
Loading…
Reference in New Issue