| commit | ab83e99e98df54c0f219d2760f03c4b4749f73ef | [log] [tgz] |
|---|---|---|
| author | Yingyi Bu <yingyi@couchbase.com> | Thu Feb 02 11:00:26 2017 -0800 |
| committer | Yingyi Bu <buyingyi@gmail.com> | Thu Feb 02 11:50:36 2017 -0800 |
| tree | 803f7e0fcf053a6ea1fdfef589ddb29e5e962437 | |
| parent | ef9be0f9804502205c0bc60a9a07e95f3b849fd9 [diff] |
Polish the github README. Change-Id: I93b4eca1ef9a27dc2f14cd4a0e4bb384159731ce Reviewed-on: https://asterix-gerrit.ics.uci.edu/1479 Sonar-Qube: Jenkins <jenkins@fulliautomatix.ics.uci.edu> Tested-by: Jenkins <jenkins@fulliautomatix.ics.uci.edu> Reviewed-by: Yingyi Bu <buyingyi@gmail.com>
AsterixDB is a BDMS (Big Data Management System) with a rich feature set that sets it apart from other Big Data platforms. Its feature set makes it well-suited to modern needs such as web data warehousing and social data storage and analysis. AsterixDB has:
Data model A semistructured NoSQL style data model (ADM) resulting from extending JSON with object database ideas
Query languages Two expressive and declarative query languages (SQL++ and AQL) that support a broad range of queries and analysis over semistructured data
Scalability A parallel runtime query execution engine, Apache Hyracks, that has been scale-tested on up to 1000+ cores and 500+ disks
Native storage Partitioned LSM-based data storage and indexing to support efficient ingestion and management of semistructured data
External storage Support for query access to externally stored data (e.g., data in HDFS) as well as to data stored natively by AsterixDB
Data types A rich set of primitive data types, including spatial and temporal data in addition to integer, floating point, and textual data
Indexing Secondary indexing options that include B+ trees, R trees, and inverted keyword (exact and fuzzy) index types
Transactions Basic transactional (concurrency and recovery) capabilities akin to those of a NoSQL store
Learn more about AsterixDB at [http://asterixdb.apache.org] (http://asterixdb.apache.org)
##Building AsterixDB
To build AsterixDB from source, you should have a platform with the following:
Instructions for building the master:
Checkout AsterixDB master:
$git clone https://github.com/apache/asterixdb.git
Build AsterixDB master:
$cd asterixdb $mvn clean package -DskipTests
##Running AsterixDB (on your machine from your build) Here are steps to get AsterixDB running on your local machine:
Start a single-machine AsterixDB instance:
$cd asterixdb/asterix-server/target/asterix-server-*-binary-assembly/ $./samples/local/bin/start-sample-cluster.sh
Good to go and run queries in your browser at:
http://localhost:19001
Read more documentations to learn the data model, query language, and how to create a cluster instance: [https://ci.apache.org/projects/asterixdb/index.html] (https://ci.apache.org/projects/asterixdb/index.html)
##Documentation
AsterixDB's official documentation resides at [https://ci.apache.org/projects/asterixdb/index.html] (https://ci.apache.org/projects/asterixdb/index.html). This is built from the maven project under asterix-doc/ as a maven site. The documentation on the official website refers to the most stable build version, so for pre-release versions one should refer to the compiled documentation.
##Support/Contact
If you have any questions, please feel free to ask on our mailing list, users@asterixdb.apache.org. Join the list by sending an email to users-subscribe@asterixdb.apache.org. If you are interested in the internals or developement of AsterixDB, also please feel free to subscribe to our developer mailing list, dev@asterixdb.apache.org, by sending an email to dev-subscribe@asterixdb.apache.org.