You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/03/03 17:16:01 UTC
[GitHub] [arrow] lidavidm commented on a change in pull request #12538: ARROW-15572: [Java][Docs] Java Tutorial: Getting Started Section
lidavidm commented on a change in pull request #12538:
URL: https://github.com/apache/arrow/pull/12538#discussion_r818878870
##########
File path: docs/source/java/install.rst
##########
@@ -0,0 +1,118 @@
+.. 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.
+
+Installing Java Modules
+=======================
+
+.. contents::
+
+System Compatibility
+--------------------
+
+Java modules are regularly built and tested on macOS and Linux distributions.
+
+Java Compatibility
+------------------
+
+Java modules are currently compatible with Java 8 / 9 / 10 / 11.
+
+Installing from Maven
+---------------------
+
+By default, Maven will download from the central repository: https://repo.maven.apache.org/maven2/org/apache/arrow/
+
+Configure your pom.xml with java module version needed, for example for: memory-netty, format, and vector
+
+.. code-block::
+
+ <?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>7.0.0</arrow.version>
+ </properties>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.arrow</groupId>
+ <artifactId>arrow-vector</artifactId>
+ <version>${arrow.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.arrow</groupId>
+ <artifactId>arrow-memory-netty</artifactId>
+ <version>${arrow.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.arrow</groupId>
+ <artifactId>arrow-format</artifactId>
+ <version>${arrow.version}</version>
+ </dependency>
+ </dependencies>
+ </project>
+
+Installing from Source
+----------------------
+
+See :ref:`java-development`.
+
+Installing Nightly Packages
+---------------------------
+
+.. warning::
+ These packages are not official releases. Use them at your own risk.
+
+All arrow nightly version are uploaded to github assets for example for March 01 it is uploading to `Github Nightly`_
Review comment:
```suggestion
Arrow nightly builds are uploaded to GitHub. For example, for 2022/03/01, they can be found at `Github Nightly`_.
```
##########
File path: docs/source/java/install.rst
##########
@@ -0,0 +1,118 @@
+.. 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.
+
+Installing Java Modules
+=======================
+
+.. contents::
+
+System Compatibility
+--------------------
+
+Java modules are regularly built and tested on macOS and Linux distributions.
+
+Java Compatibility
+------------------
+
+Java modules are currently compatible with Java 8 / 9 / 10 / 11.
+
+Installing from Maven
+---------------------
+
+By default, Maven will download from the central repository: https://repo.maven.apache.org/maven2/org/apache/arrow/
+
+Configure your pom.xml with java module version needed, for example for: memory-netty, format, and vector
Review comment:
```suggestion
Configure your pom.xml with the Java modules needed, for example:
``arrow-memory-netty``, ``arrow-format``, and ``arrow-vector``.
```
##########
File path: docs/source/java/install.rst
##########
@@ -0,0 +1,118 @@
+.. 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.
+
+Installing Java Modules
+=======================
+
+.. contents::
+
+System Compatibility
+--------------------
+
+Java modules are regularly built and tested on macOS and Linux distributions.
+
+Java Compatibility
+------------------
+
+Java modules are currently compatible with Java 8 / 9 / 10 / 11.
+
+Installing from Maven
+---------------------
+
+By default, Maven will download from the central repository: https://repo.maven.apache.org/maven2/org/apache/arrow/
+
+Configure your pom.xml with java module version needed, for example for: memory-netty, format, and vector
+
+.. code-block::
+
+ <?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>7.0.0</arrow.version>
+ </properties>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.arrow</groupId>
+ <artifactId>arrow-vector</artifactId>
+ <version>${arrow.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.arrow</groupId>
+ <artifactId>arrow-memory-netty</artifactId>
+ <version>${arrow.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.arrow</groupId>
+ <artifactId>arrow-format</artifactId>
+ <version>${arrow.version}</version>
+ </dependency>
+ </dependencies>
+ </project>
+
+Installing from Source
+----------------------
+
+See :ref:`java-development`.
+
+Installing Nightly Packages
+---------------------------
+
+.. warning::
+ These packages are not official releases. Use them at your own risk.
+
+All arrow nightly version are uploaded to github assets for example for March 01 it is uploading to `Github Nightly`_
+
+For example if you need to test your code with these artifacts, then, you need to configure maven settings with:
Review comment:
```suggestion
To test your code with these artifacts, then configure Maven with:
```
##########
File path: docs/source/java/install.rst
##########
@@ -0,0 +1,118 @@
+.. 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.
+
+Installing Java Modules
+=======================
+
+.. contents::
+
+System Compatibility
+--------------------
+
+Java modules are regularly built and tested on macOS and Linux distributions.
+
+Java Compatibility
+------------------
+
+Java modules are currently compatible with Java 8 / 9 / 10 / 11.
+
+Installing from Maven
+---------------------
+
+By default, Maven will download from the central repository: https://repo.maven.apache.org/maven2/org/apache/arrow/
+
+Configure your pom.xml with java module version needed, for example for: memory-netty, format, and vector
+
+.. code-block::
+
+ <?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>7.0.0</arrow.version>
+ </properties>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.arrow</groupId>
+ <artifactId>arrow-vector</artifactId>
+ <version>${arrow.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.arrow</groupId>
+ <artifactId>arrow-memory-netty</artifactId>
+ <version>${arrow.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.arrow</groupId>
+ <artifactId>arrow-format</artifactId>
+ <version>${arrow.version}</version>
+ </dependency>
+ </dependencies>
+ </project>
+
+Installing from Source
+----------------------
+
+See :ref:`java-development`.
+
+Installing Nightly Packages
+---------------------------
+
+.. warning::
+ These packages are not official releases. Use them at your own risk.
+
+All arrow nightly version are uploaded to github assets for example for March 01 it is uploading to `Github Nightly`_
+
+For example if you need to test your code with these artifacts, then, you need to configure maven settings with:
+
+.. code-block:: xml
+
+ $ cat ~/.m2/settings.xml
+ <?xml version="1.0" encoding="UTF-8"?>
+ <settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd" xmlns="http://maven.apache.org/SETTINGS/1.1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <profiles>
+ <profile>
+ <repositories>
+ <repository>
+ <id>staged</id>
+ <name>staged-releases</name>
+ <url>https://github.com/ursacomputing/crossbow/releases/tag/nightly-2022-03-01-0-github-java-jars/</url>
+ <releases>
+ <enabled>true</enabled>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+ </repositories>
+ <id>arrownightly</id>
+ </profile>
+ </profiles>
+ </settings>
+ $ mvn -Parrownightly clean install -X
+ Downloading from staged: https://github.com/ursacomputing/crossbow/releases/tag/nightly-2022-03-01-0-github-java-jars/org/apache/arrow/arrow-vector/8.0.0.dev143/arrow-vector-8.0.0.dev143.pom
+
+Consider that you could see arrow nightly builds at `Arrow Nightly`_.
+
+.. _Arrow Nightly: https://lists.apache.org/list.html?builds@arrow.apache.org
Review comment:
```suggestion
.. _builds@arrow.apache.org: https://lists.apache.org/list.html?builds@arrow.apache.org
```
##########
File path: docs/source/java/install.rst
##########
@@ -0,0 +1,118 @@
+.. 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.
+
+Installing Java Modules
+=======================
+
+.. contents::
+
+System Compatibility
+--------------------
+
+Java modules are regularly built and tested on macOS and Linux distributions.
+
+Java Compatibility
+------------------
+
+Java modules are currently compatible with Java 8 / 9 / 10 / 11.
+
+Installing from Maven
+---------------------
+
+By default, Maven will download from the central repository: https://repo.maven.apache.org/maven2/org/apache/arrow/
+
+Configure your pom.xml with java module version needed, for example for: memory-netty, format, and vector
+
+.. code-block::
+
+ <?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>7.0.0</arrow.version>
+ </properties>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.arrow</groupId>
+ <artifactId>arrow-vector</artifactId>
+ <version>${arrow.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.arrow</groupId>
+ <artifactId>arrow-memory-netty</artifactId>
+ <version>${arrow.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.arrow</groupId>
+ <artifactId>arrow-format</artifactId>
+ <version>${arrow.version}</version>
+ </dependency>
+ </dependencies>
+ </project>
+
+Installing from Source
+----------------------
+
+See :ref:`java-development`.
+
+Installing Nightly Packages
+---------------------------
+
+.. warning::
+ These packages are not official releases. Use them at your own risk.
+
+All arrow nightly version are uploaded to github assets for example for March 01 it is uploading to `Github Nightly`_
+
+For example if you need to test your code with these artifacts, then, you need to configure maven settings with:
+
+.. code-block:: xml
+
+ $ cat ~/.m2/settings.xml
+ <?xml version="1.0" encoding="UTF-8"?>
+ <settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd" xmlns="http://maven.apache.org/SETTINGS/1.1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <profiles>
+ <profile>
+ <repositories>
+ <repository>
+ <id>staged</id>
+ <name>staged-releases</name>
+ <url>https://github.com/ursacomputing/crossbow/releases/tag/nightly-2022-03-01-0-github-java-jars/</url>
+ <releases>
+ <enabled>true</enabled>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+ </repositories>
+ <id>arrownightly</id>
+ </profile>
+ </profiles>
+ </settings>
+ $ mvn -Parrownightly clean install -X
+ Downloading from staged: https://github.com/ursacomputing/crossbow/releases/tag/nightly-2022-03-01-0-github-java-jars/org/apache/arrow/arrow-vector/8.0.0.dev143/arrow-vector-8.0.0.dev143.pom
+
+Consider that you could see arrow nightly builds at `Arrow Nightly`_.
Review comment:
```suggestion
Arrow nightly builds are posted on the mailing list at `builds@arrow.apache.org`_.
```
--
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-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org