tree: 5048fedfa29c392f863d30c3f128da113e899718 [path history] [tgz]
  1. .gitattributes
  2. .gitignore
  3. Dockerfile
  4. README.md
  5. adapter/
  6. algorithm/
  7. dev/
  8. flight/
  9. format/
  10. gandiva/
  11. memory/
  12. performance/
  13. plasma/
  14. pom.xml
  15. tools/
  16. vector/
java/README.md

Arrow Java

Setup Build Environment

install:

  • java 7 or later
  • maven 3.3 or later

Building and running tests

cd java
mvn install

Building and running tests for arrow jni modules like gandiva and orc (optional)

Arrow Cpp must be built before this step. The cpp build directory must be provided as the value for argument arrow.cpp.build.dir. eg.

cd java
mvn install -P arrow-jni -am -Darrow.cpp.build.dir=../../release

The gandiva library is still in Alpha stages, and subject to API changes without deprecation warnings.

Java Code Style Guide

Arrow Java follows the Google style guide here with the following differences:

  • Imports are grouped, from top to bottom, in this order: static imports, standard Java, org.*, com.*
  • Line length can be up to 120 characters
  • Operators for line wrapping are at end-of-line
  • Naming rules for methods, parameters, etc. have been relaxed
  • Disabled NoFinalizer, OverloadMethodsDeclarationOrder, and VariableDeclarationUsageDistance due to the existing code base. These rules should be followed when possible.

Refer to `java/dev/checkstyle/checkstyle.xml for rule specifics.

Test Logging Configuration

When running tests, Arrow Java uses the Logback logger with SLF4J. By default, it uses the logback.xml present in the corresponding module's src/test/resources directory, which has the default log level set to INFO. Arrow Java can be built with an alternate logback configuration file using the following command run in the project root directory:

mvn -Dlogback.configurationFile=file:<path-of-logback-file>

See Logback Configuration for more details.