You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@carbondata.apache.org by ch...@apache.org on 2016/06/29 14:22:08 UTC
[1/2] incubator-carbondata git commit: Updated ReadMe and added
references of other material to it.
Repository: incubator-carbondata
Updated Branches:
refs/heads/master c49833c81 -> e9bbf75c2
Updated ReadMe and added references of other material to it.
Updated readme doc
corrected style in readme
Updated style
Fixed review comments
Project: http://git-wip-us.apache.org/repos/asf/incubator-carbondata/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-carbondata/commit/f2dd9a2f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-carbondata/tree/f2dd9a2f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-carbondata/diff/f2dd9a2f
Branch: refs/heads/master
Commit: f2dd9a2f06bb120b54796edab68e08ce0bcae124
Parents: c49833c
Author: ravipesala <ra...@gmail.com>
Authored: Wed Jun 29 19:07:53 2016 +0530
Committer: chenliang613 <ch...@apache.org>
Committed: Wed Jun 29 19:47:09 2016 +0530
----------------------------------------------------------------------
README.md | 66 ++-----
docs/Apache CarbonData meetup material.pdf | Bin 1021758 -> 0 bytes
docs/Apache-CarbonData-meetup-material.pdf | Bin 0 -> 1021758 bytes
docs/DDL-Operations-on-Carbon.md | 1 -
docs/How to contribute to Apache CarbonData.md | 185 --------------------
docs/How-to-contribute-to-Apache-CarbonData.md | 185 ++++++++++++++++++++
docs/Quick Start.md | 100 -----------
docs/Quick-Start.md | 100 +++++++++++
8 files changed, 300 insertions(+), 337 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-carbondata/blob/f2dd9a2f/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 2ab3f50..fdab038 100644
--- a/README.md
+++ b/README.md
@@ -30,64 +30,28 @@ CarbonData file format is a columnar store in HDFS, it has many features that a
* Column group: Allow multiple columns to form a column group that would be stored as row format. This reduces the row reconstruction cost at query time.
* Supports for various use cases with one single Data format : like interactive OLAP-style query, Sequential Access (big scan), Random Access (narrow scan).
-### CarbonData File Structure and Format
-The online document at [CarbonData File Format](https://github.com/HuaweiBigData/carbondata/wiki/CarbonData-File-Structure-and-Format)
+### Building CarbonData and using Development tools
+Please refer [Bulding CarbonData and configuring IDE](docs/Installing-CarbonData-And-IDE-Configuartion.md)
-### Building CarbonData
-Prerequisites for building CarbonData:
-* Unix-like environment (Linux, Mac OS X)
-* git
-* Apache Maven (we recommend version 3.0.4)
-* Java 7 or 8
-* Scala 2.10
-* Apache Thrift 0.9.3
-
-I. Clone and build CarbonData
-```
-$ git clone https://github.com/apache/incubator-carbondata.git
-```
-II. Go to the root of the source tree
-```
-$ cd carbondata
-```
-III. Build the project
-* Build without testing:
-```
-$ mvn -DskipTests clean install
-```
-* Build with testing:
-```
-$ mvn clean install
-```
-* Build along with integration test cases: (Note : It takes more time to build)
-```
-$ mvn -Pintegration-test clean install
-```
-
-### Developing CarbonData
-The CarbonData committers use IntelliJ IDEA and Eclipse IDE to develop.
+### Getting Started
+Read the [quick start](docs/Quick-Start.md)
-#### IntelliJ IDEA
-* Download IntelliJ at https://www.jetbrains.com/idea/ and install the Scala plug-in for IntelliJ at http://plugins.jetbrains.com/plugin/?id=1347
-* Go to "File -> Import Project", locate the CarbonData source directory, and select "Maven Project".
-* In the Import Wizard, select "Import Maven projects automatically" and leave other settings at their default.
-* Leave other settings at their default and you should be able to start your development.
-* When you run the scala test, sometimes you will get out of memory exception. You can increase your VM memory usage by the following setting, for example:
-```
--XX:MaxPermSize=512m -Xmx3072m
-```
-You can also make those setting to be the default by setting to the "Defaults -> ScalaTest".
+### Usage of CarbonData
+ [DDL Operations on CarbonData](docs/DDL-Operations-on-Carbon.md)
+
+ [DML Operations on CarbonData](docs/DML-Operations-on-Carbon.md)
+
+ [CarbonData data management](docs/Carbondata-Management.md)
-#### Eclipse
-* Download the Scala IDE (preferred) or install the scala plugin to Eclipse.
-* Import the CarbonData Maven projects ("File" -> "Import" -> "Maven" -> "Existing Maven Projects" -> locate the CarbonData source directory).
+### CarbonData File Structure and interfaces
+Please refer [CarbonData File Format](docs/Carbondata-File-Structure-and-Format.md) and [CarbonData Interfaces](docs/Carbon-Interfaces.md)
-### Getting Started
-Read the [quick start](https://github.com/HuaweiBigData/carbondata/wiki/Quick-Start).
+### Other Technical Material
+[Apache CarbonData meetup material](docs/Apache-CarbonData-meetup-material.pdf)
### Fork and Contribute
This is an active open source project for everyone, and we are always open to people who want to use this system or contribute to it.
-This guide document introduce [how to contribute to CarbonData](https://github.com/HuaweiBigData/carbondata/wiki/How-to-contribute-and-Code-Style).
+This guide document introduce [how to contribute to CarbonData](docs/How-to-contribute-to-Apache-CarbonData.md).
### Contact us
To get involved in CarbonData:
http://git-wip-us.apache.org/repos/asf/incubator-carbondata/blob/f2dd9a2f/docs/Apache CarbonData meetup material.pdf
----------------------------------------------------------------------
diff --git a/docs/Apache CarbonData meetup material.pdf b/docs/Apache CarbonData meetup material.pdf
deleted file mode 100644
index 5f85fff..0000000
Binary files a/docs/Apache CarbonData meetup material.pdf and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-carbondata/blob/f2dd9a2f/docs/Apache-CarbonData-meetup-material.pdf
----------------------------------------------------------------------
diff --git a/docs/Apache-CarbonData-meetup-material.pdf b/docs/Apache-CarbonData-meetup-material.pdf
new file mode 100644
index 0000000..5f85fff
Binary files /dev/null and b/docs/Apache-CarbonData-meetup-material.pdf differ
http://git-wip-us.apache.org/repos/asf/incubator-carbondata/blob/f2dd9a2f/docs/DDL-Operations-on-Carbon.md
----------------------------------------------------------------------
diff --git a/docs/DDL-Operations-on-Carbon.md b/docs/DDL-Operations-on-Carbon.md
index 8fed4b2..4ac427e 100644
--- a/docs/DDL-Operations-on-Carbon.md
+++ b/docs/DDL-Operations-on-Carbon.md
@@ -173,5 +173,4 @@ NA
### Scenarios
NA
-
***
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-carbondata/blob/f2dd9a2f/docs/How to contribute to Apache CarbonData.md
----------------------------------------------------------------------
diff --git a/docs/How to contribute to Apache CarbonData.md b/docs/How to contribute to Apache CarbonData.md
deleted file mode 100644
index 1b0afe3..0000000
--- a/docs/How to contribute to Apache CarbonData.md
+++ /dev/null
@@ -1,185 +0,0 @@
-<!--
- 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.
--->
-
-# How to contribute to Apache CarbonData
-
-The Apache CarbonData community welcomes all kinds of contributions from anyone with a passion for
-faster data format! Apache CarbonData is a new file format for faster interactive query using
-advanced columnar storage, index, compression and encoding techniques to improve computing
-efficiency,in turn it will help speedup queries an order of magnitude faster over PetaBytes of data.
-
-We use a review-then-commit workflow in CarbonData for all contributions.
-
-* Engage -> Design -> Code -> Review -> Commit
-
-## Engage
-
-### Mailing list(s)
-
-We discuss design and implementation issues on dev@carbondata.incubator.apache.org Join by
-emailing dev-subscribe@carbondata.incubator.apache.org
-
-### Apache JIRA
-
-We use [Apache JIRA](https://issues.apache.org/jira/browse/CARBONDATA) as an issue tracking and
-project management tool, as well as a way to communicate among a very diverse and distributed set
-of contributors. To be able to gather feedback, avoid frustration, and avoid duplicated efforts all
-CarbonData-related work should be tracked there.
-
-If you do not already have an Apache JIRA account, sign up [here](https://issues.apache.org/jira/).
-
-If a quick search doesn\u2019t turn up an existing JIRA issue for the work you want to contribute,
-create it. Please discuss your proposal with a committer or the component lead in JIRA or,
-alternatively, on the developer mailing list(dev@carbondata.incubator.apache.org).
-
-If there\u2019s an existing JIRA issue for your intended contribution, please comment about your
-intended work. Once the work is understood, a committer will assign the issue to you.
-(If you don\u2019t have a JIRA role yet, you\u2019ll be added to the \u201ccontributor\u201d role.) If an issue is
-currently assigned, please check with the current assignee before reassigning.
-
-For moderate or large contributions, you should not start coding or writing a design doc unless
-there is a corresponding JIRA issue assigned to you for that work. Simple changes,
-like fixing typos, do not require an associated issue.
-
-### Design
-
-To avoid potential frustration during the code review cycle, we encourage you to clearly scope and
-design non-trivial contributions with the CarbonData community before you start coding.
-
-Generally, the JIRA issue is the best place to gather relevant design docs, comments, or references.
-It\u2019s great to explicitly include relevant stakeholders early in the conversation. For designs that
-may be generally interesting, we also encourage conversations on the developer\u2019s mailing list.
-
-### Code
-
-We use GitHub\u2019s pull request functionality to review proposed code changes.
-If you do not already have a personal GitHub account, sign up [here](https://github.com).
-
-#### Fork the repository on GitHub
-
-Go to the [Apache CarbonData GitHub mirror](https://github.com/apache/incubator-carbondata) and
-fork the repository to your own private account.
-This will be your private workspace for staging changes.
-
-#### Clone the repository locally
-
-You are now ready to create the development environment on your local machine.
-Clone CarbonData\u2019s read-only GitHub mirror.
-```
-$ git clone https://github.com/apache/incubator-carbondata.git
-$ cd incubator-carbondata
-```
-Add your forked repository as an additional Git remote, where you\u2019ll push your changes.
-```
-$ git remote add <GitHub_user> https://github.com/<GitHub_user>/incubator-carbondata.git
-```
-You are now ready to start developing!
-
-#### Create a branch in your fork
-
-You\u2019ll work on your contribution in a branch in your own (forked) repository. Create a local branch,
-initialized with the state of the branch you expect your changes to be merged into.
-Keep in mind that we use several branches, including master, feature-specific, and
-release-specific branches. If you are unsure, initialize with the state of the master branch.
-```
-$ git fetch --all
-$ git checkout -b <my-branch> origin/master
-```
-At this point, you can start making and committing changes to this branch in a standard way.
-
-#### Syncing and pushing your branch
-
-Periodically while you work, and certainly before submitting a pull request, you should update
-your branch with the most recent changes to the target branch.
-```
-$ git pull --rebase
-```
-Remember to always use --rebase parameter to avoid extraneous merge commits.
-
-To push your local, committed changes to your (forked) repository on GitHub, run:
-```
-$ git push <GitHub_user> <my-branch>
-```
-#### Testing
-
-All code should have appropriate unit testing coverage. New code should have new tests in the
-same contribution. Bug fixes should include a regression test to prevent the issue from reoccurring.
-
-For contributions to the Java code, run unit tests locally via Maven.
-```
-$ mvn clean verify
-```
-
-### Review
-
-Once the initial code is complete and the tests pass, it\u2019s time to start the code review process.
-We review and discuss all code, no matter who authors it. It\u2019s a great way to build community,
-since you can learn from other developers, and they become familiar with your contribution.
-It also builds a strong project by encouraging a high quality bar and keeping code consistent
-throughout the project.
-
-#### Create a pull request
-
-Organize your commits to make your reviewer\u2019s job easier. Use the following command to
-re-order, squash, edit, or change description of individual commits.
-```
-$ git rebase -i origin/master
-```
-Navigate to the CarbonData GitHub mirror to create a pull request. The title of the pull request
-should be strictly in the following format:
-```
-[CARBONDATA-issue number>] Title of the pull request
-```
-Please include a descriptive pull request message to help make the reviewer\u2019s job easier.
-
-If you know a good committer to review your pull request, please make a comment like the following.
-If not, don\u2019t worry, a committer will pick it up.
-```
-Hi @<committer/reviewer name>, can you please take a look?
-```
-
-#### Code Review and Revision
-
-During the code review process, don\u2019t rebase your branch or otherwise modify published commits,
-since this can remove existing comment history and be confusing to the reviewer,
-When you make a revision, always push it in a new commit.
-
-Our GitHub mirror automatically provides pre-commit testing coverage using Jenkins.
-Please make sure those tests pass,the contribution cannot be merged otherwise.
-
-#### LGTM
-Once the reviewer is happy with the change, they\u2019ll respond with an LGTM (\u201clooks good to me!\u201d).
-At this point, the committer will take over, possibly make some additional touch ups,
-and merge your changes into the codebase.
-
-In the case both the author and the reviewer are committers, either can merge the pull request.
-Just be sure to communicate clearly whose responsibility it is in this particular case.
-
-Thank you for your contribution to Apache CarbonData!
-
-#### Deleting your branch(optional)
-Once the pull request is merged into the Apache CarbonData repository, you can safely delete the
-branch locally and purge it from your forked repository.
-
-From another local branch, run:
-```
-$ git fetch --all
-$ git branch -d <my-branch>
-$ git push <GitHub_user> --delete <my-branch>
-```
http://git-wip-us.apache.org/repos/asf/incubator-carbondata/blob/f2dd9a2f/docs/How-to-contribute-to-Apache-CarbonData.md
----------------------------------------------------------------------
diff --git a/docs/How-to-contribute-to-Apache-CarbonData.md b/docs/How-to-contribute-to-Apache-CarbonData.md
new file mode 100644
index 0000000..1b0afe3
--- /dev/null
+++ b/docs/How-to-contribute-to-Apache-CarbonData.md
@@ -0,0 +1,185 @@
+<!--
+ 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.
+-->
+
+# How to contribute to Apache CarbonData
+
+The Apache CarbonData community welcomes all kinds of contributions from anyone with a passion for
+faster data format! Apache CarbonData is a new file format for faster interactive query using
+advanced columnar storage, index, compression and encoding techniques to improve computing
+efficiency,in turn it will help speedup queries an order of magnitude faster over PetaBytes of data.
+
+We use a review-then-commit workflow in CarbonData for all contributions.
+
+* Engage -> Design -> Code -> Review -> Commit
+
+## Engage
+
+### Mailing list(s)
+
+We discuss design and implementation issues on dev@carbondata.incubator.apache.org Join by
+emailing dev-subscribe@carbondata.incubator.apache.org
+
+### Apache JIRA
+
+We use [Apache JIRA](https://issues.apache.org/jira/browse/CARBONDATA) as an issue tracking and
+project management tool, as well as a way to communicate among a very diverse and distributed set
+of contributors. To be able to gather feedback, avoid frustration, and avoid duplicated efforts all
+CarbonData-related work should be tracked there.
+
+If you do not already have an Apache JIRA account, sign up [here](https://issues.apache.org/jira/).
+
+If a quick search doesn\u2019t turn up an existing JIRA issue for the work you want to contribute,
+create it. Please discuss your proposal with a committer or the component lead in JIRA or,
+alternatively, on the developer mailing list(dev@carbondata.incubator.apache.org).
+
+If there\u2019s an existing JIRA issue for your intended contribution, please comment about your
+intended work. Once the work is understood, a committer will assign the issue to you.
+(If you don\u2019t have a JIRA role yet, you\u2019ll be added to the \u201ccontributor\u201d role.) If an issue is
+currently assigned, please check with the current assignee before reassigning.
+
+For moderate or large contributions, you should not start coding or writing a design doc unless
+there is a corresponding JIRA issue assigned to you for that work. Simple changes,
+like fixing typos, do not require an associated issue.
+
+### Design
+
+To avoid potential frustration during the code review cycle, we encourage you to clearly scope and
+design non-trivial contributions with the CarbonData community before you start coding.
+
+Generally, the JIRA issue is the best place to gather relevant design docs, comments, or references.
+It\u2019s great to explicitly include relevant stakeholders early in the conversation. For designs that
+may be generally interesting, we also encourage conversations on the developer\u2019s mailing list.
+
+### Code
+
+We use GitHub\u2019s pull request functionality to review proposed code changes.
+If you do not already have a personal GitHub account, sign up [here](https://github.com).
+
+#### Fork the repository on GitHub
+
+Go to the [Apache CarbonData GitHub mirror](https://github.com/apache/incubator-carbondata) and
+fork the repository to your own private account.
+This will be your private workspace for staging changes.
+
+#### Clone the repository locally
+
+You are now ready to create the development environment on your local machine.
+Clone CarbonData\u2019s read-only GitHub mirror.
+```
+$ git clone https://github.com/apache/incubator-carbondata.git
+$ cd incubator-carbondata
+```
+Add your forked repository as an additional Git remote, where you\u2019ll push your changes.
+```
+$ git remote add <GitHub_user> https://github.com/<GitHub_user>/incubator-carbondata.git
+```
+You are now ready to start developing!
+
+#### Create a branch in your fork
+
+You\u2019ll work on your contribution in a branch in your own (forked) repository. Create a local branch,
+initialized with the state of the branch you expect your changes to be merged into.
+Keep in mind that we use several branches, including master, feature-specific, and
+release-specific branches. If you are unsure, initialize with the state of the master branch.
+```
+$ git fetch --all
+$ git checkout -b <my-branch> origin/master
+```
+At this point, you can start making and committing changes to this branch in a standard way.
+
+#### Syncing and pushing your branch
+
+Periodically while you work, and certainly before submitting a pull request, you should update
+your branch with the most recent changes to the target branch.
+```
+$ git pull --rebase
+```
+Remember to always use --rebase parameter to avoid extraneous merge commits.
+
+To push your local, committed changes to your (forked) repository on GitHub, run:
+```
+$ git push <GitHub_user> <my-branch>
+```
+#### Testing
+
+All code should have appropriate unit testing coverage. New code should have new tests in the
+same contribution. Bug fixes should include a regression test to prevent the issue from reoccurring.
+
+For contributions to the Java code, run unit tests locally via Maven.
+```
+$ mvn clean verify
+```
+
+### Review
+
+Once the initial code is complete and the tests pass, it\u2019s time to start the code review process.
+We review and discuss all code, no matter who authors it. It\u2019s a great way to build community,
+since you can learn from other developers, and they become familiar with your contribution.
+It also builds a strong project by encouraging a high quality bar and keeping code consistent
+throughout the project.
+
+#### Create a pull request
+
+Organize your commits to make your reviewer\u2019s job easier. Use the following command to
+re-order, squash, edit, or change description of individual commits.
+```
+$ git rebase -i origin/master
+```
+Navigate to the CarbonData GitHub mirror to create a pull request. The title of the pull request
+should be strictly in the following format:
+```
+[CARBONDATA-issue number>] Title of the pull request
+```
+Please include a descriptive pull request message to help make the reviewer\u2019s job easier.
+
+If you know a good committer to review your pull request, please make a comment like the following.
+If not, don\u2019t worry, a committer will pick it up.
+```
+Hi @<committer/reviewer name>, can you please take a look?
+```
+
+#### Code Review and Revision
+
+During the code review process, don\u2019t rebase your branch or otherwise modify published commits,
+since this can remove existing comment history and be confusing to the reviewer,
+When you make a revision, always push it in a new commit.
+
+Our GitHub mirror automatically provides pre-commit testing coverage using Jenkins.
+Please make sure those tests pass,the contribution cannot be merged otherwise.
+
+#### LGTM
+Once the reviewer is happy with the change, they\u2019ll respond with an LGTM (\u201clooks good to me!\u201d).
+At this point, the committer will take over, possibly make some additional touch ups,
+and merge your changes into the codebase.
+
+In the case both the author and the reviewer are committers, either can merge the pull request.
+Just be sure to communicate clearly whose responsibility it is in this particular case.
+
+Thank you for your contribution to Apache CarbonData!
+
+#### Deleting your branch(optional)
+Once the pull request is merged into the Apache CarbonData repository, you can safely delete the
+branch locally and purge it from your forked repository.
+
+From another local branch, run:
+```
+$ git fetch --all
+$ git branch -d <my-branch>
+$ git push <GitHub_user> --delete <my-branch>
+```
http://git-wip-us.apache.org/repos/asf/incubator-carbondata/blob/f2dd9a2f/docs/Quick Start.md
----------------------------------------------------------------------
diff --git a/docs/Quick Start.md b/docs/Quick Start.md
deleted file mode 100644
index 32c158c..0000000
--- a/docs/Quick Start.md
+++ /dev/null
@@ -1,100 +0,0 @@
-<!--
- 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.
--->
-
-# Getting started with Apache CarbonData
-
-This tutorial provides a quick introduction to using CarbonData.
-
-## Examples
-
-Firstly suggest you go through
-all [examples](https://github.com/apache/incubator-carbondata/tree/master/examples), to understand
-how to create table, how to load data, how to make query.
-
-## Interactive Query with the Spark Shell
-
-### 1.Install
-
-* Download a packaged release of [Spark 1.5.0 or later](http://spark.apache.org/downloads.html)
-* Configure the Hive Metastore using Mysql (you can use this key words to search:mysql hive metastore)
-and move mysql-connector-java jar to ${SPARK_HOME}/lib
-* Download [thrift](https://thrift.apache.org/), rename to thrift and add to path.
-* Download [Apache CarbonData code](https://github.com/apache/incubator-carbondata) and build it
-```
-$ git clone https://github.com/apache/incubator-carbondata.git carbondata
-$ cd carbondata
-$ mvn clean install -DskipTests
-$ cp assembly/target/scala-2.10/carbondata_*.jar ${SPARK_HOME}/lib
-$ mkdir ${SPARK_HOME}/carbondata
-$ cp -r processing/carbonplugins ${SPARK_HOME}/carbondata
-```
-
-### 2 Interactive Data Query
-
-* Run spark shell
-```
-$ cd ${SPARK_HOME}
-$ carbondata_jar=./lib/$(ls -1 lib |grep "^carbondata_.*\.jar$")
-$ mysql_jar=./lib/$(ls -1 lib |grep "^mysql.*\.jar$")
-$ ./bin/spark-shell --master local --jars ${carbondata_jar},${mysql_jar}
-```
-
-* Create CarbonContext instance
-```
-import org.apache.spark.sql.CarbonContext
-import java.io.File
-import org.apache.hadoop.hive.conf.HiveConf
-val cc = new CarbonContext(sc, "./carbondata/store")
-cc.setConf("carbon.kettle.home","./carbondata/carbonplugins")
-val metadata = new File("").getCanonicalPath + "/carbondata/metadata"
-cc.setConf("hive.metastore.warehouse.dir", metadata)
-cc.setConf(HiveConf.ConfVars.HIVECHECKFILEFORMAT.varname, "false")
-```
-
-* Create table
-
-```
-cc.sql("create table if not exists table1 (id string, name string, city string, age Int) STORED BY 'org.apache.carbondata.format'")
-```
-
-* Create sample.csv file in ${SPARK_HOME}/carbondata directory
-
-```
-cd ${SPARK_HOME}/carbondata
-cat > sample.csv << EOF
-id,name,city,age
-1,david,shenzhen,31
-2,eason,shenzhen,27
-3,jarry,wuhan,35
-EOF
-```
-
-* Load data to table1 in spark shell
-
-```
-val dataFilePath = new File("").getCanonicalPath + "/carbondata/sample.csv"
-cc.sql(s"load data inpath '$dataFilePath' into table table1")
-```
-
-* Query data from table1
-
-```
-cc.sql("select * from table1").show
-cc.sql("select city, avg(age), sum(age) from table1 group by city").show
-```
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-carbondata/blob/f2dd9a2f/docs/Quick-Start.md
----------------------------------------------------------------------
diff --git a/docs/Quick-Start.md b/docs/Quick-Start.md
new file mode 100644
index 0000000..32c158c
--- /dev/null
+++ b/docs/Quick-Start.md
@@ -0,0 +1,100 @@
+<!--
+ 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.
+-->
+
+# Getting started with Apache CarbonData
+
+This tutorial provides a quick introduction to using CarbonData.
+
+## Examples
+
+Firstly suggest you go through
+all [examples](https://github.com/apache/incubator-carbondata/tree/master/examples), to understand
+how to create table, how to load data, how to make query.
+
+## Interactive Query with the Spark Shell
+
+### 1.Install
+
+* Download a packaged release of [Spark 1.5.0 or later](http://spark.apache.org/downloads.html)
+* Configure the Hive Metastore using Mysql (you can use this key words to search:mysql hive metastore)
+and move mysql-connector-java jar to ${SPARK_HOME}/lib
+* Download [thrift](https://thrift.apache.org/), rename to thrift and add to path.
+* Download [Apache CarbonData code](https://github.com/apache/incubator-carbondata) and build it
+```
+$ git clone https://github.com/apache/incubator-carbondata.git carbondata
+$ cd carbondata
+$ mvn clean install -DskipTests
+$ cp assembly/target/scala-2.10/carbondata_*.jar ${SPARK_HOME}/lib
+$ mkdir ${SPARK_HOME}/carbondata
+$ cp -r processing/carbonplugins ${SPARK_HOME}/carbondata
+```
+
+### 2 Interactive Data Query
+
+* Run spark shell
+```
+$ cd ${SPARK_HOME}
+$ carbondata_jar=./lib/$(ls -1 lib |grep "^carbondata_.*\.jar$")
+$ mysql_jar=./lib/$(ls -1 lib |grep "^mysql.*\.jar$")
+$ ./bin/spark-shell --master local --jars ${carbondata_jar},${mysql_jar}
+```
+
+* Create CarbonContext instance
+```
+import org.apache.spark.sql.CarbonContext
+import java.io.File
+import org.apache.hadoop.hive.conf.HiveConf
+val cc = new CarbonContext(sc, "./carbondata/store")
+cc.setConf("carbon.kettle.home","./carbondata/carbonplugins")
+val metadata = new File("").getCanonicalPath + "/carbondata/metadata"
+cc.setConf("hive.metastore.warehouse.dir", metadata)
+cc.setConf(HiveConf.ConfVars.HIVECHECKFILEFORMAT.varname, "false")
+```
+
+* Create table
+
+```
+cc.sql("create table if not exists table1 (id string, name string, city string, age Int) STORED BY 'org.apache.carbondata.format'")
+```
+
+* Create sample.csv file in ${SPARK_HOME}/carbondata directory
+
+```
+cd ${SPARK_HOME}/carbondata
+cat > sample.csv << EOF
+id,name,city,age
+1,david,shenzhen,31
+2,eason,shenzhen,27
+3,jarry,wuhan,35
+EOF
+```
+
+* Load data to table1 in spark shell
+
+```
+val dataFilePath = new File("").getCanonicalPath + "/carbondata/sample.csv"
+cc.sql(s"load data inpath '$dataFilePath' into table table1")
+```
+
+* Query data from table1
+
+```
+cc.sql("select * from table1").show
+cc.sql("select city, avg(age), sum(age) from table1 group by city").show
+```
\ No newline at end of file
[2/2] incubator-carbondata git commit: Updated ReadMe and added
references of other material to it This closes #5
Posted by ch...@apache.org.
Updated ReadMe and added references of other material to it This closes #5
Project: http://git-wip-us.apache.org/repos/asf/incubator-carbondata/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-carbondata/commit/e9bbf75c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-carbondata/tree/e9bbf75c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-carbondata/diff/e9bbf75c
Branch: refs/heads/master
Commit: e9bbf75c281b0f39a60d5c433af2dd1f94eee2ad
Parents: c49833c f2dd9a2
Author: chenliang613 <ch...@apache.org>
Authored: Wed Jun 29 19:51:50 2016 +0530
Committer: chenliang613 <ch...@apache.org>
Committed: Wed Jun 29 19:51:50 2016 +0530
----------------------------------------------------------------------
README.md | 66 ++-----
docs/Apache CarbonData meetup material.pdf | Bin 1021758 -> 0 bytes
docs/Apache-CarbonData-meetup-material.pdf | Bin 0 -> 1021758 bytes
docs/DDL-Operations-on-Carbon.md | 1 -
docs/How to contribute to Apache CarbonData.md | 185 --------------------
docs/How-to-contribute-to-Apache-CarbonData.md | 185 ++++++++++++++++++++
docs/Quick Start.md | 100 -----------
docs/Quick-Start.md | 100 +++++++++++
8 files changed, 300 insertions(+), 337 deletions(-)
----------------------------------------------------------------------