Documentation Home
MySQL NDB Cluster API Developer Guide
Download this Manual

MySQL NDB Cluster API Developer Guide  /  ...  /  Getting, Installing, and Setting Up MySQL NDB Cluster Connector for Java

4.2.1 Getting, Installing, and Setting Up MySQL NDB Cluster Connector for Java

This section discusses how to obtain MySQL NDB Cluster Connector for Java sources, binaries, compiling, installing, getting started.

Obtaining MySQL NDB Cluster Connector for Java.  You can obtain the most recent NDB Cluster release incorporating MySQL NDB Cluster Connector for Java from

Building and installing MySQL NDB Cluster Connector for Java from source.  You can build and install ClusterJ as part of building and installing NDB Cluster, which always requires you to configure the build using a --with-plugins option that causes NDB support to be included, such as --with-plugins=ndbcluster or --with-plugins=max. Among the list of values you use for the --with-plugins option, clusterj is required for building NDB Cluster with ClusterJ support.

In addition, you should use the following configure option when configuring a build to include ClusterJ:

  • --with-extra-charsets: ClusterJ uses the ucs2 character set for internal storage, and ClusterJ cannot be built without it. The simplest way to ensure that this character set is available is to configure using --with-extra-charsets=all. This is what we recommend that you use, unless you have some reason for not wanting to include all character sets, in which case you should make sure that ucs2 is specified in the character set list passed to this option.

A typical configuration step in building NDB Cluster with support for ClusterJ might look like this:

shell> ./configure --with-plugins=ndbcluster,clusterj \
  --with-extra-charsets=all  \

Not all available options for configuring an NDB Cluster build are shown in this section. For information about other options that can be used, see Installing MySQL Using a Development Source Tree, or consult the output of configure --help.

After configuring the build, run make and make install as you normally would to compile and install the NDB Cluster software. Following installation, the MySQL NDB Cluster Connector for Java jar files can be found in share/mysql/java under the MySQL installation directory (by default, this is /usr/local/mysql/share/mysql/java).

You can also use the included file storage/ndb/clusterj/pom.xml for building ClusterJ with Maven. Setting up your build environment to use Maven requires that you run mvn install in the clusterj directory. Assuming that you are already in the root directory of the NDB Cluster source tree, you can accomplish this by performing in your shell the steps shown here:

cd storage/ndb/clusterj
mvn install

This causes ClusterJ to be built, with the resulting .jar files installed in the local repository.

MySQL NDB Cluster Connector for Java jar files.  After building and installing NDB Cluster with MySQL NDB Cluster Connector for Java, you should find the following JAR files that are needed for using ClusterJ in share/mysql/java/ under the NDB Cluster installation directory:

  • clusterj-api.jar: This is the compile-time jar file, required for compiling ClusterJ application code.

  • clusterj.jar: This is the runtime library required for executing ClusterJ applications.

User Comments
User comments in this section are, as the name implies, provided by MySQL users. The MySQL documentation team is not responsible for, nor do they endorse, any of the information provided here.
Sign Up Login You must be logged in to post a comment.