DRILL-223, add INSTALL.md and update README.md
Project: http://git-wip-us.apache.org/repos/asf/incubator-drill/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-drill/commit/511eb0ee Tree: http://git-wip-us.apache.org/repos/asf/incubator-drill/tree/511eb0ee Diff: http://git-wip-us.apache.org/repos/asf/incubator-drill/diff/511eb0ee Branch: refs/heads/master Commit: 511eb0ee9e70b8c0f612d73e9f1ec569c2737d69 Parents: 78f6e58 Author: Jacques Nadeau <[email protected]> Authored: Tue Sep 10 14:49:02 2013 -0700 Committer: Jacques Nadeau <[email protected]> Committed: Tue Sep 10 14:49:02 2013 -0700 ---------------------------------------------------------------------- INSTALL.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 21 +++------------------ 2 files changed, 48 insertions(+), 18 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-drill/blob/511eb0ee/INSTALL.md ---------------------------------------------------------------------- diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..3faf7e4 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,45 @@ +# How to build and run Apache Drill + +## Prerequisites + +Currently, the Apache Drill build process is known to work on Linux, Windows and OSX. To build, you need to have the following software installed on your system to successfully complete a build. + * Java 7+ + * protoc 2.5.x compiler + * Maven 3.0+ + +## Confirm settings + # protoc --version + libprotoc 2.5.0 + + # java -version + java version "1.7.0_09" + Java(TM) SE Runtime Environment (build 1.7.0_09-b05) + Java HotSpot(TM) 64-Bit Server VM (build 23.5-b02, mixed mode) + + # mvn --version + Apache Maven 3.0.3 (r1075438; 2011-02-28 09:31:09-0800) + +## Checkout + + git clone https://github.com/apache/incubator-drill.git + +## Build + + cd incubator-drill + mvn clean install + +## Start SQLLine + + ./sqlline -u jdbc:drill:schema=parquet-local -n admin -p admin + +## Run a query + + SELECT + _MAP['R_REGIONKEY'] AS region_key, + _MAP['R_NAME'] AS name, _MAP['R_COMMENT'] AS comment + FROM "sample-data/region.parquet"; + +## More information + +For more information including how to run a Apache Drill cluster, visit the [Apache Drill Wiki](https://cwiki.apache.org/confluence/display/DRILL/Apache+Drill+Wiki) + http://git-wip-us.apache.org/repos/asf/incubator-drill/blob/511eb0ee/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 0947187..bfc779d 100644 --- a/README.md +++ b/README.md @@ -6,26 +6,12 @@ Apache Drill is a distributed mpp query layer that supports SQL and alternative ## Milestone 1 Milestone 1 is focused on providing a technology preview for developers. It offers the ability to query JSON and Parquet columnar data storage formats using ANSI compliant SQL. It also provides the ability to run queries in distributed execution mode utilizing Apache Zookeeper as a cluster coordination service. - ## Quickstart -To build, you need to have Java 7, protoc 2.5.x and maven 3.0 installed on your build system. Currently, the Apache Drill build process is known to work on Linux and OSX. - -To Build: - - git clone https://github.com/apache/incubator-drill.git - cd incubator-drill - mvn clean install - ./sqlline -u jdbc:drill:schema=parquet-local -n admin -p admin -This starts up the sqlline JDBC CLI interface. From here you can run various types of queries such as: - - SELECT - _MAP['R_REGIONKEY'] AS region_key, - _MAP['R_NAME'] AS name, _MAP['R_COMMENT'] AS comment - FROM "sample-data/region.parquet"; +Please read INSTALL.md for setting up and running Apache Drill. ## More Information -Please see the [Apache Drill Website](http://incubator.apache.org/drill/) for more information including: +Please see the [Apache Drill Website](http://incubator.apache.org/drill/) or the [Apache Drill Wiki](https://cwiki.apache.org/confluence/display/DRILL/Apache+Drill+Wiki) for more information including: * Remote Execution Installation Instructions * Information about how to submit logical and distributed physical plans @@ -34,5 +20,4 @@ Please see the [Apache Drill Website](http://incubator.apache.org/drill/) for mo ## Join the community! -Apache Drill is an Apache Foundation project and is seeking all types of contributions. Please say hello on the Apache Drill mailing list or join our weekly Google Hangouts for more information. (More information can be found at the Apache Drill website). - +Apache Drill is an Apache Foundation project and is seeking all types of contributions. Please say hello on the Apache Drill mailing list or join our weekly Google Hangouts for more information. (More information can be found at the Apache Drill website). \ No newline at end of file
