diff --git a/docs/transports.rst b/docs/transports.rst new file mode 100644 index 00000000..b4ab4e8e --- /dev/null +++ b/docs/transports.rst @@ -0,0 +1,39 @@ +Transport classes +================= + +List of transport classes that can be used, simply import your choice and pass +it to the constructor of :class:`~elasticsearch.Elasticsearch` as +`connection_class`. Note that Thrift and Memcached protocols are experimental +and require a plugin to be installed in your cluster as well as additional +dependencies (`thrift==0.9` and `pylibmc==1.2`). + +.. py:module:: elasticsearch.connection + +Connection +---------- + +.. autoclass:: Connection + +Urllib3HttpConnection +--------------------- + +.. autoclass:: Urllib3HttpConnection + + +RequestsHttpConnection +---------------------- + +.. autoclass:: RequestsHttpConnection + + +ThriftConnection +---------------- + +.. autoclass:: ThriftConnection + + +MemcachedConnection +------------------- + +.. autoclass:: MemcachedConnection +