Pre-General Availability Draft: 2017-07-18

4.4 Installing from the Development Source Tree

Caution

Read this section only if you are interested in helping us test our new code. To just get MySQL Connector/J up and running on your system, use a standard binary release distribution.

To install MySQL Connector/J from the development source tree, make sure that you have the following software on your system:

• A Git client, to check out the sources from our GitHub repository (available from http://git-scm.com/downloads).

• Apache Ant version 1.8.2 or newer (available from http://ant.apache.org/).

• JDK 1.8.x.

• JUnit 4.1.2 (available from https://github.com/junit-team/junit/wiki/Download-and-Install).

• Javaassist 3.19 or newer (available from http://jboss-javassist.github.io/javassist/).

• Protocol Buffers Java API 2.6.0 or newer (available from, for example, the Maven Central Repository).

• The required .jar files from the Hibernate ORM 4.1 or 4.2 Final release bundle (available at http://sourceforge.net/projects/hibernate/files/hibernate4/).

To check out and compile MySQL Connector/J, follow these steps:

1. Check out the code from the source code repository for MySQL Connector/J located on GitHub at https://github.com/mysql/mysql-connector-j. The latest release of the Connector/J 8.0 series is on the release/8.0 branch; use the following command to check it out:

   shell> git clone --branch release/8.0 https://github.com/mysql/mysql-connector-j.git

   Under the current directory, the commands create a mysql-connector-j subdirectory , which contains the code you want.

2. Make sure that you have JDK 1.8.x installed.

3. Place the required junit.jar, javaassist.jar, and protobuf-java-x.y.z.jar files in a separate directory—for example, /home/username/ant-extralibs.

4. In the same directory for extra libraries described in the last step, create a directory named hibernate4, and put under it all the .jar files you can find under the /lib/required/ folder in the Hibernate ORM 4 Final release bundle.

5. Change your current working directory to the mysql-connector-j directory created in step 1 above.

6. In the directory, create a file named build.properties to indicate to Ant the locations of the root directories for your JDK 1.8.x installation, as well as the location of the extra libraries. The file should contain the following property settings, with the “path_to_*” parts replaced by the appropriate filepaths:

   com.mysql.cj.build.jdk=path_to_jdk_1.8
   com.mysql.cj.extra.libs=path_to_folder_for_extra_libraries

   Alternatively, you can set the values of those properties through the Ant -D options.

7. Issue the following command to compile the driver and create a .jar file for Connector/J:

   shell> ant dist

   This creates a build directory in the current directory, where all the build output goes. A directory is created under the build directory, whose name includes the version number of the release you are building. That directory contains the sources, the compiled .class files, and a .jar file for deployment. For more information and other possible targets, including those that create a fully packaged distribution, issue the following command:

   shell> ant -projecthelp

8. Install the newly created .jar file for the JDBC driver as you would install a binary .jar file you download from MySQL by following the instructions given in Section 4.2, “Installing the Driver and Configuring the CLASSPATH”.

Note that a package containing both the binary and source code for Connector/J 8.0 can also be downloaded from the Connector/J Download page.

Note

Going from Connector/J 5.1 to 8.0, a number of Ant properties for building Connecotr/J have been renamed or removed; see Section 4.3.1.4, “Changes for Build Properties” for details.