azure.search.IndexDocumentsBatch.yml

### YamlMime:UniversalReference
api_name: []
items:
- children:
  - azure.search.IndexDocumentsBatch.actions
  - azure.search.IndexDocumentsBatch.add_delete_documents
  - azure.search.IndexDocumentsBatch.add_merge_documents
  - azure.search.IndexDocumentsBatch.add_merge_or_upload_documents
  - azure.search.IndexDocumentsBatch.add_upload_documents
  class: azure.search.IndexDocumentsBatch
  fullName: azure.search.IndexDocumentsBatch
  inheritance:
  - type: builtins.object
  langs:
  - python
  module: azure.search
  name: IndexDocumentsBatch
  summary: 'Represent a batch of upate operations for documents in an Azure

    Search index.


    Index operations are performed in the order in which they are added

    to the batch.'
  syntax:
    content: IndexDocumentsBatch()
  type: class
  uid: azure.search.IndexDocumentsBatch
- class: azure.search.IndexDocumentsBatch
  fullName: azure.search.IndexDocumentsBatch.actions
  langs:
  - python
  module: azure.search
  name: actions
  summary: The list of currently configured index actions.
  syntax:
    return:
      type:
      - List[IndexAction]
  type: attribute
  uid: azure.search.IndexDocumentsBatch.actions
- class: azure.search.IndexDocumentsBatch
  fullName: azure.search.IndexDocumentsBatch.add_delete_documents
  langs:
  - python
  module: azure.search
  name: add_delete_documents(*documents)
  summary: 'Add documents to delete to the Azure search index.


    Delete removes the specified document from the index. Any field you

    specify in a delete operation, other than the key field, will be

    ignored. If you want to remove an individual field from a document, use

    *merge_documents* instead and set the field explicitly to None.


    Delete operations are idempotent. That is, even if a document key does

    not exist in the index, attempting a delete operation with that key will

    result in a 200 status code.'
  syntax:
    content: add_delete_documents(*documents)
    parameters:
    - description: 'Documents to delete from an Azure search index. May be

        a single list of documents, or documents as individual parameters.'
      id: documents
      type:
      - dict
      - list[dict]
  type: method
  uid: azure.search.IndexDocumentsBatch.add_delete_documents
- class: azure.search.IndexDocumentsBatch
  fullName: azure.search.IndexDocumentsBatch.add_merge_documents
  langs:
  - python
  module: azure.search
  name: add_merge_documents(*documents)
  summary: 'Add documents to merge in to existing documets in the Azure search

    index.


    Merge updates an existing document with the specified fields. If the

    document doesn''t exist, the merge will fail. Any field you specify in a

    merge will replace the existing field in the document. This also applies

    to collections of primitive and complex types.'
  syntax:
    content: add_merge_documents(*documents)
    parameters:
    - description: 'Documents to merge into an Azure search index. May be

        a single list of documents, or documents as individual parameters.'
      id: documents
      type:
      - dict
      - list[dict]
  type: method
  uid: azure.search.IndexDocumentsBatch.add_merge_documents
- class: azure.search.IndexDocumentsBatch
  fullName: azure.search.IndexDocumentsBatch.add_merge_or_upload_documents
  langs:
  - python
  module: azure.search
  name: add_merge_or_upload_documents(*documents)
  summary: 'Add documents to merge in to existing documets in the Azure search

    index, or upload if they do not yet exist.


    This action behaves like *merge* if a document with the given key

    already exists in the index. If the document does not exist, it behaves

    like *upload* with a new document.'
  syntax:
    content: add_merge_or_upload_documents(*documents)
    parameters:
    - description: 'Documents to merge or uplaod into an Azure search

        index. May be a single list of documents, or documents as individual

        parameters.'
      id: documents
      type:
      - dict
      - list[dict]
  type: method
  uid: azure.search.IndexDocumentsBatch.add_merge_or_upload_documents
- class: azure.search.IndexDocumentsBatch
  fullName: azure.search.IndexDocumentsBatch.add_upload_documents
  langs:
  - python
  module: azure.search
  name: add_upload_documents(*documents)
  summary: 'Add documents to upload to the Azure search index.


    An upload action is similar to an "upsert" where the document will be

    inserted if it is new and updated/replaced if it exists. All fields are

    replaced in the update case.'
  syntax:
    content: add_upload_documents(*documents)
    parameters:
    - description: 'Documents to upload to an Azure search index. May be

        a single list of documents, or documents as individual parameters.'
      id: documents
      type:
      - dict
      - list[dict]
  type: method
  uid: azure.search.IndexDocumentsBatch.add_upload_documents
references:
- fullName: azure.search.IndexDocumentsBatch.actions
  isExternal: false
  name: actions
  parent: azure.search.IndexDocumentsBatch
  uid: azure.search.IndexDocumentsBatch.actions
- fullName: azure.search.IndexDocumentsBatch.add_delete_documents
  isExternal: false
  name: add_delete_documents(*documents)
  parent: azure.search.IndexDocumentsBatch
  uid: azure.search.IndexDocumentsBatch.add_delete_documents
- fullName: azure.search.IndexDocumentsBatch.add_merge_documents
  isExternal: false
  name: add_merge_documents(*documents)
  parent: azure.search.IndexDocumentsBatch
  uid: azure.search.IndexDocumentsBatch.add_merge_documents
- fullName: azure.search.IndexDocumentsBatch.add_merge_or_upload_documents
  isExternal: false
  name: add_merge_or_upload_documents(*documents)
  parent: azure.search.IndexDocumentsBatch
  uid: azure.search.IndexDocumentsBatch.add_merge_or_upload_documents
- fullName: azure.search.IndexDocumentsBatch.add_upload_documents
  isExternal: false
  name: add_upload_documents(*documents)
  parent: azure.search.IndexDocumentsBatch
  uid: azure.search.IndexDocumentsBatch.add_upload_documents
- fullName: List[IndexAction]
  name: List[IndexAction]
  spec.python:
  - fullName: List
    name: List
    uid: List
  - fullName: '['
    name: '['
  - fullName: IndexAction
    name: IndexAction
    uid: IndexAction
  - fullName: ']'
    name: ']'
  uid: List[IndexAction]
- fullName: list[dict]
  name: list[dict]
  spec.python:
  - fullName: list
    name: list
    uid: list
  - fullName: '['
    name: '['
  - fullName: dict
    name: dict
    uid: dict
  - fullName: ']'
    name: ']'
  uid: list[dict]