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 71c70420 publish documentation 71c70420 is described below commit 71c704204b018567eed3c1cfb01c9eb06c4680da Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com> AuthorDate: Wed Aug 23 18:37:53 2023 +0000 publish documentation --- main/genindex.html | 4 ++- main/objects.inv | Bin 4419 -> 4429 bytes main/python/api/adbc_driver_manager.html | 30 +++++++++++++++------ 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 +- 13 files changed, 38 insertions(+), 22 deletions(-) diff --git a/main/genindex.html b/main/genindex.html index cac40096..7f1d75e7 100644 --- a/main/genindex.html +++ b/main/genindex.html @@ -697,10 +697,12 @@ </li> <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Cursor.fetch_df">fetch_df() (adbc_driver_manager.dbapi.Cursor method)</a> </li> - <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Cursor.fetchall">fetchall() (adbc_driver_manager.dbapi.Cursor method)</a> + <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Cursor.fetch_record_batch">fetch_record_batch() (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.fetchall">fetchall() (adbc_driver_manager.dbapi.Cursor method)</a> +</li> <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Cursor.fetchallarrow">fetchallarrow() (adbc_driver_manager.dbapi.Cursor method)</a> </li> <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Cursor.fetchmany">fetchmany() (adbc_driver_manager.dbapi.Cursor method)</a> diff --git a/main/objects.inv b/main/objects.inv index 6b8f2e75..219f11b9 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 5e3e61d1..18424f6b 100644 --- a/main/python/api/adbc_driver_manager.html +++ b/main/python/api/adbc_driver_manager.html @@ -1310,28 +1310,31 @@ connections.</p> <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-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> +<tr class="row-even"><td><p><a class="reference internal" href="#adbc_driver_manager.dbapi.Cursor.fetch_record_batch" title="adbc_driver_manager.dbapi.Cursor.fetch_record_batch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fetch_record_batch</span></code></a>()</p></td> +<td><p>Fetch the result as a PyArrow RecordBatchReader.</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> <td><p>Fetch all rows of the result.</p></td> </tr> -<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> +<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> <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.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-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> <td><p>Fetch some rows of the result.</p></td> </tr> -<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> +<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> <td><p>Fetch one row of the result.</p></td> </tr> -<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> +<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> <td><p>Fetch the next row, or raise StopIteration.</p></td> </tr> -<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> +<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> <td><p>Move to the next available result set (not supported).</p></td> </tr> -<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> +<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> <td><p>Preallocate memory for the parameters (no-op).</p></td> </tr> -<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> +<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> <td><p>Preallocate memory for the result set (no-op).</p></td> </tr> </tbody> @@ -1520,6 +1523,16 @@ be executed once per row.</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_record_batch"> +<span class="sig-name descname"><span class="pre">fetch_record_batch</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.RecordBatchReader.html#pyarrow.RecordBatchReader" title="(in Apache Arrow v12.0.1)"><span class="pre">RecordBatchReader</span></a></span></span><a cl [...] +<dd><p>Fetch the result as a PyArrow RecordBatchReader.</p> +<p>This implements a similar API as DuckDB: +<a class="reference external" href="https://duckdb.org/docs/guides/python/export_arrow.html#export-as-a-recordbatchreader">https://duckdb.org/docs/guides/python/export_arrow.html#export-as-a-recordbatchreader</a></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.fetchall"> <span class="sig-name descname"><span class="pre">fetchall</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"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#adbc_driver_manager.dbapi.Cursor.fetchall" title=" [...] @@ -1856,6 +1869,7 @@ be executed once per row.</p> <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.fetch_record_batch"><code class="docutils literal notranslate"><span class="pre">Cursor.fetch_record_batch()</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> <li><a class="reference internal" href="#adbc_driver_manager.dbapi.Cursor.fetchallarrow"><code class="docutils literal notranslate"><span class="pre">Cursor.fetchallarrow()</span></code></a></li> <li><a class="reference internal" href="#adbc_driver_manager.dbapi.Cursor.fetchmany"><code class="docutils literal notranslate"><span class="pre">Cursor.fetchmany()</span></code></a></li> diff --git a/main/r/adbcdrivermanager/pkgdown.yml b/main/r/adbcdrivermanager/pkgdown.yml index 8f41069e..1c3376fe 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-08-23T13:35Z +last_built: 2023-08-23T18:36Z diff --git a/main/r/adbcdrivermanager/reference/adbc_connection_init.html b/main/r/adbcdrivermanager/reference/adbc_connection_init.html index a1744c45..f19696c7 100644 --- a/main/r/adbcdrivermanager/reference/adbc_connection_init.html +++ b/main/r/adbcdrivermanager/reference/adbc_connection_init.html @@ -97,8 +97,8 @@ 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> <pointer: 0x561b1f37f940> List of 2</span> -<span class="r-out co"><span class="r-pr">#></span> $ database:<adbc_database> <pointer: 0x561b1e80fbf0> List of 2</span> +<span class="r-out co"><span class="r-pr">#></span> <adbc_connection> <pointer: 0x5608b42c3b80> List of 2</span> +<span class="r-out co"><span class="r-pr">#></span> $ database:<adbc_database> <pointer: 0x5608b46207a0> List of 2</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> <span class="r-out co"><span class="r-pr">#></span> ..$ options: list()</span> diff --git a/main/r/adbcdrivermanager/reference/adbc_database_init.html b/main/r/adbcdrivermanager/reference/adbc_database_init.html index a8863161..94a0bd26 100644 --- a/main/r/adbcdrivermanager/reference/adbc_database_init.html +++ b/main/r/adbcdrivermanager/reference/adbc_database_init.html @@ -96,7 +96,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> <pointer: 0x561b1e687540> List of 2</span> +<span class="r-out co"><span class="r-pr">#></span> <adbc_database> <pointer: 0x5608b29004c0> List of 2</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> <span class="r-out co"><span class="r-pr">#></span> $ options: list()</span> diff --git a/main/r/adbcdrivermanager/reference/adbc_statement_init.html b/main/r/adbcdrivermanager/reference/adbc_statement_init.html index 91b30e46..4a82d22d 100644 --- a/main/r/adbcdrivermanager/reference/adbc_statement_init.html +++ b/main/r/adbcdrivermanager/reference/adbc_statement_init.html @@ -98,9 +98,9 @@ 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> <pointer: 0x561b1ecd2560> List of 2</span> -<span class="r-out co"><span class="r-pr">#></span> $ connection:<adbc_connection> <pointer: 0x561b19d0efb0> List of 2</span> -<span class="r-out co"><span class="r-pr">#></span> ..$ database:<adbc_database> <pointer: 0x561b1f0c4040> List of 2</span> +<span class="r-out co"><span class="r-pr">#></span> <adbc_statement> <pointer: 0x5608b4d87a70> List of 2</span> +<span class="r-out co"><span class="r-pr">#></span> $ connection:<adbc_connection> <pointer: 0x5608b4a937b0> List of 2</span> +<span class="r-out co"><span class="r-pr">#></span> ..$ database:<adbc_database> <pointer: 0x5608b1f35b00> List of 2</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> <span class="r-out co"><span class="r-pr">#></span> .. ..$ options: list()</span> diff --git a/main/r/adbcdrivermanager/search.json b/main/r/adbcdrivermanager/search.json index 456958c9..e7a8f38b 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 8f41069e..1c3376fe 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-08-23T13:35Z +last_built: 2023-08-23T18:36Z diff --git a/main/r/adbcpostgresql/pkgdown.yml b/main/r/adbcpostgresql/pkgdown.yml index 8f41069e..1c3376fe 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-08-23T13:35Z +last_built: 2023-08-23T18:36Z diff --git a/main/r/adbcsnowflake/pkgdown.yml b/main/r/adbcsnowflake/pkgdown.yml index 8f41069e..1c3376fe 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-08-23T13:35Z +last_built: 2023-08-23T18:36Z diff --git a/main/r/adbcsqlite/pkgdown.yml b/main/r/adbcsqlite/pkgdown.yml index 8f41069e..1c3376fe 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-08-23T13:35Z +last_built: 2023-08-23T18:36Z diff --git a/main/searchindex.js b/main/searchindex.js index 4b0cc9c9..018bc256 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/index", "py [...] \ 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/index", "py [...] \ No newline at end of file