Permalink
Fetching contributors…
Cannot retrieve contributors at this time
895 lines (680 sloc) 33.5 KB
layout title permalink
docs
HOWTO
/docs/howto.html

Here's some miscellaneous documentation about using Calcite and its various adapters.

  • TOC {:toc}

Building from a source distribution

Prerequisite is Java (JDK 8, 9 or 10) on your path.

Unpack the source distribution .tar.gz file, cd to the root directory of the unpacked source, then build using the included maven wrapper:

{% highlight bash %} $ tar xvfz calcite-1.17.0-source.tar.gz $ cd calcite-1.17.0 $ ./mvnw install {% endhighlight %}

Running tests describes how to run more or fewer tests.

Building from git

Prerequisites are git and Java (JDK 8, 9 or 10) on your path.

Create a local copy of the github repository, cd to its root directory, then build using the included maven wrapper:

{% highlight bash %} $ git clone git://github.com/apache/calcite.git $ cd calcite $ ./mvnw install {% endhighlight %}

Calcite includes a number of machine-generated codes. By default, these are regenerated on every build, but this has the negative side-effect of causing a re-compilation of the entire project when the non-machine-generated code has not changed. To make sure incremental compilation still works as intended, provide the skipGenerate command line option with your maven command. If you invoke the clean lifecycle phase, you must not specify the skipGenerate option as it will not recompile the necessary code for the build to succeed.

{% highlight bash %} $ mvn clean $ mvn package ... hacks ... $ mvn package -DskipGenerate {% endhighlight %}

Running tests describes how to run more or fewer tests.

If you already have Apache Maven

If you have already installed Maven and it is on your path, then you can use mvn rather than ./mvnw in commands. You need Maven version 3.5.2 or later.

Running tests

The test suite will run by default when you build, unless you specify -DskipTests:

{% highlight bash %} $ ./mvnw -DskipTests clean install $ ./mvnw test {% endhighlight %}

There are other options that control which tests are run, and in what environment, as follows.

  • -Dcalcite.test.db=DB (where db is h2, hsqldb, mysql, or postgresql) 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.
    • All others access a test virtual machine (see integration tests below). mysql and postgresql might be somewhat faster than hsqldb, but you need to populate it (i.e. provision a VM).
  • -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.splunk enables tests that run against Splunk. Splunk must be installed and running.

Running integration tests

For testing Calcite's external adapters, a test virtual machine should be used. The VM includes Cassandra, Druid, H2, HSQLDB, MySQL, MongoDB, and PostgreSQL.

Test VM requires 5GiB of disk space and it takes 30 minutes to build.

Note: you can use calcite-test-dataset to populate your own database, however it is recommended to use test VM so the test environment can be reproduced.

VM preparation

  1. Install dependencies: Vagrant and VirtualBox

  2. Clone https://github.com/vlsi/calcite-test-dataset.git at the same level as calcite repository. For instance:

{% highlight bash %} code +-- calcite +-- calcite-test-dataset {% endhighlight %}

Note: integration tests search for ../calcite-test-dataset or ../../calcite-test-dataset. You can specify full path via calcite.test.dataset system property.

  1. Build and start the VM:

{% highlight bash %} cd calcite-test-dataset && mvn install {% endhighlight %}

VM management

Test VM is provisioned by Vagrant, so regular Vagrant vagrant up and vagrant halt should be used to start and stop the VM. The connection strings for different databases are listed in calcite-test-dataset readme.

Suggested test flow

Note: test VM should be started before you launch integration tests. Calcite itself does not start/stop the VM.

Command line:

  • Executing regular unit tests (does not require external data): no change. mvn test or mvn install.
  • Executing all tests, for all the DBs: mvn verify -Pit. it stands for "integration-test". mvn install -Pit works as well.
  • Executing just tests for external DBs, excluding unit tests: mvn -Dtest=foo -DfailIfNoTests=false -Pit verify
  • Executing just MongoDB tests: cd mongo; mvn verify -Pit

