This is an automated email from the ASF dual-hosted git repository.
lidavidm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new b587a3d14f MINOR: [Java] Update installation documentation for BOM
file (#38475)
b587a3d14f is described below
commit b587a3d14f229945f243ed22bdd2d11ef2825ea9
Author: James Duong <[email protected]>
AuthorDate: Fri Oct 27 14:18:57 2023 -0700
MINOR: [Java] Update installation documentation for BOM file (#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]>
---
docs/source/java/install.rst | 34 ++++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)
diff --git a/docs/source/java/install.rst b/docs/source/java/install.rst
index 47e91fb39e..32c121573a 100644
--- a/docs/source/java/install.rst
+++ b/docs/source/java/install.rst
@@ -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
