Copyright 2012-2017 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.

CrNiCKL (pronounced "chronicle") is a database for time series written in Java and running on top of SQL and NoSQL systems. The base system cannot run by itself, it requires a driver. Currently, drivers are available for JDBC and MongoDB.

The distribution consists of three archives

crnickl-x.y.z.jar
crnickl-x.y.z-javadoc.jar
crnickl-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.

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</artifactId>
  <version>x.y.z</version>
  <scope>compile</scope>
</dependency>

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.git
$ cd crnickl
$ 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 dependency must be addressed:

• t2-x.y.z.jar (see Time2 Library)

Replace x.y.z with the actual version number which can be found in the POM file included in the binary JAR:

/META-INF/maven/ch.agent/crnickl/pom.xml

Most often CrNiCKL is pulled as a transitive dependency by the actual CrNiCKL database driver chosen for an application. Drivers are available from GitHub and Maven.

The source is available on GitHub.

More information on CrNiCKL is available at the project web site.

Updated: 2017-10-04/jpv