Skip to content

Commit fd1bc58

Browse files
author
tianchen
committed
ARROW-6206: [Java][Docs] Document environment variables/java properties
1 parent 13851d4 commit fd1bc58

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

java/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,24 @@ and arrow-format into a single JAR. Using the classifier "shade-format-flatbuff
5454
pom.xml will make use of this JAR, you can then exclude/resolve the original dependency to
5555
a version of your choosing.
5656

57+
## System/Environmental Variables
58+
59+
There are several system/environmental variables that users can config.
60+
61+
* BoundsChecking: Bounds checking is on by default. You can disable it by setting either the
62+
system property("arrow.enable_unsafe_memory_access") or the environmental variable
63+
("ARROW_ENABLE_UNSAFE_MEMORY_ACCESS") to "true". When both the system property and the environmental
64+
variable are set, the system property takes precedence.
65+
66+
* NullCheckingForGet: Null checking is on by default. You can disable it by setting either the
67+
system property("arrow.enable_null_check_for_get") or the environmental variable
68+
("ARROW_ENABLE_NULL_CHECK_FOR_GET") to "false". When both the system property and the environmental
69+
variable are set, the system property takes precedence.
70+
71+
## Java Properties
72+
73+
For java 9 or later, should set "-Dio.netty.tryReflectionSetAccessible=true".
74+
5775
## Java Code Style Guide
5876

5977
Arrow Java follows the Google style guide [here][3] with the following

0 commit comments

Comments
 (0)