Connectors and APIs Manual  /  ...  /  Source Installation System Prerequisites

2.4.1 Source Installation System Prerequisites

To install Connector/C++ from source, the following system requirements must be satisfied:

Build Tools

You must have the cross-platform build tool CMake (3.0 or higher).

You must have a C++ compiler that supports C++17 (as of Connector/C++ 8.0.33).

MySQL Client Library

To build Connector/C++ from source, the MySQL C API client library may be required:

  • Building the JDBC connector requires a client library from MySQL 8.0 or later (which includes 8.4), or MySQL 5.7 (5.7.9 or later). This occurs when Connector/C++ is configured with the WITH_JDBC CMake option enabled to include the JDBC connector.

  • For Connector/C++ built without the JDBC connector, the client library is not needed.

Typically, the MySQL client library is installed when MySQL is installed. However, check your operating system documentation for other installation options.

To specify where to find the client library, set the MYSQL_DIR CMake option appropriately at configuration time as necessary (see Section 2.4.4, “Connector/C++ Source-Configuration Options”).

Boost C++ Libraries

To compile Connector/C++ the Boost C++ libraries are needed only if you build the legacy JDBC API or if the version of the C++ standard library on your system does not implement the UTF8 converter (codecvt_utf8).

If the Boost C++ libraries are needed, Boost 1.59.0 or newer must be installed. To obtain Boost and its installation instructions, visit the official Boost site.

After Boost is installed, use the WITH_BOOST CMake option to indicate where the Boost files are located (see Section 2.4.4, “Connector/C++ Source-Configuration Options”):

cmake [other_options] -DWITH_BOOST=/usr/local/boost_1_59_0

Adjust the path as necessary to match your installation.

SSL Support

Use the WITH_SSL CMake option to specify which SSL library to use when compiling Connector/C++. OpenSSL 1.0.x or higher is required. Your other options are:

  • As of Connector/C++ 8.0.18, it is possible to compile against OpenSSL 1.1.

  • As of Connector/C++ 8.0.30, it is possible to compile against OpenSSL 3.0.

For more information about WITH_SSL and SSL libraries, see Section 2.4.4, “Connector/C++ Source-Configuration Options”.