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 5a61aa9fd publish documentation 5a61aa9fd is described below commit 5a61aa9fdb1e7884c2b854e16381fc305debdbcb Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com> AuthorDate: Sat Sep 6 07:07:12 2025 +0000 publish documentation --- main/genindex.html | 4 +++- main/objects.inv | Bin 4039 -> 4049 bytes main/python/api/adbc_driver_manager.html | 24 +++++++++++++++------ 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 +- 14 files changed, 35 insertions(+), 21 deletions(-) diff --git a/main/genindex.html b/main/genindex.html index dc5645fdd..82e84054c 100644 --- a/main/genindex.html +++ b/main/genindex.html @@ -635,9 +635,11 @@ <li><a href="python/recipe/postgresql.html#index-4">PostgreSQL</a> </li> </ul></li> + <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.AdbcStatement.bind">bind() (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.AdbcStatement.bind">bind() (adbc_driver_manager.AdbcStatement method)</a> + <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.StatementOptions.BIND_BY_NAME">BIND_BY_NAME (adbc_driver_manager.StatementOptions attribute)</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> </li> diff --git a/main/objects.inv b/main/objects.inv index 0257c48f1..be57edaef 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 b7667aa54..c4db72e02 100644 --- a/main/python/api/adbc_driver_manager.html +++ b/main/python/api/adbc_driver_manager.html @@ -577,6 +577,12 @@ definitions in Python. For a higher-level interface, use <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></a></p> <p>Statement options that are standardized between drivers.</p> <p>Not all drivers support all options.</p> +<dl class="py attribute"> +<dt class="sig sig-object py" id="adbc_driver_manager.StatementOptions.BIND_BY_NAME"> +<span class="sig-name descname"><span class="pre">BIND_BY_NAME</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.statement.bind_by_name'</span></em><a class="headerlink" href="#adbc_driver_manager.StatementOptions.BIND_BY_NAME" title="Link to this definition">¶</a></dt> +<dd><p>Bind parameters by name instead of by position.</p> +</dd></dl> + <dl class="py attribute"> <dt class="sig sig-object py" id="adbc_driver_manager.StatementOptions.INCREMENTAL"> <span class="sig-name descname"><span class="pre">INCREMENTAL</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.statement.exec.incremental'</span></em><a class="headerlink" href="#adbc_driver_manager.StatementOptions.INCREMENTAL" title="Link to this definition">¶</a></dt> @@ -1979,16 +1985,21 @@ could not be determined.</p> <dt class="sig sig-object py" id="adbc_driver_manager.dbapi.Cursor.execute"> <span class="sig-name descname"><span class="pre">execute</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"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.13)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></sp [...] <dd><p>Execute a query.</p> -<dl class="field-list simple"> +<dl class="field-list"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><dl class="simple"> +<dd class="field-odd"><dl> <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 Python sequence (to provide -a single set of parameters), or an Arrow record batch, -table, or record batch reader (to provide multiple -parameters, which will each be bound in turn).</p> +<dt><strong>parameters</strong></dt><dd><p>Parameters to bind. Can be a Python sequence (to bind a single +set of parameters), a Python dictionary (to bind a single set of +parameters by name instead of position), or an Arrow record batch, +table, or record batch reader (to provide multiple parameters, +which will each be bound in turn).</p> +<p>To bind by name when providing Arrow data, explicitly toggle the +statement option “adbc.statement.bind_by_name”.</p> +<p>Note that providing a list of tuples is not supported (this mode +of usage is deprecated in DBAPI-2.0; use executemany() instead).</p> </dd> </dl> </dd> @@ -2358,6 +2369,7 @@ United States and other countries. </ul> </li> <li><a class="reference internal" href="#adbc_driver_manager.StatementOptions"><code class="docutils literal notranslate"><span class="pre">StatementOptions</span></code></a><ul> +<li><a class="reference internal" href="#adbc_driver_manager.StatementOptions.BIND_BY_NAME"><code class="docutils literal notranslate"><span class="pre">StatementOptions.BIND_BY_NAME</span></code></a></li> <li><a class="reference internal" href="#adbc_driver_manager.StatementOptions.INCREMENTAL"><code class="docutils literal notranslate"><span class="pre">StatementOptions.INCREMENTAL</span></code></a></li> <li><a class="reference internal" href="#adbc_driver_manager.StatementOptions.INGEST_MODE"><code class="docutils literal notranslate"><span class="pre">StatementOptions.INGEST_MODE</span></code></a></li> <li><a class="reference internal" href="#adbc_driver_manager.StatementOptions.INGEST_TARGET_CATALOG"><code class="docutils literal notranslate"><span class="pre">StatementOptions.INGEST_TARGET_CATALOG</span></code></a></li> diff --git a/main/r/adbcbigquery/pkgdown.yml b/main/r/adbcbigquery/pkgdown.yml index 9ef72c9e6..855999dd8 100644 --- a/main/r/adbcbigquery/pkgdown.yml +++ b/main/r/adbcbigquery/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.7.0.2 pkgdown: 2.1.3 pkgdown_sha: ~ articles: {} -last_built: 2025-09-05T05:31Z +last_built: 2025-09-06T07:06Z 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 ce4ef9591..cc1ccbbc2 100644 --- a/main/r/adbcdrivermanager/pkgdown.yml +++ b/main/r/adbcdrivermanager/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.7.0.2 pkgdown: 2.1.3 pkgdown_sha: ~ articles: {} -last_built: 2025-09-05T05:31Z +last_built: 2025-09-06T07:06Z 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 f4f55e301..1c0319652 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 0x56288256c060> </span> +<span class="r-out co"><span class="r-pr">#></span> <adbc_connection at 0x560b302668a0> </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 0x562884aa2a60> </span> +<span class="r-out co"><span class="r-pr">#></span> $ database:<adbc_database at 0x560b32d93b60> </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 4</span> <span class="r-out co"><span class="r-pr">#></span> .. ..$ load_flags : int 15</span> diff --git a/main/r/adbcdrivermanager/reference/adbc_database_init.html b/main/r/adbcdrivermanager/reference/adbc_database_init.html index c2351eef4..08ae9a19a 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 0x5628846b1cf0> </span> +<span class="r-out co"><span class="r-pr">#></span> <adbc_database at 0x560b32191980> </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 4</span> <span class="r-out co"><span class="r-pr">#></span> ..$ load_flags : int 15</span> diff --git a/main/r/adbcdrivermanager/reference/adbc_statement_init.html b/main/r/adbcdrivermanager/reference/adbc_statement_init.html index 506a47a61..263a791a9 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 0x5628844d23f0> </span> +<span class="r-out co"><span class="r-pr">#></span> <adbc_statement at 0x560b32d45c10> </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 0x5628846beaa0> </span> +<span class="r-out co"><span class="r-pr">#></span> $ connection:<adbc_connection at 0x560b32328370> </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 0x562883f3fb20> </span> +<span class="r-out co"><span class="r-pr">#></span> ..$ database:<adbc_database at 0x560b334d0280> </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 4</span> <span class="r-out co"><span class="r-pr">#></span> .. .. ..$ load_flags : int 15</span> diff --git a/main/r/adbcdrivermanager/search.json b/main/r/adbcdrivermanager/search.json index 44e16dfa8..3ac61e1db 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 7999f1fa3..0828b64bd 100644 --- a/main/r/adbcflightsql/pkgdown.yml +++ b/main/r/adbcflightsql/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.7.0.2 pkgdown: 2.1.3 pkgdown_sha: ~ articles: {} -last_built: 2025-09-05T05:32Z +last_built: 2025-09-06T07:06Z 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 99009e2c8..13611a307 100644 --- a/main/r/adbcpostgresql/pkgdown.yml +++ b/main/r/adbcpostgresql/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.7.0.2 pkgdown: 2.1.3 pkgdown_sha: ~ articles: {} -last_built: 2025-09-05T05:32Z +last_built: 2025-09-06T07:06Z 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 d72342179..607062571 100644 --- a/main/r/adbcsnowflake/pkgdown.yml +++ b/main/r/adbcsnowflake/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.7.0.2 pkgdown: 2.1.3 pkgdown_sha: ~ articles: {} -last_built: 2025-09-05T05:31Z +last_built: 2025-09-06T07:06Z 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 74884af57..490d97b40 100644 --- a/main/r/adbcsqlite/pkgdown.yml +++ b/main/r/adbcsqlite/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.7.0.2 pkgdown: 2.1.3 pkgdown_sha: ~ articles: {} -last_built: 2025-09-05T05:31Z +last_built: 2025-09-06T07:06Z 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 4987f4284..822fe54d8 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles":{"ADBC API Standard":[[26,null]],"ADBC Driver Manager and Manifests":[[23,null]],"API Reference":[[3,"api-reference"],[31,"api-reference"],[41,"api-reference"],[50,"api-reference"]],"And then what is the \u201cADBC JDBC driver\u201d?":[[21,"and-then-what-is-the-adbc-jdbc-driver"]],"Apache Arrow ADBC":[[29,null]],"Arrow type to PostgreSQL type mapping":[[17,"id5"]],"Authenticate with a username and password":[[47,"authenticate-with-a-username-and-password"]]," [...] \ No newline at end of file +Search.setIndex({"alltitles":{"ADBC API Standard":[[26,null]],"ADBC Driver Manager and Manifests":[[23,null]],"API Reference":[[3,"api-reference"],[31,"api-reference"],[41,"api-reference"],[50,"api-reference"]],"And then what is the \u201cADBC JDBC driver\u201d?":[[21,"and-then-what-is-the-adbc-jdbc-driver"]],"Apache Arrow ADBC":[[29,null]],"Arrow type to PostgreSQL type mapping":[[17,"id5"]],"Authenticate with a username and password":[[47,"authenticate-with-a-username-and-password"]]," [...] \ No newline at end of file