From b7cba71be62addb5f7bb1aa14cb3d0a674d1ed1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Honza=20Kr=C3=A1l?= Date: Thu, 9 Jun 2016 11:21:00 +0200 Subject: [PATCH] Explain differences between urllib3 and requests backends Fixes #402 --- docs/transports.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/transports.rst b/docs/transports.rst index c55155b2..2bef83b9 100644 --- a/docs/transports.rst +++ b/docs/transports.rst @@ -14,6 +14,11 @@ For example to use the ``requests``-based connection just import it and use it:: from elasticsearch import Elasticsearch, RequestsHttpConnection es = Elasticsearch(connection_class=RequestsHttpConnection) +The default connection class is based on ``urllib3`` which is more performant +and lightweight than the optional ``requests``-based class. Only use +``RequestsHttpConnection`` if you have need of any of ``requests`` advanced +features like custom auth plugins etc. + .. py:module:: elasticsearch.connection