NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

› ›

bulk

edit

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

bulk

edit

client.bulk({
  index: string,
  type: string,
  wait_for_active_shards: string,
  refresh: 'true' | 'false' | 'wait_for',
  routing: string,
  timeout: string,
  type: string,
  fields: string | string[],
  _source: string | string[],
  _source_excludes: string | string[],
  _source_includes: string | string[],
  pipeline: string,
  body: object
})

Reference

`index`	`string` - Default index for items which don’t provide one
`type`	`string` - Default document type for items which don’t provide one
`wait_for_active_shards` or `waitForActiveShards`	`string` - Sets the number of shard copies that must be active before proceeding with the bulk 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`	`'true' \| 'false' \| 'wait_for'` - If `true` then refresh the effected 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.
`routing`	`string` - Specific routing value
`timeout`	`string` - Explicit operation timeout
`type`	`string` - Default document type for items which don’t provide one
`fields`	`string \| string[]` - Default comma-separated list of fields to return in the response for updates, can be overridden on each sub-request
`_source`	`string \| string[]` - True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
`_source_excludes` or `_sourceExcludes`	`string \| string[]` - Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
`_source_includes` or `_sourceIncludes`	`string \| string[]` - Default list of fields to extract and return from the _source field, can be overridden on each sub-request
`pipeline`	`string` - The pipeline id to preprocess incoming documents with
`body`	`object` - The operation definition and data (action-data pairs), separated by newlines

« Common parameters cat.aliases »