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 5e8e039a1 publish documentation
5e8e039a1 is described below
commit 5e8e039a1eb06d6fe264eeccac56a9e417f14564
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Aug 5 01:01:17 2025 +0000
publish documentation
---
main/_sources/format/specification.rst.txt | 6 +++++-
main/format/specification.html | 8 +++++---
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 +-
13 files changed, 24 insertions(+), 18 deletions(-)
diff --git a/main/_sources/format/specification.rst.txt
b/main/_sources/format/specification.rst.txt
index ce242e96c..e5cdb487e 100644
--- a/main/_sources/format/specification.rst.txt
+++ b/main/_sources/format/specification.rst.txt
@@ -19,7 +19,9 @@
ADBC API Standard
=================
-This document summarizes the general featureset.
+This document summarizes the general featureset of the ADBC API and should be
considered informative only.
+
+For authoritative definitions of the ADBC API, refer to the following sources:
- For C/C++ details, see :external+cpp_adbc:doc:`adbc.h`.
- For Go details, see the `source
<https://github.com/apache/arrow-adbc/blob/main/go/adbc/adbc.go>`__.
@@ -27,6 +29,8 @@ This document summarizes the general featureset.
<https://github.com/apache/arrow-adbc/tree/main/java/core>`__, particularly
the package :jpackage:`org.apache.arrow.adbc.core`.
+:external+cpp_adbc:doc:`adbc.h`. is considered canonical.
+
Databases
=========
diff --git a/main/format/specification.html b/main/format/specification.html
index af2edd7f7..1b290e3e4 100644
--- a/main/format/specification.html
+++ b/main/format/specification.html
@@ -9,10 +9,10 @@
<meta property="og:type" content="website" />
<meta property="og:url"
content="https://arrow.apache.org/adbc/main/format/specification.html" />
<meta property="og:site_name" content="ADBC" />
-<meta property="og:description" content="This document summarizes the general
featureset. For C/C++ details, see adbc.h., For Go details, see the source.,
For Java details, see the source, particularly the package
org.apache.arrow.adbc.co..." />
+<meta property="og:description" content="This document summarizes the general
featureset of the ADBC API and should be considered informative only. For
authoritative definitions of the ADBC API, refer to the following sources: For
C/C++ d..." />
<meta property="og:image"
content="https://arrow.apache.org/adbc/main/_static/banner.png" />
<meta property="og:image:alt" content="ADBC" />
-<meta name="description" content="This document summarizes the general
featureset. For C/C++ details, see adbc.h., For Go details, see the source.,
For Java details, see the source, particularly the package
org.apache.arrow.adbc.co..." />
+<meta name="description" content="This document summarizes the general
featureset of the ADBC API and should be considered informative only. For
authoritative definitions of the ADBC API, refer to the following sources: For
C/C++ d..." />
<link rel="index" title="Index" href="../genindex.html" /><link rel="search"
title="Search" href="../search.html" /><link rel="next" title="Versioning and
Compatibility" href="versioning.html" /><link rel="prev" title="Writing New
Drivers" href="../driver/authoring.html" />
<!-- Generated with Sphinx 8.2.3 and Furo 2024.08.06 -->
@@ -397,13 +397,15 @@
<article role="main" id="furo-main-content">
<section id="adbc-api-standard">
<h1>ADBC API Standard<a class="headerlink" href="#adbc-api-standard"
title="Link to this heading">¶</a></h1>
-<p>This document summarizes the general featureset.</p>
+<p>This document summarizes the general featureset of the ADBC API and should
be considered informative only.</p>
+<p>For authoritative definitions of the ADBC API, refer to the following
sources:</p>
<ul class="simple">
<li><p>For C/C++ details, see <a class="reference external"
href="https://arrow.apache.org/adbc/main/cpp/api/adbc_8h.html" title="(in ADBC
C vversion)"><span class="xref std std-doc">adbc.h</span></a>.</p></li>
<li><p>For Go details, see the <a class="reference external"
href="https://github.com/apache/arrow-adbc/blob/main/go/adbc/adbc.go">source</a>.</p></li>
<li><p>For Java details, see the <a class="reference external"
href="https://github.com/apache/arrow-adbc/tree/main/java/core">source</a>,
particularly
the package <a class="reference external"
href="https://arrow.apache.org/adbc/main/java/api/org/apache/arrow/adbc/core/package-summary.html"
title="(in ADBC Java vversion)"><code class="xref std std-jpackage docutils
literal notranslate"><span
class="pre">org.apache.arrow.adbc.core</span></code></a>.</p></li>
</ul>
+<p><a class="reference external"
href="https://arrow.apache.org/adbc/main/cpp/api/adbc_8h.html" title="(in ADBC
C vversion)"><span class="xref std std-doc">adbc.h</span></a>. is considered
canonical.</p>
<section id="databases">
<h2>Databases<a class="headerlink" href="#databases" title="Link to this
heading">¶</a></h2>
<p>Databases hold state shared by multiple connections. Generally, this
diff --git a/main/r/adbcbigquery/pkgdown.yml b/main/r/adbcbigquery/pkgdown.yml
index aa2ce1128..9e1e62b3f 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-08-05T00:17Z
+last_built: 2025-08-05T01:00Z
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 ab23aa5b8..742f579e7 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-08-05T00:16Z
+last_built: 2025-08-05T01:00Z
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 f73e67dca..432f8924b 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
0x560f6d506840> </span>
+<span class="r-out co"><span class="r-pr">#></span> <adbc_connection at
0x555f50dbd930> </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 0x560f6c452720> </span>
+<span class="r-out co"><span class="r-pr">#></span> $
database:<adbc_database at 0x555f50e2aee0> </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 b8351f6f4..9dc213cb7 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
0x560f6df16d20> </span>
+<span class="r-out co"><span class="r-pr">#></span> <adbc_database at
0x555f505795d0> </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 204546475..38c981d52 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
0x560f6d791c60> </span>
+<span class="r-out co"><span class="r-pr">#></span> <adbc_statement at
0x555f4fa93b40> </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 0x560f6c507e20> </span>
+<span class="r-out co"><span class="r-pr">#></span> $
connection:<adbc_connection at 0x555f50e17340> </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 0x560f6d623530> </span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
database:<adbc_database at 0x555f5009f450> </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 f871da6a3..265d3c11d 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 c7f3ac5cf..6c92c0bec 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-08-05T00:16Z
+last_built: 2025-08-05T01:00Z
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 0f2491824..4ca00619e 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-08-05T00:16Z
+last_built: 2025-08-05T01:00Z
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 34d4c76be..9b470ed96 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-08-05T00:17Z
+last_built: 2025-08-05T01:00Z
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 50fc9da1c..b5df8d762 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-08-05T00:16Z
+last_built: 2025-08-05T01:00Z
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 bf98edef0..307d430ba 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