Put component template API
editPut component template API
editCreates or updates a component template. Component templates are building blocks for constructing index templates. that specify index mappings, settings, and aliases.
PUT _component_template/template_1 { "template": { "settings": { "number_of_shards": 1 }, "mappings": { "_source": { "enabled": false }, "properties": { "host_name": { "type": "keyword" }, "created_at": { "type": "date", "format": "EEE MMM dd HH:mm:ss Z yyyy" } } } } }
Request
editPUT /_component_template/<component-template>
Description
editAn index template can be composed of multiple component templates.
To use a component template, specify it in an index template’s composed_of
list.
Component templates are only applied to indices
as part of a matching index template.
Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.
Component templates are only used during index creation. Changes to component templates do not affect existing indices, including a stream’s backing indices.
Comments in component templates
editYou can use C-style /* */ block comments in component templates. You can include comments anywhere in the request body, except before the opening curly bracket.
Path parameters
edit-
<component-template>
- (Required, string) Name of the component template to create.
Query parameters
edit-
create
-
(Optional, boolean)
If
true
, this request cannot replace or update existing component templates. Defaults tofalse
. -
master_timeout
-
(Optional, time units) Specifies the period of time to wait for
a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to
30s
.
Request body
edit-
template
-
(Required, object)
This is the template to be applied, may optionally include a
mappings
,settings
, oraliases
configuration. -
aliases
- (Optional, alias object) Index aliases which include the index. See Update index alias.
-
mappings
-
(Optional, mapping object) Mapping for fields in the index. If specified, this mapping can include:
- Field names
- Field data types
- Mapping parameters
See Mapping.
-
settings
- (Optional, index setting object) Configuration options for the index. See Index Settings.
-
version
- (Optional, integer) Version number used to manage component templates externally. This number is not automatically generated or incremented by Elasticsearch.
-
_meta
- (Optional, object) Optional user metadata about the component template. May have any contents. This map is not automatically generated by Elasticsearch.
Examples
editComponent template with index aliases
editYou can include index aliases in a component template.
Applying component templates
editYou cannot directly apply a component template to an index.
To be applied, a component template must be included in an index template’s composed_of
list. See Index templates .
Component template versioning
editYou can use the version
parameter to add a version number to a component template.
External systems can use these version numbers to simplify template management.
The version
parameter is optional and not automatically generated or used by Elasticsearch.
To unset a version
, replace the template without specifying one.
PUT /_component_template/template_1 { "template": { "settings" : { "number_of_shards" : 1 } }, "version": 123 }
To check the version
, you can use the get component template API.
Component template metadata
editYou can use the _meta
parameter to add arbitrary metadata to a component template.
This user-defined object is stored in the cluster state,
so keeping it short is preferrable.
The _meta
parameter is optional and not automatically generated or used by Elasticsearch.
To unset _meta
, replace the template without specifying one.
PUT /_component_template/template_1 { "template": { "settings" : { "number_of_shards" : 1 } }, "_meta": { "description": "set number of shards to one", "serialization": { "class": "MyComponentTemplate", "id": 10 } } }
To check the _meta
, you can use the get component template API.