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 7de90389 docs(python/adbc_driver_manager): improve docstrings for
set_options (#965)
7de90389 is described below
commit 7de90389be7a5d39d190e374a541d5f3877c0c49
Author: Diego Fernández Giraldo <[email protected]>
AuthorDate: Mon Aug 14 17:02:47 2023 -0400
docs(python/adbc_driver_manager): improve docstrings for set_options (#965)
Add example usage for how to set options from the Python bindings.
---
python/adbc_driver_manager/adbc_driver_manager/_lib.pyx | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/python/adbc_driver_manager/adbc_driver_manager/_lib.pyx
b/python/adbc_driver_manager/adbc_driver_manager/_lib.pyx
index 406d5778..a0961488 100644
--- a/python/adbc_driver_manager/adbc_driver_manager/_lib.pyx
+++ b/python/adbc_driver_manager/adbc_driver_manager/_lib.pyx
@@ -584,6 +584,8 @@ cdef class AdbcDatabase(_AdbcHandle):
def set_options(self, **kwargs) -> None:
"""Set arbitrary key-value options.
+ Pass options as kwargs: ``set_options(**{"some.option": "value"})``.
+
Note, not all drivers support setting options after creation.
See Also
@@ -839,6 +841,8 @@ cdef class AdbcConnection(_AdbcHandle):
def set_options(self, **kwargs) -> None:
"""Set arbitrary key-value options.
+ Pass options as kwargs: ``set_options(**{"some.option": "value"})``.
+
Note, not all drivers support setting options after creation.
See Also
@@ -1104,7 +1108,9 @@ cdef class AdbcStatement(_AdbcHandle):
check_error(status, &c_error)
def set_options(self, **kwargs) -> None:
- """Set arbitrary key-value options.
+ """Set arbitrary key-value options for this statement only.
+
+ Pass options as kwargs: ``set_options(**{"some.option": "value"})``.
See Also
--------
