Snap.Bulk.Action.Delete (Snap v0.17.0)

Copy Markdown View Source

Represents a delete step in a Snap.Bulk operation.

Supports the following fields:

  • id - the document ID to delete (required)
  • index - the index to delete from, if not specified on the bulk operation
  • require_alias - when true, the destination must be an index alias
  • routing - the custom routing value for the document
  • version - the explicit version number, for optimistic concurrency control
  • version_type - one of :internal, :external or :external_gte
  • if_seq_no - only perform the action if the document has this sequence number
  • if_primary_term - only perform the action if the document has this primary term

Summary

Types

t()

Types

t()

@type t() :: %Snap.Bulk.Action.Delete{
  id: String.t(),
  if_primary_term: integer() | nil,
  if_seq_no: integer() | nil,
  index: String.t() | nil,
  require_alias: boolean() | nil,
  routing: String.t() | nil,
  version: integer() | nil,
  version_type: Snap.Bulk.Action.version_type() | nil
}