python-elasticsearch-doc 1.2.0-1 / usr / share / doc / python-elasticsearch-doc / html / transports.html

This file is indexed.

/usr/share/doc/python-elasticsearch-doc/html/transports.html is in python-elasticsearch-doc 1.2.0-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Transport classes &mdash; Elasticsearch 1.2.0 documentation</title>
    
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '1.2.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="Elasticsearch 1.2.0 documentation" href="index.html" />
    <link rel="next" title="Helpers" href="helpers.html" />
    <link rel="prev" title="Connection Layer API" href="connection.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="helpers.html" title="Helpers"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="connection.html" title="Connection Layer API"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Elasticsearch 1.2.0 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="transport-classes">
<span id="transports"></span><h1>Transport classes<a class="headerlink" href="#transport-classes" title="Permalink to this headline"></a></h1>
<p>List of transport classes that can be used, simply import your choice and pass
it to the constructor of <a class="reference internal" href="api.html#elasticsearch.Elasticsearch" title="elasticsearch.Elasticsearch"><tt class="xref py py-class docutils literal"><span class="pre">Elasticsearch</span></tt></a> as
<cite>connection_class</cite>. Note that Thrift and Memcached protocols are experimental
and require a plugin to be installed in your cluster as well as additional
dependencies (<cite>thrift==0.9</cite> and <cite>pylibmc==1.2</cite>).</p>
<p>For example to use the thrift connection just import it and use it. The
connection classes are aware of their respective default ports (9500 for
thrift) so there is no need to specify them unless modified:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">elasticsearch</span> <span class="kn">import</span> <span class="n">Elasticsearch</span><span class="p">,</span> <span class="n">ThriftConnection</span>
<span class="n">es</span> <span class="o">=</span> <span class="n">Elasticsearch</span><span class="p">(</span><span class="n">connection_class</span><span class="o">=</span><span class="n">ThriftConnection</span><span class="p">)</span>
</pre></div>
</div>
<span class="target" id="module-elasticsearch.connection"></span><div class="section" id="connection">
<h2>Connection<a class="headerlink" href="#connection" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="elasticsearch.connection.Connection">
<em class="property">class </em><tt class="descclassname">elasticsearch.connection.</tt><tt class="descname">Connection</tt><big>(</big><em>host='localhost'</em>, <em>port=9200</em>, <em>url_prefix=''</em>, <em>timeout=10</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.connection.Connection" title="Permalink to this definition"></a></dt>
<dd><p>Class responsible for maintaining a connection to an Elasticsearch node. It
holds persistent connection pool to it and it&#8217;s main interface
(<cite>perform_request</cite>) is thread-safe.</p>
<p>Also responsible for logging.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>host</strong> &#8211; hostname of the node (default: localhost)</li>
<li><strong>port</strong> &#8211; port to use (default: 9200)</li>
<li><strong>url_prefix</strong> &#8211; optional url prefix for elasticsearch</li>
<li><strong>timeout</strong> &#8211; default timeout in seconds (default: 10)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
<div class="section" id="urllib3httpconnection">
<h2>Urllib3HttpConnection<a class="headerlink" href="#urllib3httpconnection" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="elasticsearch.connection.Urllib3HttpConnection">
<em class="property">class </em><tt class="descclassname">elasticsearch.connection.</tt><tt class="descname">Urllib3HttpConnection</tt><big>(</big><em>host='localhost'</em>, <em>port=9200</em>, <em>http_auth=None</em>, <em>use_ssl=False</em>, <em>maxsize=10</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.connection.Urllib3HttpConnection" title="Permalink to this definition"></a></dt>
<dd><p>Default connection class using the <cite>urllib3</cite> library and the http protocol.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>http_auth</strong> &#8211; optional http auth information as either &#8216;:&#8217; separated
string or a tuple</li>
<li><strong>use_ssl</strong> &#8211; use ssl for the connection if <cite>True</cite></li>
<li><strong>maxsize</strong> &#8211; the maximum number of connections which will be kept open to
this host.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
<div class="section" id="requestshttpconnection">
<h2>RequestsHttpConnection<a class="headerlink" href="#requestshttpconnection" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="elasticsearch.connection.RequestsHttpConnection">
<em class="property">class </em><tt class="descclassname">elasticsearch.connection.</tt><tt class="descname">RequestsHttpConnection</tt><big>(</big><em>host='localhost'</em>, <em>port=9200</em>, <em>http_auth=None</em>, <em>use_ssl=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.connection.RequestsHttpConnection" title="Permalink to this definition"></a></dt>
<dd><p>Connection using the <cite>requests</cite> library.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>http_auth</strong> &#8211; optional http auth information as either &#8216;:&#8217; separated
string or a tuple</li>
<li><strong>use_ssl</strong> &#8211; use ssl for the connection if <cite>True</cite></li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
<div class="section" id="thriftconnection">
<h2>ThriftConnection<a class="headerlink" href="#thriftconnection" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="elasticsearch.connection.ThriftConnection">
<em class="property">class </em><tt class="descclassname">elasticsearch.connection.</tt><tt class="descname">ThriftConnection</tt><big>(</big><em>host='localhost'</em>, <em>port=9500</em>, <em>framed_transport=False</em>, <em>use_ssl=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.connection.ThriftConnection" title="Permalink to this definition"></a></dt>
<dd><p>Connection using the <cite>thrift</cite> protocol to communicate with elasticsearch.</p>
<p>See <a class="reference external" href="https://github.com/elasticsearch/elasticsearch-transport-thrift">https://github.com/elasticsearch/elasticsearch-transport-thrift</a> for additional info.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>framed_transport</strong> &#8211; use <cite>TTransport.TFramedTransport</cite> instead of</td>
</tr>
</tbody>
</table>
<p><cite>TTransport.TBufferedTransport</cite></p>
</dd></dl>

</div>
<div class="section" id="memcachedconnection">
<h2>MemcachedConnection<a class="headerlink" href="#memcachedconnection" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="elasticsearch.connection.MemcachedConnection">
<em class="property">class </em><tt class="descclassname">elasticsearch.connection.</tt><tt class="descname">MemcachedConnection</tt><big>(</big><em>host='localhost'</em>, <em>port=11211</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.connection.MemcachedConnection" title="Permalink to this definition"></a></dt>
<dd><p>Client using the <cite>pylibmc</cite> python library to communicate with elasticsearch
using the memcached protocol. Requires plugin in the cluster.</p>
<p>See <a class="reference external" href="https://github.com/elasticsearch/elasticsearch-transport-memcached">https://github.com/elasticsearch/elasticsearch-transport-memcached</a> for more details.</p>
</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Transport classes</a><ul>
<li><a class="reference internal" href="#connection">Connection</a></li>
<li><a class="reference internal" href="#urllib3httpconnection">Urllib3HttpConnection</a></li>
<li><a class="reference internal" href="#requestshttpconnection">RequestsHttpConnection</a></li>
<li><a class="reference internal" href="#thriftconnection">ThriftConnection</a></li>
<li><a class="reference internal" href="#memcachedconnection">MemcachedConnection</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="connection.html"
                        title="previous chapter">Connection Layer API</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="helpers.html"
                        title="next chapter">Helpers</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/transports.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="helpers.html" title="Helpers"
             >next</a> |</li>
        <li class="right" >
          <a href="connection.html" title="Connection Layer API"
             >previous</a> |</li>
        <li><a href="index.html">Elasticsearch 1.2.0 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2013, Honza Král.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.