Once you have extracted the distribution archive, you can
install the driver by placing
mysql-connector-java-in your classpath, either by adding the full path to
it to your
CLASSPATH environment variable, or
by directly specifying it with the command line switch
-cp when starting the JVM.
To use the driver with the JDBC
com.mysql.cj.jdbc.Driver as the class that
You can set the
variable under Unix, Linux, or OS X either locally for a user
within the user's
.login or other login file, or you can also
set it globally by editing the global
For example, add the Connector/J driver to your
CLASSPATH using one of the following forms,
depending on your command shell:
# Bourne-compatible shell (sh, ksh, bash, zsh): shell> export CLASSPATH=/path/mysql-connector-java-ver.jar:$CLASSPATH # C shell (csh, tcsh): shell> setenv CLASSPATH /path/mysql-connector-java-ver.jar:$CLASSPATH
For Windows platforms, you set the environment variable through the System Control Panel.
To use the X DevAPI features in Connector/J, you also need the
which you can download from, for exmaple, the official Maven
and add it to the CLASSPATH.
If you prefer, you can use Maven dependencies manager to install
and configure the Connector/J library in your project.
Connector/J is published in The
Central Repository with "
mysql" and "
mysql-connector-java," and can be linked to your
project by adding the following dependency in your pom.xml file:
<dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>x.y.z</version> </dependency>
Note that if you choose use Maven to manage your project
dependencies, you do not need to explicitly refer to the library
protobuf-java as it is resolved by dependency
transitivity. However, if you do not want to use the X DevAPI
features, you may also want to add a dependency exclusion to
avoid linking the unneeded sub-library. For example:
<dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>x.y.z</version> <exclusions> <exclusion> <groupId>com.google.protobuf</groupId> <artifactId>protobuf-java</artifactId> </exclusion> </exclusions> </dependency>
To use MySQL Connector/J with an application server such as
GlassFish, Tomcat, or JBoss, read your vendor's documentation
for more information on how to configure third-party class
libraries, as most application servers ignore the
CLASSPATH environment variable. For
configuration examples for some J2EE application servers, see
Chapter 8, Connection Pooling with Connector/J,
Section 9.3, “Configuring Load Balancing with Connector/J”,
Section 9.5, “Advanced Load-balancing and Failover Configuration”.
However, the authoritative source for JDBC connection pool
configuration information for your particular application server
is the documentation for that application server.
If you are developing servlets or JSPs, and your application
server is J2EE-compliant, you can put the driver's
.jar file in the
WEB-INF/lib subdirectory of your webapp, as
this is a standard location for third party class libraries in
J2EE web applications.
You can also use the
MysqlConnectionPoolDataSource classes in
com.mysql.cj.jdbc package, if your J2EE
application server supports or requires them. The
javax.sql.XADataSource interface is
implemented using the
which supports XA distributed transactions.
support the following parameters (through standard set
serverName(see the previous section about failover hosts)