Skip to content

Commit

Permalink
Deploying to master from @ psycopg/psycopg-website@1d5551d 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
dvarrazzo committed Jun 17, 2024
1 parent 870cba0 commit e2a79b6
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions psycopg3/docs/_sources/advanced/prepare.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ PgBouncer__ middleware, using the following caveats:
- PgBouncer version must be version `1.22`__ or newer.
- PgBouncer `max_prepared_statements`__ must be greater than 0.
- The libpq version on the client must be from PostgreSQL 17 or newer
(you can check the `~Capabilities.has_pgbouncer_prepared` capability to
verify it).
(you can check the `~Capabilities.has_send_close_prepared()` capability to
verify that the libpq implements the features required by PgBouncer).

.. __: https://www.pgbouncer.org/
.. __: https://www.pgbouncer.org/2024/01/pgbouncer-1-22-0
Expand Down
2 changes: 1 addition & 1 deletion psycopg3/docs/_sources/api/objects.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ Libpq capabilities information
the legacy :pq:`PQcancel` implementation.

.. automethod:: has_stream_chunked
.. automethod:: has_pgbouncer_prepared
.. automethod:: has_send_close_prepared

.. seealso:: :ref:`pgbouncer`

Expand Down
4 changes: 2 additions & 2 deletions psycopg3/docs/advanced/prepare.html
Original file line number Diff line number Diff line change
Expand Up @@ -299,8 +299,8 @@
<li><p>PgBouncer version must be version <a class="reference external" href="https://www.pgbouncer.org/2024/01/pgbouncer-1-22-0">1.22</a> or newer.</p></li>
<li><p>PgBouncer <a class="reference external" href="https://www.pgbouncer.org/config.html#max_prepared_statements">max_prepared_statements</a> must be greater than 0.</p></li>
<li><p>The libpq version on the client must be from PostgreSQL 17 or newer
(you can check the <a class="reference internal" href="../api/objects.html#psycopg.Capabilities.has_pgbouncer_prepared" title="psycopg.Capabilities.has_pgbouncer_prepared"><code class="xref py py-obj docutils literal notranslate"><span class="pre">has_pgbouncer_prepared</span></code></a> capability to
verify it).</p></li>
(you can check the <a class="reference internal" href="../api/objects.html#psycopg.Capabilities.has_send_close_prepared" title="psycopg.Capabilities.has_send_close_prepared"><code class="xref py py-obj docutils literal notranslate"><span class="pre">has_send_close_prepared()</span></code></a> capability to
verify that the libpq implements the features required by PgBouncer).</p></li>
</ul>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
Expand Down
8 changes: 4 additions & 4 deletions psycopg3/docs/api/objects.html
Original file line number Diff line number Diff line change
Expand Up @@ -534,9 +534,9 @@ <h2>Connection information<a class="headerlink" href="#connection-information" t
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="psycopg.Capabilities.has_pgbouncer_prepared">
<span class="sig-name descname"><span class="pre">has_pgbouncer_prepared</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">check</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></span><a class="headerlink" href="#psycopg.Capabilities.has_pgbouncer_prepared" title="Permalink to this definition">#</a></dt>
<dd><p>Check if prepared statements in PgBouncer are supported.</p>
<dt class="sig sig-object py" id="psycopg.Capabilities.has_send_close_prepared">
<span class="sig-name descname"><span class="pre">has_send_close_prepared</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">check</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></span><a class="headerlink" href="#psycopg.Capabilities.has_send_close_prepared" title="Permalink to this definition">#</a></dt>
<dd><p>Check if the <code class="xref py py-obj docutils literal notranslate"><span class="pre">pq.PGconn.send_closed_prepared()</span></code> method is implemented.</p>
<p>The feature requires libpq 17.0 and greater.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
Expand Down Expand Up @@ -897,7 +897,7 @@ <h2>Two-Phase Commit related objects<a class="headerlink" href="#two-phase-commi
<li><a class="reference internal" href="#psycopg.Capabilities.has_set_trace_flags"><code class="docutils literal notranslate"><span class="pre">Capabilities.has_set_trace_flags()</span></code></a></li>
<li><a class="reference internal" href="#psycopg.Capabilities.has_cancel_safe"><code class="docutils literal notranslate"><span class="pre">Capabilities.has_cancel_safe()</span></code></a></li>
<li><a class="reference internal" href="#psycopg.Capabilities.has_stream_chunked"><code class="docutils literal notranslate"><span class="pre">Capabilities.has_stream_chunked()</span></code></a></li>
<li><a class="reference internal" href="#psycopg.Capabilities.has_pgbouncer_prepared"><code class="docutils literal notranslate"><span class="pre">Capabilities.has_pgbouncer_prepared()</span></code></a></li>
<li><a class="reference internal" href="#psycopg.Capabilities.has_send_close_prepared"><code class="docutils literal notranslate"><span class="pre">Capabilities.has_send_close_prepared()</span></code></a></li>
</ul>
</li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions psycopg3/docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -1031,10 +1031,10 @@ <h2>H</h2>
<li><a href="api/objects.html#psycopg.Capabilities.has_encrypt_password">has_encrypt_password() (psycopg.Capabilities method)</a>
</li>
<li><a href="api/objects.html#psycopg.Capabilities.has_hostaddr">has_hostaddr() (psycopg.Capabilities method)</a>
</li>
<li><a href="api/objects.html#psycopg.Capabilities.has_pgbouncer_prepared">has_pgbouncer_prepared() (psycopg.Capabilities method)</a>
</li>
<li><a href="api/objects.html#psycopg.Capabilities.has_pipeline">has_pipeline() (psycopg.Capabilities method)</a>
</li>
<li><a href="api/objects.html#psycopg.Capabilities.has_send_close_prepared">has_send_close_prepared() (psycopg.Capabilities method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
Expand Down
Binary file modified psycopg3/docs/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion psycopg3/docs/searchindex.js

Large diffs are not rendered by default.

0 comments on commit e2a79b6

Please sign in to comment.