Helper documentation tweaks
This commit is contained in:
@@ -1,3 +1,5 @@
|
|||||||
|
.. _api:
|
||||||
|
|
||||||
API Documentation
|
API Documentation
|
||||||
=================
|
=================
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
.. _helpers:
|
||||||
|
|
||||||
Helpers
|
Helpers
|
||||||
=======
|
=======
|
||||||
|
|
||||||
|
|||||||
@@ -51,6 +51,11 @@ Example Usage
|
|||||||
Features
|
Features
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
This client was designed as very thin wrapper around Elasticseach's REST API to
|
||||||
|
allow for maximum flexibility. This means that there are no opinions in this
|
||||||
|
client; it also means that some of the APIs are a little cumbersome to use from
|
||||||
|
Python. We have created some :ref:`helpers` to help with this issue.
|
||||||
|
|
||||||
Extendability
|
Extendability
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,8 @@ def bulk_index(client, docs, chunk_size=500, stats_only=False, **kwargs):
|
|||||||
{
|
{
|
||||||
'_index': 'index-name',
|
'_index': 'index-name',
|
||||||
'_type': 'document',
|
'_type': 'document',
|
||||||
'_parent': '5',
|
'_id': 42,
|
||||||
|
'_parent': 5,
|
||||||
'_ttl': '1d',
|
'_ttl': '1d',
|
||||||
'_source': {
|
'_source': {
|
||||||
...
|
...
|
||||||
|
|||||||
Reference in New Issue
Block a user