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 1a05f59 publish documentation
1a05f59 is described below
commit 1a05f59c8e5024bdb386bf5a058a0e731243ede6
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Thu Jan 26 19:59:07 2023 +0000
publish documentation
---
main/_sources/driver/go/flight_sql.rst.txt | 33 +++++++++++++++++-------------
main/driver/go/flight_sql.html | 29 +++++++++++++++-----------
main/searchindex.js | 2 +-
3 files changed, 37 insertions(+), 27 deletions(-)
diff --git a/main/_sources/driver/go/flight_sql.rst.txt
b/main/_sources/driver/go/flight_sql.rst.txt
index a598ce4..bc90a8a 100644
--- a/main/_sources/driver/go/flight_sql.rst.txt
+++ b/main/_sources/driver/go/flight_sql.rst.txt
@@ -113,28 +113,33 @@ Client Options
The options used for creating the Flight RPC client can be customized.
These options map 1:1 with the options in FlightClientOptions:
-``arrow.flight.sql.client_option.mtls_cert_chain``
+``adbc.flight.sql.client_option.mtls_cert_chain``
The certificate chain to use for mTLS.
-``arrow.flight.sql.client_option.mtls_private_key``
+``adbc.flight.sql.client_option.mtls_private_key``
The private key to use for mTLS.
-``arrow.flight.sql.client_option.tls_override_hostname``
+``adbc.flight.sql.client_option.tls_override_hostname``
Override the hostname used to verify the server's TLS certificate.
-``arrow.flight.sql.client_option.tls_skip_verify``
+``adbc.flight.sql.client_option.tls_skip_verify``
Disable verification of the server's TLS certificate. Value
should be ``true`` or ``false``.
-``arrow.flight.sql.client_option.tls_root_certs``
+``adbc.flight.sql.client_option.tls_root_certs``
Override the root certificates used to validate the server's TLS
certificate.
-``arrow.flight.sql.client_option.generic_int_option.<OPTION_NAME>``
- Option prefixes used to specify generic transport-layer options.
+``adbc.flight.sql.client_option.with_block``
+ Whether connections should wait until connections are established,
+ or connect lazily when used. The latter is gRPC's default
+ behavior, but the driver defaults to eager connection to surface
+ errors earlier. Value should be ``true`` or ``false``.
-``arrow.flight.sql.client_option.generic_string_option.<OPTION_NAME>``
- Option prefixes used to specify generic transport-layer options.
+``adbc.flight.sql.client_option.with_max_msg_size``
+ The maximum message size to accept from the server. The driver
+ defaults to 16 MiB since Flight services tend to return larger
+ reponse payloads. Should be a positive integer number of bytes.
Custom Call Headers
-------------------
@@ -143,7 +148,7 @@ Custom HTTP headers can be attached to requests via options
that apply
to :cpp:class:`AdbcDatabase`, :cpp:class:`AdbcConnection`, and
:cpp:class:`AdbcStatement`.
-``arrow.flight.sql.rpc.call_header.<HEADER NAME>``
+``adbc.flight.sql.rpc.call_header.<HEADER NAME>``
Add the header ``<HEADER NAME>`` to outgoing requests with the given
value.
@@ -170,7 +175,7 @@ of the partitions.
The queue size can be changed by setting an option on the
:cpp:class:`AdbcStatement`:
-``arrow.flight.sql.rpc.queue_size``
+``adbc.flight.sql.rpc.queue_size``
The number of batches to queue per partition. Defaults to 5.
Metadata
@@ -203,14 +208,14 @@ special options on :cpp:class:`AdbcConnection`. In
general, it is
best practice to set timeouts to avoid unexpectedly getting stuck.
The options are as follows:
-``arrow.flight.sql.rpc.timeout_seconds.fetch``
+``adbc.flight.sql.rpc.timeout_seconds.fetch``
A timeout (in floating-point seconds) for any API calls that fetch
data. This corresponds to Flight ``DoGet`` calls.
For example, this controls the timeout of the underlying Flight
calls that fetch more data as a result set is consumed.
-``arrow.flight.sql.rpc.timeout_seconds.query``
+``adbc.flight.sql.rpc.timeout_seconds.query``
A timeout (in floating-point seconds) for any API calls that
execute a query. This corresponds to Flight ``GetFlightInfo``
calls.
@@ -218,7 +223,7 @@ The options are as follows:
For example, this controls the timeout of the underlying Flight
calls that implement :func:`AdbcStatementExecuteQuery`.
-``arrow.flight.sql.rpc.timeout_seconds.update``
+``adbc.flight.sql.rpc.timeout_seconds.update``
A timeout (in floating-point seconds) for any API calls that
upload data or perform other updates.
diff --git a/main/driver/go/flight_sql.html b/main/driver/go/flight_sql.html
index 0e911da..9b23ce6 100644
--- a/main/driver/go/flight_sql.html
+++ b/main/driver/go/flight_sql.html
@@ -407,21 +407,26 @@ ingestion as a result.</p>
<p>The options used for creating the Flight RPC client can be customized.
These options map 1:1 with the options in FlightClientOptions:</p>
<dl class="simple">
-<dt><code class="docutils literal notranslate"><span
class="pre">arrow.flight.sql.client_option.mtls_cert_chain</span></code></dt><dd><p>The
certificate chain to use for mTLS.</p>
+<dt><code class="docutils literal notranslate"><span
class="pre">adbc.flight.sql.client_option.mtls_cert_chain</span></code></dt><dd><p>The
certificate chain to use for mTLS.</p>
</dd>
-<dt><code class="docutils literal notranslate"><span
class="pre">arrow.flight.sql.client_option.mtls_private_key</span></code></dt><dd><p>The
private key to use for mTLS.</p>
+<dt><code class="docutils literal notranslate"><span
class="pre">adbc.flight.sql.client_option.mtls_private_key</span></code></dt><dd><p>The
private key to use for mTLS.</p>
</dd>
-<dt><code class="docutils literal notranslate"><span
class="pre">arrow.flight.sql.client_option.tls_override_hostname</span></code></dt><dd><p>Override
the hostname used to verify the server’s TLS certificate.</p>
+<dt><code class="docutils literal notranslate"><span
class="pre">adbc.flight.sql.client_option.tls_override_hostname</span></code></dt><dd><p>Override
the hostname used to verify the server’s TLS certificate.</p>
</dd>
-<dt><code class="docutils literal notranslate"><span
class="pre">arrow.flight.sql.client_option.tls_skip_verify</span></code></dt><dd><p>Disable
verification of the server’s TLS certificate. Value
+<dt><code class="docutils literal notranslate"><span
class="pre">adbc.flight.sql.client_option.tls_skip_verify</span></code></dt><dd><p>Disable
verification of the server’s TLS certificate. Value
should be <code class="docutils literal notranslate"><span
class="pre">true</span></code> or <code class="docutils literal
notranslate"><span class="pre">false</span></code>.</p>
</dd>
-<dt><code class="docutils literal notranslate"><span
class="pre">arrow.flight.sql.client_option.tls_root_certs</span></code></dt><dd><p>Override
the root certificates used to validate the server’s TLS
+<dt><code class="docutils literal notranslate"><span
class="pre">adbc.flight.sql.client_option.tls_root_certs</span></code></dt><dd><p>Override
the root certificates used to validate the server’s TLS
certificate.</p>
</dd>
-<dt><code class="docutils literal notranslate"><span
class="pre">arrow.flight.sql.client_option.generic_int_option.<OPTION_NAME></span></code></dt><dd><p>Option
prefixes used to specify generic transport-layer options.</p>
+<dt><code class="docutils literal notranslate"><span
class="pre">adbc.flight.sql.client_option.with_block</span></code></dt><dd><p>Whether
connections should wait until connections are established,
+or connect lazily when used. The latter is gRPC’s default
+behavior, but the driver defaults to eager connection to surface
+errors earlier. Value should be <code class="docutils literal
notranslate"><span class="pre">true</span></code> or <code class="docutils
literal notranslate"><span class="pre">false</span></code>.</p>
</dd>
-<dt><code class="docutils literal notranslate"><span
class="pre">arrow.flight.sql.client_option.generic_string_option.<OPTION_NAME></span></code></dt><dd><p>Option
prefixes used to specify generic transport-layer options.</p>
+<dt><code class="docutils literal notranslate"><span
class="pre">adbc.flight.sql.client_option.with_max_msg_size</span></code></dt><dd><p>The
maximum message size to accept from the server. The driver
+defaults to 16 MiB since Flight services tend to return larger
+reponse payloads. Should be a positive integer number of bytes.</p>
</dd>
</dl>
</section>
@@ -431,7 +436,7 @@ certificate.</p>
to <a class="reference internal"
href="../../cpp/api/adbc.html#_CPPv412AdbcDatabase" title="AdbcDatabase"><code
class="xref cpp cpp-class docutils literal notranslate"><span
class="pre">AdbcDatabase</span></code></a>, <a class="reference internal"
href="../../cpp/api/adbc.html#_CPPv414AdbcConnection"
title="AdbcConnection"><code class="xref cpp cpp-class docutils literal
notranslate"><span class="pre">AdbcConnection</span></code></a>, and
<a class="reference internal"
href="../../cpp/api/adbc.html#_CPPv413AdbcStatement"
title="AdbcStatement"><code class="xref cpp cpp-class docutils literal
notranslate"><span class="pre">AdbcStatement</span></code></a>.</p>
<dl>
-<dt><code class="docutils literal notranslate"><span
class="pre">arrow.flight.sql.rpc.call_header.<HEADER</span> <span
class="pre">NAME></span></code></dt><dd><p>Add the header <code
class="docutils literal notranslate"><span class="pre"><HEADER</span> <span
class="pre">NAME></span></code> to outgoing requests with the given
+<dt><code class="docutils literal notranslate"><span
class="pre">adbc.flight.sql.rpc.call_header.<HEADER</span> <span
class="pre">NAME></span></code></dt><dd><p>Add the header <code
class="docutils literal notranslate"><span class="pre"><HEADER</span> <span
class="pre">NAME></span></code> to outgoing requests with the given
value.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -457,7 +462,7 @@ of the partitions.</p>
<p>The queue size can be changed by setting an option on the
<a class="reference internal"
href="../../cpp/api/adbc.html#_CPPv413AdbcStatement"
title="AdbcStatement"><code class="xref cpp cpp-class docutils literal
notranslate"><span class="pre">AdbcStatement</span></code></a>:</p>
<dl class="simple">
-<dt><code class="docutils literal notranslate"><span
class="pre">arrow.flight.sql.rpc.queue_size</span></code></dt><dd><p>The number
of batches to queue per partition. Defaults to 5.</p>
+<dt><code class="docutils literal notranslate"><span
class="pre">adbc.flight.sql.rpc.queue_size</span></code></dt><dd><p>The number
of batches to queue per partition. Defaults to 5.</p>
</dd>
</dl>
</section>
@@ -486,18 +491,18 @@ special options on <a class="reference internal"
href="../../cpp/api/adbc.html#_
best practice to set timeouts to avoid unexpectedly getting stuck.
The options are as follows:</p>
<dl>
-<dt><code class="docutils literal notranslate"><span
class="pre">arrow.flight.sql.rpc.timeout_seconds.fetch</span></code></dt><dd><p>A
timeout (in floating-point seconds) for any API calls that fetch
+<dt><code class="docutils literal notranslate"><span
class="pre">adbc.flight.sql.rpc.timeout_seconds.fetch</span></code></dt><dd><p>A
timeout (in floating-point seconds) for any API calls that fetch
data. This corresponds to Flight <code class="docutils literal
notranslate"><span class="pre">DoGet</span></code> calls.</p>
<p>For example, this controls the timeout of the underlying Flight
calls that fetch more data as a result set is consumed.</p>
</dd>
-<dt><code class="docutils literal notranslate"><span
class="pre">arrow.flight.sql.rpc.timeout_seconds.query</span></code></dt><dd><p>A
timeout (in floating-point seconds) for any API calls that
+<dt><code class="docutils literal notranslate"><span
class="pre">adbc.flight.sql.rpc.timeout_seconds.query</span></code></dt><dd><p>A
timeout (in floating-point seconds) for any API calls that
execute a query. This corresponds to Flight <code class="docutils literal
notranslate"><span class="pre">GetFlightInfo</span></code>
calls.</p>
<p>For example, this controls the timeout of the underlying Flight
calls that implement <code class="xref py py-func docutils literal
notranslate"><span class="pre">AdbcStatementExecuteQuery()</span></code>.</p>
</dd>
-<dt><code class="docutils literal notranslate"><span
class="pre">arrow.flight.sql.rpc.timeout_seconds.update</span></code></dt><dd><p>A
timeout (in floating-point seconds) for any API calls that
+<dt><code class="docutils literal notranslate"><span
class="pre">adbc.flight.sql.rpc.timeout_seconds.update</span></code></dt><dd><p>A
timeout (in floating-point seconds) for any API calls that
upload data or perform other updates.</p>
<p>For example, this controls the timeout of the underlying Flight
calls that implement bulk ingestion, or transaction support.</p>
diff --git a/main/searchindex.js b/main/searchindex.js
index 2f18adb..9676fa4 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/features", "driver/cpp/index", "driver/cpp/postgresql",
"driver/cpp/sqlite", "driver/go/flight_sql", "driver/java/flight_sql",
"driver/java/index", "driver/java/jdbc", "format/comparison",
"format/specification", "format/versioning", "go/index", "index", " [...]
\ 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/features", "driver/cpp/index", "driver/cpp/postgresql",
"driver/cpp/sqlite", "driver/go/flight_sql", "driver/java/flight_sql",
"driver/java/index", "driver/java/jdbc", "format/comparison",
"format/specification", "format/versioning", "go/index", "index", " [...]
\ No newline at end of file
