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 9194bbf7 publish documentation 9194bbf7 is described below commit 9194bbf7d317ead31905ac6e4d95d7c9e18ea2d1 Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com> AuthorDate: Sun Aug 27 01:21:25 2023 +0000 publish documentation --- main/_sources/cpp/driver_manager.rst.txt | 64 +++++++++++++++++++++- main/_sources/driver/installation.rst.txt | 64 +++++++++++++++++++++- main/cpp/api/adbc.html | 20 +++---- main/cpp/driver_manager.html | 56 ++++++++++++++++++- main/driver/flight_sql.html | 2 +- main/driver/installation.html | 57 ++++++++++++++++++- main/format/specification.html | 2 +- main/python/api/adbc_driver_manager.html | 16 +++--- 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 +- 18 files changed, 269 insertions(+), 38 deletions(-) diff --git a/main/_sources/cpp/driver_manager.rst.txt b/main/_sources/cpp/driver_manager.rst.txt index 120e5dd5..d8db791d 100644 --- a/main/_sources/cpp/driver_manager.rst.txt +++ b/main/_sources/cpp/driver_manager.rst.txt @@ -27,7 +27,69 @@ specific driver. Installation ============ -TODO +Install the appropriate driver package. You can use conda-forge_, ``apt`` or ``dnf``. + +conda-forge: + +- ``mamba install adbc-driver-manager`` + +You can use ``apt`` on the following platforms: + +- Debian GNU/Linux bookworm +- Ubuntu 22.04 + +Prepare the Apache Arrow APT repository: + +.. code-block:: bash + + sudo apt update + sudo apt install -y -V ca-certificates lsb-release wget + sudo wget https://apache.jfrog.io/artifactory/arrow/$(lsb_release --id --short | tr 'A-Z' 'a-z')/apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb + sudo apt install -y -V ./apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb + rm ./apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb + sudo apt update + +Install: + +- ``sudo apt install libadbc-driver-manager-dev`` + +You can use ``dnf`` on the following platforms: + +- AlmaLinux 8 +- Oracle Linux 8 +- Red Hat Enterprise Linux 8 +- AlmaLinux 9 +- Oracle Linux 9 +- Red Hat Enterprise Linux 9 + +Prepare the Apache Arrow Yum repository: + +.. code-block:: bash + + sudo dnf install -y epel-release || sudo dnf install -y oracle-epel-release-el$(cut -d: -f5 /etc/system-release-cpe | cut -d. -f1) || sudo dnf install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-$(cut -d: -f5 /etc/system-release-cpe | cut -d. -f1).noarch.rpm + sudo dnf install -y https://apache.jfrog.io/artifactory/arrow/almalinux/$(cut -d: -f5 /etc/system-release-cpe | cut -d. -f1)/apache-arrow-release-latest.rpm + sudo dnf config-manager --set-enabled epel || : + sudo dnf config-manager --set-enabled powertools || : + sudo dnf config-manager --set-enabled crb || : + sudo dnf config-manager --set-enabled ol$(cut -d: -f5 /etc/system-release-cpe | cut -d. -f1)_codeready_builder || : + sudo dnf config-manager --set-enabled codeready-builder-for-rhel-$(cut -d: -f5 /etc/system-release-cpe | cut -d. -f1)-rhui-rpms || : + sudo subscription-manager repos --enable codeready-builder-for-rhel-$(cut -d: -f5 /etc/system-release-cpe | cut -d. -f1)-$(arch)-rpms || : + +Install: + +- ``sudo dnf install adbc-driver-manager-devel`` + +Then they can be used via CMake, e.g.: + +.. code-block:: cmake + + find_package(AdbcDriverPostgreSQL) + + # ... + + target_link_libraries(myapp PRIVATE AdbcDriverPostgreSQL::adbc_driver_postgresql_shared) + +.. _conda-forge: https://conda-forge.org/ Usage ===== diff --git a/main/_sources/driver/installation.rst.txt b/main/_sources/driver/installation.rst.txt index ffd3a8c9..75407477 100644 --- a/main/_sources/driver/installation.rst.txt +++ b/main/_sources/driver/installation.rst.txt @@ -26,12 +26,66 @@ Installation C/C++ ===== -Install the appropriate driver package. These are currently only available from conda-forge_: +Install the appropriate driver package. You can use conda-forge_, ``apt`` or ``dnf``. + +conda-forge: - ``mamba install libadbc-driver-flightsql`` - ``mamba install libadbc-driver-postgresql`` - ``mamba install libadbc-driver-sqlite`` +You can use ``apt`` on the following platforms: + +- Debian GNU/Linux bookworm +- Ubuntu 22.04 + +Prepare the Apache Arrow APT repository: + +.. code-block:: bash + + sudo apt update + sudo apt install -y -V ca-certificates lsb-release wget + sudo wget https://apache.jfrog.io/artifactory/arrow/$(lsb_release --id --short | tr 'A-Z' 'a-z')/apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb + sudo apt install -y -V ./apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb + rm ./apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb + sudo apt update + +Install: + +- ``sudo apt install libadbc-driver-flightsql-dev`` +- ``sudo apt install libadbc-driver-postgresql-dev`` +- ``sudo apt install libadbc-driver-sqlite-dev`` +- ``sudo apt install libadbc-driver-snowflake-dev`` + +You can use ``dnf`` on the following platforms: + +- AlmaLinux 8 +- Oracle Linux 8 +- Red Hat Enterprise Linux 8 +- AlmaLinux 9 +- Oracle Linux 9 +- Red Hat Enterprise Linux 9 + +Prepare the Apache Arrow Yum repository: + +.. code-block:: bash + + sudo dnf install -y epel-release || sudo dnf install -y oracle-epel-release-el$(cut -d: -f5 /etc/system-release-cpe | cut -d. -f1) || sudo dnf install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-$(cut -d: -f5 /etc/system-release-cpe | cut -d. -f1).noarch.rpm + sudo dnf install -y https://apache.jfrog.io/artifactory/arrow/almalinux/$(cut -d: -f5 /etc/system-release-cpe | cut -d. -f1)/apache-arrow-release-latest.rpm + sudo dnf config-manager --set-enabled epel || : + sudo dnf config-manager --set-enabled powertools || : + sudo dnf config-manager --set-enabled crb || : + sudo dnf config-manager --set-enabled ol$(cut -d: -f5 /etc/system-release-cpe | cut -d. -f1)_codeready_builder || : + sudo dnf config-manager --set-enabled codeready-builder-for-rhel-$(cut -d: -f5 /etc/system-release-cpe | cut -d. -f1)-rhui-rpms || : + sudo subscription-manager repos --enable codeready-builder-for-rhel-$(cut -d: -f5 /etc/system-release-cpe | cut -d. -f1)-$(arch)-rpms || : + +Install: + +- ``sudo dnf install adbc-driver-flightsql-devel`` +- ``sudo dnf install adbc-driver-postgresql-devel`` +- ``sudo dnf install adbc-driver-sqlite-devel`` +- ``sudo dnf install adbc-driver-snowflake-devel`` + Then they can be used via CMake, e.g.: .. code-block:: cmake @@ -80,7 +134,7 @@ From conda-forge_: - ``mamba install adbc-driver-sqlite`` R -====== += Install the appropriate driver package from GitHub: @@ -94,3 +148,9 @@ Install the appropriate driver package from GitHub: Installation of stable releases from CRAN is anticipated following the release of ADBC Libraries 0.6.0. + +Ruby +==== + +Install the appropriate driver package for C/C++. You can use it from +Ruby. diff --git a/main/cpp/api/adbc.html b/main/cpp/api/adbc.html index 9238ab90..d146cae3 100644 --- a/main/cpp/api/adbc.html +++ b/main/cpp/api/adbc.html @@ -550,22 +550,22 @@ <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver17ConnectionGetInfoE"> -<span id="_CPPv3N10AdbcDriver17ConnectionGetInfoE"></span><span id="_CPPv2N10AdbcDriver17ConnectionGetInfoE"></span><span class="target" id="structAdbcDriver_1a1eef1c652948ec2de46d34631c6e358e"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionGetInfo</span></span></span><sp [...] +<span id="_CPPv3N10AdbcDriver17ConnectionGetInfoE"></span><span id="_CPPv2N10AdbcDriver17ConnectionGetInfoE"></span><span class="target" id="structAdbcDriver_1a1eef1c652948ec2de46d34631c6e358e"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionGetInfo</span></span></span><sp [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver20ConnectionGetObjectsE"> -<span id="_CPPv3N10AdbcDriver20ConnectionGetObjectsE"></span><span id="_CPPv2N10AdbcDriver20ConnectionGetObjectsE"></span><span class="target" id="structAdbcDriver_1a8315bf6354ada180a6512fa0a54ebbb8"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionGetObjects</span></span>< [...] +<span id="_CPPv3N10AdbcDriver20ConnectionGetObjectsE"></span><span id="_CPPv2N10AdbcDriver20ConnectionGetObjectsE"></span><span class="target" id="structAdbcDriver_1a8315bf6354ada180a6512fa0a54ebbb8"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionGetObjects</span></span>< [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver24ConnectionGetTableSchemaE"> -<span id="_CPPv3N10AdbcDriver24ConnectionGetTableSchemaE"></span><span id="_CPPv2N10AdbcDriver24ConnectionGetTableSchemaE"></span><span class="target" id="structAdbcDriver_1a1d26143ead6993a715c17293a8174b2e"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionGetTableSchema</s [...] +<span id="_CPPv3N10AdbcDriver24ConnectionGetTableSchemaE"></span><span id="_CPPv2N10AdbcDriver24ConnectionGetTableSchemaE"></span><span class="target" id="structAdbcDriver_1a1d26143ead6993a715c17293a8174b2e"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionGetTableSchema</s [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver23ConnectionGetTableTypesE"> -<span id="_CPPv3N10AdbcDriver23ConnectionGetTableTypesE"></span><span id="_CPPv2N10AdbcDriver23ConnectionGetTableTypesE"></span><span class="target" id="structAdbcDriver_1a91179eb4c7e6c3ef9596a7b23d8cae8b"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionGetTableTypes</span [...] +<span id="_CPPv3N10AdbcDriver23ConnectionGetTableTypesE"></span><span id="_CPPv2N10AdbcDriver23ConnectionGetTableTypesE"></span><span class="target" id="structAdbcDriver_1a91179eb4c7e6c3ef9596a7b23d8cae8b"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionGetTableTypes</span [...] <dd></dd></dl> <dl class="cpp var"> @@ -585,7 +585,7 @@ <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver23ConnectionReadPartitionE"> -<span id="_CPPv3N10AdbcDriver23ConnectionReadPartitionE"></span><span id="_CPPv2N10AdbcDriver23ConnectionReadPartitionE"></span><span class="target" id="structAdbcDriver_1a7c8480231fa8c17dc65d7629ddc72195"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionReadPartition</span [...] +<span id="_CPPv3N10AdbcDriver23ConnectionReadPartitionE"></span><span id="_CPPv2N10AdbcDriver23ConnectionReadPartitionE"></span><span class="target" id="structAdbcDriver_1a7c8480231fa8c17dc65d7629ddc72195"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionReadPartition</span [...] <dd></dd></dl> <dl class="cpp var"> @@ -600,27 +600,27 @@ <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver13StatementBindE"> -<span id="_CPPv3N10AdbcDriver13StatementBindE"></span><span id="_CPPv2N10AdbcDriver13StatementBindE"></span><span class="target" id="structAdbcDriver_1a6ffcf398baaad8b832c0d597db42c657"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementBind</span></span></span><span class="p" [...] +<span id="_CPPv3N10AdbcDriver13StatementBindE"></span><span id="_CPPv2N10AdbcDriver13StatementBindE"></span><span class="target" id="structAdbcDriver_1a6ffcf398baaad8b832c0d597db42c657"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementBind</span></span></span><span class="p" [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver19StatementBindStreamE"> -<span id="_CPPv3N10AdbcDriver19StatementBindStreamE"></span><span id="_CPPv2N10AdbcDriver19StatementBindStreamE"></span><span class="target" id="structAdbcDriver_1a35cd912a46aebded295af36b71f3d24f"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementBindStream</span></span></sp [...] +<span id="_CPPv3N10AdbcDriver19StatementBindStreamE"></span><span id="_CPPv2N10AdbcDriver19StatementBindStreamE"></span><span class="target" id="structAdbcDriver_1a35cd912a46aebded295af36b71f3d24f"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementBindStream</span></span></sp [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver21StatementExecuteQueryE"> -<span id="_CPPv3N10AdbcDriver21StatementExecuteQueryE"></span><span id="_CPPv2N10AdbcDriver21StatementExecuteQueryE"></span><span class="target" id="structAdbcDriver_1aa9700d80d4ce28dab9b302d3b1a91193"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementExecuteQuery</span></spa [...] +<span id="_CPPv3N10AdbcDriver21StatementExecuteQueryE"></span><span id="_CPPv2N10AdbcDriver21StatementExecuteQueryE"></span><span class="target" id="structAdbcDriver_1aa9700d80d4ce28dab9b302d3b1a91193"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementExecuteQuery</span></spa [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver26StatementExecutePartitionsE"> -<span id="_CPPv3N10AdbcDriver26StatementExecutePartitionsE"></span><span id="_CPPv2N10AdbcDriver26StatementExecutePartitionsE"></span><span class="target" id="structAdbcDriver_1aaaf4cf044fca466cf767a6346cee25fc"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementExecutePartiti [...] +<span id="_CPPv3N10AdbcDriver26StatementExecutePartitionsE"></span><span id="_CPPv2N10AdbcDriver26StatementExecutePartitionsE"></span><span class="target" id="structAdbcDriver_1aaaf4cf044fca466cf767a6346cee25fc"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementExecutePartiti [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver27StatementGetParameterSchemaE"> -<span id="_CPPv3N10AdbcDriver27StatementGetParameterSchemaE"></span><span id="_CPPv2N10AdbcDriver27StatementGetParameterSchemaE"></span><span class="target" id="structAdbcDriver_1a127b86dcd7ae73e93f5ede25e66b33e8"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementGetParameter [...] +<span id="_CPPv3N10AdbcDriver27StatementGetParameterSchemaE"></span><span id="_CPPv2N10AdbcDriver27StatementGetParameterSchemaE"></span><span class="target" id="structAdbcDriver_1a127b86dcd7ae73e93f5ede25e66b33e8"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementGetParameter [...] <dd></dd></dl> <dl class="cpp var"> diff --git a/main/cpp/driver_manager.html b/main/cpp/driver_manager.html index 01a50aff..6d7e2e8a 100644 --- a/main/cpp/driver_manager.html +++ b/main/cpp/driver_manager.html @@ -329,7 +329,61 @@ use multiple drivers simultaneously, and decouple themselves from the specific driver.</p> <section id="installation"> <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading">#</a></h2> -<p>TODO</p> +<p>Install the appropriate driver package. You can use <a class="reference external" href="https://conda-forge.org/">conda-forge</a>, <code class="docutils literal notranslate"><span class="pre">apt</span></code> or <code class="docutils literal notranslate"><span class="pre">dnf</span></code>.</p> +<p>conda-forge:</p> +<ul class="simple"> +<li><p><code class="docutils literal notranslate"><span class="pre">mamba</span> <span class="pre">install</span> <span class="pre">adbc-driver-manager</span></code></p></li> +</ul> +<p>You can use <code class="docutils literal notranslate"><span class="pre">apt</span></code> on the following platforms:</p> +<ul class="simple"> +<li><p>Debian GNU/Linux bookworm</p></li> +<li><p>Ubuntu 22.04</p></li> +</ul> +<p>Prepare the Apache Arrow APT repository:</p> +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt<span class="w"> </span>update +sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>-V<span class="w"> </span>ca-certificates<span class="w"> </span>lsb-release<span class="w"> </span>wget +sudo<span class="w"> </span>wget<span class="w"> </span>https://apache.jfrog.io/artifactory/arrow/<span class="k">$(</span>lsb_release<span class="w"> </span>--id<span class="w"> </span>--short<span class="w"> </span><span class="p">|</span><span class="w"> </span>tr<span class="w"> </span><span class="s1">'A-Z'</span><span class="w"> </span><span class="s1">'a-z'</span><span class="k">)</span>/apache-arrow-apt-source-latest-<span class="k">$(</span>lsb_release<span class [...] +sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>-V<span class="w"> </span>./apache-arrow-apt-source-latest-<span class="k">$(</span>lsb_release<span class="w"> </span>--codename<span class="w"> </span>--short<span class="k">)</span>.deb +rm<span class="w"> </span>./apache-arrow-apt-source-latest-<span class="k">$(</span>lsb_release<span class="w"> </span>--codename<span class="w"> </span>--short<span class="k">)</span>.deb +sudo<span class="w"> </span>apt<span class="w"> </span>update +</pre></div> +</div> +<p>Install:</p> +<ul class="simple"> +<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apt</span> <span class="pre">install</span> <span class="pre">libadbc-driver-manager-dev</span></code></p></li> +</ul> +<p>You can use <code class="docutils literal notranslate"><span class="pre">dnf</span></code> on the following platforms:</p> +<ul class="simple"> +<li><p>AlmaLinux 8</p></li> +<li><p>Oracle Linux 8</p></li> +<li><p>Red Hat Enterprise Linux 8</p></li> +<li><p>AlmaLinux 9</p></li> +<li><p>Oracle Linux 9</p></li> +<li><p>Red Hat Enterprise Linux 9</p></li> +</ul> +<p>Prepare the Apache Arrow Yum repository:</p> +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>dnf<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>epel-release<span class="w"> </span><span class="o">||</span><span class="w"> </span>sudo<span class="w"> </span>dnf<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>oracle-epel-release-el<span class="k">$(</span>cut<span class="w"> </span>-d:<span class="w"> </span>- [...] +sudo<span class="w"> </span>dnf<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>https://apache.jfrog.io/artifactory/arrow/almalinux/<span class="k">$(</span>cut<span class="w"> </span>-d:<span class="w"> </span>-f5<span class="w"> </span>/etc/system-release-cpe<span class="w"> </span><span class="p">|</span><span class="w"> </span>cut<span class="w"> </span>-d.<span class="w"> </span>-f1<span class="k">)</span>/apache-arrow-release-latest.rpm +sudo<span class="w"> </span>dnf<span class="w"> </span>config-manager<span class="w"> </span>--set-enabled<span class="w"> </span>epel<span class="w"> </span><span class="o">||</span><span class="w"> </span>: +sudo<span class="w"> </span>dnf<span class="w"> </span>config-manager<span class="w"> </span>--set-enabled<span class="w"> </span>powertools<span class="w"> </span><span class="o">||</span><span class="w"> </span>: +sudo<span class="w"> </span>dnf<span class="w"> </span>config-manager<span class="w"> </span>--set-enabled<span class="w"> </span>crb<span class="w"> </span><span class="o">||</span><span class="w"> </span>: +sudo<span class="w"> </span>dnf<span class="w"> </span>config-manager<span class="w"> </span>--set-enabled<span class="w"> </span>ol<span class="k">$(</span>cut<span class="w"> </span>-d:<span class="w"> </span>-f5<span class="w"> </span>/etc/system-release-cpe<span class="w"> </span><span class="p">|</span><span class="w"> </span>cut<span class="w"> </span>-d.<span class="w"> </span>-f1<span class="k">)</span>_codeready_builder<span class="w"> </span><span class="o">||</span><span class [...] +sudo<span class="w"> </span>dnf<span class="w"> </span>config-manager<span class="w"> </span>--set-enabled<span class="w"> </span>codeready-builder-for-rhel-<span class="k">$(</span>cut<span class="w"> </span>-d:<span class="w"> </span>-f5<span class="w"> </span>/etc/system-release-cpe<span class="w"> </span><span class="p">|</span><span class="w"> </span>cut<span class="w"> </span>-d.<span class="w"> </span>-f1<span class="k">)</span>-rhui-rpms<span class="w"> </span><span class="o">||< [...] +sudo<span class="w"> </span>subscription-manager<span class="w"> </span>repos<span class="w"> </span>--enable<span class="w"> </span>codeready-builder-for-rhel-<span class="k">$(</span>cut<span class="w"> </span>-d:<span class="w"> </span>-f5<span class="w"> </span>/etc/system-release-cpe<span class="w"> </span><span class="p">|</span><span class="w"> </span>cut<span class="w"> </span>-d.<span class="w"> </span>-f1<span class="k">)</span>-<span class="k">$(</span>arch<span class="k">)</s [...] +</pre></div> +</div> +<p>Install:</p> +<ul class="simple"> +<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">dnf</span> <span class="pre">install</span> <span class="pre">adbc-driver-manager-devel</span></code></p></li> +</ul> +<p>Then they can be used via CMake, e.g.:</p> +<div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nb">find_package</span><span class="p">(</span><span class="s">AdbcDriverPostgreSQL</span><span class="p">)</span> + +<span class="c"># ...</span> + +<span class="nb">target_link_libraries</span><span class="p">(</span><span class="s">myapp</span><span class="w"> </span><span class="s">PRIVATE</span><span class="w"> </span><span class="s">AdbcDriverPostgreSQL::adbc_driver_postgresql_shared</span><span class="p">)</span> +</pre></div> +</div> </section> <section id="usage"> <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading">#</a></h2> diff --git a/main/driver/flight_sql.html b/main/driver/flight_sql.html index 00cb059a..671cd0b7 100644 --- a/main/driver/flight_sql.html +++ b/main/driver/flight_sql.html @@ -325,7 +325,7 @@ <h1>Flight SQL Driver<a class="headerlink" href="#flight-sql-driver" title="Permalink to this heading">#</a></h1> <p><strong>Available for:</strong> C/C++, GLib/Ruby, Go, Java, Python</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 v12.0.1)"><span>Arrow Flight SQL</span></a> compatible endpoint.</p> +<a class="reference external" href="https://arrow.apache.org/docs/format/FlightSql.html" title="(in Apache Arrow v13.0.0)"><span>Arrow Flight SQL</span></a> compatible endpoint.</p> <section id="installation"> <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading">#</a></h2> <div class="sd-tab-set docutils"> diff --git a/main/driver/installation.html b/main/driver/installation.html index f5758f6a..38832af1 100644 --- a/main/driver/installation.html +++ b/main/driver/installation.html @@ -329,12 +329,61 @@ </div> <section id="c-c"> <h2>C/C++<a class="headerlink" href="#c-c" title="Permalink to this heading">#</a></h2> -<p>Install the appropriate driver package. These are currently only available from <a class="reference external" href="https://conda-forge.org/">conda-forge</a>:</p> +<p>Install the appropriate driver package. You can use <a class="reference external" href="https://conda-forge.org/">conda-forge</a>, <code class="docutils literal notranslate"><span class="pre">apt</span></code> or <code class="docutils literal notranslate"><span class="pre">dnf</span></code>.</p> +<p>conda-forge:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">mamba</span> <span class="pre">install</span> <span class="pre">libadbc-driver-flightsql</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">mamba</span> <span class="pre">install</span> <span class="pre">libadbc-driver-postgresql</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">mamba</span> <span class="pre">install</span> <span class="pre">libadbc-driver-sqlite</span></code></p></li> </ul> +<p>You can use <code class="docutils literal notranslate"><span class="pre">apt</span></code> on the following platforms:</p> +<ul class="simple"> +<li><p>Debian GNU/Linux bookworm</p></li> +<li><p>Ubuntu 22.04</p></li> +</ul> +<p>Prepare the Apache Arrow APT repository:</p> +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt<span class="w"> </span>update +sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>-V<span class="w"> </span>ca-certificates<span class="w"> </span>lsb-release<span class="w"> </span>wget +sudo<span class="w"> </span>wget<span class="w"> </span>https://apache.jfrog.io/artifactory/arrow/<span class="k">$(</span>lsb_release<span class="w"> </span>--id<span class="w"> </span>--short<span class="w"> </span><span class="p">|</span><span class="w"> </span>tr<span class="w"> </span><span class="s1">'A-Z'</span><span class="w"> </span><span class="s1">'a-z'</span><span class="k">)</span>/apache-arrow-apt-source-latest-<span class="k">$(</span>lsb_release<span class [...] +sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>-V<span class="w"> </span>./apache-arrow-apt-source-latest-<span class="k">$(</span>lsb_release<span class="w"> </span>--codename<span class="w"> </span>--short<span class="k">)</span>.deb +rm<span class="w"> </span>./apache-arrow-apt-source-latest-<span class="k">$(</span>lsb_release<span class="w"> </span>--codename<span class="w"> </span>--short<span class="k">)</span>.deb +sudo<span class="w"> </span>apt<span class="w"> </span>update +</pre></div> +</div> +<p>Install:</p> +<ul class="simple"> +<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apt</span> <span class="pre">install</span> <span class="pre">libadbc-driver-flightsql-dev</span></code></p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apt</span> <span class="pre">install</span> <span class="pre">libadbc-driver-postgresql-dev</span></code></p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apt</span> <span class="pre">install</span> <span class="pre">libadbc-driver-sqlite-dev</span></code></p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apt</span> <span class="pre">install</span> <span class="pre">libadbc-driver-snowflake-dev</span></code></p></li> +</ul> +<p>You can use <code class="docutils literal notranslate"><span class="pre">dnf</span></code> on the following platforms:</p> +<ul class="simple"> +<li><p>AlmaLinux 8</p></li> +<li><p>Oracle Linux 8</p></li> +<li><p>Red Hat Enterprise Linux 8</p></li> +<li><p>AlmaLinux 9</p></li> +<li><p>Oracle Linux 9</p></li> +<li><p>Red Hat Enterprise Linux 9</p></li> +</ul> +<p>Prepare the Apache Arrow Yum repository:</p> +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>dnf<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>epel-release<span class="w"> </span><span class="o">||</span><span class="w"> </span>sudo<span class="w"> </span>dnf<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>oracle-epel-release-el<span class="k">$(</span>cut<span class="w"> </span>-d:<span class="w"> </span>- [...] +sudo<span class="w"> </span>dnf<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>https://apache.jfrog.io/artifactory/arrow/almalinux/<span class="k">$(</span>cut<span class="w"> </span>-d:<span class="w"> </span>-f5<span class="w"> </span>/etc/system-release-cpe<span class="w"> </span><span class="p">|</span><span class="w"> </span>cut<span class="w"> </span>-d.<span class="w"> </span>-f1<span class="k">)</span>/apache-arrow-release-latest.rpm +sudo<span class="w"> </span>dnf<span class="w"> </span>config-manager<span class="w"> </span>--set-enabled<span class="w"> </span>epel<span class="w"> </span><span class="o">||</span><span class="w"> </span>: +sudo<span class="w"> </span>dnf<span class="w"> </span>config-manager<span class="w"> </span>--set-enabled<span class="w"> </span>powertools<span class="w"> </span><span class="o">||</span><span class="w"> </span>: +sudo<span class="w"> </span>dnf<span class="w"> </span>config-manager<span class="w"> </span>--set-enabled<span class="w"> </span>crb<span class="w"> </span><span class="o">||</span><span class="w"> </span>: +sudo<span class="w"> </span>dnf<span class="w"> </span>config-manager<span class="w"> </span>--set-enabled<span class="w"> </span>ol<span class="k">$(</span>cut<span class="w"> </span>-d:<span class="w"> </span>-f5<span class="w"> </span>/etc/system-release-cpe<span class="w"> </span><span class="p">|</span><span class="w"> </span>cut<span class="w"> </span>-d.<span class="w"> </span>-f1<span class="k">)</span>_codeready_builder<span class="w"> </span><span class="o">||</span><span class [...] +sudo<span class="w"> </span>dnf<span class="w"> </span>config-manager<span class="w"> </span>--set-enabled<span class="w"> </span>codeready-builder-for-rhel-<span class="k">$(</span>cut<span class="w"> </span>-d:<span class="w"> </span>-f5<span class="w"> </span>/etc/system-release-cpe<span class="w"> </span><span class="p">|</span><span class="w"> </span>cut<span class="w"> </span>-d.<span class="w"> </span>-f1<span class="k">)</span>-rhui-rpms<span class="w"> </span><span class="o">||< [...] +sudo<span class="w"> </span>subscription-manager<span class="w"> </span>repos<span class="w"> </span>--enable<span class="w"> </span>codeready-builder-for-rhel-<span class="k">$(</span>cut<span class="w"> </span>-d:<span class="w"> </span>-f5<span class="w"> </span>/etc/system-release-cpe<span class="w"> </span><span class="p">|</span><span class="w"> </span>cut<span class="w"> </span>-d.<span class="w"> </span>-f1<span class="k">)</span>-<span class="k">$(</span>arch<span class="k">)</s [...] +</pre></div> +</div> +<p>Install:</p> +<ul class="simple"> +<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">dnf</span> <span class="pre">install</span> <span class="pre">adbc-driver-flightsql-devel</span></code></p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">dnf</span> <span class="pre">install</span> <span class="pre">adbc-driver-postgresql-devel</span></code></p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">dnf</span> <span class="pre">install</span> <span class="pre">adbc-driver-sqlite-devel</span></code></p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">dnf</span> <span class="pre">install</span> <span class="pre">adbc-driver-snowflake-devel</span></code></p></li> +</ul> <p>Then they can be used via CMake, e.g.:</p> <div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nb">find_package</span><span class="p">(</span><span class="s">AdbcDriverPostgreSQL</span><span class="p">)</span> @@ -391,6 +440,11 @@ <p>Installation of stable releases from CRAN is anticipated following the release of ADBC Libraries 0.6.0.</p> </section> +<section id="ruby"> +<h2>Ruby<a class="headerlink" href="#ruby" title="Permalink to this heading">#</a></h2> +<p>Install the appropriate driver package for C/C++. You can use it from +Ruby.</p> +</section> </section> </article> @@ -454,6 +508,7 @@ release of ADBC Libraries 0.6.0.</p> <li><a class="reference internal" href="#java">Java</a></li> <li><a class="reference internal" href="#python">Python</a></li> <li><a class="reference internal" href="#r">R</a></li> +<li><a class="reference internal" href="#ruby">Ruby</a></li> </ul> </li> </ul> diff --git a/main/format/specification.html b/main/format/specification.html index b2ee44ec..8746f14c 100644 --- a/main/format/specification.html +++ b/main/format/specification.html @@ -609,7 +609,7 @@ sequenceDiagram </div><figcaption> <p><span class="caption-text">This is similar to fetching data in Arrow Flight RPC (by -design). See <a class="reference external" href="https://arrow.apache.org/docs/format/Flight.html" title="(in Apache Arrow v12.0.1)"><span class="xref std std-doc">“Downloading Data”</span></a>.</span><a class="headerlink" href="#id5" title="Permalink to this image">#</a></p> +design). See <a class="reference external" href="https://arrow.apache.org/docs/format/Flight.html" title="(in Apache Arrow v13.0.0)"><span class="xref std std-doc">“Downloading Data”</span></a>.</span><a class="headerlink" href="#id5" title="Permalink to this image">#</a></p> </figcaption> </figure> </section> diff --git a/main/python/api/adbc_driver_manager.html b/main/python/api/adbc_driver_manager.html index 18424f6b..a9d90a35 100644 --- a/main/python/api/adbc_driver_manager.html +++ b/main/python/api/adbc_driver_manager.html @@ -1166,7 +1166,7 @@ cannot be disabled.</p> <dl class="py method"> <dt class="sig sig-object py" id="adbc_driver_manager.dbapi.Connection.adbc_get_objects"> -<span class="sig-name descname"><span class="pre">adbc_get_objects</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'all'</span></span><spa [...] +<span class="sig-name descname"><span class="pre">adbc_get_objects</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'all'</span></span><spa [...] <dd><p>List catalogs, schemas, tables, etc. in the database.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -1192,7 +1192,7 @@ cannot be disabled.</p> <dl class="py method"> <dt class="sig sig-object py" id="adbc_driver_manager.dbapi.Connection.adbc_get_table_schema"> -<span class="sig-name descname"><span class="pre">adbc_get_table_schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">catalog_filter</span></span><s [...] +<span class="sig-name descname"><span class="pre">adbc_get_table_schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">catalog_filter</span></span><s [...] <dd><p>Get the Arrow schema of a table by name.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -1342,7 +1342,7 @@ connections.</p> </div> <dl class="py method"> <dt class="sig sig-object py" id="adbc_driver_manager.dbapi.Cursor.adbc_execute_partitions"> -<span class="sig-name descname"><span class="pre">adbc_execute_partitions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">operation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">& [...] +<span class="sig-name descname"><span class="pre">adbc_execute_partitions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">operation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">& [...] <dd><p>Execute a query and get the partitions of a distributed result set.</p> <dl class="field-list simple"> <dt class="field-odd">Returns<span class="colon">:</span></dt> @@ -1361,7 +1361,7 @@ read_partition.</p> <dl class="py method"> <dt class="sig sig-object py" id="adbc_driver_manager.dbapi.Cursor.adbc_ingest"> -<span class="sig-name descname"><span class="pre">adbc_ingest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="r [...] +<span class="sig-name descname"><span class="pre">adbc_ingest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="r [...] <dd><p>Ingest Arrow data into a database table.</p> <p>Depending on the driver, this can avoid per-row overhead that would result from a typical prepare-bind-insert loop.</p> @@ -1390,7 +1390,7 @@ provide this information.</p> <dl class="py method"> <dt class="sig sig-object py" id="adbc_driver_manager.dbapi.Cursor.adbc_prepare"> -<span class="sig-name descname"><span class="pre">adbc_prepare</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"><span class="pre">bytes</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig [...] +<span class="sig-name descname"><span class="pre">adbc_prepare</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"><span class="pre">bytes</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig [...] <dd><p>Prepare a query without executing it.</p> <p>To execute the query afterwards, call <a class="reference internal" href="#adbc_driver_manager.dbapi.Cursor.execute" title="adbc_driver_manager.dbapi.Cursor.execute"><code class="xref py py-meth docutils literal notranslate"><span class="pre">execute()</span></code></a> or <a class="reference internal" href="#adbc_driver_manager.dbapi.Cursor.executemany" title="adbc_driver_manager.dbapi.Cursor.executemany"><code class="xref py py-meth docutils literal notranslate"><span class="pre">executemany()</span></code></a> with the same query. This will not @@ -1507,7 +1507,7 @@ be executed once per row.</p> <dl class="py method"> <dt class="sig sig-object py" id="adbc_driver_manager.dbapi.Cursor.fetch_arrow_table"> -<span class="sig-name descname"><span class="pre">fetch_arrow_table</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table" title="(in Apache Arrow v12.0.1)"><span class="pre">Table</span></a></span></span><a class="headerlink" href="#adbc_driver_m [...] +<span class="sig-name descname"><span class="pre">fetch_arrow_table</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table" title="(in Apache Arrow v13.0.0)"><span class="pre">Table</span></a></span></span><a class="headerlink" href="#adbc_driver_m [...] <dd><p>Fetch all rows of the result as a PyArrow Table.</p> <p>This implements a similar API as DuckDB.</p> <p class="rubric">Notes</p> @@ -1525,7 +1525,7 @@ be executed once per row.</p> <dl class="py method"> <dt class="sig sig-object py" id="adbc_driver_manager.dbapi.Cursor.fetch_record_batch"> -<span class="sig-name descname"><span class="pre">fetch_record_batch</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://arrow.apache.org/docs/python/generated/pyarrow.RecordBatchReader.html#pyarrow.RecordBatchReader" title="(in Apache Arrow v12.0.1)"><span class="pre">RecordBatchReader</span></a></span></span><a cl [...] +<span class="sig-name descname"><span class="pre">fetch_record_batch</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://arrow.apache.org/docs/python/generated/pyarrow.RecordBatchReader.html#pyarrow.RecordBatchReader" title="(in Apache Arrow v13.0.0)"><span class="pre">RecordBatchReader</span></a></span></span><a cl [...] <dd><p>Fetch the result as a PyArrow RecordBatchReader.</p> <p>This implements a similar API as DuckDB: <a class="reference external" href="https://duckdb.org/docs/guides/python/export_arrow.html#export-as-a-recordbatchreader">https://duckdb.org/docs/guides/python/export_arrow.html#export-as-a-recordbatchreader</a></p> @@ -1541,7 +1541,7 @@ be executed once per row.</p> <dl class="py method"> <dt class="sig sig-object py" id="adbc_driver_manager.dbapi.Cursor.fetchallarrow"> -<span class="sig-name descname"><span class="pre">fetchallarrow</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table" title="(in Apache Arrow v12.0.1)"><span class="pre">Table</span></a></span></span><a class="headerlink" href="#adbc_driver_manag [...] +<span class="sig-name descname"><span class="pre">fetchallarrow</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table" title="(in Apache Arrow v13.0.0)"><span class="pre">Table</span></a></span></span><a class="headerlink" href="#adbc_driver_manag [...] <dd><p>Fetch all rows of the result as a PyArrow Table.</p> <p>This implements a similar API as turbodbc.</p> <p class="rubric">Notes</p> diff --git a/main/r/adbcdrivermanager/pkgdown.yml b/main/r/adbcdrivermanager/pkgdown.yml index d6572673..3f5a5f7c 100644 --- a/main/r/adbcdrivermanager/pkgdown.yml +++ b/main/r/adbcdrivermanager/pkgdown.yml @@ -2,5 +2,5 @@ pandoc: 3.1.3 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2023-08-23T19:07Z +last_built: 2023-08-27T01:20Z diff --git a/main/r/adbcdrivermanager/reference/adbc_connection_init.html b/main/r/adbcdrivermanager/reference/adbc_connection_init.html index 37db96d9..6d47fbe4 100644 --- a/main/r/adbcdrivermanager/reference/adbc_connection_init.html +++ b/main/r/adbcdrivermanager/reference/adbc_connection_init.html @@ -97,8 +97,8 @@ finer-grained control over behaviour at the R level.</p></dd> <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2> <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">db</span> <span class="op"><-</span> <span class="fu"><a href="adbc_database_init.html">adbc_database_init</a></span><span class="op">(</span><span class="fu"><a href="adbc_driver_void.html">adbc_driver_void</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-in"><span><span class="fu">adbc_connection_init</span><span class="op">(</span><span class="va">db</span><span class="op">)</span></span></span> -<span class="r-out co"><span class="r-pr">#></span> <adbc_connection> <pointer: 0x563503cb0f50> List of 2</span> -<span class="r-out co"><span class="r-pr">#></span> $ database:<adbc_database> <pointer: 0x563504019130> List of 2</span> +<span class="r-out co"><span class="r-pr">#></span> <adbc_connection> <pointer: 0x555a8a7b49f0> List of 2</span> +<span class="r-out co"><span class="r-pr">#></span> $ database:<adbc_database> <pointer: 0x555a8ca2b370> List of 2</span> <span class="r-out co"><span class="r-pr">#></span> ..$ driver :<adbc_driver_void> List of 1</span> <span class="r-out co"><span class="r-pr">#></span> .. ..$ driver_init_func:Class 'adbc_driver_init_func' <externalptr> </span> <span class="r-out co"><span class="r-pr">#></span> ..$ options: list()</span> diff --git a/main/r/adbcdrivermanager/reference/adbc_database_init.html b/main/r/adbcdrivermanager/reference/adbc_database_init.html index 6fae01e8..2adda643 100644 --- a/main/r/adbcdrivermanager/reference/adbc_database_init.html +++ b/main/r/adbcdrivermanager/reference/adbc_database_init.html @@ -96,7 +96,7 @@ finer-grained control over behaviour at the R level.</p></dd> <div class="section level2"> <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2> <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="fu">adbc_database_init</span><span class="op">(</span><span class="fu"><a href="adbc_driver_void.html">adbc_driver_void</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></span> -<span class="r-out co"><span class="r-pr">#></span> <adbc_database> <pointer: 0x5634fdfa5eb0> List of 2</span> +<span class="r-out co"><span class="r-pr">#></span> <adbc_database> <pointer: 0x555a8b2b71b0> List of 2</span> <span class="r-out co"><span class="r-pr">#></span> $ driver :<adbc_driver_void> List of 1</span> <span class="r-out co"><span class="r-pr">#></span> ..$ driver_init_func:Class 'adbc_driver_init_func' <externalptr> </span> <span class="r-out co"><span class="r-pr">#></span> $ options: list()</span> diff --git a/main/r/adbcdrivermanager/reference/adbc_statement_init.html b/main/r/adbcdrivermanager/reference/adbc_statement_init.html index 7c20989f..791e82ce 100644 --- a/main/r/adbcdrivermanager/reference/adbc_statement_init.html +++ b/main/r/adbcdrivermanager/reference/adbc_statement_init.html @@ -98,9 +98,9 @@ finer-grained control over behaviour at the R level.</p></dd> <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">db</span> <span class="op"><-</span> <span class="fu"><a href="adbc_database_init.html">adbc_database_init</a></span><span class="op">(</span><span class="fu"><a href="adbc_driver_void.html">adbc_driver_void</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-in"><span><span class="va">con</span> <span class="op"><-</span> <span class="fu"><a href="adbc_connection_init.html">adbc_connection_init</a></span><span class="op">(</span><span class="va">db</span><span class="op">)</span></span></span> <span class="r-in"><span><span class="fu">adbc_statement_init</span><span class="op">(</span><span class="va">con</span><span class="op">)</span></span></span> -<span class="r-out co"><span class="r-pr">#></span> <adbc_statement> <pointer: 0x563503551430> List of 2</span> -<span class="r-out co"><span class="r-pr">#></span> $ connection:<adbc_connection> <pointer: 0x563501988530> List of 2</span> -<span class="r-out co"><span class="r-pr">#></span> ..$ database:<adbc_database> <pointer: 0x563503ba97a0> List of 2</span> +<span class="r-out co"><span class="r-pr">#></span> <adbc_statement> <pointer: 0x555a8d74f050> List of 2</span> +<span class="r-out co"><span class="r-pr">#></span> $ connection:<adbc_connection> <pointer: 0x555a8d713060> List of 2</span> +<span class="r-out co"><span class="r-pr">#></span> ..$ database:<adbc_database> <pointer: 0x555a8d1a0e40> List of 2</span> <span class="r-out co"><span class="r-pr">#></span> .. ..$ driver :<adbc_driver_void> List of 1</span> <span class="r-out co"><span class="r-pr">#></span> .. .. ..$ driver_init_func:Class 'adbc_driver_init_func' <externalptr> </span> <span class="r-out co"><span class="r-pr">#></span> .. ..$ options: list()</span> diff --git a/main/r/adbcdrivermanager/search.json b/main/r/adbcdrivermanager/search.json index 38302ba7..decb89b2 100644 --- a/main/r/adbcdrivermanager/search.json +++ b/main/r/adbcdrivermanager/search.json @@ -1 +1 @@ -[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache License","title":"Apache License","text":"Version 2.0, January 2004 <http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"/LICENSE.html","id":"id_1-definitions","dir":"","previous_headings":"Terms and Conditions for use, reproduction, and distribution","what":"1. Definitions","title":"Apache License","text":"“License” shall mean terms conditions use, reproduction, distribution defined Sections [...] +[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache License","title":"Apache License","text":"Version 2.0, January 2004 <http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"/LICENSE.html","id":"id_1-definitions","dir":"","previous_headings":"Terms and Conditions for use, reproduction, and distribution","what":"1. Definitions","title":"Apache License","text":"“License” shall mean terms conditions use, reproduction, distribution defined Sections [...] diff --git a/main/r/adbcflightsql/pkgdown.yml b/main/r/adbcflightsql/pkgdown.yml index d6572673..3f5a5f7c 100644 --- a/main/r/adbcflightsql/pkgdown.yml +++ b/main/r/adbcflightsql/pkgdown.yml @@ -2,5 +2,5 @@ pandoc: 3.1.3 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2023-08-23T19:07Z +last_built: 2023-08-27T01:20Z diff --git a/main/r/adbcpostgresql/pkgdown.yml b/main/r/adbcpostgresql/pkgdown.yml index d6572673..3f5a5f7c 100644 --- a/main/r/adbcpostgresql/pkgdown.yml +++ b/main/r/adbcpostgresql/pkgdown.yml @@ -2,5 +2,5 @@ pandoc: 3.1.3 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2023-08-23T19:07Z +last_built: 2023-08-27T01:20Z diff --git a/main/r/adbcsnowflake/pkgdown.yml b/main/r/adbcsnowflake/pkgdown.yml index d6572673..714701b2 100644 --- a/main/r/adbcsnowflake/pkgdown.yml +++ b/main/r/adbcsnowflake/pkgdown.yml @@ -2,5 +2,5 @@ pandoc: 3.1.3 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2023-08-23T19:07Z +last_built: 2023-08-27T01:19Z diff --git a/main/r/adbcsqlite/pkgdown.yml b/main/r/adbcsqlite/pkgdown.yml index d6572673..3f5a5f7c 100644 --- a/main/r/adbcsqlite/pkgdown.yml +++ b/main/r/adbcsqlite/pkgdown.yml @@ -2,5 +2,5 @@ pandoc: 3.1.3 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2023-08-23T19:07Z +last_built: 2023-08-27T01:20Z diff --git a/main/searchindex.js b/main/searchindex.js index 018bc256..f02b710e 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["cpp/api/adbc", "cpp/api/adbc_driver_manager", "cpp/api/index", "cpp/concurrency", "cpp/driver_manager", "cpp/index", "cpp/quickstart", "development/contributing", "development/nightly", "development/releasing", "driver/duckdb", "driver/flight_sql", "driver/installation", "driver/jdbc", "driver/postgresql", "driver/snowflake", "driver/sqlite", "driver/status", "faq", "format/comparison", "format/specification", "format/versioning", "index", "java/index", "py [...] \ No newline at end of file +Search.setIndex({"docnames": ["cpp/api/adbc", "cpp/api/adbc_driver_manager", "cpp/api/index", "cpp/concurrency", "cpp/driver_manager", "cpp/index", "cpp/quickstart", "development/contributing", "development/nightly", "development/releasing", "driver/duckdb", "driver/flight_sql", "driver/installation", "driver/jdbc", "driver/postgresql", "driver/snowflake", "driver/sqlite", "driver/status", "faq", "format/comparison", "format/specification", "format/versioning", "index", "java/index", "py [...] \ No newline at end of file