From within IDE:

  • Executing regular unit tests: no change.
  • Executing MongoDB tests: run MongoAdapterIT.java as usual (no additional properties are required)
  • Executing MySQL tests: run JdbcTest and JdbcAdapterTest with setting -Dcalcite.test.db=mysql
  • Executing PostgreSQL tests: run JdbcTest and JdbcAdapterTest with setting -Dcalcite.test.db=postgresql

Integration tests technical details

Tests with external data are executed at maven's integration-test phase. We do not currently use pre-integration-test/post-integration-test, however we could use that in future. The verification of build pass/failure is performed at verify phase. Integration tests should be named ...IT.java, so they are not picked up on unit test execution.

Contributing

See the [developers guide]({{ site.baseurl }}/develop/#contributing).

Getting started

See the [developers guide]({{ site.baseurl }}/develop/#getting-started).

Setting up an IDE for contributing

Setting up IntelliJ IDEA

To setup IntelliJ IDEA, follow the standard steps for the installation of IDEA and set up one of the JDK versions currently supported by Calcite.

Start with building Calcite from the command line.

Go to File > Open... and open up Calcite's pom.xml file. When IntelliJ asks if you want to open it as a project or a file, select project. Also, say yes when it asks if you want a new window. IntelliJ's Maven project importer should handle the rest.

There is a partially implemented IntelliJ code style configuration that you can import located on GitHub. It does not do everything needed to make Calcite's style checker happy, but it does a decent amount of it. To import, go to Preferences > Editor > Code Style, click the gear next to "scheme", then Import Scheme > IntelliJ IDEA Code Style XML.

Once the importer is finished, test the project setup. For example, navigate to the method JdbcTest.testWinAgg with Navigate > Symbol and enter testWinAgg. Run testWinAgg by right-clicking and selecting Run (or the equivalent keyboard shortcut).

If you encounter an error while running the JdbcTest.testWinAgg , run the following Maven command from the command line:

$ ./mvnw -DskipTests clean install

You should see "BUILD SUCCESS".

Once that is complete, proceed with running JdbcTest.testWinAgg.

Setting up NetBeans

From the main menu, select File > Open Project and navigate to a name of the project (Calcite) with a small Maven icon, and choose to open. (See this tutorial for an example of how to open a Maven project) Wait for NetBeans to finish importing all dependencies.

To ensure that the project is configured successfully, navigate to the method testWinAgg in org.apache.calcite.test.JdbcTest. Right-click on the method and select to Run Focused Test Method. NetBeans will run a Maven process, and you should see in the command output window a line with Running org.apache.calcite.test.JdbcTest followed by "BUILD SUCCESS".

Tracing

To enable tracing, add the following flags to the java command line:

-Dcalcite.debug=true

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)

By default, Calcite uses the Log4j bindings for SLF4J. There is a provided configuration file which outputs logging at the INFO level to the console in core/src/test/resources/log4j.properties. You can modify the level for the rootLogger to increase verbosity or change the level for a specific class if you so choose.

{% highlight properties %}

Change rootLogger level to WARN

log4j.rootLogger=WARN, A1

Increase level to DEBUG for RelOptPlanner

log4j.logger.org.apache.calcite.plan.RelOptPlanner=DEBUG

Increase level to TRACE for HepPlanner

log4j.logger.org.apache.calcite.plan.hep.HepPlanner=TRACE {% endhighlight %}

Debugging generated classes in Intellij

Calcite uses Janino to generate Java code. The generated classes can be debugged interactively (see the Janino tutorial).

To debug generated classes, set two system properties when starting the JVM:

  • -Dorg.codehaus.janino.source_debugging.enable=true
  • -Dorg.codehaus.janino.source_debugging.dir=C:\tmp (This property is optional; if not set, Janino will create temporary files in the system's default location for temporary files, such as /tmp on Unix-based systems.)

After code is generated, either go into Intellij and mark the folder that contains generated temporary files as a generated sources root or sources root, or directly set the value of org.codehaus.janino.source_debugging.dir to an existing source root when starting the JVM.

CSV adapter

See the [tutorial]({{ site.baseurl }}/docs/tutorial.html).

MongoDB adapter

First, download and install Calcite, and install MongoDB.

Note: you can use MongoDB from integration test virtual machine above.

Import MongoDB's zipcode data set into MongoDB:

{% highlight bash %} $ curl -o /tmp/zips.json https://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 {% endhighlight %}

Log into MongoDB to check it's there:

{% highlight bash %} $ 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 {% endhighlight %}

Connect using the [mongo-zips-model.json]({{ site.sourceRoot }}/mongodb/src/test/resources/mongo-zips-model.json) Calcite model:

{% highlight bash %} $ ./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 $ {% endhighlight %}

Splunk adapter

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.)

Implementing an adapter

New adapters can be created by implementing CalcitePrepare.Context:

{% highlight java %} import org.apache.calcite.adapter.java.JavaTypeFactory; import org.apache.calcite.jdbc.CalcitePrepare; import org.apache.calcite.jdbc.CalciteSchema;

public class AdapterContext implements CalcitePrepare.Context { @Override public JavaTypeFactory getTypeFactory() { // adapter implementation return typeFactory; }

@Override public CalciteSchema getRootSchema() { // adapter implementation return rootSchema; } } {% endhighlight %}

Testing adapter in Java

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.

{% highlight java %} 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 prepared = new CalcitePrepareImpl().prepareSql(ctx, sql, null, elementType, -1); Object enumerable = prepared.getExecutable(); // etc. } } {% endhighlight %}

Advanced topics for developers

The following sections might be of interest if you are adding features to particular parts of the code base. You don't need to understand these topics if you are just building from source and running tests.

JavaTypeFactory

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:

  • Use a single instance of JavaTypeFactory within the calcite context;
  • Store the types so that the same object is always returned for the same type.

Rebuilding generated Protocol Buffer code

Calcite's Avatica Server component supports RPC serialization using Protocol Buffers. In the context of Avatica, Protocol Buffers can generate a collection of messages defined by a schema. The library itself can parse old serialized messages using a new schema. This is highly desirable in an environment where the client and server are not guaranteed to have the same version of objects.

Typically, the code generated by the Protocol Buffers library doesn't need to be re-generated only every build, only when the schema changes.

First, install Protobuf 3.0:

{% highlight bash %} $ wget https://github.com/google/protobuf/releases/download/v3.0.0-beta-1/protobuf-java-3.0.0-beta-1.tar.gz $ tar xf protobuf-java-3.0.0-beta-1.tar.gz && cd protobuf-3.0.0-beta-1 $ ./configure $ make $ sudo make install {% endhighlight %}

Then, re-generate the compiled code:

{% highlight bash %} $ cd avatica/core $ ./src/main/scripts/generate-protobuf.sh {% endhighlight %}

Advanced topics for committers

The following sections are of interest to Calcite committers and in particular release managers.

Merging pull requests (for Calcite committers)

Ask the contributor to squash the PR into a single commit with a message starting with [CALCITE-XXX] where XXX is the associated JIRA issue number. You can take this step yourself if needed. The contributor's name should also be added in parentheses at the end of the first line of the commit message. Finally, after a couple new lines make sure the message contains "Close apache/calcite#YYY" where YYY is the GitHub issue number. This is important as it is the only way we have to close issues on GitHub without asking the originator to do so manually. When the PR has been merged and pushed, be sure to mark the JIRA issue as resolved (do not use closed as that is reserved for release time).

Set up PGP signing keys (for Calcite committers)

Follow instructions here to create a key pair. (On macOS, I did brew install gpg and gpg --gen-key.)

Add your public key to the KEYS file by following instructions in the KEYS file. (The KEYS file is not present in the git repo or in a release tar ball because that would be redundant.)

Set up Maven repository credentials (for Calcite committers)

Follow the instructions here to add your credentials to your maven configuration.

Making a snapshot (for Calcite committers)

Before you start:

  • Set up signing keys as described above.
  • Make sure you are using JDK 8 (not 9 or 10).
  • Make sure build and tests succeed with -Dcalcite.test.db=hsqldb (the default)

{% highlight 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 ./mvnw clean

./mvnw -Papache-release -Dgpg.passphrase=${GPG_PASSPHRASE} install {% endhighlight %}

When the dry-run has succeeded, change install to deploy.

Making a release (for Calcite committers)

Before you start:

  • Set up signing keys as described above.
  • Make sure you are using JDK 8 (not 9 or 10).
  • Check that README and site/_docs/howto.md have the correct version number.
  • Check that NOTICE has the current copyright year.
  • Set version.major and version.minor in pom.xml.
  • Make sure build and tests succeed, including with -P it,it-oracle.
  • Make sure that ./mvnw javadoc:javadoc javadoc:test-javadoc succeeds (i.e. gives no errors; warnings are OK)
  • Generate a report of vulnerabilities that occur among dependencies, using -Ppedantic; if you like, run again with -DfailBuildOnCVSS=8 to see whether serious vulnerabilities exist. Report to private@calcite.apache.org if new critical vulnerabilities are found among dependencies.
  • Make sure that ./mvnw apache-rat:check succeeds. (It will be run as part of the release, but it's better to trouble-shoot early.)
  • Decide the supported configurations of JDK, operating system and Guava. These will probably be the same as those described in the release notes of the previous release. Document them in the release notes. To test Guava version x.y, specify -Dguava.version=x.y
  • Optional extra tests:
    • -Dcalcite.test.db=mysql
    • -Dcalcite.test.db=hsqldb
    • -Dcalcite.test.slow
    • -Dcalcite.test.mongodb
    • -Dcalcite.test.splunk
  • Trigger a Coverity scan by merging the latest code into the julianhyde/coverity_scan branch, and when it completes, make sure that there are no important issues.
  • Add release notes to site/_docs/history.md. Include the commit history, and say which versions of Java, Guava and operating systems the release is tested against.
  • Make sure that every "resolved" JIRA case (including duplicates) has a fix version assigned (most likely the version we are just about to release)

Smoke-test sqlline with Spatial and Oracle function tables:

{% highlight sql %} $ ./sqlline

!connect jdbc:calcite:fun=spatial,oracle "sa" "" SELECT NVL(ST_Is3D(ST_PointFromText('POINT(-71.064544 42.28787)')), TRUE); +--------+ | EXPR$0 | +--------+ | false | +--------+ 1 row selected (0.039 seconds) !quit {% endhighlight %}

Create a release branch named after the release, e.g. branch-1.1, and push it to Apache.

{% highlight bash %} $ git checkout -b branch-X.Y $ git push -u origin branch-X.Y {% endhighlight %}

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.

{% highlight 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 ./mvnw clean

Do a dry run of the release:prepare step, which sets version numbers

(accept the default tag name of calcite-X.Y.Z)

Note X.Y.Z is the current version we're trying to release, and X.Y+1.Z is the next development version.

For example, if I am currently building a release for 1.16.0, X.Y.Z would be 1.16.0 and X.Y+1.Z would be 1.17.0.

./mvnw -DdryRun=true -DskipTests -DreleaseVersion=X.Y.Z -DdevelopmentVersion=X.Y+1.Z-SNAPSHOT -Papache-release -Darguments="-Dgpg.passphrase=${GPG_PASSPHRASE}" release:prepare 2>&1 | tee /tmp/prepare-dry.log

If you have multiple GPG keys, you can select the key used to sign the release by adding -Dgpg.keyname=${GPG_KEY_ID} to -Darguments:

./mvnw -DdryRun=true -DskipTests -DreleaseVersion=X.Y.Z -DdevelopmentVersion=X.Y+1.Z-SNAPSHOT -Papache-release -Darguments="-Dgpg.passphrase=${GPG_PASSPHRASE} -Dgpg.keyname=${GPG_KEY_ID}" release:prepare 2>&1 | tee /tmp/prepare-dry.log {% endhighlight %}

Check the artifacts. Note that when performing the dry run SNAPSHOT will appear in any file or directory names given below. The version will be automatically changed when performing the release for real.

  • In the target directory should be these 6 files, among others:
    • apache-calcite-X.Y.Z-src.tar.gz
    • apache-calcite-X.Y.Z-src.tar.gz.asc
    • apache-calcite-X.Y.Z-src.tar.gz.sha256
  • Note that the file names start apache-calcite-.
  • In the source distro .tar.gz (currently there is no binary distro), check that all files belong to a directory called apache-calcite-X.Y.Z-src.
  • That directory must contain files NOTICE, LICENSE, README, README.md
    • Check that the version in README is correct
    • Check that the copyright year in NOTICE is correct
  • Make sure that there is no KEYS file in the source distros
  • In each .jar (for example core/target/calcite-core-X.Y.Z.jar and mongodb/target/calcite-mongodb-X.Y.Z-sources.jar), check that the META-INF directory contains DEPENDENCIES, LICENSE, NOTICE and git.properties
  • In core/target/calcite-core-X.Y.Z.jar, check that org-apache-calcite-jdbc.properties is present and does not contain un-substituted ${...} variables
  • Check PGP, per this

Now, remove the -DdryRun flag and run the release for real. For this step you'll have to add the Apache servers to ~/.m2/settings.xml.

{% highlight bash %}

Prepare sets the version numbers, creates a tag, and pushes it to git

Note X.Y.Z is the current version we're trying to release, and X.Y+1.Z is the next development version.

For example, if I am currently building a release for 1.16.0, X.Y.Z would be 1.16.0 and X.Y+1.Z would be 1.17.0.

./mvnw -DdryRun=false -DskipTests -DreleaseVersion=X.Y.Z -DdevelopmentVersion=X.Y+1.Z-SNAPSHOT -Papache-release -Darguments="-Dgpg.passphrase=${GPG_PASSPHRASE}" release:prepare 2>&1 | tee /tmp/prepare.log

If you have multiple GPG keys, you can select the key used to sign the release by adding -Dgpg.keyname=${GPG_KEY_ID} to -Darguments:

./mvnw -DdryRun=false -DskipTests -DreleaseVersion=X.Y.Z -DdevelopmentVersion=X.Y+1.Z-SNAPSHOT -Papache-release -Darguments="-Dgpg.passphrase=${GPG_PASSPHRASE} -Dgpg.keyname=${GPG_KEY_ID}" release:prepare 2>&1 | tee /tmp/prepare-dry.log

Perform checks out the tagged version, builds, and deploys to the staging repository

./mvnw -DskipTests -Papache-release -Darguments="-Dgpg.passphrase=${GPG_PASSPHRASE}" release:perform 2>&1 | tee /tmp/perform.log {% endhighlight %}

Verify the staged artifacts in the Nexus repository:

Upload the artifacts via subversion to a staging area, https://dist.apache.org/repos/dist/dev/calcite/apache-calcite-X.Y.Z-rcN:

{% highlight bash %}

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/calcite popd

Move the files into a directory

mkdir ~/dist/dev/calcite/apache-calcite-X.Y.Z-rcN mv apache-calcite-* ~/dist/dev/calcite/apache-calcite-X.Y.Z-rcN

Check in

cd ~/dist/dev/calcite svn add apache-calcite-X.Y.Z-rcN svn ci {% endhighlight %}

Cleaning up after a failed release attempt (for Calcite committers)

{% highlight bash %}

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 calcite-X.Y.Z git push origin :refs/tags/calcite-X.Y.Z

Remove modified files

./mvnw release:clean

Check whether there are modified files and if so, go back to the

original git commit

git status git reset --hard HEAD {% endhighlight %}

Validate a release

{% highlight bash %}

Check that the signing key (e.g. DDB6E9812AD3FAE3) is pushed

gpg --recv-keys key

Check keys

curl -O https://dist.apache.org/repos/dist/release/calcite/KEYS

Sign/check sha256 hashes

(Assumes your O/S has a 'shasum' command.)

function checkHash() { cd "$1" for i in *.{pom,gz}; do if [ ! -f $i ]; then continue fi if [ -f $i.sha256 ]; then if [ "$(cat $i.sha256)" = "$(shasum -a 256 $i)" ]; then echo $i.sha256 present and correct else echo $i.sha256 does not match fi else shasum -a 256 $i > $i.sha256 echo $i.sha256 created fi done } checkHash apache-calcite-X.Y.Z-rcN {% endhighlight %}

Get approval for a release via Apache voting process (for Calcite committers)

Release vote on dev list

{% highlight text %} To: dev@calcite.apache.org Subject: [VOTE] Release apache-calcite-X.Y.Z (release candidate N)

Hi all,

I have created a build for Apache Calcite X.Y.Z, release candidate N.

Thanks to everyone who has contributed to this release. You can read the release notes here: https://github.com/apache/calcite/blob/XXXX/site/_docs/history.md

The commit to be voted upon: https://git-wip-us.apache.org/repos/asf/calcite/commit/NNNNNN

Its hash is XXXX.

The artifacts to be voted on are located here: https://dist.apache.org/repos/dist/dev/calcite/apache-calcite-X.Y.Z-rcN/

The hashes of the artifacts are as follows: src.tar.gz.sha256 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.

The vote is open for the next 72 hours and passes if a majority of at least three +1 PMC votes are cast.

[ ] +1 Release this package as Apache Calcite X.Y.Z [ ] 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 {% endhighlight %}

After vote finishes, send out the result:

{% highlight text %} Subject: [RESULT] [VOTE] Release apache-calcite-X.Y.Z (release candidate N) To: dev@calcite.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:

N non-binding +1s:

No 0s or -1s.

Therefore I am delighted to announce that the proposal to release Apache Calcite X.Y.Z has passed.

Thanks everyone. We’ll now roll the release out to the mirrors.

There was some feedback during voting. I shall open a separate thread to discuss.

Julian {% endhighlight %}

Use the Apache URL shortener to generate shortened URLs for the vote proposal and result emails. Examples: s.apache.org/calcite-1.2-vote and s.apache.org/calcite-1.2-result.

Publishing a release (for Calcite committers)

After a successful release vote, we need to push the release out to mirrors, and other tasks.

Choose a release date. This is based on the time when you expect to announce the release. This is usually a day after the vote closes. Remember that UTC date changes at 4pm Pacific time.

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 (YYYY-MM-DD)" (fill in release number and date appropriately). Uncheck "Send mail for this update".

Promote the staged nexus artifacts.

  • Go to https://repository.apache.org/ and login
  • Under "Build Promotion" click "Staging Repositories"
  • In the line with "orgapachecalcite-xxxx", check the box
  • Press "Release" button

Check the artifacts into svn.

{% highlight bash %}

Get the release candidate.

mkdir -p ~/dist/dev cd ~/dist/dev svn co https://dist.apache.org/repos/dist/dev/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/calcite cd calcite cp -rp ../../dev/calcite/apache-calcite-X.Y.Z-rcN apache-calcite-X.Y.Z svn add apache-calcite-X.Y.Z

Check in.

svn ci {% endhighlight %}

Svnpubsub will publish to the release repo and propagate to the mirrors within 24 hours.

If there are now more than 2 releases, clear out the oldest ones:

{% highlight bash %} cd ~/dist/release/calcite svn rm apache-calcite-X.Y.Z svn ci {% endhighlight %}

The old releases will remain available in the release archive.

You should receive an email from the Apache Reporter Service. Make sure to add the version number and date of the latest release at the site linked to in the email.

Add a release note by copying [site/_posts/2016-10-12-release-1.10.0.md]({{ site.sourceRoot }}/site/_posts/2016-10-12-release-1.10.0.md), generate the javadoc using ./mvnw site, publish the site, and check that it appears in the contents in news.

Merge the release branch back into master (e.g. git merge --ff-only branch-X.Y).

After 24 hours, announce the release by sending an email to announce@apache.org. You can use the 1.10.0 announcement as a template. Be sure to include a brief description of the project.

Publishing the web site (for Calcite committers)

{: #publish-the-web-site}

See instructions in [site/README.md]({{ site.sourceRoot }}/site/README.md).