-
Notifications
You must be signed in to change notification settings - Fork 4k
ARROW-15572: [Java][Docs] Add Installation section to Java documentation #12538
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
davisusanibar
wants to merge
5
commits into
apache:master
from
davisusanibar:java-tutorial-ARROW-15572
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
4499ac6
Java Tutorial: Getting Started Section
davisusanibar 43a3d8a
Update docs/source/java/install.rst
davisusanibar ef89021
Solving PR comments
davisusanibar 72abfd1
Solving PR comments
davisusanibar bbaa8b2
Apply suggestions from code review
davisusanibar File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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,119 @@ | ||
| .. 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. | ||
|
|
||
| Installing Java Modules | ||
| ======================= | ||
|
|
||
| .. contents:: | ||
|
|
||
| System Compatibility | ||
| -------------------- | ||
|
|
||
| Java modules are regularly built and tested on macOS and Linux distributions. | ||
|
|
||
| Java Compatibility | ||
| ------------------ | ||
|
|
||
| Java modules are currently compatible with Java 8 / 9 / 10 / 11. | ||
|
|
||
| Installing from Maven | ||
| --------------------- | ||
|
|
||
| By default, Maven will download from the central repository: https://repo.maven.apache.org/maven2/org/apache/arrow/ | ||
|
|
||
| Configure your pom.xml with the Java modules needed, for example: | ||
| ``arrow-memory-netty``, ``arrow-format``, and ``arrow-vector``. | ||
|
|
||
| .. code-block:: | ||
|
|
||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <groupId>org.example</groupId> | ||
| <artifactId>demo</artifactId> | ||
| <version>1.0-SNAPSHOT</version> | ||
| <properties> | ||
| <arrow.version>7.0.0</arrow.version> | ||
| </properties> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.apache.arrow</groupId> | ||
| <artifactId>arrow-vector</artifactId> | ||
| <version>${arrow.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.apache.arrow</groupId> | ||
| <artifactId>arrow-memory-netty</artifactId> | ||
| <version>${arrow.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.apache.arrow</groupId> | ||
| <artifactId>arrow-format</artifactId> | ||
| <version>${arrow.version}</version> | ||
| </dependency> | ||
| </dependencies> | ||
| </project> | ||
|
|
||
| Installing from Source | ||
| ---------------------- | ||
|
|
||
| See :ref:`java-development`. | ||
|
|
||
| Installing Nightly Packages | ||
| --------------------------- | ||
|
|
||
| .. warning:: | ||
| These packages are not official releases. Use them at your own risk. | ||
|
|
||
| Arrow nightly builds are uploaded to GitHub. For example, for 2022/03/01, they can be found at `Github Nightly`_. | ||
|
|
||
| To test your code with these artifacts, then configure Maven with: | ||
|
|
||
| .. code-block:: xml | ||
|
|
||
| $ cat ~/.m2/settings.xml | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd" xmlns="http://maven.apache.org/SETTINGS/1.1.0" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> | ||
| <profiles> | ||
| <profile> | ||
| <repositories> | ||
| <repository> | ||
| <id>staged</id> | ||
| <name>staged-releases</name> | ||
| <url>https://github.com/ursacomputing/crossbow/releases/tag/nightly-2022-03-01-0-github-java-jars/</url> | ||
| <releases> | ||
| <enabled>true</enabled> | ||
| </releases> | ||
| <snapshots> | ||
| <enabled>true</enabled> | ||
| </snapshots> | ||
| </repository> | ||
| </repositories> | ||
| <id>arrownightly</id> | ||
| </profile> | ||
| </profiles> | ||
| </settings> | ||
| $ mvn -Parrownightly clean install -X | ||
| Downloading from staged: https://github.com/ursacomputing/crossbow/releases/tag/nightly-2022-03-01-0-github-java-jars/org/apache/arrow/arrow-vector/8.0.0.dev143/arrow-vector-8.0.0.dev143.pom | ||
|
|
||
| Arrow nightly builds are posted on the mailing list at `builds@arrow.apache.org`_. | ||
|
|
||
| .. _builds@arrow.apache.org: https://lists.apache.org/list.html?builds@arrow.apache.org | ||
| .. _Github Nightly: https://github.com/ursacomputing/crossbow/releases/tag/nightly-2022-03-01-0-github-java-jars | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.