This is an automated email from the ASF dual-hosted git repository.
andygrove pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion-java.git
The following commit(s) were added to refs/heads/main by this push:
new bbd700a docs: document Maven Central coordinates for 0.1.0 (#99)
bbd700a is described below
commit bbd700a854969b7ef6c148f0e384c57984d559bc
Author: Andy Grove <[email protected]>
AuthorDate: Thu May 28 08:57:08 2026 -0600
docs: document Maven Central coordinates for 0.1.0 (#99)
---
README.md | 30 +++++++++++++++++++++--
docs/source/index.md | 4 ++--
docs/source/user-guide/index.md | 4 ++--
docs/source/user-guide/installation.md | 44 ++++++++++++++++++++++++++++++----
4 files changed, 71 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 7c0caeb..c14eb8c 100644
--- a/README.md
+++ b/README.md
@@ -6,8 +6,34 @@ return to the JVM as [Apache Arrow] batches via the Arrow C
Data Interface.
[Apache DataFusion]: https://datafusion.apache.org/
[Apache Arrow]: https://arrow.apache.org/
-> Early development: no releases yet, API will change. Bug reports and
-> contributions welcome.
+> Early development: the API will change between releases. Bug reports
+> and contributions welcome.
+
+## Install
+
+Released to [Maven
Central](https://central.sonatype.com/artifact/org.apache.datafusion/datafusion-java).
+The JAR bundles the native library for Linux and macOS on x86_64 and
+aarch64. Windows users need to build from source.
+
+Maven:
+
+```xml
+<dependency>
+ <groupId>org.apache.datafusion</groupId>
+ <artifactId>datafusion-java</artifactId>
+ <version>0.1.0</version>
+</dependency>
+```
+
+Gradle:
+
+```kotlin
+implementation("org.apache.datafusion:datafusion-java:0.1.0")
+```
+
+Arrow needs `--add-opens=java.base/java.nio=ALL-UNNAMED` on the JVM
+command line. See the [installation
guide](docs/source/user-guide/installation.md)
+for details and for building from source.
## Quickstart
diff --git a/docs/source/index.md b/docs/source/index.md
index 0ee9519..851ab10 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -25,8 +25,8 @@ return to the JVM as [Apache Arrow] batches via the Arrow C
Data Interface.
[Apache DataFusion]: https://datafusion.apache.org/
[Apache Arrow]: https://arrow.apache.org/
-> Early development: no releases yet, API will change. Bug reports and
-> contributions welcome.
+> Early development: the API will change between releases. Bug reports
+> and contributions welcome.
## Quickstart
diff --git a/docs/source/user-guide/index.md b/docs/source/user-guide/index.md
index 85c2bed..a8d42be 100644
--- a/docs/source/user-guide/index.md
+++ b/docs/source/user-guide/index.md
@@ -42,5 +42,5 @@ table-provider
api-reference
```
-> Early development: no releases yet, API will change. Bug reports and
-> contributions welcome.
+> Early development: the API will change between releases. Bug reports
+> and contributions welcome.
diff --git a/docs/source/user-guide/installation.md
b/docs/source/user-guide/installation.md
index 3141355..83e5d73 100644
--- a/docs/source/user-guide/installation.md
+++ b/docs/source/user-guide/installation.md
@@ -19,18 +19,49 @@ under the License.
# Installation
-Apache DataFusion Java has not yet published a release. Until the first
-release, the only way to use the library is to build from source.
+Apache DataFusion Java is published to
+[Maven
Central](https://central.sonatype.com/artifact/org.apache.datafusion/datafusion-java).
+The JAR bundles the native library for Linux (x86_64, aarch64) and macOS
+(x86_64, aarch64), so no separate native install is required on those
+platforms. Windows is not yet supported by the published JAR; Windows
+users need to build from source.
## Requirements
-- **JDK 17 or newer.** Set `JAVA_HOME` to point at it.
-- **Rust toolchain (stable).** Install via [rustup].
+- **JDK 17 or newer.**
+- Arrow needs access to `java.nio` internals. Add this to the JVM
+ arguments of whatever runs your code:
-[rustup]: https://rustup.rs/
+ ```
+ --add-opens=java.base/java.nio=ALL-UNNAMED
+ ```
+
+## Maven
+
+```xml
+<dependency>
+ <groupId>org.apache.datafusion</groupId>
+ <artifactId>datafusion-java</artifactId>
+ <version>0.1.0</version>
+</dependency>
+```
+
+## Gradle
+
+```kotlin
+dependencies {
+ implementation("org.apache.datafusion:datafusion-java:0.1.0")
+}
+```
+
+Arrow (`arrow-vector`, `arrow-c-data`, `arrow-memory-netty`) is pulled in
+transitively — you do not need to declare it yourself.
## Build from source
+If you are on Windows, on another platform without a bundled native
+library, or want to run against unreleased changes, build from source:
+
```sh
git clone https://github.com/apache/datafusion-java.git
cd datafusion-java
@@ -41,6 +72,9 @@ make test
against it. The native library must be built before the JVM tests can
run.
+Building from source requires a stable Rust toolchain (install via
+[rustup](https://rustup.rs/)) in addition to the JDK.
+
The first build in a fresh checkout reaches out to
`raw.githubusercontent.com` to fetch the DataFusion `.proto` files used to
generate the `datafusion-proto` Java classes. Subsequent builds are
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
