
ckl-mongodb.1.0.1.source-code.README.html Maven / Gradle / Ivy
Show all versions of crnickl-mongodb Show documentation
crnickl-mongodb : MongoDB implementation of the CrNiCKL Database
Copyright 2012-2013 Hauser Olsson GmbH.
Licensed 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.
This is a MongoDB implementation of the CrNiCKL (chronicle) database.
CrNiCKL (pronounced "chronicle") is a database for time series written in
Java running on top of SQL and NoSQL systems.
Distribution
The distribution consists of three archives
crnickl-mongodb-x.y.z.jar
crnickl-mongodb-x.y.z-javadoc.jar
crnickl-mongodb-x.y.z-sources.jar
with compiled classes, HTML documentation, and sources. The version number
x.y.z
follows the maven convention. The distribution also includes .asc
files with detached cryptographic signatures.
For Maven users
The software is available from the Maven central
repository. To use version x.y.z
, insert the following dependency into your
pom.xml
file:
<dependency>
<groupId>ch.agent</groupId>
<artifactId>crnickl-mongodb</artifactId>
<version>x.y.z</version>
<scope>compile</scope>
</dependency>
Building the software
The recommended way is to use git for accessing the
source and maven for building. The procedure
is easy, as maven takes care of locating and downloading dependencies:
$ git clone https://github.com/jpvetterli/crnickl-mongodb.git
$ cd crnickl-mongodb
$ mvn install
This builds and installs the distribution JARs in your local maven
repository. They can also be found in the target
directory.
When building the software by other means, the following dependencies must be
addressed:
crnickl-x.y.z.jar
CrNiCKL database
t2-x.y.z.jar
Time2 Library
mongo-java-driver-x.y.z.jar
MongoDB
Replace all x.y.z
with the actual version numbers which can be found in the
POM
file included in the binary JAR:
/META-INF/maven/ch.agent/crnickl-mongodb/pom.xml
Unit tests
The following command runs unit tests:
$ mvn -Dmaven.test.skip=false test
Browsing the source code
The source is available on GitHub at
http://github.com/jpvetterli/crnickl-mongodb.git.
Finding more information
More information on CrNiCKL is available at
http://agent.ch/timeseries/crnickl/.
This README was updated on 2013-04-30 (jpv).