IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« count delete »

› ›

create

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

`create`

edit

client.create([params, [callback]])

Adds a typed JSON document in a specific index, making it searchable. If a document with the same index, type, and id already exists, an error will occur.

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Create a document.

await client.create({
  index: 'myindex',
  type: 'mytype',
  id: '1',
  body: {
    title: 'Test 1',
    tags: ['y', 'z'],
    published: true,
    published_at: '2013-01-01',
    counter: 1
  }
});

Params

`waitForActiveShards`	`String` — Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
`refresh`	`String` — If `true` then refresh 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` (the default) then do nothing with refreshes. Options `"true"` `"false"` `"wait_for"` `""`
`routing`	`String` — Specific routing value
`timeout`	`DurationString` — Explicit operation timeout
`version`	`Number` — Explicit version number for concurrency control
`versionType`	`String` — Specific version type Options `"internal"` `"external"` `"external_gte"` `"force"`
`pipeline`	`String` — The pipeline id to preprocess incoming documents with
`id`	`String` — Document ID
`index`	`String` — The name of the index
`type`	`String` — The type of the document
`body`	`Object`, `JSON` — The request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

« count delete »