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 55fee32ca publish documentation
55fee32ca is described below
commit 55fee32ca0bd5736ba2400131bb521aa3dbd3776
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Mon Mar 10 22:49:45 2025 +0000
publish documentation
---
main/genindex.html | 6 ++++--
main/objects.inv | Bin 3118 -> 3128 bytes
main/python/api/adbc_driver_manager.html | 14 +++++++++++---
main/python/api/adbc_driver_postgresql.html | 9 +++++++++
main/r/adbcbigquery/pkgdown.yml | 2 +-
main/r/adbcdrivermanager/pkgdown.yml | 2 +-
.../reference/adbc_connection_init.html | 4 ++--
.../reference/adbc_database_init.html | 2 +-
.../reference/adbc_statement_init.html | 6 +++---
main/r/adbcdrivermanager/search.json | 2 +-
main/r/adbcflightsql/pkgdown.yml | 2 +-
main/r/adbcpostgresql/pkgdown.yml | 2 +-
main/r/adbcsnowflake/pkgdown.yml | 2 +-
main/r/adbcsqlite/pkgdown.yml | 2 +-
main/searchindex.js | 2 +-
15 files changed, 38 insertions(+), 19 deletions(-)
diff --git a/main/genindex.html b/main/genindex.html
index fdd74801a..fb387c75c 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -1256,11 +1256,13 @@
</li>
<li><a
href="python/api/adbc_driver_manager.html#adbc_driver_manager.AdbcStatusCode.UNAUTHORIZED">UNAUTHORIZED
(adbc_driver_manager.AdbcStatusCode 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.AdbcStatusCode.UNKNOWN">UNKNOWN
(adbc_driver_manager.AdbcStatusCode 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.DatabaseOptions.URI">URI
(adbc_driver_manager.DatabaseOptions attribute)</a>
+</li>
+ <li><a
href="python/api/adbc_driver_postgresql.html#adbc_driver_postgresql.StatementOptions.USE_COPY">USE_COPY
(adbc_driver_postgresql.StatementOptions attribute)</a>
</li>
<li><a
href="python/api/adbc_driver_manager.html#adbc_driver_manager.DatabaseOptions.USERNAME">USERNAME
(adbc_driver_manager.DatabaseOptions attribute)</a>
</li>
diff --git a/main/objects.inv b/main/objects.inv
index 66cd138d2..e0462aef1 100644
Binary files a/main/objects.inv and b/main/objects.inv differ
diff --git a/main/python/api/adbc_driver_manager.html
b/main/python/api/adbc_driver_manager.html
index d1de0f1c6..fde2e1b80 100644
--- a/main/python/api/adbc_driver_manager.html
+++ b/main/python/api/adbc_driver_manager.html
@@ -1458,7 +1458,7 @@ cannot be disabled.</p>
<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Connection.commit"
title="adbc_driver_manager.dbapi.Connection.commit"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">commit</span></code></a>()</p></td>
<td><p>Explicitly commit.</p></td>
</tr>
-<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Connection.cursor"
title="adbc_driver_manager.dbapi.Connection.cursor"><code class="xref py py-obj
docutils literal notranslate"><span
class="pre">cursor</span></code></a>()</p></td>
+<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Connection.cursor"
title="adbc_driver_manager.dbapi.Connection.cursor"><code class="xref py py-obj
docutils literal notranslate"><span class="pre">cursor</span></code></a>(*[,
adbc_stmt_kwargs])</p></td>
<td><p>Create a new cursor for querying the database.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.dbapi.Connection.rollback"
title="adbc_driver_manager.dbapi.Connection.rollback"><code class="xref py
py-obj docutils literal notranslate"><span
class="pre">rollback</span></code></a>()</p></td>
@@ -1596,8 +1596,16 @@ connections.</p>
<dl class="py method">
<dt class="sig sig-object py" id="adbc_driver_manager.dbapi.Connection.cursor">
-<span class="sig-name descname"><span class="pre">cursor</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 internal"
href="#adbc_driver_manager.dbapi.Cursor"
title="adbc_driver_manager.dbapi.Cursor"><span
class="pre">Cursor</span></a></span></span><a class="headerlink"
href="#adbc_driver_manager.dbapi.Connection.cursor" title="Link to th [...]
+<span class="sig-name descname"><span class="pre">cursor</span></span><span
class="sig-paren">(</span><em class="sig-param"><span
class="keyword-only-separator o"><abbr title="Keyword-only parameters separator
(PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em
class="sig-param"><span class="n"><span
class="pre">adbc_stmt_kwargs</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">Dict</span><span class="p"><sp [...]
<dd><p>Create a new cursor for querying the database.</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>adbc_stmt_kwargs</strong><span class="classifier">dict,
optional</span></dt><dd><p>ADBC-specific options to pass to the underlying ADBC
statement.</p>
+</dd>
+</dl>
+</dd>
+</dl>
</dd></dl>
<dl class="py method">
@@ -1610,7 +1618,7 @@ connections.</p>
<dl class="py class">
<dt class="sig sig-object py" id="adbc_driver_manager.dbapi.Cursor">
-<em class="property"><span class="k"><span
class="pre">class</span></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">Cursor</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">conn</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference intern [...]
+<em class="property"><span class="k"><span
class="pre">class</span></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">Cursor</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">conn</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference intern [...]
<dd><p>Bases: <a class="reference internal"
href="#adbc_driver_manager.dbapi._Closeable"
title="adbc_driver_manager.dbapi._Closeable"><code class="xref py py-class
docutils literal notranslate"><span class="pre">_Closeable</span></code></a></p>
<p>A DB-API 2.0 (PEP 249) cursor.</p>
<p>Do not create this object directly; use Connection.cursor().</p>
diff --git a/main/python/api/adbc_driver_postgresql.html
b/main/python/api/adbc_driver_postgresql.html
index ac643db07..0b08c4789 100644
--- a/main/python/api/adbc_driver_postgresql.html
+++ b/main/python/api/adbc_driver_postgresql.html
@@ -402,6 +402,14 @@
actual size may differ.</p>
</dd></dl>
+<dl class="py attribute">
+<dt class="sig sig-object py"
id="adbc_driver_postgresql.StatementOptions.USE_COPY">
+<span class="sig-name descname"><span class="pre">USE_COPY</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.use_copy'</span></em><a class="headerlink"
href="#adbc_driver_postgresql.StatementOptions.USE_COPY" title="Link to this
definition">ΒΆ</a></dt>
+<dd><p>Enable or disable the <code class="docutils literal notranslate"><span
class="pre">COPY</span></code> optimization (default: enabled).</p>
+<p>This is necessary for some queries since PostgreSQL does not support
+<code class="docutils literal notranslate"><span
class="pre">COPY</span></code> with those queries, e.g. queries using <code
class="docutils literal notranslate"><span class="pre">SHOW</span></code>.</p>
+</dd></dl>
+
</dd></dl>
<dl class="py function">
@@ -499,6 +507,7 @@ United States and other countries.
<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>
+<li><a class="reference internal"
href="#adbc_driver_postgresql.StatementOptions.USE_COPY"><code class="docutils
literal notranslate"><span
class="pre">StatementOptions.USE_COPY</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>
diff --git a/main/r/adbcbigquery/pkgdown.yml b/main/r/adbcbigquery/pkgdown.yml
index 411069414..acf197c7e 100644
--- a/main/r/adbcbigquery/pkgdown.yml
+++ b/main/r/adbcbigquery/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.6.3
pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2025-03-10T22:33Z
+last_built: 2025-03-10T22:49Z
urls:
reference: https://arrow.apache.org/adbc/current/r/adbcbigquery/reference
article: https://arrow.apache.org/adbc/current/r/adbcbigquery/articles
diff --git a/main/r/adbcdrivermanager/pkgdown.yml
b/main/r/adbcdrivermanager/pkgdown.yml
index c7a5f9ed4..d777cf039 100644
--- a/main/r/adbcdrivermanager/pkgdown.yml
+++ b/main/r/adbcdrivermanager/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.6.3
pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2025-03-10T22:33Z
+last_built: 2025-03-10T22:49Z
urls:
reference:
https://arrow.apache.org/adbc/current/r/adbcdrivermanager/reference
article: https://arrow.apache.org/adbc/current/r/adbcdrivermanager/articles
diff --git a/main/r/adbcdrivermanager/reference/adbc_connection_init.html
b/main/r/adbcdrivermanager/reference/adbc_connection_init.html
index 4839cff07..02cbdf0b6 100644
--- a/main/r/adbcdrivermanager/reference/adbc_connection_init.html
+++ b/main/r/adbcdrivermanager/reference/adbc_connection_init.html
@@ -105,9 +105,9 @@ finer-grained control over behaviour at the R
level.</p></dd>
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor"
href="#ref-examples"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span
class="r-in"><span><span class="va">db</span> <span class="op"><-</span>
<span class="fu"><a
href="adbc_database_init.html">adbc_database_init</a></span><span
class="op">(</span><span class="fu"><a
href="adbc_driver_void.html">adbc_driver_void</a></span><span
class="op">(</span><span class="op">)</span><span
class="op">)</span></span></span>
<span class="r-in"><span><span class="fu">adbc_connection_init</span><span
class="op">(</span><span class="va">db</span><span
class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span> <adbc_connection at
0x55784a006530> </span>
+<span class="r-out co"><span class="r-pr">#></span> <adbc_connection at
0x55ddf7b664c0> </span>
<span class="r-out co"><span class="r-pr">#></span> List of 1</span>
-<span class="r-out co"><span class="r-pr">#></span> $
database:<adbc_database at 0x557849930060> </span>
+<span class="r-out co"><span class="r-pr">#></span> $
database:<adbc_database at 0x55ddfad6e4f0> </span>
<span class="r-out co"><span class="r-pr">#></span> List of 1</span>
<span class="r-out co"><span class="r-pr">#></span> ..$
driver:<adbc_driver_void> List of 2</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$
driver_init_func:Class 'adbc_driver_init_func' <externalptr> </span>
diff --git a/main/r/adbcdrivermanager/reference/adbc_database_init.html
b/main/r/adbcdrivermanager/reference/adbc_database_init.html
index ae94debc8..052dd0727 100644
--- a/main/r/adbcdrivermanager/reference/adbc_database_init.html
+++ b/main/r/adbcdrivermanager/reference/adbc_database_init.html
@@ -104,7 +104,7 @@ finer-grained control over behaviour at the R
level.</p></dd>
<div class="section level2">
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor"
href="#ref-examples"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span
class="r-in"><span><span class="fu">adbc_database_init</span><span
class="op">(</span><span class="fu"><a
href="adbc_driver_void.html">adbc_driver_void</a></span><span
class="op">(</span><span class="op">)</span><span
class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span> <adbc_database at
0x55784a6cb530> </span>
+<span class="r-out co"><span class="r-pr">#></span> <adbc_database at
0x55ddfad8eb80> </span>
<span class="r-out co"><span class="r-pr">#></span> List of 1</span>
<span class="r-out co"><span class="r-pr">#></span> $
driver:<adbc_driver_void> List of 2</span>
<span class="r-out co"><span class="r-pr">#></span> ..$
driver_init_func:Class 'adbc_driver_init_func' <externalptr> </span>
diff --git a/main/r/adbcdrivermanager/reference/adbc_statement_init.html
b/main/r/adbcdrivermanager/reference/adbc_statement_init.html
index ab0685dce..e62f0368b 100644
--- a/main/r/adbcdrivermanager/reference/adbc_statement_init.html
+++ b/main/r/adbcdrivermanager/reference/adbc_statement_init.html
@@ -106,11 +106,11 @@ finer-grained control over behaviour at the R
level.</p></dd>
<div class="sourceCode"><pre class="sourceCode r"><code><span
class="r-in"><span><span class="va">db</span> <span class="op"><-</span>
<span class="fu"><a
href="adbc_database_init.html">adbc_database_init</a></span><span
class="op">(</span><span class="fu"><a
href="adbc_driver_void.html">adbc_driver_void</a></span><span
class="op">(</span><span class="op">)</span><span
class="op">)</span></span></span>
<span class="r-in"><span><span class="va">con</span> <span
class="op"><-</span> <span class="fu"><a
href="adbc_connection_init.html">adbc_connection_init</a></span><span
class="op">(</span><span class="va">db</span><span
class="op">)</span></span></span>
<span class="r-in"><span><span class="fu">adbc_statement_init</span><span
class="op">(</span><span class="va">con</span><span
class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span> <adbc_statement at
0x557849cf3090> </span>
+<span class="r-out co"><span class="r-pr">#></span> <adbc_statement at
0x55ddfb2bde70> </span>
<span class="r-out co"><span class="r-pr">#></span> List of 1</span>
-<span class="r-out co"><span class="r-pr">#></span> $
connection:<adbc_connection at 0x557848ec5ae0> </span>
+<span class="r-out co"><span class="r-pr">#></span> $
connection:<adbc_connection at 0x55ddfb08cd00> </span>
<span class="r-out co"><span class="r-pr">#></span> List of 1</span>
-<span class="r-out co"><span class="r-pr">#></span> ..$
database:<adbc_database at 0x5578471cab00> </span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
database:<adbc_database at 0x55ddfb5059f0> </span>
<span class="r-out co"><span class="r-pr">#></span> List of 1</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$
driver:<adbc_driver_void> List of 2</span>
<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
driver_init_func:Class 'adbc_driver_init_func' <externalptr> </span>
diff --git a/main/r/adbcdrivermanager/search.json
b/main/r/adbcdrivermanager/search.json
index 4b1c1168b..98b1a3819 100644
--- a/main/r/adbcdrivermanager/search.json
+++ b/main/r/adbcdrivermanager/search.json
@@ -1 +1 @@
-[{"path":"https://arrow.apache.org/adbc/current/r/adbcdrivermanager/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"https://arrow.apache.org/adbc/current/r/adbcdrivermanager/LICENSE.html","id":"id_1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title [...]
+[{"path":"https://arrow.apache.org/adbc/current/r/adbcdrivermanager/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"https://arrow.apache.org/adbc/current/r/adbcdrivermanager/LICENSE.html","id":"id_1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title [...]
diff --git a/main/r/adbcflightsql/pkgdown.yml b/main/r/adbcflightsql/pkgdown.yml
index 6efdc14e9..056712a69 100644
--- a/main/r/adbcflightsql/pkgdown.yml
+++ b/main/r/adbcflightsql/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.6.3
pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2025-03-10T22:33Z
+last_built: 2025-03-10T22:48Z
urls:
reference: https://arrow.apache.org/adbc/current/r/adbcflightsql/reference
article: https://arrow.apache.org/adbc/current/r/adbcflightsql/articles
diff --git a/main/r/adbcpostgresql/pkgdown.yml
b/main/r/adbcpostgresql/pkgdown.yml
index 379cce568..9287569f3 100644
--- a/main/r/adbcpostgresql/pkgdown.yml
+++ b/main/r/adbcpostgresql/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.6.3
pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2025-03-10T22:32Z
+last_built: 2025-03-10T22:48Z
urls:
reference: https://arrow.apache.org/adbc/current/r/adbcpostgresql/reference
article: https://arrow.apache.org/adbc/current/r/adbcpostgresql/articles
diff --git a/main/r/adbcsnowflake/pkgdown.yml b/main/r/adbcsnowflake/pkgdown.yml
index e4f8ef91c..fb19e2bda 100644
--- a/main/r/adbcsnowflake/pkgdown.yml
+++ b/main/r/adbcsnowflake/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.6.3
pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2025-03-10T22:33Z
+last_built: 2025-03-10T22:48Z
urls:
reference: https://arrow.apache.org/adbc/current/r/adbcsnowflake/reference
article: https://arrow.apache.org/adbc/current/r/adbcsnowflake/articles
diff --git a/main/r/adbcsqlite/pkgdown.yml b/main/r/adbcsqlite/pkgdown.yml
index 0ca2ededb..65fc8a148 100644
--- a/main/r/adbcsqlite/pkgdown.yml
+++ b/main/r/adbcsqlite/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.6.3
pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2025-03-10T22:32Z
+last_built: 2025-03-10T22:48Z
urls:
reference: https://arrow.apache.org/adbc/current/r/adbcsqlite/reference
article: https://arrow.apache.org/adbc/current/r/adbcsqlite/articles
diff --git a/main/searchindex.js b/main/searchindex.js
index e74203268..9d829bf30 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"ADBC API Standard":[[24,null]],"API
Reference":[[3,"api-reference"],[29,"api-reference"],[37,"api-reference"]],"And
then what is the \u201cADBC JDBC
driver\u201d?":[[20,"and-then-what-is-the-adbc-jdbc-driver"]],"Apache Arrow
ADBC":[[27,null]],"Arrow type to PostgreSQL type
mapping":[[16,"id5"]],"Authenticate with a username and
password":[[43,"authenticate-with-a-username-and-password"]],"Authentication":[[13,"authentication"],[17,"authentication"]],"Autoco
[...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"ADBC API Standard":[[24,null]],"API
Reference":[[3,"api-reference"],[29,"api-reference"],[37,"api-reference"]],"And
then what is the \u201cADBC JDBC
driver\u201d?":[[20,"and-then-what-is-the-adbc-jdbc-driver"]],"Apache Arrow
ADBC":[[27,null]],"Arrow type to PostgreSQL type
mapping":[[16,"id5"]],"Authenticate with a username and
password":[[43,"authenticate-with-a-username-and-password"]],"Authentication":[[13,"authentication"],[17,"authentication"]],"Autoco
[...]
\ No newline at end of file
