This is an automated email from the ASF dual-hosted git repository.
emkornfield pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new 1f175e1 ARROW-8634: [Java] Add Getting Started section to Java README
1f175e1 is described below
commit 1f175e12a101960fd5b293a2dc366855eaaad141
Author: Andy Grove <[email protected]>
AuthorDate: Thu Apr 30 21:42:51 2020 -0700
ARROW-8634: [Java] Add Getting Started section to Java README
Currently, it is difficult to get started with Arrow Java because there are
no examples, and no "getting started" guide.
This PR adds a couple of trivial examples as a starting point.
Closes #7066 from andygrove/ARROW-8634
Authored-by: Andy Grove <[email protected]>
Signed-off-by: Micah Kornfield <[email protected]>
---
java/README.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/java/README.md b/java/README.md
index f312636..9851308 100644
--- a/java/README.md
+++ b/java/README.md
@@ -19,6 +19,16 @@
# Arrow Java
+## Getting Started
+
+The following guides explain the fundamental data structures used in the Java
implementation of Apache Arrow.
+
+- [ValueVector](https://arrow.apache.org/docs/java/vector.html) is an
abstraction that is used to store a sequence of values having the same type in
an individual column.
+-
[VectorSchemaRoot](https://arrow.apache.org/docs/java/vector_schema_root.html)
is a container that can hold multiple vectors based on a schema.
+- The [Reading/Writing IPC
formats](https://arrow.apache.org/docs/java/ipc.html) guide explains how to
stream record batches as well as serializing record batches to files.
+
+Generated javadoc documentation is available
[here](https://arrow.apache.org/docs/java/).
+
## Setup Build Environment
install:
