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 9ab9af3 publish documentation
9ab9af3 is described below
commit 9ab9af38e75c4229be8f9d8751cd7ea8d910cebc
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Wed Mar 29 17:54:45 2023 +0000
publish documentation
---
main/_sources/driver/installation.rst.txt | 33 +++++++++++++++++++++++++++----
main/driver/installation.html | 29 +++++++++++++++++++++++----
main/python/api/adbc_driver_manager.html | 2 +-
main/searchindex.js | 2 +-
4 files changed, 56 insertions(+), 10 deletions(-)
diff --git a/main/_sources/driver/installation.rst.txt
b/main/_sources/driver/installation.rst.txt
index 2779d87..6ca06cc 100644
--- a/main/_sources/driver/installation.rst.txt
+++ b/main/_sources/driver/installation.rst.txt
@@ -26,7 +26,23 @@ Installation
C/C++
=====
-At this time, separate packages for C/C++-based drivers are not available.
+Install the appropriate driver package. These are currently only available
from conda-forge_:
+
+- ``mamba install libadbc-driver-flightsql``
+- ``mamba install libadbc-driver-postgresql``
+- ``mamba install libadbc-driver-sqlite``
+
+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/
Go
==
@@ -47,7 +63,16 @@ Add a dependency on the driver package, for example:
Python
======
-Install the appropriate driver package from PyPI, for example:
+Install the appropriate driver package.
+
+For example, from PyPI:
+
+- ``pip install adbc-driver-flightsql``
+- ``pip install adbc-driver-postgresql``
+- ``pip install adbc-driver-sqlite``
+
+From conda-forge_:
-- ``pip install adbc_driver_postgresql``
-- ``pip install adbc_driver_sqlite``
+- ``mamba install adbc-driver-flightsql``
+- ``mamba install adbc-driver-postgresql``
+- ``mamba install adbc-driver-sqlite``
diff --git a/main/driver/installation.html b/main/driver/installation.html
index 4da9c31..7b255fe 100644
--- a/main/driver/installation.html
+++ b/main/driver/installation.html
@@ -334,7 +334,20 @@
</div>
<section id="c-c">
<h2>C/C++<a class="headerlink" href="#c-c" title="Permalink to this
heading">#</a></h2>
-<p>At this time, separate packages for C/C++-based drivers are not
available.</p>
+<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>
+<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>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="go">
<h2>Go<a class="headerlink" href="#go" title="Permalink to this
heading">#</a></h2>
@@ -354,10 +367,18 @@
</section>
<section id="python">
<h2>Python<a class="headerlink" href="#python" title="Permalink to this
heading">#</a></h2>
-<p>Install the appropriate driver package from PyPI, for example:</p>
+<p>Install the appropriate driver package.</p>
+<p>For example, from PyPI:</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">pip</span>
<span class="pre">install</span> <span
class="pre">adbc-driver-flightsql</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">pip</span>
<span class="pre">install</span> <span
class="pre">adbc-driver-postgresql</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">pip</span>
<span class="pre">install</span> <span
class="pre">adbc-driver-sqlite</span></code></p></li>
+</ul>
+<p>From <a class="reference external"
href="https://conda-forge.org/";>conda-forge</a>:</p>
<ul class="simple">
-<li><p><code class="docutils literal notranslate"><span class="pre">pip</span>
<span class="pre">install</span> <span
class="pre">adbc_driver_postgresql</span></code></p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">pip</span>
<span class="pre">install</span> <span
class="pre">adbc_driver_sqlite</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span
class="pre">mamba</span> <span class="pre">install</span> <span
class="pre">adbc-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">adbc-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">adbc-driver-sqlite</span></code></p></li>
</ul>
</section>
</section>
diff --git a/main/python/api/adbc_driver_manager.html
b/main/python/api/adbc_driver_manager.html
index 4b4a22a..14eb4b6 100644
--- a/main/python/api/adbc_driver_manager.html
+++ b/main/python/api/adbc_driver_manager.html
@@ -1337,7 +1337,7 @@ connections.</p>
<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">Parameters<span class="colon">:</span></dt>
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>partitions</strong><span class="classifier">list of
byte</span></dt><dd><p>A list of partition descriptors, which can be read with
read_partition.</p>
diff --git a/main/searchindex.js b/main/searchindex.js
index 33f8fdd..a70a9b8 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",
"development/contributing", "development/nightly", "development/releasing",
"driver/cpp/index", "driver/cpp/postgresql", "driver/cpp/sqlite",
"driver/go/flight_sql", "driver/go/index", "driver/installation",
"driver/java/flight_sql", "driver/java/index", "driver/java/jdbc",
"driver/status", "faq", "format/comparison", "format/specification", [...]
\ 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",
"development/contributing", "development/nightly", "development/releasing",
"driver/cpp/index", "driver/cpp/postgresql", "driver/cpp/sqlite",
"driver/go/flight_sql", "driver/go/index", "driver/installation",
"driver/java/flight_sql", "driver/java/index", "driver/java/jdbc",
"driver/status", "faq", "format/comparison", "format/specification", [...]
\ No newline at end of file
