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 1f0f72fb publish documentation
1f0f72fb is described below
commit 1f0f72fb7b28c9335bd9bc90fa7ecd7ad94a8de1
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Mon Jun 12 13:01:57 2023 +0000
publish documentation
---
main/_sources/driver/flight_sql.rst.txt | 19 ++++++++++++++++---
main/driver/flight_sql.html | 17 +++++++++++++++--
main/python/api/adbc_driver_flightsql.html | 4 ++--
main/searchindex.js | 2 +-
4 files changed, 34 insertions(+), 8 deletions(-)
diff --git a/main/_sources/driver/flight_sql.rst.txt
b/main/_sources/driver/flight_sql.rst.txt
index 9ec20628..0e9f227d 100644
--- a/main/_sources/driver/flight_sql.rst.txt
+++ b/main/_sources/driver/flight_sql.rst.txt
@@ -97,9 +97,22 @@ the :cpp:class:`AdbcDatabase`.
.. code-block:: python
- import adbc_driver_flightsql.dbapi
-
- with adbc_driver_flightsql.dbapi.connect("grpc://localhost:8080") as
conn:
+ from adbc_driver_flightsql import DatabaseOptions
+ from adbc_driver_flightsql.dbapi import connect
+
+ headers = {"foo": "bar"}
+
+ with connect(
+ "grpc+tls://localhost:8080",
+ db_kwargs={
+ DatabaseOptions.AUTHORIZATION_HEADER.value: "Bearer <token>",
+ DatabaseOptions.TLS_SKIP_VERIFY.value: "true",
+ **{
+ f"{DatabaseOptions.RPC_CALL_HEADER_PREFIX.value}{k}": v
+ for k, v in headers.items()
+ },
+ }
+ ) as conn:
pass
Supported Features
diff --git a/main/driver/flight_sql.html b/main/driver/flight_sql.html
index edb25d5f..43397de2 100644
--- a/main/driver/flight_sql.html
+++ b/main/driver/flight_sql.html
@@ -383,9 +383,22 @@ C++</label><div class="sd-tab-content docutils">
<input id="sd-tab-item-5" name="sd-tab-set-1" type="radio">
</input><label class="sd-tab-label" data-sync-id="python" for="sd-tab-item-5">
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="nn">adbc_driver_flightsql.dbapi</span>
+<div class="highlight-python notranslate"><div
class="highlight"><pre><span></span><span class="kn">from</span> <span
class="nn">adbc_driver_flightsql</span> <span class="kn">import</span> <span
class="n">DatabaseOptions</span>
+<span class="kn">from</span> <span
class="nn">adbc_driver_flightsql.dbapi</span> <span class="kn">import</span>
<span class="n">connect</span>
-<span class="k">with</span> <span class="n">adbc_driver_flightsql</span><span
class="o">.</span><span class="n">dbapi</span><span class="o">.</span><span
class="n">connect</span><span class="p">(</span><span
class="s2">"grpc://localhost:8080"</span><span class="p">)</span>
<span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
+<span class="n">headers</span> <span class="o">=</span> <span
class="p">{</span><span class="s2">"foo"</span><span
class="p">:</span> <span class="s2">"bar"</span><span
class="p">}</span>
+
+<span class="k">with</span> <span class="n">connect</span><span
class="p">(</span>
+ <span class="s2">"grpc+tls://localhost:8080"</span><span
class="p">,</span>
+ <span class="n">db_kwargs</span><span class="o">=</span><span
class="p">{</span>
+ <span class="n">DatabaseOptions</span><span class="o">.</span><span
class="n">AUTHORIZATION_HEADER</span><span class="o">.</span><span
class="n">value</span><span class="p">:</span> <span class="s2">"Bearer
<token>"</span><span class="p">,</span>
+ <span class="n">DatabaseOptions</span><span class="o">.</span><span
class="n">TLS_SKIP_VERIFY</span><span class="o">.</span><span
class="n">value</span><span class="p">:</span> <span
class="s2">"true"</span><span class="p">,</span>
+ <span class="o">**</span><span class="p">{</span>
+ <span class="sa">f</span><span class="s2">"</span><span
class="si">{</span><span class="n">DatabaseOptions</span><span
class="o">.</span><span class="n">RPC_CALL_HEADER_PREFIX</span><span
class="o">.</span><span class="n">value</span><span class="si">}{</span><span
class="n">k</span><span class="si">}</span><span class="s2">"</span><span
class="p">:</span> <span class="n">v</span>
+ <span class="k">for</span> <span class="n">k</span><span
class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span
class="n">headers</span><span class="o">.</span><span
class="n">items</span><span class="p">()</span>
+ <span class="p">},</span>
+ <span class="p">}</span>
+<span class="p">)</span> <span class="k">as</span> <span
class="n">conn</span><span class="p">:</span>
<span class="k">pass</span>
</pre></div>
</div>
diff --git a/main/python/api/adbc_driver_flightsql.html
b/main/python/api/adbc_driver_flightsql.html
index c15fffb4..30782d6f 100644
--- a/main/python/api/adbc_driver_flightsql.html
+++ b/main/python/api/adbc_driver_flightsql.html
@@ -329,7 +329,7 @@
<dd><p>Add an arbitrary header to all outgoing requests.</p>
<p>This option should prefix the name of the header to add
(i.e. it should be used like
-<code class="docutils literal notranslate"><span
class="pre">f"{ConnectionOptions.RpcCallHeaderPrefix}.x-my-header"</span></code>).</p>
+<code class="docutils literal notranslate"><span
class="pre">f"{ConnectionOptions.RPC_CALL_HEADER_PREFIX}x-my-header"</span></code>).</p>
<p>Overrides any headers set via the equivalent database option.</p>
</dd></dl>
@@ -461,7 +461,7 @@ floating-point seconds).</p>
<dd><p>Add an arbitrary header to all outgoing requests.</p>
<p>This option should prefix the name of the header to add
(i.e. it should be used like
-<code class="docutils literal notranslate"><span
class="pre">f"{ConnectionOptions.RpcCallHeaderPrefix}.x-my-header"</span></code>).</p>
+<code class="docutils literal notranslate"><span
class="pre">f"{ConnectionOptions.RPC_CALL_HEADER_PREFIX}x-my-header"</span></code>).</p>
<p>Overrides any headers set via the equivalent database or
connection options.</p>
</dd></dl>
diff --git a/main/searchindex.js b/main/searchindex.js
index 2b79f36d..c09215ad 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/flight_sql", "driver/installation", "driver/jdbc", "driver/postgresql",
"driver/snowflake", "driver/sqlite", "driver/status", "faq",
"format/comparison", "format/specification", "format/versioning", "index",
"java/index", "python/api/adbc_driver_flightsql", "p [...]
\ 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/flight_sql", "driver/installation", "driver/jdbc", "driver/postgresql",
"driver/snowflake", "driver/sqlite", "driver/status", "faq",
"format/comparison", "format/specification", "format/versioning", "index",
"java/index", "python/api/adbc_driver_flightsql", "p [...]
\ No newline at end of file
