asterixdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ima...@apache.org
Subject incubator-asterixdb git commit: Add README markdown
Date Mon, 11 May 2015 22:15:33 GMT
Repository: incubator-asterixdb
Updated Branches:
  refs/heads/master d2d78adcf -> d2dc3b7f2


Add README markdown

This is mainly for GitHub.

Change-Id: I233c0eebe12954c8d311a19074c41841cdfa01c9
Reviewed-on: https://asterix-gerrit.ics.uci.edu/256
Tested-by: Jenkins <jenkins@fulliautomatix.ics.uci.edu>
Reviewed-by: Ian Maxon <imaxon@uci.edu>


Project: http://git-wip-us.apache.org/repos/asf/incubator-asterixdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-asterixdb/commit/d2dc3b7f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-asterixdb/tree/d2dc3b7f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-asterixdb/diff/d2dc3b7f

Branch: refs/heads/master
Commit: d2dc3b7f23dccf544ce401d3c2e64b9c1ff93d3d
Parents: d2d78ad
Author: Ian Maxon <imaxon@apache.org>
Authored: Thu May 7 17:33:30 2015 -0700
Committer: Ian Maxon <imaxon@uci.edu>
Committed: Mon May 11 15:14:09 2015 -0700

----------------------------------------------------------------------
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-asterixdb/blob/d2dc3b7f/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fc5c4d9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+#AsterixDB
+
+AsterixDB is a full-function BDMS (Big Data Management System) with a rich feature set that
distinguishes it from pretty much any other Big Data platform that's out and available today.
 We believe that its feature set makes it well-suited to modern needs such as web data warehousing
and social data storage and analysis.  AsterixDB has:
+
+ * A semistructured NoSQL style data model (ADM) resulting from extending JSON with object
database ideas
+ * An expressive and declarative query language (AQL) that supports a broad range of queries
and analysis over semistructured data
+ * A parallel runtime query execution engine, Hyracks, that has been scale-tested on up to
1000+ cores and 500+ disks
+ * Partitioned LSM-based data storage and indexing to support efficient ingestion and management
of semistructured data
+ * Support for query access to externally stored data (e.g., data in HDFS) as well as to
data stored natively by AsterixDB
+ * A rich set of primitive data types, including spatial and temporal data in addition to
integer, floating point, and textual data
+ * Secondary indexing options that include B+ trees, R trees, and inverted keyword (exact
and fuzzy) index types
+ * Support for fuzzy and spatial queries as well as for more traditional parametric queries
+ * Basic transactional (concurrency and recovery) capabilities akin to those of a NoSQL store
+
+Learn more about AsterixDB at [http://asterixdb.ics.uci.edu/] (http://asterixdb.ics.uci.edu/)
+
+
+##Building AsterixDB
+
+To build AsterixDB from source, you should have a platform with the following:
+* A Unix-ish environment (Linux, OS X, will all do).
+* git
+* Maven 3.1.1 or newer.
+* Java 7 or newer.
+
+Additionally to run all the integration tests you should be running `sshd` locally, and have
passwordless ssh logins.
+
+
+##Documentation
+
+AsterixDB's official documentation resides at [http://asterixdb.ics.uci.edu/documentation/index.html]
(http://asterixdb.ics.uci.edu/documentation/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 release 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, [dev@asterixdb.incubator.apache.org](mailto:dev@asterixdb.incubator.apache.org).
Join the list by sending an email to [dev-subscribe@asterixdb.incubator.apache.org](mailto:dev-subscribe@asterixdb.incubator.apache.org)
+
+


Mime
View raw message