Permalink
Show file tree
Hide file tree
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
7 changed files
with
264 additions
and
129 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,107 @@ | ||
[![][travis img]][travis] [![][coveralls img]][coveralls] [![][mavenbadge img]][mavenbadge] [![][versioneye img]][versioneye] | ||
<!-- | ||
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. | ||
--> | ||
|
||
[](https://travis-ci.org/apache/incubator-datasketches-pig) | ||
[](https://maven-badges.herokuapp.com/maven-central/org.apache.datasketches/datasketches-pig) | ||
[](https://lgtm.com/projects/g/apache/incubator-datasketches-pig/context:java) | ||
[](https://lgtm.com/projects/g/apache/incubator-datasketches-pig/alerts/) | ||
[](https://coveralls.io/github/apache/incubator-datasketches-pig?branch=master) | ||
|
||
================= | ||
|
||
# Sketch UDFs for Pig | ||
Depends on sketches-core. The released jars include a jar with just the Pig UDFs and a shaded jar | ||
that also includes a shaded sketches-core. | ||
# DataSketches UDF/UDAF Adaptors for Apache Pig | ||
Please refer to our [website](https://datasketches.github.io) for more comprehensive information about the various sketching algorithms and how to use them. | ||
|
||
## Documentation | ||
|
||
### [DataSketches Library Website](https://datasketches.github.io/) | ||
|
||
### [Java Core Overview](https://datasketches.github.io/docs/TheChallenge.html) | ||
|
||
### [Java Core Javadocs](https://datasketches.github.io/api/core/snapshot/apidocs/index.html) | ||
|
||
### Hadoop Pig UDFs | ||
See relevant sections under the different sketch types in Java Core Overview | ||
|
||
|
||
## Downloading Latest Release | ||
__NOTE:__ This component accesses resource files for testing. As a result, the directory elements of the full absolute path of the target installation directory | ||
must qualify as Java identifiers. In other words, the directory elements must not have any space characters (or non-Java identifier characters) in any of the path elements. | ||
|
||
This is required by the Oracle Java Specification in order to ensure location-independent | ||
access to resources: [See Oracle Location-Independent Access to Resources](https://docs.oracle.com/javase/8/docs/technotes/guides/lang/resources.html) | ||
|
||
### [Zip File from Apache Archive](http://archive.apache.org/dist/incubator/datasketches/pig/) | ||
|
||
### [Jar Files from Maven Central](https://repository.apache.org/content/repositories/releases/org/apache/datasketches/datasketches-pig/) | ||
|
||
### [GitHub](https://github.com/apache/incubator-datasketches-pig/releases) | ||
|
||
## Build Instructions | ||
|
||
### JDK8 is Required Compiler | ||
This DataSketches component is pure Java and you must compile using JDK 8. | ||
|
||
### Recommended Build Tool | ||
This DataSketches component is structured as a Maven project and Maven is the recommended Build Tool. | ||
|
||
There are two types of tests: normal unit tests and tests run by the strict profile. | ||
|
||
To run normal unit tests: | ||
|
||
$ mvn clean test | ||
|
||
To run the strict profile tests: | ||
|
||
$ mvn clean test -P strict | ||
|
||
To install jars built from the downloaded source: | ||
|
||
$ mvn clean install -DskipTests=true | ||
|
||
This will create the following jars: | ||
|
||
* datasketches-pig-X.Y.Z-incubating.jar The compiled main class files. | ||
* datasketches-pig-X.Y.Z-incubating-tests.jar The compiled test class files. | ||
* datasketches-pig-X.Y.Z-incubating-sources.jar The main source files. | ||
* datasketches-pig-X.Y.Z-incubating-test-sources.jar The test source files | ||
* datasketches-pig-X.Y.Z-incubating-javadoc.jar The compressed Javadocs. | ||
|
||
### Dependencies | ||
|
||
## [Documentation](https://datasketches.github.io) | ||
#### Run-time | ||
This has the following top-level dependencies: | ||
|
||
## [Latest Release](https://github.com/DataSketches/sketches-pig/releases) | ||
* org.apache.datasketches : datasketches-java | ||
* org.apache.pig : pig | ||
* org.apache.hadoop : hadoop-common | ||
* org.apache.hadoop : hadoop-mapreduce-client-core | ||
* org.apache.hadoop : hadoop-mapreduce-client-common | ||
* org.apache.commons : commons-math3 | ||
|
||
## [Comments](https://groups.google.com/forum/#!forum/sketches-user) | ||
#### Testing | ||
See the pom.xml file for test dependencies. | ||
|
||
[travis]:https://travis-ci.org//DataSketches/sketches-pig/builds?branch=master | ||
[travis img]:https://secure.travis-ci.org/DataSketches/sketches-pig.svg?branch=master | ||
## Resources | ||
|
||
[coveralls]:https://coveralls.io/github/DataSketches/sketches-pig?branch=master | ||
[coveralls img]:https://coveralls.io/repos/github/DataSketches/sketches-pig/badge.svg?branch=master | ||
### [Issues for datasketches-pig](https://github.com/apache/incubator-datasketches-pig/issues) | ||
|
||
[mavenbadge]:https://search.maven.org/#search|gav|1|g%3A%22com.yahoo.datasketches%22%20AND%20a%3A%22sketches-pig%22 | ||
[mavenbadge img]:https://maven-badges.herokuapp.com/maven-central/com.yahoo.datasketches/sketches-pig/badge.svg | ||
### [Forum](https://groups.google.com/forum/#!forum/sketches-user) | ||
|
||
[versioneye]:https://www.versioneye.com/user/projects/587fd6ebb194d4003d5289ae | ||
[versioneye img]:https://www.versioneye.com/user/projects/587fd6ebb194d4003d5289ae/badge.svg?style=flat | ||
### [Dev mailing list](dev@datasketches.apache.org) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.