Skip to content

Commit

Permalink
MINOR: [Java] Update installation documentation for BOM file (apache#…
Browse files Browse the repository at this point in the history
…38475)

Update the installation documentation to describe how to use the bill of materials module.

### Rationale for this change
Add information to get users to use the bill of materials file.

### What changes are included in this PR?
Provide an example of including the bill of materials dependency.

### Are these changes tested?
N/A

### Are there any user-facing changes?
Documentation

Lead-authored-by: James Duong <[email protected]>
Co-authored-by: James Duong <[email protected]>
Co-authored-by: David Li <[email protected]>
Co-authored-by: Dane Pitkin <[email protected]>
Signed-off-by: David Li <[email protected]>
  • Loading branch information
4 people authored Oct 27, 2023
1 parent 848725f commit b587a3d
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/source/java/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,40 @@ arrow-vector, and arrow-memory-netty.
</dependencies>
</project>
A bill of materials (BOM) module has been provided to simplify adding
Arrow modules. This eliminates the need to specify the version for
every module. An alternative to the above would be:

.. code-block:: xml
<?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>15.0.0</arrow.version>
</properties>
<dependencies>
<dependency>
<groupId>org.apache.arrow</groupId>
<artifactId>arrow-bom</artifactId>
<version>${arrow.version}</version>
</dependency>
<dependency>
<groupId>org.apache.arrow</groupId>
<artifactId>arrow-vector</artifactId>
</dependency>
<dependency>
<groupId>org.apache.arrow</groupId>
<artifactId>arrow-memory-netty</artifactId>
</dependency>
</dependencies>
</project>
To use the Arrow Flight dependencies, also add the ``os-maven-plugin``
plugin. This plugin generates useful platform-dependent properties
such as ``os.detected.name`` and ``os.detected.arch`` needed to resolve
Expand Down

0 comments on commit b587a3d

Please sign in to comment.