This is an automated email from the ASF dual-hosted git repository.
lidavidm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-adbc.git
The following commit(s) were added to refs/heads/main by this push:
new 234a913 docs: add Conda installation instructions (#562)
234a913 is described below
commit 234a9138a57ed2780cda5ff2b6bca7f99c1b9d11
Author: David Li <[email protected]>
AuthorDate: Wed Mar 29 13:48:21 2023 -0400
docs: add Conda installation instructions (#562)
Fixes #561.
---
docs/source/driver/installation.rst | 33 +++++++++++++++++++---
.../adbc_driver_manager/dbapi.py | 4 +--
2 files changed, 31 insertions(+), 6 deletions(-)
diff --git a/docs/source/driver/installation.rst
b/docs/source/driver/installation.rst
index 2779d87..6ca06cc 100644
--- a/docs/source/driver/installation.rst
+++ b/docs/source/driver/installation.rst
@@ -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/python/adbc_driver_manager/adbc_driver_manager/dbapi.py
b/python/adbc_driver_manager/adbc_driver_manager/dbapi.py
index 81aea3f..9a05f73 100644
--- a/python/adbc_driver_manager/adbc_driver_manager/dbapi.py
+++ b/python/adbc_driver_manager/adbc_driver_manager/dbapi.py
@@ -776,8 +776,8 @@ class Cursor(_Closeable):
"""
Execute a query and get the partitions of a distributed result set.
- Parameters
- ----------
+ Returns
+ -------
partitions : list of byte
A list of partition descriptors, which can be read with
read_partition.
