actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Document the format of the body parameter for bulk operations, and correct a couple of typos in the documentation.

Browse Source
This commit is contained in:
Richard Boulton
2013-11-19 17:03:32 +00:00
parent 5557fbff1e
commit 7c84613abc
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
elasticsearch/client/__init__.py
+6 -3
View File
@@ -511,12 +511,14 @@ class Elasticsearch(object):
See the :func:`~elasticsearch.helpers.bulk_index` for a more friendly See the :func:`~elasticsearch.helpers.bulk_index` for a more friendly
API. API.
:arg body: The operation definition and data (action-data pairs) :arg body: The operation definition and data (action-data pairs), as
either a newline separated string, or a sequence of dicts to
serialize (one per row).
:arg index: Default index for items which don't provide one :arg index: Default index for items which don't provide one
:arg doc_type: Default document type for items which don't provide one :arg doc_type: Default document type for items which don't provide one
:arg consistency: Explicit write consistency setting for the operation :arg consistency: Explicit write consistency setting for the operation
:arg refresh: Refresh the index after performing the operation :arg refresh: Refresh the index after performing the operation
:arg replication: Explicitly set the replication type (efault: sync) :arg replication: Explicitly set the replication type (default: sync)
""" """
_, data = self.transport.perform_request('POST', _make_path(index, doc_type, '_bulk'), _, data = self.transport.perform_request('POST', _make_path(index, doc_type, '_bulk'),
params=params, body=self._bulk_body(body)) params=params, body=self._bulk_body(body))
@@ -529,7 +531,8 @@ class Elasticsearch(object):
`<http://www.elasticsearch.org/guide/reference/api/multi-search/>`_ `<http://www.elasticsearch.org/guide/reference/api/multi-search/>`_
:arg body: The request definitions (metadata-search request definition :arg body: The request definitions (metadata-search request definition
pairs), separated by newlines pairs), as either a newline separated string, or a sequence of
dicts to serialize (one per row).
:arg index: A comma-separated list of index names to use as default :arg index: A comma-separated list of index names to use as default
:arg doc_type: A comma-separated list of document types to use as default :arg doc_type: A comma-separated list of document types to use as default
:arg search_type: Search operation type :arg search_type: Search operation type