Connection Layer docs

This commit is contained in:
Honza Kral
2013-09-24 15:49:38 +02:00
parent ac4b9cf3ab
commit 4477895b42
2 changed files with 18 additions and 1 deletions
+17
View File
@@ -1,6 +1,16 @@
Connection Layer API
====================
All of the classes reponsible for handling the connection to the Elasticsearch
cluster. The default subclasses used can be overriden by passing parameters to the
:class:`~elasticsearch.Elasticsearch` class. All of the arguments to the client
will be passed on to :class:`~elasticsearch.Transport`,
:class:`~elasticsearch.ConnectionPool` and :class:`~elasticsearch.Connection`.
For example if you wanted to use your own implementation of the
:class:`~elasticsearch.ConnectionSelector` class you can just pass in the
`selector_class` parameter.
.. py:module:: elasticsearch
Transport
@@ -17,6 +27,13 @@ Connection Pool
:members:
Connection Selector
-------------------
.. autoclass:: ConnectionSelector(opts)
:members:
Connection
----------