davisusanibar commented on a change in pull request #12739: URL: https://github.com/apache/arrow/pull/12739#discussion_r836872197
########## File path: docs/source/java/getstarted.rst ########## @@ -0,0 +1,417 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + +.. default-domain:: java +.. highlight:: java + +.. _getstarted: + +Getting Started +=============== + +.. contents:: + +This is the variety of arrow java documentation: + +* `Specification and protocols`_: This contains agnostic specification that is implemented in this case by arrow java modules. +* `Supported environment`_ (like this): This contains answers for what-is-that arrow java module. +* `Cookbook`_: This contains answers about how-to-use arrow java modules with practices examples. +* `Development`_: This contains detailed information about what you need to consider to start with arrow java development. + +Arrow Java Modules +------------------ + +Arrow java modules is created using specification such as columnar format, off-heap +memory, serialization and interprocess communication (IPC). Some of the java modules +was created with their own native implementations and others through bindings. + +.. list-table:: Arrow Java Implementations and Bindings + :widths: 25 75 + :header-rows: 1 + + * - Module + - Root Decision + * - Arrow Memory + - Native implementation. + * - Arrow Vector + - Native implementation. + * - Arrow Flight Grpc + - Native implementation. + * - Arrow Flight Sql + - Native implementation. + * - Arrow Algorithm + - Native implementation. + * - Arrow Compression + - Native implementation. + * - Arrow C Data Interface + - Native implementation. + * - Arrow Dataset + - Bindings + * - Arrow ORC + - Bindings + * - Arrow Gandiva + - Bindings + +Arrow java is divided in these modules to offer in-memory columnar data structures: + +.. list-table:: Arrow Java Modules + :widths: 25 75 + :header-rows: 1 + + * - Module + - Description + * - arrow-format + - Generated Java files from the IPC Flatbuffer definitions. + * - arrow-memory-core + - Core off-heap memory management libraries for Arrow ValueVectors. + * - arrow-memory-unsafe + - Allocator and utils for allocating memory in Arrow based on sun.misc.Unsafe. + * - arrow-memory-netty + - Netty allocator and utils for allocating memory in Arrow. + * - arrow-vector + - An off-heap reference implementation for Arrow columnar data format. + * - arrow-tools + - Java applications for working with Arrow ValueVectors. + * - arrow-jdbc + - (`Experimental`) A library for converting JDBC data to Arrow data. + * - arrow-plasma + - (`Experimental`) Java client for the Plasma object store. + * - flight-core + - (`Experimental`) An RPC mechanism for transferring ValueVectors. + * - flight-grpc + - (`Experimental`) Contains utility class to expose Flight gRPC service and client + * - flight-sql + - (`Experimental`) Contains utility classes to expose Flight SQL semantics for clients and servers over Arrow Flight. + * - flight-integration-tests + - Integration tests for Flight RPC. + * - arrow-performance + - JMH Performance benchmarks for other Arrow libraries. + * - arrow-algorithm + - (`Experimental`) A collection of algorithms for working with ValueVectors. + * - arrow-avro + - (`Experimental`) A library for converting Avro data to Arrow data. + * - arrow-compression + - (`Experimental`) A library for working with the compression/decompression of Arrow data. + * - arrow-c-data + - Java implementation of C Data Interface + * - arrow-orc + - (`Experimental`) A JNI wrapper for the C++ ORC reader implementation. + * - arrow-gandiva + - Java wrappers around the native Gandiva SQL expression compiler. + * - arrow-dataset + - Java implementation of Arrow Dataset API/Framework + +For more detail about how to install this modules please review +:doc:`Installing Java Modules <install>`. + +.. figure:: img/arrow_java_wks_deps.png + :scale: 75 % + :alt: Offer a workspace dependency view for arrow java modules + + Workspace dependency view for arrow java modules. Review comment: Deleted -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
