dynamic
editdynamic
editWhen you index a document containing a new field, Elasticsearch adds the field dynamically to a document or to inner objects within a document. The
following document adds the string field username
, the object field
name
, and two string fields under the name
object:
response = client.index( index: 'my-index-000001', id: 1, body: { username: 'johnsmith', name: { first: 'John', last: 'Smith' } } ) puts response response = client.indices.get_mapping( index: 'my-index-000001' ) puts response
PUT my-index-000001/_doc/1 { "username": "johnsmith", "name": { "first": "John", "last": "Smith" } } GET my-index-000001/_mapping
Refer to fields under the |
|
Check the mapping to view changes. |
The following document adds two string fields: email
and name.middle
:
response = client.index( index: 'my-index-000001', id: 2, body: { username: 'marywhite', email: 'mary@white.com', name: { first: 'Mary', middle: 'Alice', last: 'White' } } ) puts response response = client.indices.get_mapping( index: 'my-index-000001' ) puts response
PUT my-index-000001/_doc/2 { "username": "marywhite", "email": "mary@white.com", "name": { "first": "Mary", "middle": "Alice", "last": "White" } } GET my-index-000001/_mapping
Setting dynamic
on inner objects
editInner objects inherit the dynamic
setting from their parent
object. In the following example, dynamic mapping is
disabled at the type level, so no new top-level fields will be added
dynamically.
However, the user.social_networks
object enables dynamic mapping, so you can
add fields to this inner object.
response = client.indices.create( index: 'my-index-000001', body: { mappings: { dynamic: false, properties: { user: { properties: { name: { type: 'text' }, social_networks: { dynamic: true, properties: {} } } } } } } ) puts response
Parameters for dynamic
editThe dynamic
parameter controls whether new fields are added dynamically, and
accepts the following parameters:
|
New fields are added to the mapping (default). |
|
New fields are added to the mapping as runtime fields.
These fields are not indexed, and are loaded from |
|
New fields are ignored. These fields will not be indexed
or searchable, but will still appear in the |
|
If new fields are detected, an exception is thrown and the document is rejected. New fields must be explicitly added to the mapping. |