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.

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

Reformat supported field types index page #4349

Merged
merged 3 commits into from
Jun 21, 2023
Merged

Reformat supported field types index page #4349

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1abdbaf
Reformat supported field types index page
kolchfa-aws Jun 15, 2023
7f624c6
Reorder search TOC topics
kolchfa-aws Jun 15, 2023
b5d7b25
Merge branch 'main' into field-types-main
kolchfa-aws Jun 21, 2023
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
20 changes: 9 additions & 11 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,35 +110,32 @@ just_the_docs:
name: OpenSearch Dashboards
nav_fold: true
tuning-your-cluster:
name: Tuning your cluster
name: Creating and tuning your cluster
nav_fold: true
security:
name: Security in OpenSearch
nav_fold: true
security-analytics:
name: Security analytics
nav_fold: true
field-types:
name: Mappings and field types
nav_fold: true
query-dsl:
name: Query DSL, Aggregations, and Analyzers
nav_fold: true
search-plugins:
name: Search
nav_fold: true
ml-commons-plugin:
name: Machine learning
nav_fold: true
tuning-your-cluster:
name: Creating and tuning your cluster
nav_fold: true
monitoring-your-cluster:
name: Monitoring your cluster
nav_fold: true
observing-your-data:
name: Observability
nav_fold: true
query-dsl:
name: Query DSL, Aggregations, and Analyzers
nav_fold: true
field-types:
name: Mappings and field types
nav_fold: true
clients:
name: Clients
nav_fold: true
Expand Down Expand Up @@ -229,4 +226,5 @@ exclude:
- vendor/gems/
- vendor/ruby/
- README.md
- .idea
- .idea
- templates
30 changes: 15 additions & 15 deletions _field-types/supported-field-types/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ redirect_from:

You can specify data types for your fields when creating a mapping. The following table lists all data field types that OpenSearch supports.

Field data type | Description
:--- | :---
[`alias`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/alias/) | An additional name for an existing field.
[`binary`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/binary/) | A binary value in Base64 encoding.
[Numeric]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/numeric/) | `byte`, `double`, `float`, `half_float`, `integer`, `long`, `unsigned_long`, `scaled_float`, `short`.
[`boolean`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/boolean/) | A Boolean value.
[`date`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/date/) | A date value as a formatted string, a long value, or an integer.
[`ip`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/ip/) | An IP address in IPv4 or IPv6 format.
[Range]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/range/) | `integer_range`, `long_range`,`double_range`, `float_range`, `date_range`,`ip_range`.
[Object]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/object/) | `object`, `nested`, `join`.
String | [`keyword`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/keyword/), [`text`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/text/), [`token_count`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/token-count/).
[Autocomplete]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/autocomplete/) | `completion`, `search_as_you_type`.
[Geographic]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/geographic/) | `geo_point`, `geo_shape`.
[Rank]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/rank/) | `rank_feature`, `rank_features`.
[`percolator`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/percolator/) | Specifies to treat this field as a query.
Category | Field types and descriptions
:--- | :---
Alias | [`alias`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/alias/): An additional name for an existing field.
Binary | [`binary`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/binary/): A binary value in Base64 encoding.
[Numeric]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/numeric/) | A numeric value (`byte`, `double`, `float`, `half_float`, `integer`, `long`, [`unsigned_long`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/unsigned-long/), `scaled_float`, `short`).
Boolean | [`boolean`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/boolean/): A Boolean value.
[Date]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/dates/)| [`date`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/date/): A date stored in milliseconds. <br> [`date_nanos`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/date-nanos/): A date stored in nanoseconds.
IP | [`ip`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/ip/): An IP address in IPv4 or IPv6 format.
[Range]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/range/) | A range of values (`integer_range`, `long_range`, `double_range`, `float_range`, `date_range`, `ip_range`).
[Object]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/object/)| [`object`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/object/): A JSON object. <br>[`nested`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/nested/): Used when objects in an array need to be indexed independently as separate documents.<br>[`flat_object`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/flat-object/): A JSON object treated as a string.<br>[`join`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/join/): Establishes a parent-child relationship between documents in the same index.
[String]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/string/)|[`keyword`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/keyword/): Contains a string that is not analyzed.<br> [`text`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/text/): Contains a string that is analyzed.<br>[`token_count`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/token-count/): Stores the number of analyzed tokens in a string.
[Autocomplete]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/autocomplete/) |[`completion`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/completion/): Provides autocomplete functionality through a completion suggester.<br> [`search_as_you_type`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/search-as-you-type/): Provides search-as-you-type functionality using both prefix and infix completion.
[Geographic]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/geographic/)| [`geo_point`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/geo-point/): A geographic point.<br>[`geo_shape`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/geo-shape/): A geographic shape.
[Rank]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/rank/) | Boosts or decreases the relevance score of documents (`rank_feature`, `rank_features`).
Percolator | [`percolator`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/percolator/): Specifies to treat this field as a query.

## Arrays

Expand Down