Here's some miscellaneous documentation about using Calcite and its various adapters.
Prerequisites are maven (3.2.1 or later) and Java (JDK 1.7 or later, 1.8 preferred) on your path.
Unpack the source distribution .tar.gz
or .zip
file, cd
to the root directory of the unpacked source, then build using maven:
$ tar xvfz calcite-1.2.0-incubating-source.tar.gz $ cd calcite-1.2.0-incubating $ mvn install
Running tests describes how to run more or fewer tests.
Prerequisites are git, maven (3.2.1 or later) and Java (JDK 1.7 or later, 1.8 preferred) on your path.
Create a local copy of the github repository, cd
to its root directory, then build using maven:
$ git clone git://github.com/apache/incubator-calcite.git $ cd incubator-calcite $ mvn install
Running tests describes how to run more or fewer tests.
The test suite will run by default when you build, unless you specify -DskipTests
:
$ mvn clean $ mvn -DskipTests install
There are other options that control which tests are run, and in what environment, as follows.
-Dcalcite.test.db=DB
(where db is hsqldb
or mysql
) allows you to change the JDBC data source for the test suite. Calcite's test suite requires a JDBC data source populated with the foodmart data set.hsqldb
, the default, uses an in-memory hsqldb database.mysql
uses a MySQL database in jdbc:mysql://localhost/foodmart
. It is somewhat faster than hsqldb, but you need to populate it manually.-Dcalcite.debug
prints extra debugging information to stdout.-Dcalcite.test.slow
enables tests that take longer to execute. For example, there are tests that create virtual TPC-H and TPC-DS schemas in-memory and run tests from those benchmarks.-Dcalcite.test.mongodb=true
enables tests that run against MongoDB. MongoDB must be installed, running, and populated with the zips.json data set.-Dcalcite.test.splunk=true
enables tests that run against Splunk. Splunk must be installed and running.We welcome contributions.
If you are planning to make a large contribution, talk to us first! It helps to agree on the general approach. Log a JIRA case for your proposed feature or start a discussion on the dev list.
Fork the github repository, and create a branch for your feature.
Develop your feature and test cases, and make sure that mvn install
succeeds. (Run extra tests if your change warrants it.)
Commit your change to your branch, and use a comment that starts with the JIRA case number, like this:
[CALCITE-345] AssertionError in RexToLixTranslator comparing to date literal
If your change had multiple commits, use git rebase -i master
to combine them into a single commit, and to bring your code up to date with the latest on the main line.
Then push your commit(s) to github, and create a pull request from your branch to the incubator-calcite master branch. Update the JIRA case to reference your pull request, and a committer will review your changes.
To enable tracing, add the following flags to the java command line:
-Dcalcite.debug=true -Djava.util.logging.config.file=core/src/test/resources/logging.properties
The first flag causes Calcite to print the Java code it generates (to execute queries) to stdout. It is especially useful if you are debugging mysterious problems like this:
Exception in thread "main" java.lang.ClassCastException: Integer cannot be cast to Long at Baz$1$1.current(Unknown Source)
The second flag specifies a config file for the java.util.logging framework. Put the following into core/src/test/resources/logging.properties:
handlers= java.util.logging.ConsoleHandler .level= INFO org.apache.calcite.plan.RelOptPlanner.level=FINER java.util.logging.ConsoleHandler.level=ALL
The line org.apache.calcite.plan.RelOptPlanner.level=FINER
tells the planner to produce fairly verbose output. You can modify the file to enable other loggers, or to change levels. For instance, if you change FINER
to FINEST
the planner will give you an account of the planning process so detailed that it might fill up your hard drive.
See the tutorial.
First, download and install Calcite, and install MongoDB.
Import MongoDB's zipcode data set into MongoDB:
$ curl -o /tmp/zips.json http://media.mongodb.org/zips.json $ mongoimport --db test --collection zips --file /tmp/zips.json Tue Jun 4 16:24:14.190 check 9 29470 Tue Jun 4 16:24:14.469 imported 29470 objects
Log into MongoDB to check it's there:
$ mongo MongoDB shell version: 2.4.3 connecting to: test > db.zips.find().limit(3) { "city" : "ACMAR", "loc" : [ -86.51557, 33.584132 ], "pop" : 6055, "state" : "AL", "_id" : "35004" } { "city" : "ADAMSVILLE", "loc" : [ -86.959727, 33.588437 ], "pop" : 10616, "state" : "AL", "_id" : "35005" } { "city" : "ADGER", "loc" : [ -87.167455, 33.434277 ], "pop" : 3205, "state" : "AL", "_id" : "35006" } > exit bye
Connect using the mongo-zips-model.json Calcite model:
$ ./sqlline sqlline> !connect jdbc:calcite:model=mongodb/target/test-classes/mongo-zips-model.json admin admin Connecting to jdbc:calcite:model=mongodb/target/test-classes/mongo-zips-model.json Connected to: Calcite (version 1.x.x) Driver: Calcite JDBC Driver (version 1.x.x) Autocommit status: true Transaction isolation: TRANSACTION_REPEATABLE_READ sqlline> !tables +------------+--------------+-----------------+---------------+ | TABLE_CAT | TABLE_SCHEM | TABLE_NAME | TABLE_TYPE | +------------+--------------+-----------------+---------------+ | null | mongo_raw | zips | TABLE | | null | mongo_raw | system.indexes | TABLE | | null | mongo | ZIPS | VIEW | | null | metadata | COLUMNS | SYSTEM_TABLE | | null | metadata | TABLES | SYSTEM_TABLE | +------------+--------------+-----------------+---------------+ sqlline> select count(*) from zips; +---------+ | EXPR$0 | +---------+ | 29467 | +---------+ 1 row selected (0.746 seconds) sqlline> !quit Closing: org.apache.calcite.jdbc.FactoryJdbc41$CalciteConnectionJdbc41 $
To run the test suite and sample queries against Splunk, load Splunk's tutorialdata.zip
data set as described in the Splunk tutorial.
(This step is optional, but it provides some interesting data for the sample queries. It is also necessary if you intend to run the test suite, using -Dcalcite.test.splunk=true
.)
New adapters can be created by implementing CalcitePrepare.Context
:
import org.apache.calcite.adapter.java.JavaTypeFactory; import org.apache.calcite.jdbc.CalcitePrepare; import org.apache.calcite.jdbc.CalciteRootSchema; public class AdapterContext implements CalcitePrepare.Context { @Override public JavaTypeFactory getTypeFactory() { // adapter implementation return typeFactory; } @Override public CalciteRootSchema getRootSchema() { // adapter implementation return rootSchema; } }
The example below shows how SQL query can be submitted to CalcitePrepare
with a custom context (AdapterContext
in this case). Calcite prepares and implements the query execution, using the resources provided by the Context
. CalcitePrepare.PrepareResult
provides access to the underlying enumerable and methods for enumeration. The enumerable itself can naturally be some adapter specific implementation.
import org.apache.calcite.jdbc.CalcitePrepare; import org.apache.calcite.prepare.CalcitePrepareImpl; import org.junit.Test; public class AdapterContextTest { @Test public void testSelectAllFromTable() { AdapterContext ctx = new AdapterContext(); String sql = "SELECT * FROM TABLENAME"; Class elementType = Object[].class; CalcitePrepare.PrepareResult<Object> prepared = new CalcitePrepareImpl().prepareSql(ctx, sql, null, elementType, -1); Object enumerable = prepared.getExecutable(); // etc. } }
When Calcite compares types (instances of RelDataType
), it requires them to be the same object. If there are two distinct type instances that refer to the same Java type, Calcite may fail to recognize that they match. It is recommended to:
JavaTypeFactory
within the calcite context;Follow instructions at http://www.apache.org/dev/release-signing to create a key pair. (On Mac OS X, I did brew install gpg
and gpg --gen-key
.)
Add your public key to the KEYS
file by following instructions in the KEYS
file.
Before you start:
-Dcalcite.test.db=hsqldb
(the default)# Set passphrase variable without putting it into shell history read -s GPG_PASSPHRASE # Make sure that there are no junk files in the sandbox git clean -xn mvn clean mvn -Papache-release -Dgpg.passphrase=${GPG_PASSPHRASE} install
When the dry-run has succeeded, change install
to deploy
.
Before you start:
README
, README.md
and HOWTO.md
have the correct version number.julianhyde/coverity_scan
branch, and when it completes, make sure that there are no important issues.Create a release branch named after the release, e.g. branch-1.1
, and push it to Apache.
$ git checkout -b branch-X.Y $ git push -u origin branch-X.Y We will use the branch for the entire the release process. Meanwhile, we do not allow commits to the master branch. After the release is final, we can use `git merge --ff-only` to append the changes on the release branch onto the master branch. (Apache does not allow reverts to the master branch, which makes it difficult to clean up the kind of messy commits that inevitably happen while you are trying to finalize a release.) Now, set up your environment and do a dry run. The dry run will not commit any changes back to git and gives you the opportunity to verify that the release process will complete as expected. If any of the steps fail, clean up (see below), fix the problem, and start again from the top. ```bash # Set passphrase variable without putting it into shell history read -s GPG_PASSPHRASE # Make sure that there are no junk files in the sandbox git clean -xn mvn clean # Do a dry run of the release:prepare step, which sets version numbers. mvn -DdryRun=true -DskipTests -DreleaseVersion=X.Y.Z-incubating -DdevelopmentVersion=X.Y.Z+1-incubating-SNAPSHOT -Papache-release -Darguments="-Dgpg.passphrase=${GPG_PASSPHRASE}" release:prepare 2>&1 | tee /tmp/prepare-dry.log
Check the artifacts:
target
directory should be these 8 files, among others:apache-calcite-
and include incubating
in the version..tar.gz
and .zip
(currently there is no binary distro), check that all files belong to a directory called apache-calcite-X.Y.Z-incubating-src
.DISCLAIMER
, NOTICE
, LICENSE
, README
, README.md
README
is correctcore/target/calcite-core-X.Y.Z-incubating.jar
and mongodb/target/calcite-mongodb-X.Y.Z-incubating-sources.jar
), check that the META-INF
directory contains DEPENDENCIES
, LICENSE
, NOTICE
and git.properties
org-apache-calcite-jdbc.properties
is present and does not contain un-substituted ${...}
variablesNow, remove the -DdryRun
flag and run the release for real.
# Prepare sets the version numbers, creates a tag, and pushes it to git. mvn -DdryRun=false -DskipTests -DreleaseVersion=X.Y.Z-incubating -DdevelopmentVersion=X.Y.Z+1-incubating-SNAPSHOT -Papache-release -Darguments="-Dgpg.passphrase=${GPG_PASSPHRASE}" release:prepare 2>&1 | tee /tmp/prepare.log # Perform checks out the tagged version, builds, and deploys to the staging repository mvn -DskipTests -Papache-release -Darguments="-Dgpg.passphrase=${GPG_PASSPHRASE}" release:perform 2>&1 | tee /tmp/perform.log
Verify the staged artifacts in the Nexus repository:
Build Promotion
, click Staging Repositories
Staging Repositories
tab there should be a with with profile org.apache.calcite
Upload the artifacts via subversion to a staging area, https://dist.apache.org/repos/dist/dev/incubator/calcite/apache-calcite-X.Y.Z-incubating-rcN:
# Create a subversion workspace, if you haven't already mkdir -p ~/dist/dev pushd ~/dist/dev svn co https://dist.apache.org/repos/dist/dev/incubator/calcite popd # Move the files into a directory cd target mkdir ~/dist/dev/calcite/apache-calcite-X.Y.Z-incubating-rcN mv apache-calcite-* ~/dist/dev/calcite/apache-calcite-X.Y.Z-incubating-rcN # Check in cd ~/dist/dev/calcite svn add apache-calcite-X.Y.Z-incubating-rcN svn ci
# Make sure that the tag you are about to generate does not already # exist (due to a failed release attempt) git tag # If the tag exists, delete it locally and remotely git tag -d apache-calcite-X.Y.Z-incubating git push origin :refs/tags/apache-calcite-X.Y.Z-incubating # Remove modified files mvn release:clean # Check whether there are modified files and if so, go back to the # original git commit git status git reset --hard HEAD
# Check that the signing key (e.g. 2AD3FAE3) is pushed gpg --recv-keys key # Check keys curl -O https://dist.apache.org/repos/dist/release/incubator/calcite/KEYS # Sign/check md5 and sha1 hashes # (Assumes your O/S has 'md5' and 'sha1' commands.) function checkHash() { cd "$1" for i in *.{zip,pom,gz}; do if [ ! -f $i ]; then continue fi if [ -f $i.md5 ]; then if [ "$(cat $i.md5)" = "$(md5 -q $i)" ]; then echo $i.md5 present and correct else echo $i.md5 does not match fi else md5 -q $i > $i.md5 echo $i.md5 created fi if [ -f $i.sha1 ]; then if [ "$(cat $i.sha1)" = "$(sha1 -q $i)" ]; then echo $i.sha1 present and correct else echo $i.sha1 does not match fi else sha1 -q $i > $i.sha1 echo $i.sha1 created fi done } checkHash apache-calcite-X.Y.Z-incubating-rcN
Release vote on dev list
To: dev@calcite.incubator.apache.org Subject: [VOTE] Release apache-calcite-X.Y.Z-incubating (release candidate N) Hi all, I have created a build for Apache Calcite X.Y.Z-incubating, release candidate N. Thanks to everyone who has contributed to this release. <Further details about release.> You can read the release notes here: https://github.com/apache/incubator-calcite/blob/XXXX/doc/HISTORY.md The commit to be voted upon: http://git-wip-us.apache.org/repos/asf/incubator-calcite/commit/NNNNNN Its hash is XXXX. The artifacts to be voted on are located here: https://dist.apache.org/repos/dist/dev/incubator/calcite/apache-calcite-X.Y.Z-incubating-rcN/ The hashes of the artifacts are as follows: src.tar.gz.md5 XXXX src.tar.gz.sha1 XXXX src.zip.md5 XXXX src.zip.sha1 XXXX A staged Maven repository is available for review at: https://repository.apache.org/content/repositories/orgapachecalcite-NNNN Release artifacts are signed with the following key: https://people.apache.org/keys/committer/jhyde.asc Please vote on releasing this package as Apache Calcite X.Y.Z-incubating. The vote is open for the next 72 hours and passes if a majority of at least three +1 PPMC votes are cast. [ ] +1 Release this package as Apache Calcite X.Y.Z-incubating [ ] 0 I don't feel strongly about it, but I'm okay with the release [ ] -1 Do not release this package because... Here is my vote: +1 (binding) Julian
After vote finishes, send out the result:
Subject: [RESULT] [VOTE] Release apache-calcite-X.Y.Z-incubating (release candidate N) To: dev@calcite.incubator.apache.org Thanks to everyone who has tested the release candidate and given their comments and votes. The tally is as follows. N binding +1s: <names> N non-binding +1s: <names> No 0s or -1s. Therefore I am delighted to announce that the proposal to release Apache Calcite X.Y.Z-incubating has passed. I'll now start a vote on the general list. Those of you in the IPMC, please recast your vote on the new thread. Julian
Propose a vote on the incubator list.
To: general@incubator.apache.org Subject: [VOTE] Release Apache Calcite X.Y.Z (incubating) Hi all, The Calcite community has voted on and approved a proposal to release Apache Calcite X.Y.Z (incubating). Proposal: http://mail-archives.apache.org/mod_mbox/incubator-calcite-dev/201408.mbox/MESSAGE-URI Vote result: N binding +1 votes N non-binding +1 votes No -1 votes http://mail-archives.apache.org/mod_mbox/incubator-calcite-dev/201408.mbox/MESSAGE-URI The commit to be voted upon: http://git-wip-us.apache.org/repos/asf/incubator-calcite/commit/NNNNNN Its hash is XXXX. The artifacts to be voted on are located here: https://dist.apache.org/repos/dist/dev/incubator/calcite/apache-calcite-X.Y.Z-incubating-rcN/ The hashes of the artifacts are as follows: src.tar.gz.md5 XXXX src.tar.gz.sha1 XXXX src.zip.md5 XXXX src.zip.sha1 XXXX A staged Maven repository is available for review at: https://repository.apache.org/content/repositories/orgapachecalcite-NNNN Release artifacts are signed with the following key: https://people.apache.org/keys/committer/jhyde.asc Pursuant to the Releases section of the Incubation Policy and with the endorsement of NNN of our mentors we would now like to request the permission of the Incubator PMC to publish the release. The vote is open for 72 hours, or until the necessary number of votes (3 +1) is reached. [ ] +1 Release this package as Apache Calcite X.Y.Z incubating [ ] -1 Do not release this package because... Julian Hyde, on behalf of Apache Calcite PPMC
After vote finishes, send out the result:
To: general@incubator.apache.org Subject: [RESULT] [VOTE] Release Apache Calcite X.Y.Z (incubating) This vote passes with N +1s and no 0 or -1 votes: +1 <name> (mentor) There was some feedback during voting. I shall open a separate thread to discuss. Thanks everyone. We’ll now roll the release out to the mirrors. Julian
After a successful release vote, we need to push the release out to mirrors, and other tasks.
In JIRA, search for all issues resolved in this release, and do a bulk update changing their status to “Closed”, with a change comment “Resolved in release X.Y.Z-incubating (YYYY-MM-DD)” (fill in release number and date appropriately).
Promote the staged nexus artifacts.
Check the artifacts into svn.
# Get the release candidate. mkdir -p ~/dist/dev cd ~/dist/dev svn co https://dist.apache.org/repos/dist/dev/incubator/calcite # Copy the artifacts. Note that the copy does not have '-rcN' suffix. mkdir -p ~/dist/release cd ~/dist/release svn co https://dist.apache.org/repos/dist/release/incubator/calcite cd calcite cp -rp ../../dev/calcite/apache-calcite-X.Y.Z-incubating-rcN apache-calcite-X.Y.Z-incubating svn add apache-calcite-X.Y.Z-incubating # Check in. svn ci
Svnpubsub will publish to https://dist.apache.org/repos/dist/release/incubator/calcite and propagate to http://www.apache.org/dyn/closer.cgi/incubator/calcite within 24 hours.
Get the code:
$ svn co https://svn.apache.org/repos/asf/incubator/calcite/site calcite-site
(Note: https:
, not http:
.)
Build the site:
$ cd calcite-site $ ./build.sh
It will prompt you to install jekyll, redcarpet and pygments, if you do not have them installed. It will also check out the git source code repo, so that it can generate javadoc.
Check in:
svn ci -m"Commit message" file...
The site will automatically be deployed as http://calcite.incubator.apache.org.