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 2a3e69e7 publish documentation
2a3e69e7 is described below
commit 2a3e69e74ea5e66b3c3fed2243d103df1095b01b
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Jun 13 18:39:53 2023 +0000
publish documentation
---
main/genindex.html | 2 ++
main/objects.inv | Bin 7469 -> 7476 bytes
main/python/api/adbc_driver_flightsql.html | 2 +-
main/python/api/adbc_driver_manager.html | 41 ++++++++++++++++++++--------
main/python/api/adbc_driver_postgresql.html | 16 ++++++++++-
main/python/api/adbc_driver_sqlite.html | 2 +-
main/searchindex.js | 2 +-
7 files changed, 49 insertions(+), 16 deletions(-)
diff --git a/main/genindex.html b/main/genindex.html
index d8760320..46829bf1 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -821,6 +821,8 @@
<li><a
href="python/api/adbc_driver_manager.html#adbc_driver_manager.AdbcStatement.execute_update">execute_update()
(adbc_driver_manager.AdbcStatement method)</a>
</li>
<li><a
href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Cursor.executemany">executemany()
(adbc_driver_manager.dbapi.Cursor method)</a>
+</li>
+ <li><a
href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Cursor.executescript">executescript()
(adbc_driver_manager.dbapi.Cursor method)</a>
</li>
</ul></td>
</tr></table>
diff --git a/main/objects.inv b/main/objects.inv
index 3f7e1400..660f0e31 100644
Binary files a/main/objects.inv and b/main/objects.inv differ
diff --git a/main/python/api/adbc_driver_flightsql.html
b/main/python/api/adbc_driver_flightsql.html
index 6a7f53fd..6805b7df 100644
--- a/main/python/api/adbc_driver_flightsql.html
+++ b/main/python/api/adbc_driver_flightsql.html
@@ -526,7 +526,7 @@ floating-point seconds).</p>
<p>DBAPI 2.0-compatible facade for the ADBC Arrow Flight SQL driver.</p>
<dl class="py function">
<dt class="sig sig-object py" id="adbc_driver_flightsql.dbapi.connect">
-<span class="sig-prename descclassname"><span
class="pre">adbc_driver_flightsql.dbapi.</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>, <em class="sig-param"><span class="n"><span
class="pre">db_kwargs</span></span><span [...]
+<span class="sig-prename descclassname"><span
class="pre">adbc_driver_flightsql.dbapi.</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>, <em class="sig-param"><span class="n"><span
class="pre">db_kwargs</span></span><span [...]
<dd><p>Connect to a Flight SQL backend via ADBC.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
diff --git a/main/python/api/adbc_driver_manager.html
b/main/python/api/adbc_driver_manager.html
index 545eed5f..9779517f 100644
--- a/main/python/api/adbc_driver_manager.html
+++ b/main/python/api/adbc_driver_manager.html
@@ -1027,7 +1027,7 @@ depends on the driver.</p>
<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this
heading">#</a></h3>
<dl class="py function">
<dt class="sig sig-object py" id="adbc_driver_manager.dbapi.connect">
-<span class="sig-prename descclassname"><span
class="pre">adbc_driver_manager.dbapi.</span></span><span class="sig-name
descname"><span class="pre">connect</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="o"><span
class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span
class="pre">driver</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em>, <em cl [...]
+<span class="sig-prename descclassname"><span
class="pre">adbc_driver_manager.dbapi.</span></span><span class="sig-name
descname"><span class="pre">connect</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="o"><span
class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span
class="pre">driver</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em>, <em cl [...]
<dd><p>Connect to a database via ADBC.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -1046,6 +1046,10 @@ database.</p>
<dt><strong>conn_kwargs</strong></dt><dd><p>Key-value parameters to pass to
the driver to initialize the
connection.</p>
</dd>
+<dt><strong>autocommit</strong></dt><dd><p>Whether to enable autocommit. For
compliance with DB-API,
+this is disabled by default. A warning will be emitted if it
+cannot be disabled.</p>
+</dd>
</dl>
</dd>
</dl>
@@ -1074,7 +1078,7 @@ connection.</p>
<h3>Classes<a class="headerlink" href="#id2" title="Permalink to this
heading">#</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="adbc_driver_manager.dbapi.Connection">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-prename descclassname"><span
class="pre">adbc_driver_manager.dbapi.</span></span><span class="sig-name
descname"><span class="pre">Connection</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">db</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">Union</span><span class="p">< [...]
+<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-prename descclassname"><span
class="pre">adbc_driver_manager.dbapi.</span></span><span class="sig-name
descname"><span class="pre">Connection</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">db</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">Union</span><span class="p">< [...]
<dd><p>Bases: <code class="xref py py-class docutils literal
notranslate"><span class="pre">_Closeable</span></code></p>
<p>A DB-API 2.0 (PEP 249) connection.</p>
<p>Do not create this object directly; use connect().</p>
@@ -1291,34 +1295,37 @@ connections.</p>
<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.executemany"
title="adbc_driver_manager.dbapi.Cursor.executemany"><code class="xref py
py-obj docutils literal notranslate"><span
class="pre">executemany</span></code></a>(operation, seq_of_parameters)</p></td>
<td><p>Execute a query with multiple parameter sets.</p></td>
</tr>
-<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetch_arrow_table"
title="adbc_driver_manager.dbapi.Cursor.fetch_arrow_table"><code class="xref py
py-obj docutils literal notranslate"><span
class="pre">fetch_arrow_table</span></code></a>()</p></td>
+<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.executescript"
title="adbc_driver_manager.dbapi.Cursor.executescript"><code class="xref py
py-obj docutils literal notranslate"><span
class="pre">executescript</span></code></a>(operation)</p></td>
+<td><p>Execute multiple statements.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetch_arrow_table"
title="adbc_driver_manager.dbapi.Cursor.fetch_arrow_table"><code class="xref py
py-obj docutils literal notranslate"><span
class="pre">fetch_arrow_table</span></code></a>()</p></td>
<td><p>Fetch all rows of the result as a PyArrow Table.</p></td>
</tr>
-<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetch_df"
title="adbc_driver_manager.dbapi.Cursor.fetch_df"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">fetch_df</span></code></a>()</p></td>
+<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetch_df"
title="adbc_driver_manager.dbapi.Cursor.fetch_df"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">fetch_df</span></code></a>()</p></td>
<td><p>Fetch all rows of the result as a Pandas DataFrame.</p></td>
</tr>
-<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetchall"
title="adbc_driver_manager.dbapi.Cursor.fetchall"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">fetchall</span></code></a>()</p></td>
+<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetchall"
title="adbc_driver_manager.dbapi.Cursor.fetchall"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">fetchall</span></code></a>()</p></td>
<td><p>Fetch all rows of the result.</p></td>
</tr>
-<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetchallarrow"
title="adbc_driver_manager.dbapi.Cursor.fetchallarrow"><code class="xref py
py-obj docutils literal notranslate"><span
class="pre">fetchallarrow</span></code></a>()</p></td>
+<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetchallarrow"
title="adbc_driver_manager.dbapi.Cursor.fetchallarrow"><code class="xref py
py-obj docutils literal notranslate"><span
class="pre">fetchallarrow</span></code></a>()</p></td>
<td><p>Fetch all rows of the result as a PyArrow Table.</p></td>
</tr>
-<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetchmany"
title="adbc_driver_manager.dbapi.Cursor.fetchmany"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">fetchmany</span></code></a>([size])</p></td>
+<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetchmany"
title="adbc_driver_manager.dbapi.Cursor.fetchmany"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">fetchmany</span></code></a>([size])</p></td>
<td><p>Fetch some rows of the result.</p></td>
</tr>
-<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetchone"
title="adbc_driver_manager.dbapi.Cursor.fetchone"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">fetchone</span></code></a>()</p></td>
+<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetchone"
title="adbc_driver_manager.dbapi.Cursor.fetchone"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">fetchone</span></code></a>()</p></td>
<td><p>Fetch one row of the result.</p></td>
</tr>
-<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.next"
title="adbc_driver_manager.dbapi.Cursor.next"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">next</span></code></a>()</p></td>
+<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.next"
title="adbc_driver_manager.dbapi.Cursor.next"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">next</span></code></a>()</p></td>
<td><p>Fetch the next row, or raise StopIteration.</p></td>
</tr>
-<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.nextset"
title="adbc_driver_manager.dbapi.Cursor.nextset"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">nextset</span></code></a>()</p></td>
+<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.nextset"
title="adbc_driver_manager.dbapi.Cursor.nextset"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">nextset</span></code></a>()</p></td>
<td><p>Move to the next available result set (not supported).</p></td>
</tr>
-<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.setinputsizes"
title="adbc_driver_manager.dbapi.Cursor.setinputsizes"><code class="xref py
py-obj docutils literal notranslate"><span
class="pre">setinputsizes</span></code></a>(sizes)</p></td>
+<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.setinputsizes"
title="adbc_driver_manager.dbapi.Cursor.setinputsizes"><code class="xref py
py-obj docutils literal notranslate"><span
class="pre">setinputsizes</span></code></a>(sizes)</p></td>
<td><p>Preallocate memory for the parameters (no-op).</p></td>
</tr>
-<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.setoutputsize"
title="adbc_driver_manager.dbapi.Cursor.setoutputsize"><code class="xref py
py-obj docutils literal notranslate"><span
class="pre">setoutputsize</span></code></a>(size[, column])</p></td>
+<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.setoutputsize"
title="adbc_driver_manager.dbapi.Cursor.setoutputsize"><code class="xref py
py-obj docutils literal notranslate"><span
class="pre">setoutputsize</span></code></a>(size[, column])</p></td>
<td><p>Preallocate memory for the result set (no-op).</p></td>
</tr>
</tbody>
@@ -1480,6 +1487,15 @@ be executed once per row.</p>
</dl>
</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py"
id="adbc_driver_manager.dbapi.Cursor.executescript">
+<span class="sig-name descname"><span
class="pre">executescript</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">operation</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">→</span> <span
class="sig-return-typehint"><span class="pre">None</span></span>< [...]
+<dd><p>Execute multiple statements.</p>
+<p>If there is a pending transaction, commits first.</p>
+<p class="rubric">Notes</p>
+<p>This is an extension and not part of the DBAPI standard.</p>
+</dd></dl>
+
<dl class="py method">
<dt class="sig sig-object py"
id="adbc_driver_manager.dbapi.Cursor.fetch_arrow_table">
<span class="sig-name descname"><span
class="pre">fetch_arrow_table</span></span><span
class="sig-paren">(</span><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <span
class="sig-return-typehint"><a class="reference external"
href="https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table";
title="(in Apache Arrow v12.0.0)"><span
class="pre">Table</span></a></span></span><a class="headerlink"
href="#adbc_driver_m [...]
@@ -1831,6 +1847,7 @@ be executed once per row.</p>
<li><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.description"><code class="docutils
literal notranslate"><span class="pre">Cursor.description</span></code></a></li>
<li><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.execute"><code class="docutils literal
notranslate"><span class="pre">Cursor.execute()</span></code></a></li>
<li><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.executemany"><code class="docutils
literal notranslate"><span
class="pre">Cursor.executemany()</span></code></a></li>
+<li><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.executescript"><code class="docutils
literal notranslate"><span
class="pre">Cursor.executescript()</span></code></a></li>
<li><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetch_arrow_table"><code
class="docutils literal notranslate"><span
class="pre">Cursor.fetch_arrow_table()</span></code></a></li>
<li><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetch_df"><code class="docutils literal
notranslate"><span class="pre">Cursor.fetch_df()</span></code></a></li>
<li><a class="reference internal"
href="#adbc_driver_manager.dbapi.Cursor.fetchall"><code class="docutils literal
notranslate"><span class="pre">Cursor.fetchall()</span></code></a></li>
diff --git a/main/python/api/adbc_driver_postgresql.html
b/main/python/api/adbc_driver_postgresql.html
index 4901ff23..7f4535cd 100644
--- a/main/python/api/adbc_driver_postgresql.html
+++ b/main/python/api/adbc_driver_postgresql.html
@@ -334,8 +334,22 @@
<p>DBAPI 2.0-compatible facade for the ADBC libpq driver.</p>
<dl class="py function">
<dt class="sig sig-object py" id="adbc_driver_postgresql.dbapi.connect">
-<span class="sig-prename descclassname"><span
class="pre">adbc_driver_postgresql.dbapi.</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 [...]
+<span class="sig-prename descclassname"><span
class="pre">adbc_driver_postgresql.dbapi.</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>, <em class="sig-param"><span class="n"><span
class="pre">db_kwargs</span></span><span [...]
<dd><p>Connect to PostgreSQL via ADBC.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><dl class="simple">
+<dt><strong>uri</strong><span class="classifier">str</span></dt><dd><p>The URI
to connect to.</p>
+</dd>
+<dt><strong>db_kwargs</strong><span class="classifier">dict,
optional</span></dt><dd><p>Initial database connection parameters.</p>
+</dd>
+<dt><strong>conn_kwargs</strong><span class="classifier">dict,
optional</span></dt><dd><p>Connection-specific parameters. (ADBC
differentiates between
+a ‘database’ object shared between multiple ‘connection’
+objects.)</p>
+</dd>
+</dl>
+</dd>
+</dl>
</dd></dl>
</section>
diff --git a/main/python/api/adbc_driver_sqlite.html
b/main/python/api/adbc_driver_sqlite.html
index 2ff4430e..26407f66 100644
--- a/main/python/api/adbc_driver_sqlite.html
+++ b/main/python/api/adbc_driver_sqlite.html
@@ -348,7 +348,7 @@
<p>DBAPI 2.0-compatible facade for the ADBC SQLite driver.</p>
<dl class="py function">
<dt class="sig sig-object py" id="adbc_driver_sqlite.dbapi.connect">
-<span class="sig-prename descclassname"><span
class="pre">adbc_driver_sqlite.dbapi.</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">Optional</span><span class="p"><span
class="pre">[</span></span><span class="pre">str</span><span class="p"><spa
[...]
+<span class="sig-prename descclassname"><span
class="pre">adbc_driver_sqlite.dbapi.</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">Optional</span><span class="p"><span
class="pre">[</span></span><span class="pre">str</span><span class="p"><spa
[...]
<dd><p>Connect to SQLite via ADBC.</p>
</dd></dl>
diff --git a/main/searchindex.js b/main/searchindex.js
index 7145029a..2c481b06 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",
"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_driver_flightsql", "p [...]
\ 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",
"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_driver_flightsql", "p [...]
\ No newline at end of file
