You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: specification/_global/create/CreateRequest.ts
+101-19
Original file line number
Diff line number
Diff line change
@@ -30,13 +30,85 @@ import {
30
30
import{Duration}from'@_types/Time'
31
31
32
32
/**
33
-
* Index a document.
34
-
* Adds a JSON document to the specified data stream or index and makes it searchable.
35
-
* If the target is an index and the document already exists, the request updates the document and increments its version.
33
+
* Create a new document in the index.
34
+
*
35
+
* You can index a new JSON document with the `/<target>/_doc/` or `/<target>/_create/<_id>` APIs
36
+
* Using `_create` guarantees that the document is indexed only if it does not already exist.
37
+
* It returns a 409 response when a document with a same ID already exists in the index.
38
+
* To update an existing document, you must use the `/<target>/_doc/` API.
39
+
*
40
+
* If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:
41
+
*
42
+
* * To add a document using the `PUT /<target>/_create/<_id>` or `POST /<target>/_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege.
43
+
* * To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.
44
+
*
45
+
* Automatic data stream creation requires a matching index template with data stream enabled.
46
+
*
47
+
* **Automatically create data streams and indices**
48
+
*
49
+
* If the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.
50
+
*
51
+
* If the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.
52
+
*
53
+
* NOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.
54
+
*
55
+
* If no mapping exists, the index operation creates a dynamic mapping.
56
+
* By default, new fields and objects are automatically added to the mapping if needed.
57
+
*
58
+
* Automatic index creation is controlled by the `action.auto_create_index` setting.
59
+
* If it is `true`, any index can be created automatically.
60
+
* You can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.
61
+
* Specify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.
62
+
* When a list is specified, the default behaviour is to disallow.
63
+
*
64
+
* NOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.
65
+
* It does not affect the creation of data streams.
66
+
*
67
+
* **Routing**
68
+
*
69
+
* By default, shard placement — or routing — is controlled by using a hash of the document's ID value.
70
+
* For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.
71
+
*
72
+
* When setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.
73
+
* This does come at the (very minimal) cost of an additional document parsing pass.
74
+
* If the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.
75
+
*
76
+
* NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.
77
+
*
78
+
* ** Distributed**
79
+
*
80
+
* The index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.
81
+
* After the primary shard completes the operation, if needed, the update is distributed to applicable replicas.
82
+
*
83
+
* **Active shards**
84
+
*
85
+
* To improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.
86
+
* If the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.
87
+
* By default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).
88
+
* This default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.
89
+
* To alter this behavior per operation, use the `wait_for_active_shards request` parameter.
90
+
*
91
+
* Valid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).
92
+
* Specifying a negative value or a number greater than the number of shard copies will throw an error.
93
+
*
94
+
* For example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).
95
+
* If you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.
96
+
* This means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.
97
+
* If `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.
98
+
* This requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.
99
+
* However, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.
100
+
* The operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.
101
+
*
102
+
* It is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.
103
+
* After the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.
104
+
* The `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.
* To automatically generate a document ID, use the `POST /<target>/_doc/` request format.
51
124
*/
52
125
id: Id
53
126
/**
54
-
* Name of the data stream or index to target.
55
-
* If the target doesn’t exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.
56
-
* If the target doesn’t exist and doesn’t match a data stream template, this request creates the index.
127
+
* The name of the data stream or index to target.
128
+
* If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.
129
+
* If the target doesn't exist and doesn’t match a data stream template, this request creates the index.
57
130
*/
58
131
index: IndexName
59
132
}
60
133
query_parameters: {
61
134
/**
62
-
* ID of the pipeline to use to preprocess incoming documents.
63
-
* If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
64
-
* If a final pipeline is configured it will always run, regardless of the value of this parameter.
135
+
* The ID of the pipeline to use to preprocess incoming documents.
136
+
* If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.
137
+
* If a final pipeline is configured, it will always run regardless of the value of this parameter.
65
138
*/
66
139
pipeline?: string
67
140
/**
68
-
* If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
69
-
* Valid values: `true`, `false`, `wait_for`.
141
+
* If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.
142
+
* If `wait_for`, it waits for a refresh to make this operation visible to search.
143
+
* If `false`, it does nothing with refreshes.
70
144
* @server_default false
71
145
*/
72
146
refresh?: Refresh
73
147
/**
74
-
* Custom value used to route operations to a specific shard.
148
+
* A custom value that is used to route operations to a specific shard.
75
149
*/
76
150
routing?: Routing
77
151
/**
78
-
* Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.
152
+
* The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.
153
+
* Elasticsearch waits for at least the specified timeout period before failing.
154
+
* The actual wait time could be longer, particularly when multiple waits occur.
155
+
*
156
+
* This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.
157
+
* Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.
158
+
* By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.
159
+
* The actual wait time could be longer, particularly when multiple waits occur.
79
160
* @server_default 1m
80
161
*/
81
162
timeout?: Duration
82
163
/**
83
-
* Explicit version number for concurrency control.
84
-
* The specified version must match the current version of the document for the request to succeed.
164
+
* The explicit version number for concurrency control.
165
+
* It must be a non-negative long number.
85
166
*/
86
167
version?: VersionNumber
87
168
/**
88
-
* Specific version type: `external`, `external_gte`.
169
+
* The version type.
89
170
*/
90
171
version_type?: VersionType
91
172
/**
92
173
* The number of shard copies that must be active before proceeding with the operation.
93
-
* Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
174
+
* You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
175
+
* The default value of `1` means it waits for each primary shard to be active.
94
176
* @server_default 1
95
177
*/
96
178
wait_for_active_shards?: WaitForActiveShards
97
179
}
98
180
/**
99
-
* Request body contains the JSON source for the document data.
181
+
* The request body contains the JSON source for the document data.
0 commit comments