FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: add Sphinx documentation site with user and contributor guides by andygrove · Pull Request #24 · apache/datafusion-java · GitHub

Repository navigation

Merged
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
95cccca
docs: scaffold Sphinx documentation site
andygrove May 13, 2026
0dcab13
docs: add ASF license header to make.bat
andygrove May 13, 2026
19d1666
docs: write landing page with toctree
andygrove May 13, 2026
da500e7
docs: add user guide installation page
andygrove May 13, 2026
dbc55e3
docs: write user guide landing page
andygrove May 13, 2026
86eb8fb
docs: add user guide quickstart
andygrove May 13, 2026
b5e0c96
docs: add user guide sessioncontext page
andygrove May 13, 2026
abbaf09
docs: add user guide dataframe page
andygrove May 13, 2026
b7b692f
docs: add user guide parquet page
andygrove May 13, 2026
f276700
docs: add user guide project status page
andygrove May 13, 2026
4552569
docs: write contributor guide landing page
andygrove May 13, 2026
056d487
docs: add contributor guide development page
andygrove May 13, 2026
a947eab
docs: add contributor guide code style page
andygrove May 13, 2026
b3e7de8
docs: add contributor guide releasing placeholder
andygrove May 13, 2026
0c05dc7
docs: add contributor guide datafusion bump recipe
andygrove May 13, 2026
7cf3531
docs: trim README and link to docs site
andygrove May 13, 2026
62216f8
docs: trim CONTRIBUTING and link to docs site
andygrove May 13, 2026
9cb7dc3
docs: fix incorrect ParquetReadOptions API and tighten development page
andygrove May 13, 2026
a691900
docs: nest toctrees in section index pages for sidebar nav
andygrove May 13, 2026
c8018e4
docs: add user guide page on building plans via datafusion-proto
andygrove May 13, 2026
19c6409
Merge remote-tracking branch 'apache/main' into worktree-docs-site
andygrove May 13, 2026
File filter

Filter by extension

Filter by extension .md  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
Prev Previous commit
Next Next commit
docs: add user guide installation page
  • Loading branch information
andygrove committed May 13, 2026
commit da500e7801fcab12b369d4ae01a2fd844e6803ba
52 changes: 52 additions & 0 deletions docs/source/user-guide/installation.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
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.

## Requirements

- **JDK 17 or newer.** Set `JAVA_HOME` to point at it.
- **Rust toolchain (stable).** Install via [rustup].

[rustup]: https://rustup.rs/

## Build from source

```sh
git clone https://github.com/apache/datafusion-java.git
cd datafusion-java
make test
```

`make test` compiles the native Rust crate, then runs the JUnit tests
against it. The native library must be built before the JVM tests can
run.

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
offline; the `download-maven-plugin` cache under
`~/.m2/repository/.cache/` satisfies them.

For development workflow details — running individual tests, the TPC-H
integration test data, code style, and how to update the underlying
DataFusion version — see the [Contributor Guide](../contributor-guide/development.md).

Back | FazBrowse Home | New Git URL