mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-05-20 23:54:49 +00:00
4b1c116461
Adds infrastructure so `gradle :docs:check` will extract tests from snippets in the documentation and execute the tests. This is included in `gradle check` so it should happen on CI and during a normal build. By default each `// AUTOSENSE` snippet creates a unique REST test. These tests are executed in a random order and the cluster is wiped between each one. If multiple snippets chain together into a test you can annotate all snippets after the first with `// TEST[continued]` to have the generated tests for both snippets joined. Snippets marked as `// TESTRESPONSE` are checked against the response of the last action. See docs/README.asciidoc for lots more. Closes #12583. That issue is about catching bugs in the docs during build. This catches *some* bugs in the docs during build which is a good start.
69 lines
2.1 KiB
Plaintext
69 lines
2.1 KiB
Plaintext
[[dynamic-mapping]]
|
|
== Dynamic Mapping
|
|
|
|
One of the most important features of Elasticsearch is that it tries to get
|
|
out of your way and let you start exploring your data as quickly as possible.
|
|
To index a document, you don't have to first create an index, define a mapping
|
|
type, and define your fields -- you can just index a document and the index,
|
|
type, and fields will spring to life automatically:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT data/counters/1 <1>
|
|
{ "count": 5 }
|
|
--------------------------------------------------
|
|
// AUTOSENSE
|
|
<1> Creates the `data` index, the `counters` mapping type, and a field
|
|
called `count` with datatype `long`.
|
|
|
|
The automatic detection and addition of new types and fields is called
|
|
_dynamic mapping_. The dynamic mapping rules can be customised to suit your
|
|
purposes with:
|
|
|
|
<<default-mapping,`_default_` mapping>>::
|
|
|
|
Configure the base mapping to be used for new mapping types.
|
|
|
|
<<dynamic-field-mapping,Dynamic field mappings>>::
|
|
|
|
The rules governing dynamic field detection.
|
|
|
|
<<dynamic-templates,Dynamic templates>>::
|
|
|
|
Custom rules to configure the mapping for dynamically added fields.
|
|
|
|
TIP: <<indices-templates,Index templates>> allow you to configure the default
|
|
mappings, settings and aliases for new indices, whether created
|
|
automatically or explicitly.
|
|
|
|
|
|
[float]
|
|
=== Disabling automatic type creation
|
|
|
|
Automatic type creation can be disabled by setting the `index.mapper.dynamic`
|
|
setting to `false`, either by setting the default value in the
|
|
`config/elasticsearch.yml` file, or per-index as an index setting:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT data/_settings <1>
|
|
{
|
|
"index.mapper.dynamic":false
|
|
}
|
|
--------------------------------------------------
|
|
// AUTOSENSE
|
|
// TEST[continued]
|
|
|
|
<1> Disable automatic type creation for all indices.
|
|
|
|
Regardless of the value of this setting, types can still be added explicitly
|
|
when <<indices-create-index,creating an index>> or with the
|
|
<<indices-put-mapping,PUT mapping>> API.
|
|
|
|
|
|
include::dynamic/default-mapping.asciidoc[]
|
|
|
|
include::dynamic/field-mapping.asciidoc[]
|
|
|
|
include::dynamic/templates.asciidoc[]
|