This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-adbc.git
The following commit(s) were added to refs/heads/asf-site by this push:
new f126aa4a publish documentation
f126aa4a is described below
commit f126aa4ab1b14567a1d4ee85f03052c8370e6618
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Jul 11 15:18:33 2023 +0000
publish documentation
---
.../python/api/adbc_driver_postgresql.rst.txt | 4 ++--
main/genindex.html | 10 +++++++---
main/objects.inv | Bin 4315 -> 4341 bytes
main/python/api/adbc_driver_postgresql.html | 19 +++++++++++++++++++
main/searchindex.js | 2 +-
5 files changed, 29 insertions(+), 6 deletions(-)
diff --git a/main/_sources/python/api/adbc_driver_postgresql.rst.txt
b/main/_sources/python/api/adbc_driver_postgresql.rst.txt
index 397f979a..d7c07e91 100644
--- a/main/_sources/python/api/adbc_driver_postgresql.rst.txt
+++ b/main/_sources/python/api/adbc_driver_postgresql.rst.txt
@@ -25,8 +25,8 @@ Low-Level API
=============
.. automodule:: adbc_driver_postgresql
-
-.. autofunction:: adbc_driver_postgresql.connect
+ :members:
+ :undoc-members:
DBAPI 2.0 API
=============
diff --git a/main/genindex.html b/main/genindex.html
index 54db36fa..deb1a357 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -563,10 +563,12 @@
<td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="python/api/adbc_driver_sqlite.html#adbc_driver_sqlite.StatementOptions.BATCH_ROWS">BATCH_ROWS
(adbc_driver_sqlite.StatementOptions attribute)</a>
</li>
- <li><a
href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.BINARY">BINARY
(in module adbc_driver_manager.dbapi)</a>
+ <li><a
href="python/api/adbc_driver_postgresql.html#adbc_driver_postgresql.StatementOptions.BATCH_SIZE_HINT_BYTES">BATCH_SIZE_HINT_BYTES
(adbc_driver_postgresql.StatementOptions attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
+ <li><a
href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.BINARY">BINARY
(in module adbc_driver_manager.dbapi)</a>
+</li>
<li><a
href="python/api/adbc_driver_manager.html#adbc_driver_manager.AdbcStatement.bind">bind()
(adbc_driver_manager.AdbcStatement method)</a>
</li>
<li><a
href="python/api/adbc_driver_manager.html#adbc_driver_manager.AdbcStatement.bind_stream">bind_stream()
(adbc_driver_manager.AdbcStatement method)</a>
@@ -892,16 +894,18 @@
</li>
<li><a
href="python/api/adbc_driver_manager.html#adbc_driver_manager.AdbcStatement.set_substrait_plan">set_substrait_plan()
(adbc_driver_manager.AdbcStatement method)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Cursor.setinputsizes">setinputsizes()
(adbc_driver_manager.dbapi.Cursor method)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Cursor.setoutputsize">setoutputsize()
(adbc_driver_manager.dbapi.Cursor method)</a>
</li>
<li><a
href="python/api/adbc_driver_flightsql.html#adbc_driver_flightsql.StatementOptions">StatementOptions
(class in adbc_driver_flightsql)</a>
<ul>
<li><a
href="python/api/adbc_driver_manager.html#adbc_driver_manager.StatementOptions">(class
in adbc_driver_manager)</a>
+</li>
+ <li><a
href="python/api/adbc_driver_postgresql.html#adbc_driver_postgresql.StatementOptions">(class
in adbc_driver_postgresql)</a>
</li>
<li><a
href="python/api/adbc_driver_sqlite.html#adbc_driver_sqlite.StatementOptions">(class
in adbc_driver_sqlite)</a>
</li>
diff --git a/main/objects.inv b/main/objects.inv
index 1d1e55d6..8915717c 100644
Binary files a/main/objects.inv and b/main/objects.inv differ
diff --git a/main/python/api/adbc_driver_postgresql.html
b/main/python/api/adbc_driver_postgresql.html
index 8ac3bab9..6bc9a25d 100644
--- a/main/python/api/adbc_driver_postgresql.html
+++ b/main/python/api/adbc_driver_postgresql.html
@@ -323,6 +323,21 @@
<h1><code class="docutils literal notranslate"><span
class="pre">adbc_driver_postgresql</span></code><a class="headerlink"
href="#adbc-driver-postgresql" title="Permalink to this heading">#</a></h1>
<section id="module-adbc_driver_postgresql">
<span id="low-level-api"></span><h2>Low-Level API<a class="headerlink"
href="#module-adbc_driver_postgresql" title="Permalink to this
heading">#</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="adbc_driver_postgresql.StatementOptions">
+<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-prename descclassname"><span
class="pre">adbc_driver_postgresql.</span></span><span class="sig-name
descname"><span class="pre">StatementOptions</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">value</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">names</span></span><span class="o"><span
class="pre">=</span></span [...]
+<dd><p>Bases: <code class="xref py py-class docutils literal
notranslate"><span class="pre">Enum</span></code></p>
+<p>Statement options specific to the PostgreSQL driver.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py"
id="adbc_driver_postgresql.StatementOptions.BATCH_SIZE_HINT_BYTES">
+<span class="sig-name descname"><span
class="pre">BATCH_SIZE_HINT_BYTES</span></span><em class="property"><span
class="w"> </span><span class="p"><span class="pre">=</span></span><span
class="w"> </span><span
class="pre">'adbc.postgresql.batch_size_hint_bytes'</span></em><a
class="headerlink"
href="#adbc_driver_postgresql.StatementOptions.BATCH_SIZE_HINT_BYTES"
title="Permalink to this definition">#</a></dt>
+<dd><p>Try to limit returned batches to this size (in bytes).</p>
+<p>This is merely a hint, and because the size is estimated, the
+actual size may differ.</p>
+</dd></dl>
+
+</dd></dl>
+
<dl class="py function">
<dt class="sig sig-object py" id="adbc_driver_postgresql.connect">
<span class="sig-prename descclassname"><span
class="pre">adbc_driver_postgresql.</span></span><span class="sig-name
descname"><span class="pre">connect</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">uri</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon"> [...]
@@ -413,6 +428,10 @@ objects.)</p>
<ul>
<li><a class="reference internal" href="#"><code class="docutils literal
notranslate"><span class="pre">adbc_driver_postgresql</span></code></a><ul>
<li><a class="reference internal"
href="#module-adbc_driver_postgresql">Low-Level API</a><ul>
+<li><a class="reference internal"
href="#adbc_driver_postgresql.StatementOptions"><code class="docutils literal
notranslate"><span class="pre">StatementOptions</span></code></a><ul>
+<li><a class="reference internal"
href="#adbc_driver_postgresql.StatementOptions.BATCH_SIZE_HINT_BYTES"><code
class="docutils literal notranslate"><span
class="pre">StatementOptions.BATCH_SIZE_HINT_BYTES</span></code></a></li>
+</ul>
+</li>
<li><a class="reference internal" href="#adbc_driver_postgresql.connect"><code
class="docutils literal notranslate"><span
class="pre">connect()</span></code></a></li>
</ul>
</li>
diff --git a/main/searchindex.js b/main/searchindex.js
index 1af5d392..133fb07e 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["cpp/api/adbc", "cpp/api/adbc_driver_manager",
"cpp/api/index", "cpp/concurrency", "cpp/driver_manager", "cpp/index",
"cpp/quickstart", "development/contributing", "development/nightly",
"development/releasing", "driver/flight_sql", "driver/installation",
"driver/jdbc", "driver/postgresql", "driver/snowflake", "driver/sqlite",
"driver/status", "faq", "format/comparison", "format/specification",
"format/versioning", "index", "java/index", "python/api/adbc_dri [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["cpp/api/adbc", "cpp/api/adbc_driver_manager",
"cpp/api/index", "cpp/concurrency", "cpp/driver_manager", "cpp/index",
"cpp/quickstart", "development/contributing", "development/nightly",
"development/releasing", "driver/flight_sql", "driver/installation",
"driver/jdbc", "driver/postgresql", "driver/snowflake", "driver/sqlite",
"driver/status", "faq", "format/comparison", "format/specification",
"format/versioning", "index", "java/index", "python/api/adbc_dri [...]
\ No newline at end of file
