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 0ff838968 publish documentation
0ff838968 is described below
commit 0ff838968cfa1c02aaa268d49c0dc566ebcf5f03
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Fri Sep 5 05:32:41 2025 +0000
publish documentation
---
main/_sources/format/driver_manifests.rst.txt | 10 ++++++++--
main/_sources/format/versioning.rst.txt | 12 ++++++++++++
main/format/driver_manifests.html | 11 ++++++++---
main/format/versioning.html | 11 +++++++++++
main/r/adbcbigquery/pkgdown.yml | 2 +-
main/r/adbcdrivermanager/pkgdown.yml | 2 +-
main/r/adbcdrivermanager/reference/adbc_connection_init.html | 4 ++--
main/r/adbcdrivermanager/reference/adbc_database_init.html | 2 +-
main/r/adbcdrivermanager/reference/adbc_statement_init.html | 6 +++---
main/r/adbcdrivermanager/search.json | 2 +-
main/r/adbcflightsql/pkgdown.yml | 2 +-
main/r/adbcpostgresql/pkgdown.yml | 2 +-
main/r/adbcsnowflake/pkgdown.yml | 2 +-
main/r/adbcsqlite/pkgdown.yml | 2 +-
main/searchindex.js | 2 +-
15 files changed, 53 insertions(+), 19 deletions(-)
diff --git a/main/_sources/format/driver_manifests.rst.txt
b/main/_sources/format/driver_manifests.rst.txt
index 9c26e0ea2..f2d46137a 100644
--- a/main/_sources/format/driver_manifests.rst.txt
+++ b/main/_sources/format/driver_manifests.rst.txt
@@ -174,7 +174,7 @@ file path to the dynamic library as the driver name.
use adbc_core::driver_manager::ManagedDriver;
fn get_driver() -> ManagedDriver {
-
ManagedDriver::load_dynamic_from_name("/path/to/libadbc_driver.so", None,
AdbcVersion::V100).unwrap()
+ ManagedDriver::load_from_name("/path/to/libadbc_driver.so",
None, AdbcVersion::V100).unwrap()
}
As an alternative to passing the full path to the dynamic library, you may
@@ -208,6 +208,8 @@ Below is an example of a driver manifest:
.. code-block:: toml
+ manifest_version = 1
+
name = 'Driver Display Name'
version = '1.0.0' # driver version
publisher = 'string to identify the publisher'
@@ -241,6 +243,10 @@ a string (single path) or a table of platform-specific
paths. The ``Driver.shar
needed to successfully load a driver manifest. The other keys are optional,
but provide useful metadata
about the driver.
+The ``manifest_version`` key, if present, it must be set to 1. It defaults to
1 and can currently only
+be set to 1. Driver manager implementations must error upon reading a
manifest with
+``manifest_version`` higher than 1.
+
Platform Tuples
^^^^^^^^^^^^^^^
@@ -422,7 +428,7 @@ to control which directories will be searched for
manifests, with the behavior b
.. tab-item:: Rust
:sync: rust
- The ``ManagedDriver`` type has a method ``load_dynamic_from_name``
which takes an optional ``load_flags`` parameter. The flags as a ``u32`` with
+ The ``ManagedDriver`` type has a method ``load_from_name`` which takes
an optional ``load_flags`` parameter. The flags as a ``u32`` with
the type ``adbc_core::driver_manager::LoadFlags``, which has the
following constants:
* ``LOAD_FLAG_SEARCH_ENV`` - search the directory paths in the
environment variable
diff --git a/main/_sources/format/versioning.rst.txt
b/main/_sources/format/versioning.rst.txt
index 6a4e689cf..7b7f84548 100644
--- a/main/_sources/format/versioning.rst.txt
+++ b/main/_sources/format/versioning.rst.txt
@@ -74,3 +74,15 @@ Similarly, this documentation describes the ADBC API
standard version
options or API functions are defined), the next version would be
1.2.0. If incompatible changes are made (e.g. changing the signature
or semantics of a function), the next version would be 2.0.0.
+
+The ADBC :doc:`driver manifest <driver_manifests>` TOML format is
+versioned separately from the ADBC standard and components. Its
+version is an integer currently set to 1. This version number may
+optionally be included in the manifest as the value of the
+``manifest_version`` key. If present, it must be set to 1. If not
+present, it is assumed to be 1. The manifest version number must be
+incremented when and only when breaking changes are made to the
+driver manifest format. In future manifests with a version higher
+than 1, the ``manifest_version`` key will be required. Current
+driver manager implementations must error upon reading a manifest
+with ``manifest_version`` higher than 1.
diff --git a/main/format/driver_manifests.html
b/main/format/driver_manifests.html
index 98eecf615..c7ba97ae5 100644
--- a/main/format/driver_manifests.html
+++ b/main/format/driver_manifests.html
@@ -543,7 +543,7 @@ Rust</label><div class="sd-tab-content docutils">
<span class="k">use</span><span class="w"> </span><span
class="n">adbc_core</span><span class="p">::</span><span
class="n">driver_manager</span><span class="p">::</span><span
class="n">ManagedDriver</span><span class="p">;</span>
<span class="k">fn</span><span class="w"> </span><span
class="nf">get_driver</span><span class="p">()</span><span class="w">
</span><span class="p">-></span><span class="w"> </span><span
class="nc">ManagedDriver</span><span class="w"> </span><span class="p">{</span>
-<span class="w"> </span><span class="n">ManagedDriver</span><span
class="p">::</span><span class="n">load_dynamic_from_name</span><span
class="p">(</span><span
class="s">"/path/to/libadbc_driver.so"</span><span
class="p">,</span><span class="w"> </span><span class="nb">None</span><span
class="p">,</span><span class="w"> </span><span
class="n">AdbcVersion</span><span class="p">::</span><span
class="n">V100</span><span class="p">).</span><span
class="n">unwrap</span><span clas [...]
+<span class="w"> </span><span class="n">ManagedDriver</span><span
class="p">::</span><span class="n">load_from_name</span><span
class="p">(</span><span
class="s">"/path/to/libadbc_driver.so"</span><span
class="p">,</span><span class="w"> </span><span class="nb">None</span><span
class="p">,</span><span class="w"> </span><span
class="n">AdbcVersion</span><span class="p">::</span><span
class="n">V100</span><span class="p">).</span><span
class="n">unwrap</span><span class="p">()</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -570,7 +570,9 @@ installations.</p>
a driver manifest. This provides for consistent handling of manifests by the
driver manager implementations and
by tools that may be written to manage driver installations.</p>
<p>Below is an example of a driver manifest:</p>
-<div class="highlight-toml notranslate"><div
class="highlight"><pre><span></span><span class="n">name</span><span class="w">
</span><span class="o">=</span><span class="w"> </span><span
class="s1">'Driver Display Name'</span>
+<div class="highlight-toml notranslate"><div
class="highlight"><pre><span></span><span
class="n">manifest_version</span><span class="w"> </span><span
class="o">=</span><span class="w"> </span><span class="mi">1</span>
+
+<span class="n">name</span><span class="w"> </span><span
class="o">=</span><span class="w"> </span><span class="s1">'Driver Display
Name'</span>
<span class="n">version</span><span class="w"> </span><span
class="o">=</span><span class="w"> </span><span
class="s1">'1.0.0'</span><span class="w"> </span><span class="c1">#
driver version</span>
<span class="n">publisher</span><span class="w"> </span><span
class="o">=</span><span class="w"> </span><span class="s1">'string to
identify the publisher'</span>
<span class="n">license</span><span class="w"> </span><span
class="o">=</span><span class="w"> </span><span
class="s1">'Apache-2.0'</span><span class="w"> </span><span
class="c1"># or otherwise</span>
@@ -603,6 +605,9 @@ by tools that may be written to manage driver
installations.</p>
a string (single path) or a table of platform-specific paths. The <code
class="docutils literal notranslate"><span
class="pre">Driver.shared</span></code> key is the only key
needed to successfully load a driver manifest. The other keys are optional,
but provide useful metadata
about the driver.</p>
+<p>The <code class="docutils literal notranslate"><span
class="pre">manifest_version</span></code> key, if present, it must be set to
1. It defaults to 1 and can currently only
+be set to 1. Driver manager implementations must error upon reading a
manifest with
+<code class="docutils literal notranslate"><span
class="pre">manifest_version</span></code> higher than 1.</p>
<section id="platform-tuples">
<h4>Platform Tuples<a class="headerlink" href="#platform-tuples" title="Link
to this heading">ΒΆ</a></h4>
<p>Since the manifests use platform tuples to specify the different systems
that
@@ -820,7 +825,7 @@ allow you to control the directories to be searched by
using the value of the op
<input id="sd-tab-item-13" name="sd-tab-set-1" type="radio">
<label class="sd-tab-label" data-sync-group="tab" data-sync-id="rust"
for="sd-tab-item-13">
Rust</label><div class="sd-tab-content docutils">
-<p>The <code class="docutils literal notranslate"><span
class="pre">ManagedDriver</span></code> type has a method <code class="docutils
literal notranslate"><span class="pre">load_dynamic_from_name</span></code>
which takes an optional <code class="docutils literal notranslate"><span
class="pre">load_flags</span></code> parameter. The flags as a <code
class="docutils literal notranslate"><span class="pre">u32</span></code> with
+<p>The <code class="docutils literal notranslate"><span
class="pre">ManagedDriver</span></code> type has a method <code class="docutils
literal notranslate"><span class="pre">load_from_name</span></code> which takes
an optional <code class="docutils literal notranslate"><span
class="pre">load_flags</span></code> parameter. The flags as a <code
class="docutils literal notranslate"><span class="pre">u32</span></code> with
the type <code class="docutils literal notranslate"><span
class="pre">adbc_core::driver_manager::LoadFlags</span></code>, which has the
following constants:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span
class="pre">LOAD_FLAG_SEARCH_ENV</span></code> - search the directory paths in
the environment variable
diff --git a/main/format/versioning.html b/main/format/versioning.html
index 497234766..2f318cb9a 100644
--- a/main/format/versioning.html
+++ b/main/format/versioning.html
@@ -446,6 +446,17 @@ implement the API standard version 1.0.0.</p>
options or API functions are defined), the next version would be
1.2.0. If incompatible changes are made (e.g. changing the signature
or semantics of a function), the next version would be 2.0.0.</p>
+<p>The ADBC <a class="reference internal" href="driver_manifests.html"><span
class="doc">driver manifest</span></a> TOML format is
+versioned separately from the ADBC standard and components. Its
+version is an integer currently set to 1. This version number may
+optionally be included in the manifest as the value of the
+<code class="docutils literal notranslate"><span
class="pre">manifest_version</span></code> key. If present, it must be set to
1. If not
+present, it is assumed to be 1. The manifest version number must be
+incremented when and only when breaking changes are made to the
+driver manifest format. In future manifests with a version higher
+than 1, the <code class="docutils literal notranslate"><span
class="pre">manifest_version</span></code> key will be required. Current
+driver manager implementations must error upon reading a manifest
+with <code class="docutils literal notranslate"><span
class="pre">manifest_version</span></code> higher than 1.</p>
</section>
</section>
diff --git a/main/r/adbcbigquery/pkgdown.yml b/main/r/adbcbigquery/pkgdown.yml
index bcbf40777..9ef72c9e6 100644
--- a/main/r/adbcbigquery/pkgdown.yml
+++ b/main/r/adbcbigquery/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.7.0.2
pkgdown: 2.1.3
pkgdown_sha: ~
articles: {}
-last_built: 2025-09-05T05:01Z
+last_built: 2025-09-05T05:31Z
urls:
reference: https://arrow.apache.org/adbc/current/r/adbcbigquery/reference
article: https://arrow.apache.org/adbc/current/r/adbcbigquery/articles
diff --git a/main/r/adbcdrivermanager/pkgdown.yml
b/main/r/adbcdrivermanager/pkgdown.yml
index e60942e16..ce4ef9591 100644
--- a/main/r/adbcdrivermanager/pkgdown.yml
+++ b/main/r/adbcdrivermanager/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.7.0.2
pkgdown: 2.1.3
pkgdown_sha: ~
articles: {}
-last_built: 2025-09-05T05:01Z
+last_built: 2025-09-05T05:31Z
urls:
reference:
https://arrow.apache.org/adbc/current/r/adbcdrivermanager/reference
article: https://arrow.apache.org/adbc/current/r/adbcdrivermanager/articles
diff --git a/main/r/adbcdrivermanager/reference/adbc_connection_init.html
b/main/r/adbcdrivermanager/reference/adbc_connection_init.html
index 3414880f4..f4f55e301 100644
--- a/main/r/adbcdrivermanager/reference/adbc_connection_init.html
+++ b/main/r/adbcdrivermanager/reference/adbc_connection_init.html
@@ -105,9 +105,9 @@ finer-grained control over behaviour at the R
level.</p></dd>
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor"
href="#ref-examples"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span
class="r-in"><span><span class="va">db</span> <span class="op"><-</span>
<span class="fu"><a
href="adbc_database_init.html">adbc_database_init</a></span><span
class="op">(</span><span class="fu"><a
href="adbc_driver_void.html">adbc_driver_void</a></span><span
class="op">(</span><span class="op">)</span><span
class="op">)</span></span></span>
<span class="r-in"><span><span class="fu">adbc_connection_init</span><span
class="op">(</span><span class="va">db</span><span
class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span> <adbc_connection at
0x563903cd1fc0> </span>
+<span class="r-out co"><span class="r-pr">#></span> <adbc_connection at
0x56288256c060> </span>
<span class="r-out co"><span class="r-pr">#></span> List of 1</span>
-<span class="r-out co"><span class="r-pr">#></span> $
database:<adbc_database at 0x5639044ffe20> </span>
+<span class="r-out co"><span class="r-pr">#></span> $
database:<adbc_database at 0x562884aa2a60> </span>
<span class="r-out co"><span class="r-pr">#></span> List of 1</span>
<span class="r-out co"><span class="r-pr">#></span> ..$
driver:<adbc_driver_void> List of 4</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ load_flags
: int 15</span>
diff --git a/main/r/adbcdrivermanager/reference/adbc_database_init.html
b/main/r/adbcdrivermanager/reference/adbc_database_init.html
index 977c7f9d0..c2351eef4 100644
--- a/main/r/adbcdrivermanager/reference/adbc_database_init.html
+++ b/main/r/adbcdrivermanager/reference/adbc_database_init.html
@@ -104,7 +104,7 @@ finer-grained control over behaviour at the R
level.</p></dd>
<div class="section level2">
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor"
href="#ref-examples"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span
class="r-in"><span><span class="fu">adbc_database_init</span><span
class="op">(</span><span class="fu"><a
href="adbc_driver_void.html">adbc_driver_void</a></span><span
class="op">(</span><span class="op">)</span><span
class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span> <adbc_database at
0x5639043dfaf0> </span>
+<span class="r-out co"><span class="r-pr">#></span> <adbc_database at
0x5628846b1cf0> </span>
<span class="r-out co"><span class="r-pr">#></span> List of 1</span>
<span class="r-out co"><span class="r-pr">#></span> $
driver:<adbc_driver_void> List of 4</span>
<span class="r-out co"><span class="r-pr">#></span> ..$ load_flags :
int 15</span>
diff --git a/main/r/adbcdrivermanager/reference/adbc_statement_init.html
b/main/r/adbcdrivermanager/reference/adbc_statement_init.html
index 444c07dea..506a47a61 100644
--- a/main/r/adbcdrivermanager/reference/adbc_statement_init.html
+++ b/main/r/adbcdrivermanager/reference/adbc_statement_init.html
@@ -106,11 +106,11 @@ finer-grained control over behaviour at the R
level.</p></dd>
<div class="sourceCode"><pre class="sourceCode r"><code><span
class="r-in"><span><span class="va">db</span> <span class="op"><-</span>
<span class="fu"><a
href="adbc_database_init.html">adbc_database_init</a></span><span
class="op">(</span><span class="fu"><a
href="adbc_driver_void.html">adbc_driver_void</a></span><span
class="op">(</span><span class="op">)</span><span
class="op">)</span></span></span>
<span class="r-in"><span><span class="va">con</span> <span
class="op"><-</span> <span class="fu"><a
href="adbc_connection_init.html">adbc_connection_init</a></span><span
class="op">(</span><span class="va">db</span><span
class="op">)</span></span></span>
<span class="r-in"><span><span class="fu">adbc_statement_init</span><span
class="op">(</span><span class="va">con</span><span
class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span> <adbc_statement at
0x5638fefd46e0> </span>
+<span class="r-out co"><span class="r-pr">#></span> <adbc_statement at
0x5628844d23f0> </span>
<span class="r-out co"><span class="r-pr">#></span> List of 1</span>
-<span class="r-out co"><span class="r-pr">#></span> $
connection:<adbc_connection at 0x5639026e5fb0> </span>
+<span class="r-out co"><span class="r-pr">#></span> $
connection:<adbc_connection at 0x5628846beaa0> </span>
<span class="r-out co"><span class="r-pr">#></span> List of 1</span>
-<span class="r-out co"><span class="r-pr">#></span> ..$
database:<adbc_database at 0x5639043d16c0> </span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
database:<adbc_database at 0x562883f3fb20> </span>
<span class="r-out co"><span class="r-pr">#></span> List of 1</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$
driver:<adbc_driver_void> List of 4</span>
<span class="r-out co"><span class="r-pr">#></span> .. .. ..$ load_flags
: int 15</span>
diff --git a/main/r/adbcdrivermanager/search.json
b/main/r/adbcdrivermanager/search.json
index 87bda807f..44e16dfa8 100644
--- a/main/r/adbcdrivermanager/search.json
+++ b/main/r/adbcdrivermanager/search.json
@@ -1 +1 @@
-[{"path":"https://arrow.apache.org/adbc/current/r/adbcdrivermanager/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"https://arrow.apache.org/adbc/current/r/adbcdrivermanager/LICENSE.html","id":"id_1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title [...]
+[{"path":"https://arrow.apache.org/adbc/current/r/adbcdrivermanager/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"https://arrow.apache.org/adbc/current/r/adbcdrivermanager/LICENSE.html","id":"id_1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title [...]
diff --git a/main/r/adbcflightsql/pkgdown.yml b/main/r/adbcflightsql/pkgdown.yml
index 53641d2fb..7999f1fa3 100644
--- a/main/r/adbcflightsql/pkgdown.yml
+++ b/main/r/adbcflightsql/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.7.0.2
pkgdown: 2.1.3
pkgdown_sha: ~
articles: {}
-last_built: 2025-09-05T05:01Z
+last_built: 2025-09-05T05:32Z
urls:
reference: https://arrow.apache.org/adbc/current/r/adbcflightsql/reference
article: https://arrow.apache.org/adbc/current/r/adbcflightsql/articles
diff --git a/main/r/adbcpostgresql/pkgdown.yml
b/main/r/adbcpostgresql/pkgdown.yml
index a948fd9e0..99009e2c8 100644
--- a/main/r/adbcpostgresql/pkgdown.yml
+++ b/main/r/adbcpostgresql/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.7.0.2
pkgdown: 2.1.3
pkgdown_sha: ~
articles: {}
-last_built: 2025-09-05T05:01Z
+last_built: 2025-09-05T05:32Z
urls:
reference: https://arrow.apache.org/adbc/current/r/adbcpostgresql/reference
article: https://arrow.apache.org/adbc/current/r/adbcpostgresql/articles
diff --git a/main/r/adbcsnowflake/pkgdown.yml b/main/r/adbcsnowflake/pkgdown.yml
index 911426294..d72342179 100644
--- a/main/r/adbcsnowflake/pkgdown.yml
+++ b/main/r/adbcsnowflake/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.7.0.2
pkgdown: 2.1.3
pkgdown_sha: ~
articles: {}
-last_built: 2025-09-05T05:01Z
+last_built: 2025-09-05T05:31Z
urls:
reference: https://arrow.apache.org/adbc/current/r/adbcsnowflake/reference
article: https://arrow.apache.org/adbc/current/r/adbcsnowflake/articles
diff --git a/main/r/adbcsqlite/pkgdown.yml b/main/r/adbcsqlite/pkgdown.yml
index 33f058fb9..74884af57 100644
--- a/main/r/adbcsqlite/pkgdown.yml
+++ b/main/r/adbcsqlite/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.7.0.2
pkgdown: 2.1.3
pkgdown_sha: ~
articles: {}
-last_built: 2025-09-05T05:01Z
+last_built: 2025-09-05T05:31Z
urls:
reference: https://arrow.apache.org/adbc/current/r/adbcsqlite/reference
article: https://arrow.apache.org/adbc/current/r/adbcsqlite/articles
diff --git a/main/searchindex.js b/main/searchindex.js
index 0cab41cf4..4987f4284 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"ADBC API Standard":[[26,null]],"ADBC Driver
Manager and Manifests":[[23,null]],"API
Reference":[[3,"api-reference"],[31,"api-reference"],[41,"api-reference"],[50,"api-reference"]],"And
then what is the \u201cADBC JDBC
driver\u201d?":[[21,"and-then-what-is-the-adbc-jdbc-driver"]],"Apache Arrow
ADBC":[[29,null]],"Arrow type to PostgreSQL type
mapping":[[17,"id5"]],"Authenticate with a username and
password":[[47,"authenticate-with-a-username-and-password"]]," [...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"ADBC API Standard":[[26,null]],"ADBC Driver
Manager and Manifests":[[23,null]],"API
Reference":[[3,"api-reference"],[31,"api-reference"],[41,"api-reference"],[50,"api-reference"]],"And
then what is the \u201cADBC JDBC
driver\u201d?":[[21,"and-then-what-is-the-adbc-jdbc-driver"]],"Apache Arrow
ADBC":[[29,null]],"Arrow type to PostgreSQL type
mapping":[[17,"id5"]],"Authenticate with a username and
password":[[47,"authenticate-with-a-username-and-password"]]," [...]
\ No newline at end of file
