MySQL Connector/J Developer Guide

Abstract

This manual describes how to install, configure, and develop database applications using MySQL Connector/J 9.0, a JDBC and X DevAPI driver for communicating with MySQL servers.

MySQL Connector/J 9.0 supersedes the 8.4 series and is recommended for use on production systems. It is for use with MySQL Server 8.0 and up. Please upgrade to MySQL Connector/J 9.0.

For notes detailing the changes in each release of Connector/J, see MySQL Connector/J Release Notes.

For legal information, including licensing information, see the Preface and Legal Notices.

For help with using MySQL, please visit the MySQL Forums, where you can discuss your issues with other MySQL users.

Document generated on: 2024-11-05 (revision: 80192)

Table of Contents

Preface and Legal Notices

1 Overview of MySQL Connector/J

2 Compatibility with MySQL and Java Versions

3 What's New in Connector/J 9.0?

4 Connector/J Installation

4.1 Installing Connector/J from a Binary Distribution

4.2 Installing Connector/J Using Maven

4.3 Installing from Source

4.4 Upgrading from an Older Version

4.4.1 Upgrading to MySQL Connector/J 9.0 from Connector/J 5.1

4.5 Testing Connector/J

5 Connector/J Examples

6 Connector/J Reference

6.1 Driver/Datasource Class Name

6.2 Connection URL Syntax

6.3 Configuration Properties

6.3.1 Authentication

6.3.2 Connection

6.3.3 Session

6.3.4 Networking

6.3.5 Security

6.3.6 Statements

6.3.7 Prepared Statements

6.3.8 Result Sets

6.3.9 Metadata

6.3.10 BLOB/CLOB processing

6.3.11 Datetime types processing

6.3.12 High Availability and Clustering

6.3.13 Performance Extensions

6.3.14 Debugging/Profiling

6.3.15 Exceptions/Warnings

6.3.16 Tunes for integration with other products

6.3.17 JDBC compliance

6.3.18 X Protocol and X DevAPI

6.4 JDBC API Implementation Notes

6.5 Java, JDBC, and MySQL Types

6.6 Handling of Date-Time Values

6.6.1 Preserving Time Instants

6.6.2 Fractional Seconds

6.6.3 Handling of YEAR Values

6.7 Using Character Sets and Unicode

6.8 Using Query Attributes

6.9 Connecting Securely Using SSL

6.9.1 Setting up Server Authentication

6.9.2 Setting up Client Authentication

6.9.3 Setting up 2-Way Authentication

6.9.4 JSSE in FIPS Mode

6.9.5 Debugging an SSL Connection

6.10 Connecting Using Unix Domain Sockets

6.11 Connecting Using Named Pipes

6.12 Connecting Using Various Authentication Methods

6.12.1 Connecting Using PAM Authentication

6.12.2 Connecting Using Kerberos

6.12.3 Connecting Using Multifactor Authentication

6.12.4 Connecting Using Web Authentication (WebAuthn) Authentication

6.12.5 Connecting Using OpenID Connect Authentication

6.13 Using Source/Replica Replication with ReplicationConnection

6.14 Support for DNS SRV Records

6.15 Client Session State Tracker

6.16 Mapping MySQL Error Numbers to JDBC SQLState Codes

7 JDBC Concepts

7.1 Connecting to MySQL Using the JDBC DriverManager Interface

7.2 Using JDBC Statement Objects to Execute SQL

7.3 Using JDBC CallableStatements to Execute Stored Procedures

7.4 Retrieving AUTO_INCREMENT Column Values through JDBC

8 Connection Pooling with Connector/J

9 Multi-Host Connections

9.1 Configuring Server Failover for Connections Using JDBC

9.2 Configuring Server Failover for Connections Using X DevAPI

9.3 Configuring Load Balancing with Connector/J

9.4 Configuring Source/Replica Replication with Connector/J

9.5 Advanced Load-balancing and Failover Configuration

10 Using the X DevAPI with Connector/J: Special Topics

10.1 Connection Compression Using X DevAPI

10.2 Schema Validation

11 Using the Connector/J Interceptor Classes

12 Using Logging Frameworks with SLF4J

13 Using Connector/J with OpenTelemetry

14 Using Connector/J with Tomcat

15 Using Connector/J with Spring

15.1 Using JdbcTemplate

15.2 Transactional JDBC Access

15.3 Connection Pooling with Spring

16 Troubleshooting Connector/J Applications

17 Known Issues and Limitations

18 Connector/J Support

18.1 Connector/J Community Support

18.2 How to Report Connector/J Bugs or Problems

Index