pool/api.html

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>API &mdash; clickhouse-pool 0.6.1 documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="_static/documentation_options.js?v=2bd037f0"></script>
        <script src="_static/doctools.js?v=9a2dae69"></script>
        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="prev" title="Introduction" href="introduction.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="index.html" class="icon icon-home">
            clickhouse-pool
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#module-clickhouse_pool">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#clickhouse_pool.ChPool"><code class="docutils literal notranslate"><span class="pre">ChPool</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#clickhouse_pool.ChPool.connections_min"><code class="docutils literal notranslate"><span class="pre">ChPool.connections_min</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#clickhouse_pool.ChPool.connections_max"><code class="docutils literal notranslate"><span class="pre">ChPool.connections_max</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#clickhouse_pool.ChPool.closed"><code class="docutils literal notranslate"><span class="pre">ChPool.closed</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#clickhouse_pool.ChPool.cleanup"><code class="docutils literal notranslate"><span class="pre">ChPool.cleanup()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#clickhouse_pool.ChPool.get_client"><code class="docutils literal notranslate"><span class="pre">ChPool.get_client()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#clickhouse_pool.ChPool.pull"><code class="docutils literal notranslate"><span class="pre">ChPool.pull()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#clickhouse_pool.ChPool.push"><code class="docutils literal notranslate"><span class="pre">ChPool.push()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">clickhouse-pool</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">API</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/api.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="api">
<h1>API<a class="headerlink" href="#api" title="Link to this heading">¶</a></h1>
<section id="module-clickhouse_pool">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-clickhouse_pool" title="Link to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="clickhouse_pool.ChPool">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">clickhouse_pool.</span></span><span class="sig-name descname"><span class="pre">ChPool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/clickhouse_pool/pool.html#ChPool"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#clickhouse_pool.ChPool" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A ChPool is a pool of connections (Clients) to a ClickhouseServer.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="clickhouse_pool.ChPool.connections_min">
<span class="sig-name descname"><span class="pre">connections_min</span></span><a class="headerlink" href="#clickhouse_pool.ChPool.connections_min" title="Link to this definition">¶</a></dt>
<dd><p>minimum number of connections to keep open</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="clickhouse_pool.ChPool.connections_max">
<span class="sig-name descname"><span class="pre">connections_max</span></span><a class="headerlink" href="#clickhouse_pool.ChPool.connections_max" title="Link to this definition">¶</a></dt>
<dd><p>maximum number of connections allowed open</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="clickhouse_pool.ChPool.closed">
<span class="sig-name descname"><span class="pre">closed</span></span><a class="headerlink" href="#clickhouse_pool.ChPool.closed" title="Link to this definition">¶</a></dt>
<dd><p>if closed the pool has no connections and cannot be used</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="clickhouse_pool.ChPool.cleanup">
<span class="sig-name descname"><span class="pre">cleanup</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/clickhouse_pool/pool.html#ChPool.cleanup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#clickhouse_pool.ChPool.cleanup" title="Link to this definition">¶</a></dt>
<dd><p>Close all open connections in the pool.</p>
<p>This method loops through eveery client and calls disconnect.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="clickhouse_pool.ChPool.get_client">
<span class="sig-name descname"><span class="pre">get_client</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Generator</span><span class="p"><span class="pre">[</span></span><span class="pre">Client</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/clickhouse_pool/pool.html#ChPool.get_client"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#clickhouse_pool.ChPool.get_client" title="Link to this definition">¶</a></dt>
<dd><p>A clean way to grab a client via a contextmanager.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>key</strong> – If known, the key of the client to grab.</p>
</dd>
<dt class="field-even">Yields<span class="colon">:</span></dt>
<dd class="field-even"><p><em>Client</em> – a clickhouse-driver client</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="clickhouse_pool.ChPool.pull">
<span class="sig-name descname"><span class="pre">pull</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Client</span></span></span><a class="reference internal" href="_modules/clickhouse_pool/pool.html#ChPool.pull"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#clickhouse_pool.ChPool.pull" title="Link to this definition">¶</a></dt>
<dd><p>Get an available client from the pool.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>key</strong> – If known, the key of the client you would like.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A clickhouse-driver client.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="clickhouse_pool.ChPool.push">
<span class="sig-name descname"><span class="pre">push</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Client</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">close</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/clickhouse_pool/pool.html#ChPool.push"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#clickhouse_pool.ChPool.push" title="Link to this definition">¶</a></dt>
<dd><p>Return a client to the pool for reuse.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>client</strong> – The client to return.</p></li>
<li><p><strong>key</strong> – If known, the key of the client.</p></li>
<li><p><strong>close</strong> – Close the client instead of adding back to pool.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="introduction.html" class="btn btn-neutral float-left" title="Introduction" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2020, Eric McCarthy.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>