Honza Král
59 lines
986 B
ReStructuredText
59 lines
986 B
ReStructuredText
.. _api:
|
|
|
|
API Documentation
|
|
=================
|
|
|
|
.. note::
|
|
|
|
All the API calls map the raw REST api as closely as possible, including
|
|
the distinction between required and optional arguments to the calls. This
|
|
means that the code makes distinction between positional and keyword arguments;
|
|
we, however, recommend that people use keyword arguments for all calls for
|
|
consistency and safety.
|
|
|
|
.. note::
|
|
|
|
for compatibility with the Python ecosystem we use ``from_`` instead of
|
|
``from`` and ``doc_type`` instead of ``type`` as parameter names.
|
|
|
|
.. py:module:: elasticsearch
|
|
|
|
Elasticsearch
|
|
-------------
|
|
|
|
.. autoclass:: Elasticsearch
|
|
:members:
|
|
|
|
.. py:module:: elasticsearch.client
|
|
|
|
Indices
|
|
-------
|
|
|
|
.. autoclass:: IndicesClient
|
|
:members:
|
|
|
|
Cluster
|
|
-------
|
|
|
|
.. autoclass:: ClusterClient
|
|
:members:
|
|
|
|
Nodes
|
|
-----
|
|
|
|
.. autoclass:: NodesClient
|
|
:members:
|
|
|
|
Cat
|
|
---
|
|
|
|
.. autoclass:: CatClient
|
|
:members:
|
|
|
|
Snapshot
|
|
---
|
|
|
|
.. autoclass:: SnapshotClient
|
|
:members:
|
|
|