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 8e32c839 publish documentation
8e32c839 is described below
commit 8e32c839c16ce496c69667b3888d9c1ffed0c670
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Wed Dec 13 19:33:01 2023 +0000
publish documentation
---
main/python/api/adbc_driver_manager.html | 20 +++++++++++++-------
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/index.html | 1 +
main/r/adbcpostgresql/pkgdown.yml | 2 +-
main/r/adbcsnowflake/pkgdown.yml | 2 +-
main/r/adbcsqlite/pkgdown.yml | 2 +-
main/searchindex.js | 2 +-
12 files changed, 27 insertions(+), 20 deletions(-)
diff --git a/main/python/api/adbc_driver_manager.html
b/main/python/api/adbc_driver_manager.html
index c5ea932d..84632f86 100644
--- a/main/python/api/adbc_driver_manager.html
+++ b/main/python/api/adbc_driver_manager.html
@@ -972,7 +972,7 @@ serialize accesses to a connection.</p>
<div class="table-wrapper autosummary longtable docutils container">
<table class="autosummary longtable docutils align-default">
<tbody>
-<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.AdbcStatement.bind"
title="adbc_driver_manager.AdbcStatement.bind"><code class="xref py py-obj
docutils literal notranslate"><span class="pre">bind</span></code></a>(data,
schema)</p></td>
+<tr class="row-odd"><td><p><a class="reference internal"
href="#adbc_driver_manager.AdbcStatement.bind"
title="adbc_driver_manager.AdbcStatement.bind"><code class="xref py py-obj
docutils literal notranslate"><span class="pre">bind</span></code></a>(data[,
schema])</p></td>
<td><p>Bind an ArrowArray to this statement.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal"
href="#adbc_driver_manager.AdbcStatement.bind_stream"
title="adbc_driver_manager.AdbcStatement.bind_stream"><code class="xref py
py-obj docutils literal notranslate"><span
class="pre">bind_stream</span></code></a>(stream)</p></td>
@@ -1028,13 +1028,13 @@ serialize accesses to a connection.</p>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="adbc_driver_manager.AdbcStatement.bind">
-<span class="sig-name descname"><span class="pre">bind</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">data</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">schema</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></span><a class="headerlink"
href="#adbc_driver_manager. [...]
+<span class="sig-name descname"><span class="pre">bind</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">data</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">schema</span></span><span class="o"><span
class="pre">=</span></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">→</span> <span class="
[...]
<dd><p>Bind an ArrowArray to this statement.</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>data</strong><span class="classifier">int or
ArrowArrayHandle</span></dt><dd></dd>
-<dt><strong>schema</strong><span class="classifier">int or
ArrowSchemaHandle</span></dt><dd></dd>
+<dt><strong>data</strong><span class="classifier">PyCapsule or int or
ArrowArrayHandle</span></dt><dd></dd>
+<dt><strong>schema</strong><span class="classifier">PyCapsule or int or
ArrowSchemaHandle</span></dt><dd></dd>
</dl>
</dd>
</dl>
@@ -1047,7 +1047,7 @@ serialize accesses to a connection.</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>stream</strong><span class="classifier">int or
ArrowArrayStreamHandle</span></dt><dd></dd>
+<dt><strong>stream</strong><span class="classifier">PyCapsule or int or
ArrowArrayStreamHandle</span></dt><dd></dd>
</dl>
</dd>
</dl>
@@ -1230,6 +1230,7 @@ the type of the corresponding field will be NA
(NullType).</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.</span></span><span class="sig-name
descname"><span class="pre">ArrowArrayHandle</span></span><a class="headerlink"
href="#adbc_driver_manager.ArrowArrayHandle" title="Permalink 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 wrapper for an allocated ArrowArray.</p>
+<p>This object implements the Arrow PyCapsule interface.</p>
<dl class="field-list simple">
<dt class="field-odd">Attributes<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
@@ -1251,6 +1252,7 @@ the type of the corresponding field will be NA
(NullType).</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.</span></span><span class="sig-name
descname"><span class="pre">ArrowArrayStreamHandle</span></span><a
class="headerlink" href="#adbc_driver_manager.ArrowArrayStreamHandle"
title="Permalink 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 wrapper for an allocated ArrowArrayStream.</p>
+<p>This object implements the Arrow PyCapsule interface.</p>
<dl class="field-list simple">
<dt class="field-odd">Attributes<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
@@ -1272,6 +1274,7 @@ the type of the corresponding field will be NA
(NullType).</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.</span></span><span class="sig-name
descname"><span class="pre">ArrowSchemaHandle</span></span><a
class="headerlink" href="#adbc_driver_manager.ArrowSchemaHandle"
title="Permalink 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 wrapper for an allocated ArrowSchema.</p>
+<p>This object implements the Arrow PyCapsule interface.</p>
<dl class="field-list simple">
<dt class="field-odd">Attributes<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
@@ -1774,7 +1777,10 @@ would result from a typical prepare-bind-insert loop.</p>
<dd class="field-odd"><dl class="simple">
<dt><strong>table_name</strong></dt><dd><p>The table to insert into.</p>
</dd>
-<dt><strong>data</strong></dt><dd><p>The Arrow data to insert.</p>
+<dt><strong>data</strong></dt><dd><p>The Arrow data to insert. This can be a
pyarrow RecordBatch, Table
+or RecordBatchReader, or any Arrow-compatible data that implements
+the Arrow PyCapsule Protocol (i.e. has an <code class="docutils literal
notranslate"><span class="pre">__arrow_c_array__</span></code>
+or <a href="#id3"><span class="problematic"
id="id4">``</span></a>__arrow_c_stream__ <a href="#id5"><span
class="problematic" id="id6">``</span></a>method).</p>
</dd>
<dt><strong>mode</strong></dt><dd><p>How to deal with existing data:</p>
<ul class="simple">
@@ -1907,7 +1913,7 @@ parameters, which will each be bound in turn).</p>
<dt><strong>operation</strong><span class="classifier">bytes or
str</span></dt><dd><p>The query to execute. Pass SQL queries as strings,
(serialized) Substrait plans as bytes.</p>
</dd>
-<dt><strong>parameters</strong></dt><dd><p>Parameters to bind. Can be a list
of Python sequences, or
+<dt><strong>seq_of_parameters</strong></dt><dd><p>Parameters to bind. Can be
a list of Python sequences, or
an Arrow record batch, table, or record batch reader. If
None, then the query will be executed once, else it will
be executed once per row.</p>
diff --git a/main/r/adbcdrivermanager/pkgdown.yml
b/main/r/adbcdrivermanager/pkgdown.yml
index 5a735e76..11cb3c24 100644
--- a/main/r/adbcdrivermanager/pkgdown.yml
+++ b/main/r/adbcdrivermanager/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 3.1.3
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-12-12T21:24Z
+last_built: 2023-12-13T19:28Z
diff --git a/main/r/adbcdrivermanager/reference/adbc_connection_init.html
b/main/r/adbcdrivermanager/reference/adbc_connection_init.html
index ae097dbe..afd93012 100644
--- a/main/r/adbcdrivermanager/reference/adbc_connection_init.html
+++ b/main/r/adbcdrivermanager/reference/adbc_connection_init.html
@@ -112,9 +112,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
0x556a9aaa5ff0> </span>
+<span class="r-out co"><span class="r-pr">#></span> <adbc_connection at
0x558558323310> </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 0x556a9a0e2440> </span>
+<span class="r-out co"><span class="r-pr">#></span> $
database:<adbc_database at 0x55855c97f320> </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 1</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 e33437b5..a60b9ba2 100644
--- a/main/r/adbcdrivermanager/reference/adbc_database_init.html
+++ b/main/r/adbcdrivermanager/reference/adbc_database_init.html
@@ -111,7 +111,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
0x556a99703880> </span>
+<span class="r-out co"><span class="r-pr">#></span> <adbc_database at
0x55855b3fc730> </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 1</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 b1355b13..5101762f 100644
--- a/main/r/adbcdrivermanager/reference/adbc_statement_init.html
+++ b/main/r/adbcdrivermanager/reference/adbc_statement_init.html
@@ -113,11 +113,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
0x556a9aa84420> </span>
+<span class="r-out co"><span class="r-pr">#></span> <adbc_statement at
0x55855cf60920> </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 0x556a9a40da20> </span>
+<span class="r-out co"><span class="r-pr">#></span> $
connection:<adbc_connection at 0x55855cec9360> </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 0x556a9a33cc60> </span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
database:<adbc_database at 0x55855ce4d2e0> </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 1</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 68e84b04..95a39c52 100644
--- a/main/r/adbcdrivermanager/search.json
+++ b/main/r/adbcdrivermanager/search.json
@@ -1 +1 @@
-[{"path":"/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":"/LICENSE.html","id":"id_1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title":"Apache License","text":"“License” shall mean terms
conditions use, reproduction, distribution defined Sections [...]
+[{"path":"/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":"/LICENSE.html","id":"id_1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title":"Apache License","text":"“License” shall mean terms
conditions use, reproduction, distribution defined Sections [...]
diff --git a/main/r/adbcflightsql/pkgdown.yml b/main/r/adbcflightsql/pkgdown.yml
index 5a735e76..11cb3c24 100644
--- a/main/r/adbcflightsql/pkgdown.yml
+++ b/main/r/adbcflightsql/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 3.1.3
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-12-12T21:24Z
+last_built: 2023-12-13T19:28Z
diff --git a/main/r/adbcpostgresql/index.html b/main/r/adbcpostgresql/index.html
index 5e51b98d..5944661e 100644
--- a/main/r/adbcpostgresql/index.html
+++ b/main/r/adbcpostgresql/index.html
@@ -146,6 +146,7 @@
</main><aside class="col-md-3"><div class="links">
<h2 data-toc-skip>Links</h2>
<ul class="list-unstyled">
+<li><a href="https://cloud.r-project.org/package=adbcpostgresql";
class="external-link">View on CRAN</a></li>
<li><a href="https://github.com/apache/arrow-adbc/";
class="external-link">Browse source code</a></li>
<li><a href="https://github.com/apache/arrow-adbc/issues";
class="external-link">Report a bug</a></li>
</ul>
diff --git a/main/r/adbcpostgresql/pkgdown.yml
b/main/r/adbcpostgresql/pkgdown.yml
index 5a735e76..11cb3c24 100644
--- a/main/r/adbcpostgresql/pkgdown.yml
+++ b/main/r/adbcpostgresql/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 3.1.3
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-12-12T21:24Z
+last_built: 2023-12-13T19:28Z
diff --git a/main/r/adbcsnowflake/pkgdown.yml b/main/r/adbcsnowflake/pkgdown.yml
index 5a735e76..a1739128 100644
--- a/main/r/adbcsnowflake/pkgdown.yml
+++ b/main/r/adbcsnowflake/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 3.1.3
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-12-12T21:24Z
+last_built: 2023-12-13T19:29Z
diff --git a/main/r/adbcsqlite/pkgdown.yml b/main/r/adbcsqlite/pkgdown.yml
index 5a735e76..11cb3c24 100644
--- a/main/r/adbcsqlite/pkgdown.yml
+++ b/main/r/adbcsqlite/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 3.1.3
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-12-12T21:24Z
+last_built: 2023-12-13T19:28Z
diff --git a/main/searchindex.js b/main/searchindex.js
index 2172752e..4fe631e5 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/duckdb", "driver/flight_sql",
"driver/installation", "driver/jdbc", "driver/postgresql", "driver/snowflake",
"driver/sqlite", "driver/status", "faq", "format/comparison",
"format/specification", "format/versioning", "index", "java/api/adbc_dr [...]
\ 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/duckdb", "driver/flight_sql",
"driver/installation", "driver/jdbc", "driver/postgresql", "driver/snowflake",
"driver/sqlite", "driver/status", "faq", "format/comparison",
"format/specification", "format/versioning", "index", "java/api/adbc_dr [...]
\ No newline at end of file
