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 13685da3c publish documentation 13685da3c is described below commit 13685da3c082174a093eb6709d203d947e57f65a Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com> AuthorDate: Fri Jul 18 00:52:05 2025 +0000 publish documentation --- main/_sources/driver/duckdb.rst.txt | 2 +- main/_sources/driver/flight_sql.rst.txt | 52 +-------- main/_sources/driver/jdbc.rst.txt | 18 +-- main/_sources/driver/postgresql.rst.txt | 57 ++------- main/_sources/driver/snowflake.rst.txt | 38 +----- main/_sources/driver/sqlite.rst.txt | 41 +------ main/_sources/driver/status.rst.txt | 95 ++++----------- main/driver/duckdb.html | 7 +- main/driver/flight_sql.html | 53 ++++----- main/driver/jdbc.html | 10 +- main/driver/postgresql.html | 43 ++++--- main/driver/snowflake.html | 83 ++++++++----- main/driver/sqlite.html | 25 ++-- main/driver/status.html | 130 ++++++++++++--------- main/objects.inv | Bin 3958 -> 3976 bytes main/python/api/adbc_driver_bigquery.html | 59 +++------- 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 +- 27 files changed, 267 insertions(+), 474 deletions(-) diff --git a/main/_sources/driver/duckdb.rst.txt b/main/_sources/driver/duckdb.rst.txt index 94460eb53..870efb821 100644 --- a/main/_sources/driver/duckdb.rst.txt +++ b/main/_sources/driver/duckdb.rst.txt @@ -19,7 +19,7 @@ DuckDB Support ============== -**Available for:** C/C++, GLib/Ruby, Go, Python, R +.. adbc_driver_status:: ../../../c/integration/duckdb/README.md `DuckDB`_ provides ADBC support since `version 0.8.0 <https://duckdb.org/2023/05/17/announcing-duckdb-080.html>`_. diff --git a/main/_sources/driver/flight_sql.rst.txt b/main/_sources/driver/flight_sql.rst.txt index 1e30d77ee..11cb7b191 100644 --- a/main/_sources/driver/flight_sql.rst.txt +++ b/main/_sources/driver/flight_sql.rst.txt @@ -19,7 +19,7 @@ Flight SQL Driver ================= -**Available for:** C/C++, GLib/Ruby, Go, Java, Python, R +.. adbc_driver_status:: ../../../c/driver/flightsql/README.md The Flight SQL Driver provides access to any database implementing a :doc:`arrow:format/FlightSql` compatible endpoint. @@ -27,55 +27,7 @@ The Flight SQL Driver provides access to any database implementing a Installation ============ -.. tab-set:: - - .. tab-item:: C/C++ - :sync: cpp - - For conda-forge users: - - .. code-block:: shell - - mamba install libadbc-driver-flightsql - - .. tab-item:: Go - :sync: go - - .. code-block:: shell - - go get github.com/apache/arrow-adbc/go/adbc - - .. tab-item:: Java - :sync: java - - Add a dependency on ``org.apache.arrow.adbc:adbc-driver-flight-sql``. - - For Maven users: - - .. code-block:: xml - - <dependency> - <groupId>org.apache.arrow.adbc</groupId> - <artifactId>adbc-driver-flight-sql</artifactId> - </dependency> - - .. tab-item:: Python - :sync: python - - .. code-block:: shell - - # For conda-forge - mamba install adbc-driver-flightsql - - # For pip - pip install adbc_driver_flightsql - - .. tab-item:: R - :sync: r - - .. code-block:: r - - install.packages("adbcflightsql", repos = "https://community.r-multiverse.org") +.. adbc_driver_installation:: ../../../c/driver/flightsql/README.md Usage ===== diff --git a/main/_sources/driver/jdbc.rst.txt b/main/_sources/driver/jdbc.rst.txt index b8203a50b..63261db93 100644 --- a/main/_sources/driver/jdbc.rst.txt +++ b/main/_sources/driver/jdbc.rst.txt @@ -19,28 +19,14 @@ JDBC Adapter ============ -**Available for:** Java +.. adbc_driver_status:: ../../../java/driver/jdbc/README.md The JDBC Adapter provides access to any database with a JDBC driver. Installation ============ -.. tab-set:: - - .. tab-item:: Java - :sync: java - - Add a dependency on ``org.apache.arrow.adbc:adbc-driver-jdbc``. - - For Maven users: - - .. code-block:: xml - - <dependency> - <groupId>org.apache.arrow.adbc</groupId> - <artifactId>adbc-driver-jdbc</artifactId> - </dependency> +.. adbc_driver_installation:: ../../../java/driver/jdbc/README.md Usage ===== diff --git a/main/_sources/driver/postgresql.rst.txt b/main/_sources/driver/postgresql.rst.txt index e79838df4..0d57c4de1 100644 --- a/main/_sources/driver/postgresql.rst.txt +++ b/main/_sources/driver/postgresql.rst.txt @@ -19,7 +19,7 @@ PostgreSQL Driver ================= -**Available for:** C/C++, GLib/Ruby, Go, Python, R +.. adbc_driver_status:: ../../../c/driver/postgresql/README.md The PostgreSQL driver provides access to any database that supports the PostgreSQL wire format. It wraps `libpq`_, the client library for @@ -31,58 +31,17 @@ overall approach. .. _libpq: https://www.postgresql.org/docs/current/libpq.html .. _pgeon: https://github.com/0x0L/pgeon -.. note:: The PostgreSQL driver is in beta. - Performance/optimization and support for complex types and - different ADBC features is still ongoing. - -.. note:: AWS Redshift supports a very old version of the PostgreSQL - wire protocol and has a basic level of support in the ADBC - PostgreSQL driver. Because Redshift does not support reading or - writing COPY in PostgreSQL binary format, the optimizations that - accelerate non-Redshift queries are not enabled when connecting - to a Redshift database. This functionality is experimental. +.. note:: This driver has experimental support for Amazon Redshift. As + Redshift does not support reading or writing COPY in PostgreSQL + binary format, however, the optimizations that accelerate queries + are not enabled when connecting to Redshift. There may also be + other differences in functionality; please file a bug report if + problems are encountered. Installation ============ -.. tab-set:: - - .. tab-item:: C/C++ - :sync: cpp - - For conda-forge users: - - .. code-block:: shell - - mamba install libadbc-driver-postgresql - - .. tab-item:: Go - :sync: go - - Install the C/C++ package and use the Go driver manager. - Requires CGO. - - .. code-block:: shell - - go get github.com/apache/arrow-adbc/go/adbc/drivermgr - - .. tab-item:: Python - :sync: python - - .. code-block:: shell - - # For conda-forge - mamba install adbc-driver-postgresql - - # For pip - pip install adbc_driver_postgresql - - .. tab-item:: R - :sync: r - - .. code-block:: r - - install.packages("adbcpostgresql") +.. adbc_driver_installation:: ../../../c/driver/postgresql/README.md Usage ===== diff --git a/main/_sources/driver/snowflake.rst.txt b/main/_sources/driver/snowflake.rst.txt index 38969e2ca..beb94ba4b 100644 --- a/main/_sources/driver/snowflake.rst.txt +++ b/main/_sources/driver/snowflake.rst.txt @@ -19,48 +19,14 @@ Snowflake Driver ================ -**Available for:** C/C++, GLib/Ruby, Go, Python, R +.. adbc_driver_status:: ../../../c/driver/snowflake/README.md The Snowflake Driver provides access to Snowflake Database Warehouses. Installation ============ -.. tab-set:: - - .. tab-item:: C/C++ - :sync: cpp - - For conda-forge users: - - .. code-block:: shell - - mamba install libadbc-driver-snowflake - - .. tab-item:: Go - :sync: go - - .. code-block:: shell - - go get github.com/apache/arrow-adbc/go/adbc/driver/snowflake - - .. tab-item:: Python - :sync: python - - .. code-block:: shell - - # For conda-forge - mamba install adbc-driver-snowflake - - # For pip - pip install adbc_driver_snowflake - - .. tab-item:: R - :sync: r - - .. code-block:: shell - - install.packages("adbcsnowflake", repos = "https://community.r-multiverse.org") +.. adbc_driver_installation:: ../../../c/driver/snowflake/README.md Usage ===== diff --git a/main/_sources/driver/sqlite.rst.txt b/main/_sources/driver/sqlite.rst.txt index fc6b41384..a1c113d3d 100644 --- a/main/_sources/driver/sqlite.rst.txt +++ b/main/_sources/driver/sqlite.rst.txt @@ -19,7 +19,7 @@ SQLite Driver ============= -**Available for:** C/C++, GLib/Ruby, Go, Python, R +.. adbc_driver_status:: ../../../c/driver/sqlite/README.md The SQLite driver provides access to SQLite databases. @@ -30,44 +30,7 @@ not received attention to optimization. Installation ============ -.. tab-set:: - - .. tab-item:: C/C++ - :sync: cpp - - For conda-forge users: - - .. code-block:: shell - - mamba install libadbc-driver-sqlite - - .. tab-item:: Go - :sync: go - - Install the C/C++ package and use the Go driver manager. - Requires CGO. - - .. code-block:: shell - - go get github.com/apache/arrow-adbc/go/adbc/drivermgr - - .. tab-item:: Python - :sync: python - - .. code-block:: shell - - # For conda-forge - mamba install adbc-driver-sqlite - - # For pip - pip install adbc_driver_sqlite - - .. tab-item:: R - :sync: r - - .. code-block:: r - - install.packages("adbcsqlite") +.. adbc_driver_installation:: ../../../c/driver/sqlite/README.md Usage ===== diff --git a/main/_sources/driver/status.rst.txt b/main/_sources/driver/status.rst.txt index a32db56a9..141438f32 100644 --- a/main/_sources/driver/status.rst.txt +++ b/main/_sources/driver/status.rst.txt @@ -25,90 +25,45 @@ Driver Implementation Status details, see `GH-1841 <https://github.com/apache/arrow-adbc/issues/1841>`_. -Implementation Status -===================== - -**Experimental** drivers are not feature-complete and the implementation is still progressing. -**Beta** drivers are (mostly) feature-complete but have only been available for a short time. -**Stable** drivers are (mostly) feature-complete (as much as possible for the underlying database) and have been available/tested for a while. - .. note:: Drivers that support C/C++ can also be used from C#, GLib, Go, Python, R, Ruby, and Rust, regardless of their implementation language. -.. list-table:: - :header-rows: 1 - - * - Driver - - Supported Languages - - Implementation Language - - Status - - * - Apache DataFusion - - Rust - - Rust - - Experimental - - * - BigQuery (C#) - - C# - - C# - - Experimental - - * - BigQuery (Go) - - C/C++ - - Go - - Experimental - - * - DuckDB [#duckdb]_ - - C/C++ - - C++ - - Stable - - * - Flight SQL (Go) - - C/C++, C# [#wrapper]_ - - Go - - Stable - - * - Flight SQL (Java) - - Java - - Java - - Experimental - - * - JDBC Adapter - - Java - - Java - - Experimental +.. _driver-status: - * - PostgreSQL - - C/C++ - - C++ - - Stable +Driver Status +============= - * - SQLite - - C/C++ - - C - - Stable +**Experimental** drivers are not feature-complete and the implementation is still progressing. +**Beta** drivers are (mostly) feature-complete but have only been available for a short time. +**Stable** drivers are (mostly) feature-complete (as much as possible for the underlying database) and have been available/tested for a while. - * - Snowflake - - C/C++, Rust [#wrapper]_ - - Go - - Stable +Feature Support +=============== - * - Thrift protocol-based [#thrift]_ - - C# - - C# - - Experimental +.. adbc_driver_status_table:: + + ../../../c/driver/bigquery/README.md + ../../../csharp/src/Drivers/Apache/Hive2/README.md + ../../../csharp/src/Drivers/Apache/Impala/README.md + ../../../csharp/src/Drivers/Apache/Spark/README.md + ../../../csharp/src/Drivers/BigQuery/readme.md + ../../../csharp/src/Drivers/Databricks/readme.md + ../../../csharp/src/Drivers/FlightSql/README.md + ../../../java/driver/flight-sql/README.md + ../../../rust/driver/datafusion/README.md + ./duckdb => ../../../c/integration/duckdb/README.md [#duckdb] + ./flight_sql => ../../../c/driver/flightsql/README.md + ./jdbc => ../../../java/driver/jdbc/README.md + ./postgresql => ../../../c/driver/postgresql/README.md + ./snowflake => ../../../c/driver/snowflake/README.md + ./sqlite => ../../../c/driver/sqlite/README.md .. [#duckdb] DuckDB is developed and provided by a third party. See the `DuckDB documentation <https://duckdb.org/docs/stable/clients/adbc.html>`_ for details. -.. [#thrift] Supports Apache Hive/Impala/Spark. - -.. [#wrapper] Listed separately because a wrapper package is provided that - combines the driver and the bindings for you. - Feature Support =============== diff --git a/main/driver/duckdb.html b/main/driver/duckdb.html index 7bfdbeb88..a74b9a0af 100644 --- a/main/driver/duckdb.html +++ b/main/driver/duckdb.html @@ -9,10 +9,10 @@ <meta property="og:type" content="website" /> <meta property="og:url" content="https://arrow.apache.org/adbc/main/driver/duckdb.html" /> <meta property="og:site_name" content="ADBC" /> -<meta property="og:description" content="Available for: C/C++, GLib/Ruby, Go, Python, R DuckDB provides ADBC support since version 0.8.0. Installation: See the DuckDB documentation. Usage: ADBC support in DuckDB requires the driver manage..." /> +<meta property="og:description" content="Language: C/C++ Status: Stable DuckDB provides ADBC support since version 0.8.0. Installation: See the DuckDB documentation. Usage: ADBC support in DuckDB requires the driver manager. C++ See the D..." /> <meta property="og:image" content="https://arrow.apache.org/adbc/main/_static/banner.png" /> <meta property="og:image:alt" content="ADBC" /> -<meta name="description" content="Available for: C/C++, GLib/Ruby, Go, Python, R DuckDB provides ADBC support since version 0.8.0. Installation: See the DuckDB documentation. Usage: ADBC support in DuckDB requires the driver manage..." /> +<meta name="description" content="Language: C/C++ Status: Stable DuckDB provides ADBC support since version 0.8.0. Installation: See the DuckDB documentation. Usage: ADBC support in DuckDB requires the driver manager. C++ See the D..." /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Flight SQL Driver" href="flight_sql.html" /><link rel="prev" title="Driver Implementation Status" href="status.html" /> <!-- Generated with Sphinx 8.2.3 and Furo 2024.08.06 --> @@ -396,7 +396,8 @@ <article role="main" id="furo-main-content"> <section id="duckdb-support"> <h1>DuckDB Support<a class="headerlink" href="#duckdb-support" title="Link to this heading">¶</a></h1> -<p><strong>Available for:</strong> C/C++, GLib/Ruby, Go, Python, R</p> +<p><span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">Language: C/C++</span> +<a class="sd-sphinx-override sd-badge sd-bg-success sd-bg-text-success reference internal" href="status.html#driver-status"><span class="std std-ref">Status: Stable</span></a></p> <p><a class="reference external" href="https://duckdb.org/">DuckDB</a> provides ADBC support since <a class="reference external" href="https://duckdb.org/2023/05/17/announcing-duckdb-080.html">version 0.8.0</a>.</p> <div class="admonition note"> <p class="admonition-title">Note</p> diff --git a/main/driver/flight_sql.html b/main/driver/flight_sql.html index 54efc8f1a..c9c51a2ec 100644 --- a/main/driver/flight_sql.html +++ b/main/driver/flight_sql.html @@ -9,10 +9,10 @@ <meta property="og:type" content="website" /> <meta property="og:url" content="https://arrow.apache.org/adbc/main/driver/flight_sql.html" /> <meta property="og:site_name" content="ADBC" /> -<meta property="og:description" content="Available for: C/C++, GLib/Ruby, Go, Java, Python, R The Flight SQL Driver provides access to any database implementing a Arrow Flight SQL compatible endpoint. Installation: C/C++ For conda-forge u..." /> +<meta property="og:description" content="Language: Go Status: Stable The Flight SQL Driver provides access to any database implementing a Arrow Flight SQL compatible endpoint. Installation: C/C++ Install libadbc-driver-flightsql from cond..." /> <meta property="og:image" content="https://arrow.apache.org/adbc/main/_static/banner.png" /> <meta property="og:image:alt" content="ADBC" /> -<meta name="description" content="Available for: C/C++, GLib/Ruby, Go, Java, Python, R The Flight SQL Driver provides access to any database implementing a Arrow Flight SQL compatible endpoint. Installation: C/C++ For conda-forge u..." /> +<meta name="description" content="Language: Go Status: Stable The Flight SQL Driver provides access to any database implementing a Arrow Flight SQL compatible endpoint. Installation: C/C++ Install libadbc-driver-flightsql from cond..." /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="JDBC Adapter" href="jdbc.html" /><link rel="prev" title="DuckDB Support" href="duckdb.html" /> <!-- Generated with Sphinx 8.2.3 and Furo 2024.08.06 --> @@ -396,7 +396,8 @@ <article role="main" id="furo-main-content"> <section id="flight-sql-driver"> <h1>Flight SQL Driver<a class="headerlink" href="#flight-sql-driver" title="Link to this heading">¶</a></h1> -<p><strong>Available for:</strong> C/C++, GLib/Ruby, Go, Java, Python, R</p> +<p><span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">Language: Go</span> +<a class="sd-sphinx-override sd-badge sd-bg-success sd-bg-text-success reference internal" href="status.html#driver-status"><span class="std std-ref">Status: Stable</span></a></p> <p>The Flight SQL Driver provides access to any database implementing a <a class="reference external" href="https://arrow.apache.org/docs/format/FlightSql.html" title="(in Apache Arrow v20.0.0)"><span>Arrow Flight SQL</span></a> compatible endpoint.</p> <section id="installation"> @@ -405,7 +406,7 @@ <input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" data-sync-group="tab" data-sync-id="cpp" for="sd-tab-item-0"> C/C++</label><div class="sd-tab-content docutils"> -<p>For conda-forge users:</p> +<p>Install <a class="reference external" href="https://anaconda.org/conda-forge/libadbc-driver-flightsql">libadbc-driver-flightsql</a> from conda-forge:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>mamba<span class="w"> </span>install<span class="w"> </span>libadbc-driver-flightsql </pre></div> </div> @@ -413,49 +414,41 @@ C/C++</label><div class="sd-tab-content docutils"> <input id="sd-tab-item-1" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" data-sync-group="tab" data-sync-id="go" for="sd-tab-item-1"> Go</label><div class="sd-tab-content docutils"> -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>go<span class="w"> </span>get<span class="w"> </span>github.com/apache/arrow-adbc/go/adbc +<p>Install the C/C++ driver, then use the Go driver manager. Requires CGO.</p> +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>go<span class="w"> </span>get<span class="w"> </span>github.com/apache/arrow-adbc/go/adbc/drivermgr </pre></div> </div> </div> <input id="sd-tab-item-2" name="sd-tab-set-0" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="java" for="sd-tab-item-2"> -Java</label><div class="sd-tab-content docutils"> -<p>Add a dependency on <code class="docutils literal notranslate"><span class="pre">org.apache.arrow.adbc:adbc-driver-flight-sql</span></code>.</p> -<p>For Maven users:</p> -<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><dependency></span> -<span class="w"> </span><span class="nt"><groupId></span>org.apache.arrow.adbc<span class="nt"></groupId></span> -<span class="w"> </span><span class="nt"><artifactId></span>adbc-driver-flight-sql<span class="nt"></artifactId></span> -<span class="nt"></dependency></span> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="python" for="sd-tab-item-2"> +Python</label><div class="sd-tab-content docutils"> +<p>Install <a class="reference external" href="https://anaconda.org/conda-forge/adbc-driver-flightsql">adbc-driver-flightsql</a> from conda-forge:</p> +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>mamba<span class="w"> </span>install<span class="w"> </span>adbc-driver-flightsql </pre></div> </div> -</div> -<input id="sd-tab-item-3" name="sd-tab-set-0" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="python" for="sd-tab-item-3"> -Python</label><div class="sd-tab-content docutils"> -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># For conda-forge</span> -mamba<span class="w"> </span>install<span class="w"> </span>adbc-driver-flightsql - -<span class="c1"># For pip</span> -pip<span class="w"> </span>install<span class="w"> </span>adbc_driver_flightsql +<p>Install <a class="reference external" href="https://pypi.org/project/adbc-driver-flightsql/">adbc-driver-flightsql</a> from PyPI:</p> +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>adbc-driver-flightsql </pre></div> </div> </div> -<input id="sd-tab-item-4" name="sd-tab-set-0" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="r" for="sd-tab-item-4"> +<input id="sd-tab-item-3" name="sd-tab-set-0" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="r" for="sd-tab-item-3"> R</label><div class="sd-tab-content docutils"> +<p>Install <a class="reference external" href="https://community.r-multiverse.org/adbcflightsql/">adbcflightsql</a> from R-multiverse:</p> <div class="highlight-r notranslate"><div class="highlight"><pre><span></span><span class="nf">install.packages</span><span class="p">(</span><span class="s">"adbcflightsql"</span><span class="p">,</span><span class="w"> </span><span class="n">repos</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"https://community.r-multiverse.org"</span><span class="p">)</span> </pre></div> </div> </div> </div> +<p>Additionally, the driver may be used from C/C++, C#, GLib, Go, R, Ruby, and Rust via the driver manager.</p> </section> <section id="usage"> <h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">¶</a></h2> <p>To connect to a database, supply the “uri” parameter when constructing the <a class="reference external" href="https://arrow.apache.org/adbc/main/cpp/api/group__adbc-database.html#structAdbcDatabase" title="(in ADBC C vversion)"><code class="xref c c-struct docutils literal notranslate"><span class="pre">AdbcDatabase</span></code></a>.</p> <div class="sd-tab-set docutils"> -<input checked="checked" id="sd-tab-item-5" name="sd-tab-set-1" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="cpp" for="sd-tab-item-5"> +<input checked="checked" id="sd-tab-item-4" name="sd-tab-set-1" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="cpp" for="sd-tab-item-4"> C++</label><div class="sd-tab-content docutils"> <div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">"arrow-adbc/adbc.h"</span> @@ -468,8 +461,8 @@ C++</label><div class="sd-tab-content docutils"> </pre></div> </div> </div> -<input id="sd-tab-item-6" name="sd-tab-set-1" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="python" for="sd-tab-item-6"> +<input id="sd-tab-item-5" name="sd-tab-set-1" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="python" for="sd-tab-item-5"> Python</label><div class="sd-tab-content docutils"> <div class="admonition note"> <p class="admonition-title">Note</p> @@ -495,8 +488,8 @@ Python</label><div class="sd-tab-content docutils"> </pre></div> </div> </div> -<input id="sd-tab-item-7" name="sd-tab-set-1" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="go" for="sd-tab-item-7"> +<input id="sd-tab-item-6" name="sd-tab-set-1" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="go" for="sd-tab-item-6"> Go</label><div class="sd-tab-content docutils"> <p>Recipe source: <a class="reference external" href="https://github.com/apache/arrow-adbc/blob/main/docs/source/../../go/adbc/driver/flightsql/example_usage_test.go">example_usage_test.go</a></p> <div class="highlight-go notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 20</span><span class="c1">// Tests that use the SQLite server example.</span> diff --git a/main/driver/jdbc.html b/main/driver/jdbc.html index 0f352bc26..cb3c4579b 100644 --- a/main/driver/jdbc.html +++ b/main/driver/jdbc.html @@ -9,10 +9,10 @@ <meta property="og:type" content="website" /> <meta property="og:url" content="https://arrow.apache.org/adbc/main/driver/jdbc.html" /> <meta property="og:site_name" content="ADBC" /> -<meta property="og:description" content="Available for: Java The JDBC Adapter provides access to any database with a JDBC driver. Installation: Java Add a dependency on org.apache.arrow.adbc:adbc-driver-jdbc. For Maven users: Usage: To co..." /> +<meta property="og:description" content="Language: Java Status: Beta The JDBC Adapter provides access to any database with a JDBC driver. Installation: Java Install org.apache.arrow.adbc:adbc-driver-jdbc from Maven: Usage: To connect to a..." /> <meta property="og:image" content="https://arrow.apache.org/adbc/main/_static/banner.png" /> <meta property="og:image:alt" content="ADBC" /> -<meta name="description" content="Available for: Java The JDBC Adapter provides access to any database with a JDBC driver. Installation: Java Add a dependency on org.apache.arrow.adbc:adbc-driver-jdbc. For Maven users: Usage: To co..." /> +<meta name="description" content="Language: Java Status: Beta The JDBC Adapter provides access to any database with a JDBC driver. Installation: Java Install org.apache.arrow.adbc:adbc-driver-jdbc from Maven: Usage: To connect to a..." /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="PostgreSQL Driver" href="postgresql.html" /><link rel="prev" title="Flight SQL Driver" href="flight_sql.html" /> <!-- Generated with Sphinx 8.2.3 and Furo 2024.08.06 --> @@ -396,7 +396,8 @@ <article role="main" id="furo-main-content"> <section id="jdbc-adapter"> <h1>JDBC Adapter<a class="headerlink" href="#jdbc-adapter" title="Link to this heading">¶</a></h1> -<p><strong>Available for:</strong> Java</p> +<p><span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">Language: Java</span> +<a class="sd-sphinx-override sd-badge sd-bg-warning sd-bg-text-warning reference internal" href="status.html#driver-status"><span class="std std-ref">Status: Beta</span></a></p> <p>The JDBC Adapter provides access to any database with a JDBC driver.</p> <section id="installation"> <h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2> @@ -404,8 +405,7 @@ <input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" data-sync-group="tab" data-sync-id="java" for="sd-tab-item-0"> Java</label><div class="sd-tab-content docutils"> -<p>Add a dependency on <code class="docutils literal notranslate"><span class="pre">org.apache.arrow.adbc:adbc-driver-jdbc</span></code>.</p> -<p>For Maven users:</p> +<p>Install <a class="reference external" href="https://mvnrepository.com/artifact/org.apache.arrow.adbc/adbc-driver-jdbc">org.apache.arrow.adbc:adbc-driver-jdbc</a> from Maven:</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><dependency></span> <span class="w"> </span><span class="nt"><groupId></span>org.apache.arrow.adbc<span class="nt"></groupId></span> <span class="w"> </span><span class="nt"><artifactId></span>adbc-driver-jdbc<span class="nt"></artifactId></span> diff --git a/main/driver/postgresql.html b/main/driver/postgresql.html index f42f8e79b..2487be31b 100644 --- a/main/driver/postgresql.html +++ b/main/driver/postgresql.html @@ -9,10 +9,10 @@ <meta property="og:type" content="website" /> <meta property="og:url" content="https://arrow.apache.org/adbc/main/driver/postgresql.html" /> <meta property="og:site_name" content="ADBC" /> -<meta property="og:description" content="Available for: C/C++, GLib/Ruby, Go, Python, R The PostgreSQL driver provides access to any database that supports the PostgreSQL wire format. It wraps libpq, the client library for PostgreSQL. The..." /> +<meta property="og:description" content="Language: C/C++ Status: Stable The PostgreSQL driver provides access to any database that supports the PostgreSQL wire format. It wraps libpq, the client library for PostgreSQL. The project owes cr..." /> <meta property="og:image" content="https://arrow.apache.org/adbc/main/_static/banner.png" /> <meta property="og:image:alt" content="ADBC" /> -<meta name="description" content="Available for: C/C++, GLib/Ruby, Go, Python, R The PostgreSQL driver provides access to any database that supports the PostgreSQL wire format. It wraps libpq, the client library for PostgreSQL. The..." /> +<meta name="description" content="Language: C/C++ Status: Stable The PostgreSQL driver provides access to any database that supports the PostgreSQL wire format. It wraps libpq, the client library for PostgreSQL. The project owes cr..." /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Snowflake Driver" href="snowflake.html" /><link rel="prev" title="JDBC Adapter" href="jdbc.html" /> <!-- Generated with Sphinx 8.2.3 and Furo 2024.08.06 --> @@ -396,7 +396,8 @@ <article role="main" id="furo-main-content"> <section id="postgresql-driver"> <h1>PostgreSQL Driver<a class="headerlink" href="#postgresql-driver" title="Link to this heading">¶</a></h1> -<p><strong>Available for:</strong> C/C++, GLib/Ruby, Go, Python, R</p> +<p><span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">Language: C/C++</span> +<a class="sd-sphinx-override sd-badge sd-bg-success sd-bg-text-success reference internal" href="status.html#driver-status"><span class="std std-ref">Status: Stable</span></a></p> <p>The PostgreSQL driver provides access to any database that supports the PostgreSQL wire format. It wraps <a class="reference external" href="https://www.postgresql.org/docs/current/libpq.html">libpq</a>, the client library for PostgreSQL. The project owes credit to 0x0L’s <a class="reference external" href="https://github.com/0x0L/pgeon">pgeon</a> for the @@ -407,18 +408,12 @@ overall approach.</p> </div> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>The PostgreSQL driver is in beta. -Performance/optimization and support for complex types and -different ADBC features is still ongoing.</p> -</div> -<div class="admonition note"> -<p class="admonition-title">Note</p> -<p>AWS Redshift supports a very old version of the PostgreSQL -wire protocol and has a basic level of support in the ADBC -PostgreSQL driver. Because Redshift does not support reading or -writing COPY in PostgreSQL binary format, the optimizations that -accelerate non-Redshift queries are not enabled when connecting -to a Redshift database. This functionality is experimental.</p> +<p>This driver has experimental support for Amazon Redshift. As +Redshift does not support reading or writing COPY in PostgreSQL +binary format, however, the optimizations that accelerate queries +are not enabled when connecting to Redshift. There may also be +other differences in functionality; please file a bug report if +problems are encountered.</p> </div> <section id="installation"> <h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2> @@ -426,7 +421,7 @@ to a Redshift database. This functionality is experimental.</p> <input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" data-sync-group="tab" data-sync-id="cpp" for="sd-tab-item-0"> C/C++</label><div class="sd-tab-content docutils"> -<p>For conda-forge users:</p> +<p>Install <a class="reference external" href="https://anaconda.org/conda-forge/libadbc-driver-postgresql">libadbc-driver-postgresql</a> from conda-forge:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>mamba<span class="w"> </span>install<span class="w"> </span>libadbc-driver-postgresql </pre></div> </div> @@ -434,8 +429,7 @@ C/C++</label><div class="sd-tab-content docutils"> <input id="sd-tab-item-1" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" data-sync-group="tab" data-sync-id="go" for="sd-tab-item-1"> Go</label><div class="sd-tab-content docutils"> -<p>Install the C/C++ package and use the Go driver manager. -Requires CGO.</p> +<p>Install the C/C++ driver, then use the Go driver manager. Requires CGO.</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>go<span class="w"> </span>get<span class="w"> </span>github.com/apache/arrow-adbc/go/adbc/drivermgr </pre></div> </div> @@ -443,22 +437,25 @@ Requires CGO.</p> <input id="sd-tab-item-2" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" data-sync-group="tab" data-sync-id="python" for="sd-tab-item-2"> Python</label><div class="sd-tab-content docutils"> -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># For conda-forge</span> -mamba<span class="w"> </span>install<span class="w"> </span>adbc-driver-postgresql - -<span class="c1"># For pip</span> -pip<span class="w"> </span>install<span class="w"> </span>adbc_driver_postgresql +<p>Install <a class="reference external" href="https://anaconda.org/conda-forge/adbc-driver-postgresql">adbc-driver-postgresql</a> from conda-forge:</p> +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>mamba<span class="w"> </span>install<span class="w"> </span>adbc-driver-postgresql +</pre></div> +</div> +<p>Install <a class="reference external" href="https://pypi.org/project/adbc-driver-postgresql/">adbc-driver-postgresql</a> from PyPI:</p> +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>adbc-driver-postgresql </pre></div> </div> </div> <input id="sd-tab-item-3" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" data-sync-group="tab" data-sync-id="r" for="sd-tab-item-3"> R</label><div class="sd-tab-content docutils"> +<p>Install <a class="reference external" href="https://cran.r-project.org/web/packages/adbcpostgresql/index.html">adbcpostgresql</a> from CRAN:</p> <div class="highlight-r notranslate"><div class="highlight"><pre><span></span><span class="nf">install.packages</span><span class="p">(</span><span class="s">"adbcpostgresql"</span><span class="p">)</span> </pre></div> </div> </div> </div> +<p>Additionally, the driver may be used from C/C++, C#, GLib, Go, R, Ruby, and Rust via the driver manager.</p> </section> <section id="usage"> <h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">¶</a></h2> diff --git a/main/driver/snowflake.html b/main/driver/snowflake.html index c2b1aee5f..99ae6da6d 100644 --- a/main/driver/snowflake.html +++ b/main/driver/snowflake.html @@ -9,10 +9,10 @@ <meta property="og:type" content="website" /> <meta property="og:url" content="https://arrow.apache.org/adbc/main/driver/snowflake.html" /> <meta property="og:site_name" content="ADBC" /> -<meta property="og:description" content="Available for: C/C++, GLib/Ruby, Go, Python, R The Snowflake Driver provides access to Snowflake Database Warehouses. Installation: C/C++ For conda-forge users: Go Python R Usage: To connect to a S..." /> +<meta property="og:description" content="Language: Go Status: Stable The Snowflake Driver provides access to Snowflake Database Warehouses. Installation: C# Install Apache.Arrow.Adbc.Drivers.Interop.Snowflake from NuGet: C/C++ Install lib..." /> <meta property="og:image" content="https://arrow.apache.org/adbc/main/_static/banner.png" /> <meta property="og:image:alt" content="ADBC" /> -<meta name="description" content="Available for: C/C++, GLib/Ruby, Go, Python, R The Snowflake Driver provides access to Snowflake Database Warehouses. Installation: C/C++ For conda-forge users: Go Python R Usage: To connect to a S..." /> +<meta name="description" content="Language: Go Status: Stable The Snowflake Driver provides access to Snowflake Database Warehouses. Installation: C# Install Apache.Arrow.Adbc.Drivers.Interop.Snowflake from NuGet: C/C++ Install lib..." /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="SQLite Driver" href="sqlite.html" /><link rel="prev" title="PostgreSQL Driver" href="postgresql.html" /> <!-- Generated with Sphinx 8.2.3 and Furo 2024.08.06 --> @@ -396,53 +396,74 @@ <article role="main" id="furo-main-content"> <section id="snowflake-driver"> <h1>Snowflake Driver<a class="headerlink" href="#snowflake-driver" title="Link to this heading">¶</a></h1> -<p><strong>Available for:</strong> C/C++, GLib/Ruby, Go, Python, R</p> +<p><span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">Language: Go</span> +<a class="sd-sphinx-override sd-badge sd-bg-success sd-bg-text-success reference internal" href="status.html#driver-status"><span class="std std-ref">Status: Stable</span></a></p> <p>The Snowflake Driver provides access to Snowflake Database Warehouses.</p> <section id="installation"> <h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2> <div class="sd-tab-set docutils"> <input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="cpp" for="sd-tab-item-0"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="csharp" for="sd-tab-item-0"> +C#</label><div class="sd-tab-content docutils"> +<p>Install <a class="reference external" href="https://www.nuget.org/packages/Apache.Arrow.Adbc.Drivers.Interop.Snowflake">Apache.Arrow.Adbc.Drivers.Interop.Snowflake</a> from NuGet:</p> +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>dotnet<span class="w"> </span>package<span class="w"> </span>add<span class="w"> </span>Apache.Arrow.Adbc.Drivers.Interop.Snowflake +</pre></div> +</div> +</div> +<input id="sd-tab-item-1" name="sd-tab-set-0" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="cpp" for="sd-tab-item-1"> C/C++</label><div class="sd-tab-content docutils"> -<p>For conda-forge users:</p> +<p>Install <a class="reference external" href="https://anaconda.org/conda-forge/libadbc-driver-snowflake">libadbc-driver-snowflake</a> from conda-forge:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>mamba<span class="w"> </span>install<span class="w"> </span>libadbc-driver-snowflake </pre></div> </div> </div> -<input id="sd-tab-item-1" name="sd-tab-set-0" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="go" for="sd-tab-item-1"> +<input id="sd-tab-item-2" name="sd-tab-set-0" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="go" for="sd-tab-item-2"> Go</label><div class="sd-tab-content docutils"> +<p>Install <a class="reference external" href="https://pkg.go.dev/github.com/apache/arrow-adbc/go/adbc/driver/snowflake">github.com/apache/arrow-adbc/go/adbc/driver/snowflake</a> from Go:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>go<span class="w"> </span>get<span class="w"> </span>github.com/apache/arrow-adbc/go/adbc/driver/snowflake </pre></div> </div> </div> -<input id="sd-tab-item-2" name="sd-tab-set-0" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="python" for="sd-tab-item-2"> +<input id="sd-tab-item-3" name="sd-tab-set-0" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="python" for="sd-tab-item-3"> Python</label><div class="sd-tab-content docutils"> -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># For conda-forge</span> -mamba<span class="w"> </span>install<span class="w"> </span>adbc-driver-snowflake - -<span class="c1"># For pip</span> -pip<span class="w"> </span>install<span class="w"> </span>adbc_driver_snowflake +<p>Install <a class="reference external" href="https://anaconda.org/conda-forge/adbc-driver-snowflake">adbc-driver-snowflake</a> from conda-forge:</p> +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>mamba<span class="w"> </span>install<span class="w"> </span>adbc-driver-snowflake </pre></div> </div> +<p>Install <a class="reference external" href="https://pypi.org/project/adbc-driver-snowflake/">adbc-driver-snowflake</a> from PyPI:</p> +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>adbc-driver-snowflake +</pre></div> </div> -<input id="sd-tab-item-3" name="sd-tab-set-0" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="r" for="sd-tab-item-3"> +</div> +<input id="sd-tab-item-4" name="sd-tab-set-0" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="r" for="sd-tab-item-4"> R</label><div class="sd-tab-content docutils"> -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>install.packages<span class="o">(</span><span class="s2">"adbcsnowflake"</span>,<span class="w"> </span><span class="nv">repos</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"https://community.r-multiverse.org"</span><span class="o">)</span> +<p>Install <a class="reference external" href="https://community.r-multiverse.org/adbcsnowflake/">adbcsnowflake</a> from R-multiverse:</p> +<div class="highlight-r notranslate"><div class="highlight"><pre><span></span><span class="nf">install.packages</span><span class="p">(</span><span class="s">"adbcsnowflake"</span><span class="p">,</span><span class="w"> </span><span class="n">repos</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"https://community.r-multiverse.org"</span><span class="p">)</span> +</pre></div> +</div> +</div> +<input id="sd-tab-item-5" name="sd-tab-set-0" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="rust" for="sd-tab-item-5"> +Rust</label><div class="sd-tab-content docutils"> +<p>Install <a class="reference external" href="https://crates.io/crates/adbc_snowflake">adbc_snowflake</a> from crates.io:</p> +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>cargo<span class="w"> </span>add<span class="w"> </span>adbc_snowflake </pre></div> </div> </div> </div> +<p>Additionally, the driver may be used from C/C++, C#, GLib, Go, R, Ruby, and Rust via the driver manager.</p> </section> <section id="usage"> <h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">¶</a></h2> <p>To connect to a Snowflake database you can supply the “uri” parameter when constructing the <a class="reference external" href="https://arrow.apache.org/adbc/main/cpp/api/group__adbc-database.html#structAdbcDatabase" title="(in ADBC C vversion)"><code class="xref c c-struct docutils literal notranslate"><span class="pre">AdbcDatabase</span></code></a>.</p> <div class="sd-tab-set docutils"> -<input checked="checked" id="sd-tab-item-4" name="sd-tab-set-1" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="cpp" for="sd-tab-item-4"> +<input checked="checked" id="sd-tab-item-6" name="sd-tab-set-1" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="cpp" for="sd-tab-item-6"> C++</label><div class="sd-tab-content docutils"> <div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">"arrow-adbc/adbc.h"</span> @@ -455,8 +476,8 @@ C++</label><div class="sd-tab-content docutils"> </pre></div> </div> </div> -<input id="sd-tab-item-5" name="sd-tab-set-1" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="python" for="sd-tab-item-5"> +<input id="sd-tab-item-7" name="sd-tab-set-1" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="python" for="sd-tab-item-7"> Python</label><div class="sd-tab-content docutils"> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">adbc_driver_snowflake.dbapi</span> @@ -465,8 +486,8 @@ Python</label><div class="sd-tab-content docutils"> </pre></div> </div> </div> -<input id="sd-tab-item-6" name="sd-tab-set-1" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="r" for="sd-tab-item-6"> +<input id="sd-tab-item-8" name="sd-tab-set-1" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="r" for="sd-tab-item-8"> R</label><div class="sd-tab-content docutils"> <div class="highlight-r notranslate"><div class="highlight"><pre><span></span><span class="nf">library</span><span class="p">(</span><span class="n">adbcdrivermanager</span><span class="p">)</span> @@ -477,8 +498,8 @@ R</label><div class="sd-tab-content docutils"> </pre></div> </div> </div> -<input id="sd-tab-item-7" name="sd-tab-set-1" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="go" for="sd-tab-item-7"> +<input id="sd-tab-item-9" name="sd-tab-set-1" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="go" for="sd-tab-item-9"> Go</label><div class="sd-tab-content docutils"> <div class="highlight-go notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="p">(</span> <span class="w"> </span><span class="s">"context"</span> @@ -561,8 +582,8 @@ object. Some users have reported needing other configuration options, such as <code class="docutils literal notranslate"><span class="pre">adbc.snowflake.sql.region</span></code> and <code class="docutils literal notranslate"><span class="pre">adbc.snowflake.sql.uri.*</span></code> (see below for a listing).</p> <div class="sd-tab-set docutils"> -<input checked="checked" id="sd-tab-item-8" name="sd-tab-set-2" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="python" for="sd-tab-item-8"> +<input checked="checked" id="sd-tab-item-10" name="sd-tab-set-2" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="python" for="sd-tab-item-10"> Python</label><div class="sd-tab-content docutils"> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">adbc_driver_snowflake.dbapi</span> <span class="c1"># This will open a new browser tab, and block until you log in.</span> @@ -574,8 +595,8 @@ Python</label><div class="sd-tab-content docutils"> </pre></div> </div> </div> -<input id="sd-tab-item-9" name="sd-tab-set-2" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="r" for="sd-tab-item-9"> +<input id="sd-tab-item-11" name="sd-tab-set-2" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="r" for="sd-tab-item-11"> R</label><div class="sd-tab-content docutils"> <div class="highlight-r notranslate"><div class="highlight"><pre><span></span><span class="nf">library</span><span class="p">(</span><span class="n">adbcdrivermanager</span><span class="p">)</span> <span class="n">db</span><span class="w"> </span><span class="o"><-</span><span class="w"> </span><span class="nf">adbc_database_init</span><span class="p">(</span> @@ -589,8 +610,8 @@ R</label><div class="sd-tab-content docutils"> </pre></div> </div> </div> -<input id="sd-tab-item-10" name="sd-tab-set-2" type="radio"> -<label class="sd-tab-label" data-sync-group="tab" data-sync-id="go" for="sd-tab-item-10"> +<input id="sd-tab-item-12" name="sd-tab-set-2" type="radio"> +<label class="sd-tab-label" data-sync-group="tab" data-sync-id="go" for="sd-tab-item-12"> Go</label><div class="sd-tab-content docutils"> <div class="highlight-go notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="p">(</span> <span class="w"> </span><span class="s">"context"</span> diff --git a/main/driver/sqlite.html b/main/driver/sqlite.html index 1142692c6..d2cd9c3e6 100644 --- a/main/driver/sqlite.html +++ b/main/driver/sqlite.html @@ -9,10 +9,10 @@ <meta property="og:type" content="website" /> <meta property="og:url" content="https://arrow.apache.org/adbc/main/driver/sqlite.html" /> <meta property="og:site_name" content="ADBC" /> -<meta property="og:description" content="Available for: C/C++, GLib/Ruby, Go, Python, R The SQLite driver provides access to SQLite databases. This driver is essentially a “reference” driver that was used during ADBC development. It gener..." /> +<meta property="og:description" content="Language: C/C++ Status: Stable The SQLite driver provides access to SQLite databases. This driver is essentially a “reference” driver that was used during ADBC development. It generally supports mo..." /> <meta property="og:image" content="https://arrow.apache.org/adbc/main/_static/banner.png" /> <meta property="og:image:alt" content="ADBC" /> -<meta name="description" content="Available for: C/C++, GLib/Ruby, Go, Python, R The SQLite driver provides access to SQLite databases. This driver is essentially a “reference” driver that was used during ADBC development. It gener..." /> +<meta name="description" content="Language: C/C++ Status: Stable The SQLite driver provides access to SQLite databases. This driver is essentially a “reference” driver that was used during ADBC development. It generally supports mo..." /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Writing New Drivers" href="authoring.html" /><link rel="prev" title="Snowflake Driver" href="snowflake.html" /> <!-- Generated with Sphinx 8.2.3 and Furo 2024.08.06 --> @@ -396,7 +396,8 @@ <article role="main" id="furo-main-content"> <section id="sqlite-driver"> <h1>SQLite Driver<a class="headerlink" href="#sqlite-driver" title="Link to this heading">¶</a></h1> -<p><strong>Available for:</strong> C/C++, GLib/Ruby, Go, Python, R</p> +<p><span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">Language: C/C++</span> +<a class="sd-sphinx-override sd-badge sd-bg-success sd-bg-text-success reference internal" href="status.html#driver-status"><span class="std std-ref">Status: Stable</span></a></p> <p>The SQLite driver provides access to SQLite databases.</p> <p>This driver is essentially a “reference” driver that was used during ADBC development. It generally supports most ADBC features but has @@ -407,7 +408,7 @@ not received attention to optimization.</p> <input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" data-sync-group="tab" data-sync-id="cpp" for="sd-tab-item-0"> C/C++</label><div class="sd-tab-content docutils"> -<p>For conda-forge users:</p> +<p>Install <a class="reference external" href="https://anaconda.org/conda-forge/libadbc-driver-sqlite">libadbc-driver-sqlite</a> from conda-forge:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>mamba<span class="w"> </span>install<span class="w"> </span>libadbc-driver-sqlite </pre></div> </div> @@ -415,8 +416,7 @@ C/C++</label><div class="sd-tab-content docutils"> <input id="sd-tab-item-1" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" data-sync-group="tab" data-sync-id="go" for="sd-tab-item-1"> Go</label><div class="sd-tab-content docutils"> -<p>Install the C/C++ package and use the Go driver manager. -Requires CGO.</p> +<p>Install the C/C++ driver, then use the Go driver manager. Requires CGO.</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>go<span class="w"> </span>get<span class="w"> </span>github.com/apache/arrow-adbc/go/adbc/drivermgr </pre></div> </div> @@ -424,22 +424,25 @@ Requires CGO.</p> <input id="sd-tab-item-2" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" data-sync-group="tab" data-sync-id="python" for="sd-tab-item-2"> Python</label><div class="sd-tab-content docutils"> -<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># For conda-forge</span> -mamba<span class="w"> </span>install<span class="w"> </span>adbc-driver-sqlite - -<span class="c1"># For pip</span> -pip<span class="w"> </span>install<span class="w"> </span>adbc_driver_sqlite +<p>Install <a class="reference external" href="https://anaconda.org/conda-forge/adbc-driver-sqlite">adbc-driver-sqlite</a> from conda-forge:</p> +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>mamba<span class="w"> </span>install<span class="w"> </span>adbc-driver-sqlite +</pre></div> +</div> +<p>Install <a class="reference external" href="https://pypi.org/project/adbc-driver-sqlite/">adbc-driver-sqlite</a> from PyPI:</p> +<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>adbc-driver-sqlite </pre></div> </div> </div> <input id="sd-tab-item-3" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" data-sync-group="tab" data-sync-id="r" for="sd-tab-item-3"> R</label><div class="sd-tab-content docutils"> +<p>Install <a class="reference external" href="https://cran.r-project.org/web/packages/adbcsqlite/index.html">adbcsqlite</a> from CRAN:</p> <div class="highlight-r notranslate"><div class="highlight"><pre><span></span><span class="nf">install.packages</span><span class="p">(</span><span class="s">"adbcsqlite"</span><span class="p">)</span> </pre></div> </div> </div> </div> +<p>Additionally, the driver may be used from C/C++, C#, GLib, Go, R, Ruby, and Rust via the driver manager.</p> </section> <section id="usage"> <h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">¶</a></h2> diff --git a/main/driver/status.html b/main/driver/status.html index 69bf83447..0046bf1ef 100644 --- a/main/driver/status.html +++ b/main/driver/status.html @@ -9,10 +9,10 @@ <meta property="og:type" content="website" /> <meta property="og:url" content="https://arrow.apache.org/adbc/main/driver/status.html" /> <meta property="og:site_name" content="ADBC" /> -<meta property="og:description" content="Implementation Status: Experimental drivers are not feature-complete and the implementation is still progressing. Beta drivers are (mostly) feature-complete but have only been available for a short..." /> +<meta property="og:description" content="Driver Status: Experimental drivers are not feature-complete and the implementation is still progressing. Beta drivers are (mostly) feature-complete but have only been available for a short time. S..." /> <meta property="og:image" content="https://arrow.apache.org/adbc/main/_static/banner.png" /> <meta property="og:image:alt" content="ADBC" /> -<meta name="description" content="Implementation Status: Experimental drivers are not feature-complete and the implementation is still progressing. Beta drivers are (mostly) feature-complete but have only been available for a short..." /> +<meta name="description" content="Driver Status: Experimental drivers are not feature-complete and the implementation is still progressing. Beta drivers are (mostly) feature-complete but have only been available for a short time. S..." /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="DuckDB Support" href="duckdb.html" /><link rel="prev" title="Installation" href="installation.html" /> <!-- Generated with Sphinx 8.2.3 and Furo 2024.08.06 --> @@ -403,104 +403,121 @@ written in Go in the same process (unless working in a pure-Go application), where using the second driver may crash. For more details, see <a class="reference external" href="https://github.com/apache/arrow-adbc/issues/1841">GH-1841</a>.</p> </div> -<section id="implementation-status"> -<h2>Implementation Status<a class="headerlink" href="#implementation-status" title="Link to this heading">¶</a></h2> -<p><strong>Experimental</strong> drivers are not feature-complete and the implementation is still progressing. -<strong>Beta</strong> drivers are (mostly) feature-complete but have only been available for a short time. -<strong>Stable</strong> drivers are (mostly) feature-complete (as much as possible for the underlying database) and have been available/tested for a while.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Drivers that support C/C++ can also be used from C#, GLib, Go, Python, R, Ruby, and Rust, regardless of their implementation language.</p> </div> +<section id="driver-status"> +<span id="id1"></span><h2>Driver Status<a class="headerlink" href="#driver-status" title="Link to this heading">¶</a></h2> +<p><strong>Experimental</strong> drivers are not feature-complete and the implementation is still progressing. +<strong>Beta</strong> drivers are (mostly) feature-complete but have only been available for a short time. +<strong>Stable</strong> drivers are (mostly) feature-complete (as much as possible for the underlying database) and have been available/tested for a while.</p> +</section> +<section id="feature-support"> +<h2>Feature Support<a class="headerlink" href="#feature-support" title="Link to this heading">¶</a></h2> <div class="table-wrapper docutils container"> <table class="docutils align-default"> <thead> -<tr class="row-odd"><th class="head"><p>Driver</p></th> -<th class="head"><p>Supported Languages</p></th> -<th class="head"><p>Implementation Language</p></th> -<th class="head"><p>Status</p></th> +<tr class="row-odd"><th class="head"><p>Vendor</p></th> +<th class="head"><p>Implementation</p></th> +<th class="head"><p><a class="reference internal" href="#driver-status"><span class="std std-ref">Driver Status</span></a></p></th> +<th class="head"><p>Packages <a class="footnote-reference brackets" href="#packages" id="id2" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a></p></th> </tr> </thead> <tbody> -<tr class="row-even"><td><p>Apache DataFusion</p></td> -<td><p>Rust</p></td> +<tr class="row-even"><td><p>Apache Arrow Flight SQL</p></td> +<td><p>C#</p></td> +<td><p>Beta</p></td> +<td><p><a class="reference external" href="https://www.nuget.org/packages/Apache.Arrow.Adbc.Drivers.FlightSql">NuGet</a></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="flight_sql.html"><span class="doc">Apache Arrow Flight SQL</span></a></p></td> +<td><p>Go</p></td> +<td><p>Stable</p></td> +<td><p>conda-forge (<a class="reference external" href="https://anaconda.org/conda-forge/adbc-driver-flightsql">adbc-driver-flightsql</a>, <a class="reference external" href="https://anaconda.org/conda-forge/libadbc-driver-flightsql">libadbc-driver-flightsql</a>), <a class="reference external" href="https://pypi.org/project/adbc-driver-flightsql/">PyPI</a>, <a class="reference external" href="https://community.r-multiverse.org/adbcflightsql/">R-multiverse</a></p></td> +</tr> +<tr class="row-even"><td><p>Apache Arrow Flight SQL</p></td> +<td><p>Java</p></td> +<td><p>Beta</p></td> +<td><p><a class="reference external" href="https://mvnrepository.com/artifact/org.apache.arrow.adbc/adbc-driver-flight-sql">Maven</a></p></td> +</tr> +<tr class="row-odd"><td><p>Apache DataFusion</p></td> <td><p>Rust</p></td> <td><p>Experimental</p></td> +<td><p><a class="reference external" href="https://crates.io/crates/adbc_datafusion">crates.io</a></p></td> </tr> -<tr class="row-odd"><td><p>BigQuery (C#)</p></td> +<tr class="row-even"><td><p>Apache Hive</p></td> <td><p>C#</p></td> +<td><p>Experimental</p></td> +<td></td> +</tr> +<tr class="row-odd"><td><p>Apache Impala</p></td> <td><p>C#</p></td> <td><p>Experimental</p></td> +<td></td> </tr> -<tr class="row-even"><td><p>BigQuery (Go)</p></td> -<td><p>C/C++</p></td> -<td><p>Go</p></td> +<tr class="row-even"><td><p>Apache Spark</p></td> +<td><p>C#</p></td> <td><p>Experimental</p></td> +<td></td> </tr> -<tr class="row-odd"><td><p>DuckDB <a class="footnote-reference brackets" href="#duckdb" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a></p></td> +<tr class="row-odd"><td><p>Databricks</p></td> +<td><p>C#</p></td> +<td><p>Experimental</p></td> +<td></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="duckdb.html"><span class="doc">DuckDB</span></a> <a class="footnote-reference brackets" href="#duckdb" id="id3" role="doc-noteref"><span class="fn-bracket">[</span>2<span class="fn-bracket">]</span></a></p></td> <td><p>C/C++</p></td> -<td><p>C++</p></td> <td><p>Stable</p></td> +<td><p><a class="reference external" href="https://anaconda.org/conda-forge/python-duckdb">conda-forge</a>, <a class="reference external" href="https://pypi.org/project/duckdb/">PyPI</a></p></td> </tr> -<tr class="row-even"><td><p>Flight SQL (Go)</p></td> -<td><p>C/C++, C# <a class="footnote-reference brackets" href="#wrapper" id="id2" role="doc-noteref"><span class="fn-bracket">[</span>3<span class="fn-bracket">]</span></a></p></td> -<td><p>Go</p></td> -<td><p>Stable</p></td> +<tr class="row-odd"><td><p>Google BigQuery</p></td> +<td><p>C#</p></td> +<td><p>Beta</p></td> +<td><p><a class="reference external" href="https://www.nuget.org/packages/Apache.Arrow.Adbc.Drivers.BigQuery">NuGet</a></p></td> </tr> -<tr class="row-odd"><td><p>Flight SQL (Java)</p></td> -<td><p>Java</p></td> -<td><p>Java</p></td> +<tr class="row-even"><td><p>Google BigQuery</p></td> +<td><p>Go</p></td> <td><p>Experimental</p></td> +<td><p>conda-forge (<a class="reference external" href="https://anaconda.org/conda-forge/adbc-driver-bigquery">adbc-driver-bigquery</a>, <a class="reference external" href="https://anaconda.org/conda-forge/libadbc-driver-bigquery">libadbc-driver-bigquery</a>), <a class="reference external" href="https://pypi.org/project/adbc-driver-bigquery/">PyPI</a>, <a class="reference external" href="https://community.r-multiverse.org/adbcbigquery/">R-multiverse</a></p></td> </tr> -<tr class="row-even"><td><p>JDBC Adapter</p></td> -<td><p>Java</p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="jdbc.html"><span class="doc">JDBC</span></a></p></td> <td><p>Java</p></td> -<td><p>Experimental</p></td> +<td><p>Beta</p></td> +<td><p><a class="reference external" href="https://mvnrepository.com/artifact/org.apache.arrow.adbc/adbc-driver-jdbc">Maven</a></p></td> </tr> -<tr class="row-odd"><td><p>PostgreSQL</p></td> +<tr class="row-even"><td><p><a class="reference internal" href="postgresql.html"><span class="doc">PostgreSQL</span></a></p></td> <td><p>C/C++</p></td> -<td><p>C++</p></td> <td><p>Stable</p></td> +<td><p>conda-forge (<a class="reference external" href="https://anaconda.org/conda-forge/adbc-driver-postgresql">adbc-driver-postgresql</a>, <a class="reference external" href="https://anaconda.org/conda-forge/libadbc-driver-postgresql">libadbc-driver-postgresql</a>), <a class="reference external" href="https://cran.r-project.org/web/packages/adbcpostgresql/index.html">CRAN</a>, <a class="reference external" href="https://pypi.org/project/adbc-driver-postgresql/">PyPI</a></p></td> </tr> -<tr class="row-even"><td><p>SQLite</p></td> +<tr class="row-odd"><td><p><a class="reference internal" href="sqlite.html"><span class="doc">SQLite</span></a></p></td> <td><p>C/C++</p></td> -<td><p>C</p></td> <td><p>Stable</p></td> +<td><p>conda-forge (<a class="reference external" href="https://anaconda.org/conda-forge/adbc-driver-sqlite">adbc-driver-sqlite</a>, <a class="reference external" href="https://anaconda.org/conda-forge/libadbc-driver-sqlite">libadbc-driver-sqlite</a>), <a class="reference external" href="https://cran.r-project.org/web/packages/adbcsqlite/index.html">CRAN</a>, <a class="reference external" href="https://pypi.org/project/adbc-driver-sqlite/">PyPI</a></p></td> </tr> -<tr class="row-odd"><td><p>Snowflake</p></td> -<td><p>C/C++, Rust <a class="footnote-reference brackets" href="#wrapper" id="id3" role="doc-noteref"><span class="fn-bracket">[</span>3<span class="fn-bracket">]</span></a></p></td> +<tr class="row-even"><td><p><a class="reference internal" href="snowflake.html"><span class="doc">Snowflake</span></a></p></td> <td><p>Go</p></td> <td><p>Stable</p></td> -</tr> -<tr class="row-even"><td><p>Thrift protocol-based <a class="footnote-reference brackets" href="#thrift" id="id4" role="doc-noteref"><span class="fn-bracket">[</span>2<span class="fn-bracket">]</span></a></p></td> -<td><p>C#</p></td> -<td><p>C#</p></td> -<td><p>Experimental</p></td> +<td><p>conda-forge (<a class="reference external" href="https://anaconda.org/conda-forge/adbc-driver-snowflake">adbc-driver-snowflake</a>, <a class="reference external" href="https://anaconda.org/conda-forge/libadbc-driver-snowflake">libadbc-driver-snowflake</a>), <a class="reference external" href="https://crates.io/crates/adbc_snowflake">crates.io</a>, <a class="reference external" href="https://pkg.go.dev/github.com/apache/arrow-adbc/go/adbc/driver/snowflake">Go</a>, <a class="referen [...] </tr> </tbody> </table> </div> <aside class="footnote-list brackets"> +<aside class="footnote brackets" id="packages" role="doc-footnote"> +<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id2">1</a><span class="fn-bracket">]</span></span> +<p>This lists only packages available in package repositories. However, as noted above, many of these drivers can be used from languages not listed via the driver manager, even if a package is not yet available.</p> +</aside> <aside class="footnote brackets" id="duckdb" role="doc-footnote"> -<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id1">1</a><span class="fn-bracket">]</span></span> +<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id3">2</a><span class="fn-bracket">]</span></span> <p>DuckDB is developed and provided by a third party. See the <a class="reference external" href="https://duckdb.org/docs/stable/clients/adbc.html">DuckDB documentation</a> for details.</p> </aside> -<aside class="footnote brackets" id="thrift" role="doc-footnote"> -<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id4">2</a><span class="fn-bracket">]</span></span> -<p>Supports Apache Hive/Impala/Spark.</p> -</aside> -<aside class="footnote brackets" id="wrapper" role="doc-footnote"> -<span class="label"><span class="fn-bracket">[</span>3<span class="fn-bracket">]</span></span> -<span class="backrefs">(<a role="doc-backlink" href="#id2">1</a>,<a role="doc-backlink" href="#id3">2</a>)</span> -<p>Listed separately because a wrapper package is provided that -combines the driver and the bindings for you.</p> -</aside> </aside> </section> -<section id="feature-support"> -<h2>Feature Support<a class="headerlink" href="#feature-support" title="Link to this heading">¶</a></h2> +<section id="id4"> +<h2>Feature Support<a class="headerlink" href="#id4" title="Link to this heading">¶</a></h2> <p>N/A indicates that it is not possible to support this feature in the underlying database.</p> <p>See individual driver documentation pages for full details.</p> <dl class="simple"> @@ -608,7 +625,7 @@ result set (<a class="reference external" href="https://arrow.apache.org/adbc/ma <tr class="row-odd"><td><p>PostgreSQL</p></td> <td><p>N/A</p></td> <td><p>N/A</p></td> -<td><p>Y <a class="footnote-reference brackets" href="#postgresql-prepared" id="id5" role="doc-noteref"><span class="fn-bracket">[</span>4<span class="fn-bracket">]</span></a></p></td> +<td><p>Y <a class="footnote-reference brackets" href="#postgresql-prepared" id="id5" role="doc-noteref"><span class="fn-bracket">[</span>3<span class="fn-bracket">]</span></a></p></td> <td><p>Y</p></td> <td><p>Y</p></td> <td><p>Y</p></td> @@ -626,7 +643,7 @@ result set (<a class="reference external" href="https://arrow.apache.org/adbc/ma </div> <aside class="footnote-list brackets"> <aside class="footnote brackets" id="postgresql-prepared" role="doc-footnote"> -<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id5">4</a><span class="fn-bracket">]</span></span> +<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id5">3</a><span class="fn-bracket">]</span></span> <p>The PostgreSQL driver only supports executing prepared statements with parameters that do not return result sets (basically, an INSERT with parameters). Queries that return result sets @@ -735,8 +752,9 @@ United States and other countries. <div class="toc-tree"> <ul> <li><a class="reference internal" href="#">Driver Implementation Status</a><ul> -<li><a class="reference internal" href="#implementation-status">Implementation Status</a></li> +<li><a class="reference internal" href="#driver-status">Driver Status</a></li> <li><a class="reference internal" href="#feature-support">Feature Support</a></li> +<li><a class="reference internal" href="#id4">Feature Support</a></li> </ul> </li> </ul> diff --git a/main/objects.inv b/main/objects.inv index 47b01bea1..544c1c139 100644 Binary files a/main/objects.inv and b/main/objects.inv differ diff --git a/main/python/api/adbc_driver_bigquery.html b/main/python/api/adbc_driver_bigquery.html index ece261cce..e07ae2e07 100644 --- a/main/python/api/adbc_driver_bigquery.html +++ b/main/python/api/adbc_driver_bigquery.html @@ -509,17 +509,11 @@ destination table will be created. The default is <code class="docutils literal notranslate"><span class="pre">CREATE_IF_NEEDED</span></code>.</p> <p>The following values are supported:</p> <ul class="simple"> -<li><dl class="simple"> -<dt><code class="docutils literal notranslate"><span class="pre">CREATE_IF_NEEDED</span></code>:</dt><dd><p>Will create the table if it does not already exist. -Tables are created atomically on successful completion of a job.</p> -</dd> -</dl> -</li> -<li><dl class="simple"> -<dt><code class="docutils literal notranslate"><span class="pre">CREATE_NEVER</span></code>:</dt><dd><p>Ensures the table must already exist and will not be automatically created.</p> -</dd> -</dl> -</li> +<li><p><code class="docutils literal notranslate"><span class="pre">CREATE_IF_NEEDED</span></code>: +Will create the table if it does not already exist. +Tables are created atomically on successful completion of a job.</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">CREATE_NEVER</span></code>: +Ensures the table must already exist and will not be automatically created.</p></li> </ul> </dd></dl> @@ -617,28 +611,22 @@ The default priority is <code class="docutils literal notranslate"><span class=" <a class="reference external" href="https://cloud.google.com/bigquery/querying-data#batchqueries">https://cloud.google.com/bigquery/querying-data#batchqueries</a></p> <p>The following values are supported:</p> <ul class="simple"> -<li><dl class="simple"> -<dt><code class="docutils literal notranslate"><span class="pre">BATCH</span></code>:</dt><dd><p>BatchPriority specifies that the query should be scheduled with the +<li><p><code class="docutils literal notranslate"><span class="pre">BATCH</span></code>: +BatchPriority specifies that the query should be scheduled with the batch priority. BigQuery queues each batch query on your behalf, and starts the query as soon as idle resources are available, usually within a few minutes. If BigQuery hasn’t started the query within 24 hours, BigQuery changes the job priority to interactive. Batch queries don’t count towards your concurrent rate limit, which can make it easier to start many queries at once. More information can be found at: -<a class="reference external" href="https://cloud.google.com/bigquery/docs/running-queries#batchqueries">https://cloud.google.com/bigquery/docs/running-queries#batchqueries</a></p> -</dd> -</dl> -</li> -<li><dl class="simple"> -<dt><code class="docutils literal notranslate"><span class="pre">INTERACTIVE</span></code>:</dt><dd><p>Specifies that the query should be scheduled with interactive priority, +<a class="reference external" href="https://cloud.google.com/bigquery/docs/running-queries#batchqueries">https://cloud.google.com/bigquery/docs/running-queries#batchqueries</a></p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">INTERACTIVE</span></code>: +Specifies that the query should be scheduled with interactive priority, which means that the query is executed as soon as possible. Interactive queries count towards your concurrent rate limit and your daily limit. It is the default priority with which queries get executed. More information can be found at: -<a class="reference external" href="https://cloud.google.com/bigquery/docs/running-queries#queries">https://cloud.google.com/bigquery/docs/running-queries#queries</a></p> -</dd> -</dl> -</li> +<a class="reference external" href="https://cloud.google.com/bigquery/docs/running-queries#queries">https://cloud.google.com/bigquery/docs/running-queries#queries</a></p></li> </ul> </dd></dl> @@ -656,23 +644,14 @@ table is treated. The default is <code class="docutils literal notranslate"><span class="pre">WRITE_EMPTY</span></code>.</p> <p>The following values are supported:</p> <ul class="simple"> -<li><dl class="simple"> -<dt><code class="docutils literal notranslate"><span class="pre">WRITE_APPEND</span></code>:</dt><dd><p>Will append to any existing data in the destination table. -Data is appended atomically on successful completion of a job.</p> -</dd> -</dl> -</li> -<li><dl class="simple"> -<dt><code class="docutils literal notranslate"><span class="pre">WRITE_TRUNCATE</span></code>:</dt><dd><p>Overrides the existing data in the destination table. -Data is overwritten atomically on successful completion of a job.</p> -</dd> -</dl> -</li> -<li><dl class="simple"> -<dt><code class="docutils literal notranslate"><span class="pre">WRITE_EMPTY</span></code>:</dt><dd><p>Fails writes if the destination table already contains data.</p> -</dd> -</dl> -</li> +<li><p><code class="docutils literal notranslate"><span class="pre">WRITE_APPEND</span></code>: +Will append to any existing data in the destination table. +Data is appended atomically on successful completion of a job.</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">WRITE_TRUNCATE</span></code>: +Overrides the existing data in the destination table. +Data is overwritten atomically on successful completion of a job.</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">WRITE_EMPTY</span></code>: +Fails writes if the destination table already contains data.</p></li> </ul> </dd></dl> diff --git a/main/r/adbcbigquery/pkgdown.yml b/main/r/adbcbigquery/pkgdown.yml index 546350dcc..c145e2fad 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-07-18T00:33Z +last_built: 2025-07-18T00:51Z 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 cf0400490..18b3c01a8 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-07-18T00:33Z +last_built: 2025-07-18T00:51Z 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 b7c16f466..927499a46 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 0x56240f178b80> </span> +<span class="r-out co"><span class="r-pr">#></span> <adbc_connection at 0x56185e6da730> </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 0x56240f521330> </span> +<span class="r-out co"><span class="r-pr">#></span> $ database:<adbc_database at 0x56185eba95c0> </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 711113a64..f85ee7542 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 0x56241027fb40> </span> +<span class="r-out co"><span class="r-pr">#></span> <adbc_database at 0x56185f03e220> </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 4534e554c..448ed9aa3 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 0x562410152de0> </span> +<span class="r-out co"><span class="r-pr">#></span> <adbc_statement at 0x56185ef98c90> </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 0x5624102a0f30> </span> +<span class="r-out co"><span class="r-pr">#></span> $ connection:<adbc_connection at 0x56185f457150> </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 0x56241009af00> </span> +<span class="r-out co"><span class="r-pr">#></span> ..$ database:<adbc_database at 0x56185c218710> </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 aefdbde7b..a2fdbd27b 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 f68dcd54a..298bfcb1b 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-07-18T00:33Z +last_built: 2025-07-18T00:51Z 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 40dd66af8..bcc1e4d36 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-07-18T00:33Z +last_built: 2025-07-18T00:51Z 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 410f04eee..d8d4f0f25 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-07-18T00:33Z +last_built: 2025-07-18T00:51Z 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 eb080bd00..20822b857 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-07-18T00:33Z +last_built: 2025-07-18T00:51Z 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 7ecfcc09a..b92844467 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles":{"ADBC API Standard":[[25,null]],"API Reference":[[3,"api-reference"],[30,"api-reference"],[40,"api-reference"],[49,"api-reference"]],"And then what is the \u201cADBC JDBC driver\u201d?":[[21,"and-then-what-is-the-adbc-jdbc-driver"]],"Apache Arrow ADBC":[[28,null]],"Arrow type to PostgreSQL type mapping":[[17,"id5"]],"Authenticate with a username and password":[[46,"authenticate-with-a-username-and-password"]],"Authentication":[[14,"authentication"],[18,"auth [...] \ No newline at end of file +Search.setIndex({"alltitles":{"ADBC API Standard":[[25,null]],"API Reference":[[3,"api-reference"],[30,"api-reference"],[40,"api-reference"],[49,"api-reference"]],"And then what is the \u201cADBC JDBC driver\u201d?":[[21,"and-then-what-is-the-adbc-jdbc-driver"]],"Apache Arrow ADBC":[[28,null]],"Arrow type to PostgreSQL type mapping":[[17,"id5"]],"Authenticate with a username and password":[[46,"authenticate-with-a-username-and-password"]],"Authentication":[[14,"authentication"],[18,"auth [...] \ No newline at end of file