This is an automated email from the ASF dual-hosted git repository.
stoty pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/phoenix-connectors.git
The following commit(s) were added to refs/heads/master by this push:
new 540898d PHOENIX-6161 Update the building part of documentation for
Phoenix Connectors
540898d is described below
commit 540898d74d76741764555bba1d41edc0916905f7
Author: Richard Antal <[email protected]>
AuthorDate: Mon Sep 28 16:30:11 2020 +0200
PHOENIX-6161 Update the building part of documentation for Phoenix
Connectors
---
BUILDING.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
README.md | 3 +++
2 files changed, 64 insertions(+)
diff --git a/BUILDING.md b/BUILDING.md
new file mode 100644
index 0000000..f2aec11
--- /dev/null
+++ b/BUILDING.md
@@ -0,0 +1,61 @@
+<!--
+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.
+-->
+
+
+
+<b>[Apache Phoenix](http://phoenix.apache.org/)</b> enables OLTP and
operational analytics in Hadoop for low latency applications. Visit the Apache
Phoenix website <b>[here](http://phoenix.apache.org/)</b>. This repo contains
connectors for third party libraries to access data stored in Phoenix/HBase.
+
+Copyright ©2019 [Apache Software Foundation](http://www.apache.org/). All
Rights Reserved.
+
+## Building Apache Phoenix Connectors
+
+This repository will build jars for the different Phoenix connectors.
+Phoenix 4 and Phoenix 5 versions use different Hadoop and HBase versions, and
require separate versions of the connectors.
+Phoenix 4 requires Hadoop 2.x and HBase 1.x, while Phoenix 5 requires Hadoop
3.x and HBase 2.x
+The standard build process builds the connectors both for Phoenix 4 and
Phoenix 5.
+
+```
+$ mvn package
+```
+
+### Building against specific Phoenix version
+To build a release of Phoenix Connectors which packages a specific version of
Phoenix, specify the `phoenix-four.version` or the `phoenix-five.version`
system property to indicate a specific Phoenix version.
+
+Phoenix Connectors will package the same version of Phoenix used for
build/test. This version is controlled by the
+`phoenix-four.version` and the `phoenix-five.version` system properties.
+
+When specifying `phoenix-four.version` and the `phoenix-five.version`, also
specify the HBase version to be used
+by the corresponding `hbase-one.version` and `hbase-two.version` system
properties.
+Similarly you can overwrite the `hadoop-two.version` and the
`hadoop-three.version` system properties if necessary.
+
+```
+$ mvn package -Dphoenix-five.version=5.1.0-SNAPSHOT
+```
+
+### Running integration tests
+
+`mvn package` will run the unit tests while building, but it will not run the
integration test suite.
+
+The IT suite is run when executing `mvn install` or `mvn verify`. The Phoenix
version specified
+with `phoenix-four.version` and the `phoenix-five.version` are used for
running the integration tests.
+
+```
+$ mvn verify -Dphoenix-four.version=4.16.0-SNAPSHOT -Dhbase-one.version=1.5.0
+```
+```
+$ mvn install -Dphoenix-five.version=5.1.0-SNAPSHOT -Dhbase-one.version=2.1.9
-Dhadoop-three.version=3.0.3
+```
\ No newline at end of file
diff --git a/README.md b/README.md
index b012021..58f9e71 100644
--- a/README.md
+++ b/README.md
@@ -20,3 +20,6 @@ limitations under the License.
<b>[Apache Phoenix](http://phoenix.apache.org/)</b> enables OLTP and
operational analytics in Hadoop for low latency applications. Visit the Apache
Phoenix website <b>[here](http://phoenix.apache.org/)</b>. This repo contains
connectors for third party libraries to access data stored in Phoenix/HBase.
Copyright ©2019 [Apache Software Foundation](http://www.apache.org/). All
Rights Reserved.
+
+## Introduction
+This repo contains the Flume, Pig, Kafka, Spark and Hive connectors for
Phoenix.
\ No newline at end of file
