Table 2.13 MySQL Source-Configuration Option Reference (CMake)

• -DBUILD_CONFIG=mysql_release

  This option configures a source distribution with the same build options used by Oracle to produce binary distributions for official MySQL releases.

• -DBUNDLE_RUNTIME_LIBRARIES=bool

  Whether to bundle runtime libraries with server MSI and Zip packages for Windows.

• -DCMAKE_BUILD_TYPE=type

  The type of build to produce:

  • RelWithDebInfo: Enable optimizations and generate debugging information. This is the default MySQL build type.

  • Release: Enable optimizations but omit debugging information to reduce the build size. This build type was added in MySQL 8.0.13.

  • Debug: Disable optimizations and generate debugging information. This build type is also used if the WITH_DEBUG option is enabled. That is, -DWITH_DEBUG=1 has the same effect as -DCMAKE_BUILD_TYPE=Debug.

• -DCPACK_MONOLITHIC_INSTALL=bool

  This option affects whether the make package operation produces multiple installation package files or a single file. If disabled, the operation produces multiple installation package files, which may be useful if you want to install only a subset of a full MySQL installation. If enabled, it produces a single file for installing everything.

• -DFORCE_INSOURCE_BUILD=bool

  Defines whether to force an in-source build. Out-of-source builds are recommended, as they permit multiple builds from the same source, and cleanup can be performed quickly by removing the build directory. To force an in-source build, invoke CMake with -DFORCE_INSOURCE_BUILD=ON.

• -DCMAKE_INSTALL_PREFIX=dir_name

  The installation base directory.

  This value can be set at server startup with the --basedir option.

• -DINSTALL_BINDIR=dir_name

  Where to install user programs.

• -DINSTALL_DOCDIR=dir_name

  Where to install documentation.

• -DINSTALL_DOCREADMEDIR=dir_name

  Where to install README files.

• -DINSTALL_INCLUDEDIR=dir_name

  Where to install header files.

• -DINSTALL_INFODIR=dir_name

  Where to install Info files.

• -DINSTALL_LAYOUT=name

  Select a predefined installation layout:

  • STANDALONE: Same layout as used for .tar.gz and .zip packages. This is the default.

  • RPM: Layout similar to RPM packages.

  • SVR4: Solaris package layout.

  • DEB: DEB package layout (experimental).

  You can select a predefined layout but modify individual component installation locations by specifying other options. For example:

  cmake . -DINSTALL_LAYOUT=SVR4 -DMYSQL_DATADIR=/var/mysql/data

  The INSTALL_LAYOUT value determines the default value of the secure_file_priv, keyring_encrypted_file_data, and keyring_file_data system variables. See the descriptions of those variables in Section 5.1.8, “Server System Variables”, and Section 6.4.4.12, “Keyring System Variables”.

• -DINSTALL_LIBDIR=dir_name

  Where to install library files.

• -DINSTALL_MANDIR=dir_name

  Where to install manual pages.

• -DINSTALL_MYSQLKEYRINGDIR=dir_path

  The default directory to use as the location of the keyring_file plugin data file. The default value is platform specific and depends on the value of the INSTALL_LAYOUT CMake option; see the description of the keyring_file_data system variable in Section 5.1.8, “Server System Variables”.

• -DINSTALL_MYSQLSHAREDIR=dir_name

  Where to install shared data files.

• -DINSTALL_MYSQLTESTDIR=dir_name

  Where to install the mysql-test directory. To suppress installation of this directory, explicitly set the option to the empty value (-DINSTALL_MYSQLTESTDIR=).

• -DINSTALL_PKGCONFIGDIR=dir_name

  The directory in which to install the mysqlclient.pc file for use by pkg-config. The default value is INSTALL_LIBDIR/pkgconfig, unless INSTALL_LIBDIR ends with/mysql, in which case that is removed first.

• -DINSTALL_PLUGINDIR=dir_name

  The location of the plugin directory.

  This value can be set at server startup with the --plugin_dir option.

• -DINSTALL_PRIV_LIBDIR=dir_name

  The location of the dynamic library directory.

  Default locations: RPM = /usr/lib64/mysql/private/, DEB = /usr/lib/mysql/private/, and TAR = lib/private/.

  This option was added in MySQL 8.0.18.

  For Protobuf: Because this is a private location, loader (such as ld-linux.so on Linux) may not find the libprotobuf.so files without help. To guide loader, RPATH with value $ORIGIN/../$INSTALL_PRIV_LIBDIR is added to mysqld and mysqlxtest. This works for most cases but when using the Resource Group feature, mysqld is setsuid and then loader ignores RPATH which contains $ORIGIN. To overcome this, an explicit full path to the directory is set in DEB and RPM variants of mysqld, as the target destination is known. For tarball installs, patching of mysqld with a tool like patchelf is required.

• -DINSTALL_SBINDIR=dir_name

  Where to install the mysqld server.

• -DINSTALL_SECURE_FILE_PRIVDIR=dir_name

  The default value for the secure_file_priv system variable. The default value is platform specific and depends on the value of the INSTALL_LAYOUT CMake option; see the description of the secure_file_priv system variable in Section 5.1.8, “Server System Variables”.

• -DINSTALL_SHAREDIR=dir_name

  Where to install aclocal/mysql.m4.

• -DINSTALL_STATIC_LIBRARIES=bool

  Whether to install static libraries. The default is ON. If set to OFF, these libraries are not installed: libmysqlclient.a, libmysqlservices.a.

• -DINSTALL_SUPPORTFILESDIR=dir_name

  Where to install extra support files.

• -DLINK_RANDOMIZE=bool

  Whether to randomize the order of symbols in the mysqld binary. The default is OFF. This option should be enabled only for debugging purposes.

• -DLINK_RANDOMIZE_SEED=val

  Seed value for the LINK_RANDOMIZE option. The value is a string. The default is mysql, an arbitrary choice.

• -DMYSQL_DATADIR=dir_name

  The location of the MySQL data directory.

  This value can be set at server startup with the --datadir option.

• -DODBC_INCLUDES=dir_name

  The location of the ODBC includes directory, and may be used while configuring Connector/ODBC.

• -DODBC_LIB_DIR=dir_name

  The location of the ODBC library directory, and may be used while configuring Connector/ODBC.

• -DSYSCONFDIR=dir_name

  The default my.cnf option file directory.

  This location cannot be set at server startup, but you can start the server with a given option file using the --defaults-file=file_name option, where file_name is the full path name to the file.

• -DSYSTEMD_PID_DIR=dir_name

  The name of the directory in which to create the PID file when MySQL is managed by systemd. The default is /var/run/mysqld; this might be changed implicitly according to the INSTALL_LAYOUT value.

  This option is ignored unless WITH_SYSTEMD is enabled.

• -DSYSTEMD_SERVICE_NAME=name

  The name of the MySQL service to use when MySQL is managed by systemd. The default is mysqld; this might be changed implicitly according to the INSTALL_LAYOUTvalue.

  This option is ignored unless WITH_SYSTEMD is enabled.

• -DTMPDIR=dir_name

  The default location to use for the tmpdir system variable. If unspecified, the value defaults to P_tmpdir in <stdio.h>.

-DWITH_ARCHIVE_STORAGE_ENGINE=1
-DWITH_BLACKHOLE_STORAGE_ENGINE=1

It is not possible to compile without Performance Schema support. If it is desired to compile without particular types of instrumentation, that can be done with the following CMake options:

DISABLE_PSI_COND
DISABLE_PSI_DATA_LOCK
DISABLE_PSI_ERROR
DISABLE_PSI_FILE
DISABLE_PSI_IDLE
DISABLE_PSI_MEMORY
DISABLE_PSI_METADATA
DISABLE_PSI_MUTEX
DISABLE_PSI_PS
DISABLE_PSI_RWLOCK
DISABLE_PSI_SOCKET
DISABLE_PSI_SP
DISABLE_PSI_STAGE
DISABLE_PSI_STATEMENT
DISABLE_PSI_STATEMENT_DIGEST
DISABLE_PSI_TABLE
DISABLE_PSI_THREAD
DISABLE_PSI_TRANSACTION

For example, to compile without mutex instrumentation, configure MySQL using the -DDISABLE_PSI_MUTEX=1 option.

-DWITH_ARCHIVE_STORAGE_ENGINE=0
-DWITH_EXAMPLE_STORAGE_ENGINE=0
-DWITH_FEDERATED_STORAGE_ENGINE=0

-DWITHOUT_ARCHIVE_STORAGE_ENGINE=1
-DWITHOUT_EXAMPLE_STORAGE_ENGINE=1
-DWITHOUT_FEDERATED_STORAGE_ENGINE=1

• -DADD_GDB_INDEX=bool

  This option determines whether to enable generation of a .gdb_index section in binaries, which makes loading them in a debugger faster. The option is disabled by default. lld linker is used, and is disabled by It has no effect if a linker other than lld or GNU gold is used.

  This option was added in MySQL 8.0.18.

• -DCOMPILATION_COMMENT=string

  A descriptive comment about the compilation environment. As of MySQL 8.0.14, mysqld uses COMPILATION_COMMENT_SERVER. Other programs continue to useCOMPILATION_COMMENT.

• -DCOMPILATION_COMMENT_SERVER=string

  A descriptive comment about the compilation environment for use by mysqld (for example, to set the version_comment system variable). This option was added in MySQL 8.0.14. Prior to 8.0.14, the server uses COMPILATION_COMMENT.

• -DDEFAULT_CHARSET=charset_name

  The server character set. By default, MySQL uses the utf8mb4 character set.

  charset_name may be one of binary, armscii8, ascii, big5, cp1250, cp1251, cp1256, cp1257, cp850, cp852, cp866, cp932, dec8, eucjpms, euckr, gb2312, gbk, geostd8, greek, hebrew, hp8, keybcs2, koi8r, koi8u, latin1, latin2, latin5, latin7, macce, macroman, sjis, swe7, tis620, ucs2, ujis, utf8, utf8mb4, utf16,utf16le, utf32. The permissible character sets are listed in the cmake/character_sets.cmake file as the value of CHARSETS_AVAILABLE.

  This value can be set at server startup with the --character_set_server option.

• -DDEFAULT_COLLATION=collation_name

  The server collation. By default, MySQL uses utf8mb4_0900_ai_ci. Use the SHOW COLLATION statement to determine which collations are available for each character set.

  This value can be set at server startup with the --collation_server option.

• -DDISABLE_PSI_COND=bool

  Whether to exclude the Performance Schema condition instrumentation. The default is OFF (include).

• -DDISABLE_PSI_FILE=bool

  Whether to exclude the Performance Schema file instrumentation. The default is OFF (include).

• -DDISABLE_PSI_IDLE=bool

  Whether to exclude the Performance Schema idle instrumentation. The default is OFF (include).

• -DDISABLE_PSI_MEMORY=bool

  Whether to exclude the Performance Schema memory instrumentation. The default is OFF (include).

• -DDISABLE_PSI_METADATA=bool

  Whether to exclude the Performance Schema metadata instrumentation. The default is OFF (include).

• -DDISABLE_PSI_MUTEX=bool

  Whether to exclude the Performance Schema mutex instrumentation. The default is OFF (include).

• -DDISABLE_PSI_RWLOCK=bool

  Whether to exclude the Performance Schema rwlock instrumentation. The default is OFF (include).

• -DDISABLE_PSI_SOCKET=bool

  Whether to exclude the Performance Schema socket instrumentation. The default is OFF (include).

• -DDISABLE_PSI_SP=bool

  Whether to exclude the Performance Schema stored program instrumentation. The default is OFF (include).

• -DDISABLE_PSI_STAGE=bool

  Whether to exclude the Performance Schema stage instrumentation. The default is OFF (include).

• -DDISABLE_PSI_STATEMENT=bool

  Whether to exclude the Performance Schema statement instrumentation. The default is OFF (include).

• -DDISABLE_PSI_STATEMENT_DIGEST=bool

  Whether to exclude the Performance Schema statement_digest instrumentation. The default is OFF (include).

• -DDISABLE_PSI_TABLE=bool

  Whether to exclude the Performance Schema table instrumentation. The default is OFF (include).

• -DDISABLE_SHARED=bool

  Whether to disable building build shared libraries and compile position-dependent code. The default is OFF (compile position-independent code).

  This option is unused and was removed in MySQL 8.0.18.

• -DDISABLE_PSI_PS=bool

  Exclude the performance schema prepared statements instances instrumentation. The default is OFF (include).

• -DDISABLE_PSI_THREAD=bool

  Exclude the performance schema thread instrumentation. The default is OFF (include).

  Only disable threads when building without any instrumentation, because other instrumentations have a dependency on threads.

• -DDISABLE_PSI_TRANSACTION=bool

  Exclude the performance schema transaction instrumentation. The default is OFF (include).

• -DDISABLE_PSI_DATA_LOCK=bool

  Exclude the performance schema data lock instrumentation. The default is OFF (include).

• -DDISABLE_PSI_ERROR=bool

  Exclude the performance schema server error instrumentation. The default is OFF (include).

• -DDOWNLOAD_BOOST=bool

  Whether to download the Boost library. The default is OFF.

  See the WITH_BOOST option for additional discussion about using Boost.

• -DDOWNLOAD_BOOST_TIMEOUT=seconds

  The timeout in seconds for downloading the Boost library. The default is 600 seconds.

  See the WITH_BOOST option for additional discussion about using Boost.

• -DENABLE_DEBUG_SYNC=bool

  As of MySQL 8.0.1, ENABLE_DEBUG_SYNC is removed and enabling WITH_DEBUG enables Debug Sync.

• -DENABLE_DOWNLOADS=bool

  Whether to download optional files. For example, with this option enabled, CMake downloads the Google Test distribution that is used by the test suite to run unit tests, or Ant and JUnit required for building GCS Java wrapper.

• -DENABLE_DTRACE=bool

  Whether to include support for DTrace probes.

  This option was removed in MySQL 8.0.1.

• -DENABLE_EXPERIMENTAL_SYSVARS=bool

  Whether to enable experimental InnoDB system variables. Experimental system variables are intended for those engaged in MySQL development, should only be used in a development or test environment, and may be removed without notice in a future MySQL release. For information about experimental system variables, refer to/storage/innobase/handler/ha_innodb.cc in the MySQL source tree. Experimental system variables can be identified by searching for“PLUGIN_VAR_EXPERIMENTAL”.

• -DENABLE_GCOV=bool

  Whether to include gcov support (Linux only).

• -DENABLE_GPROF=bool

  Whether to enable gprof (optimized Linux builds only).

• -DENABLED_LOCAL_INFILE=bool

  This option controls the compiled-in default LOCAL capability for the MySQL client library. Clients that make no explicit arrangements therefore have LOCAL capability disabled or enabled according to the ENABLED_LOCAL_INFILE setting specified at MySQL build time.

  By default, the client library in MySQL binary distributions is compiled with ENABLED_LOCAL_INFILE disabled. If you compile MySQL from source, configure it withENABLED_LOCAL_INFILE disabled or enabled based on whether clients that make no explicit arrangements should have LOCAL capability disabled or enabled, respectively.

  ENABLED_LOCAL_INFILE controls the default for client-side LOCAL capability. For the server, the local_infile system variable controls server-side LOCAL capability. To explicitly cause the server to refuse or permit LOAD DATA LOCAL statements (regardless of how client programs and libraries are configured at build time or runtime), start mysqld with local_infile disabled or enabled, respectively. local_infile can also be set at runtime. See Section 6.1.6, “Security Issues with LOAD DATA LOCAL”.

• -DENABLED_PROFILING=bool

  Whether to enable query profiling code (for the SHOW PROFILE and SHOW PROFILES statements).

• -DFORCE_UNSUPPORTED_COMPILER=bool

  By default, CMake checks for minimum versions of supported compilers: Visual Studio 2015 (Windows); GCC 4.8 or Clang 3.4 (Linux); Developer Studio 12.5 (Solaris server); Developer Studio 12.4 or GCC 4.8 (Solaris client library); Clang 3.6 (macOS), Clang 3.4 (FreeBSD). To disable this check, use -DFORCE_UNSUPPORTED_COMPILER=ON.

• -DFPROFILE_GENERATE=bool

  Whether to generate profile guided optimization (PGO) data. This option is available for experimenting with PGO with GCC. See the cmake/fprofile.cmake file in a MySQL source distribution for information about using FPROFILE_GENERATE and FPROFILE_USE. These options have been tested with GCC 8 and 9.

  This option was added in MySQL 8.0.19.

• -DFPROFILE_USE=bool

  Whether to use profile guided optimization (PGO) data. This option is available for experimenting with PGO with GCC. See the cmake/fprofile.cmake file in a MySQL source distribution for information about using FPROFILE_GENERATE and FPROFILE_USE. These options have been tested with GCC 8 and 9.

  Enabling FPROFILE_USE also enables WITH_LTO.

  This option was added in MySQL 8.0.19.

• -DIGNORE_AIO_CHECK=bool

  If the -DBUILD_CONFIG=mysql_release option is given on Linux, the libaio library must be linked in by default. If you do not have libaio or do not want to install it, you can suppress the check for it by specifying -DIGNORE_AIO_CHECK=1.

• -DMAX_INDEXES=num

  The maximum number of indexes per table. The default is 64. The maximum is 255. Values smaller than 64 are ignored and the default of 64 is used.

• -DMYSQL_MAINTAINER_MODE=bool

  Whether to enable a MySQL maintainer-specific development environment. If enabled, this option causes compiler warnings to become errors.

• -DMUTEX_TYPE=type

  The mutex type used by InnoDB. Options include:

  • event: Use event mutexes. This is the default value and the original InnoDB mutex implementation.

  • sys: Use POSIX mutexes on UNIX systems. Use CRITICAL_SECTION onjects on Windows, if available.

  • futex: Use Linux futexes instead of condition variables to schedule waiting threads.

• -DMYSQLX_TCP_PORT=port_num

  The port number on which X Plugin listens for TCP/IP connections. The default is 33060.

  This value can be set at server startup with the mysqlx_port system variable.

• -DMYSQLX_UNIX_ADDR=file_name

  The Unix socket file path on which the server listens for X Plugin socket connections. This must be an absolute path name. The default is /tmp/mysqlx.sock.

  This value can be set at server startup with the mysqlx_port system variable.

• -DMYSQL_PROJECT_NAME=name

  For Windows or macOS, the project name to incorporate into the project file name.

• -DMYSQL_TCP_PORT=port_num

  The port number on which the server listens for TCP/IP connections. The default is 3306.

  This value can be set at server startup with the --port option.

• -DMYSQL_UNIX_ADDR=file_name

  The Unix socket file path on which the server listens for socket connections. This must be an absolute path name. The default is /tmp/mysql.sock.

  This value can be set at server startup with the --socket option.

• -DOPTIMIZER_TRACE=bool

  Whether to support optimizer tracing. See MySQL Internals: Tracing the Optimizer.

• -DREPRODUCIBLE_BUILD=bool

  For builds on Linux systems, this option controls whether to take extra care to create a build result independent of build location and time.

  This option was added in MySQL 8.0.11. As of MySQL 8.0.12, it defaults to ON for RelWithDebInfo builds.

• -DUSE_LD_GOLD=bool

  CMake causes the build process to link with the GNU gold linker if it is available and not explicitly disabled. To disable use of this linker, specify the -DUSE_LD_GOLD=OFF option.

• -DUSE_LD_LLD=bool

  CMake causes the build process to link with the llvm lld linker for Clang if it is available and not explicitly disabled. To disable use of this linker, specify the -DUSE_LD_LLD=OFF option.

  This option was added in MySQL 8.0.16.

• -DWIN_DEBUG_NO_INLINE=bool

  Whether to disable function inlining on Windows. The default is off (inlining enabled).

• -DWITH_ANT=path_name

  Set the path to Ant, required when building GCS Java wrapper. Works in a similar way to the existing WITH_BOOST CMake option. Set WITH_ANT to the path of a directory where the Ant tarball, or an already unpacked archive, is saved. When WITH_ANT is not set, or is set with the special value system, the build assumes a binary ant exists in $PATH.

• -DWITH_ASAN=bool

  Whether to enable the AddressSanitizer, for compilers that support it. The default is off.

• -DWITH_ASAN_SCOPE=bool

  Whether to enable the AddressSanitizer -fsanitize-address-use-after-scope Clang flag for use-after-scope detection. The default is off. To use this option, -DWITH_ASAN must also be enabled.

• -DWITH_AUTHENTICATION_LDAP=bool

  Whether to report an error if the LDAP authentication plugins cannot be built:

  • If this option is disabled (the default), the LDAP plugins are built if the required header files and libraries are found. If they are not, CMake displays a note about it.

  • If this option is enabled, a failure to find the required header file andlibraries causes CMake to produce an error, preventing the server from being built.

• -DWITH_AUTHENTICATION_PAM=bool

  Whether to build the PAM authentication plugin, for source trees that include this plugin. (See Section 6.4.1.5, “PAM Pluggable Authentication”.) If this option is specified and the plugin cannot be compiled, the build fails.

• -DWITH_AWS_SDK=path_name

  The location of the Amazon Web Services software development kit.

• -DWITH_BOOST=path_name

  The Boost library is required to build MySQL. These CMake options enable control over the library source location, and whether to download it automatically:

  • -DWITH_BOOST=path_name specifies the Boost library directory location. It is also possible to specify the Boost location by setting the BOOST_ROOT or WITH_BOOSTenvironment variable.

    -DWITH_BOOST=system is also permitted and indicates that the correct version of Boost is installed on the compilation host in the standard location. In this case, the installed version of Boost is used rather than any version included with a MySQL source distribution.

  • -DDOWNLOAD_BOOST=bool specifies whether to download the Boost source if it is not present in the specified location. The default is OFF.

  • -DDOWNLOAD_BOOST_TIMEOUT=seconds the timeout in seconds for downloading the Boost library. The default is 600 seconds.

  For example, if you normally build MySQL placing the object output in the bld subdirectory of your MySQL source tree, you can build with Boost like this:

  mkdir bld
  cd bld
  cmake .. -DDOWNLOAD_BOOST=ON -DWITH_BOOST=$HOME/my_boost

  This causes Boost to be downloaded into the my_boost directory under your home directory. If the required Boost version is already there, no download is done. If the required Boost version changes, the newer version is downloaded.

  If Boost is already installed locally and your compiler finds the Boost header files on its own, it may not be necessary to specify the preceding CMake options. However, if the version of Boost required by MySQL changes and the locally installed version has not been upgraded, you may have build problems. Using the CMake options should give you a successful build.

  With the above settings that allow Boost download into a specified location, when the required Boost version changes, you need to remove the bld folder, recreate it, and perform the cmake step again. Otherwise, the new Boost version might not get downloaded, and compilation might fail.

• -DWITH_CLIENT_PROTOCOL_TRACING=bool

  Whether to build the client-side protocol tracing framework into the client library. By default, this option is enabled.

  For information about writing protocol trace client plugins, see Section 29.2.4.11, “Writing Protocol Trace Plugins”.

  See also the WITH_TEST_TRACE_PLUGIN option.

• -DWITH_CURL=curl_type

  The location of the curl library. curl_type can be system (use the system curl library) or a path name to the curl library.

• -DWITH_DEBUG=bool

  Whether to include debugging support.

  Configuring MySQL with debugging support enables you to use the --debug="d,parser_debug" option when you start the server. This causes the Bison parser that is used to process SQL statements to dump a parser trace to the server's standard error output. Typically, this output is written to the error log.

  Sync debug checking for the InnoDB storage engine is defined under UNIV_DEBUG and is available when debugging support is compiled in using the WITH_DEBUGoption. When debugging support is compiled in, the innodb_sync_debug configuration option can be used to enable or disable InnoDB sync debug checking.

  Enabling WITH_DEBUG also enables Debug Sync. This facility is used for testing and debugging. When compiled in, Debug Sync is disabled by default at runtime. To enable it, start mysqld with the --debug-sync-timeout=N option, where N is a timeout value greater than 0. (The default value is 0, which disables Debug Sync.) Nbecomes the default timeout for individual synchronization points.

  Sync debug checking for the InnoDB storage engine is available when debugging support is compiled in using the WITH_DEBUG option.

  For a description of the Debug Sync facility and how to use synchronization points, see MySQL Internals: Test Synchronization.

• -DWITH_DEFAULT_FEATURE_SET=bool

  Whether to use the flags from cmake/build_configurations/feature_set.cmake.

• -DWITH_EDITLINE=value

  Which libedit/editline library to use. The permitted values are bundled (the default) and system.

• -DWITH_ICU={icu_type|path_name}

  MySQL uses International Components for Unicode (ICU) to support regular expression operations. The WITH_ICU option indicates the type of ICU support to include or the path name to the ICU installation to use.

  • icu_type can be one of the following values:

    • bundled: Use the ICU library bundled with the distribution. This is the default, and is the only supported option for Windows.

    • system: Use the system ICU library.

  • path_name is the path name to the ICU installation to use. This can be preferable to using the icu_type value of system because it can prevent CMake from detecting and using an older or incorrect ICU version installed on the system. (Another permitted way to do the same thing is to set WITH_ICU to system and set the CMAKE_PREFIX_PATH option to path_name.)

• -DWITH_INNODB_EXTRA_DEBUG=bool

  Whether to include extra InnoDB debugging support.

  Enabling WITH_INNODB_EXTRA_DEBUG turns on extra InnoDB debug checks. This option can only be enabled when WITH_DEBUG is enabled.

• -DWITH_GMOCK=path_name

  The path to the googlemock distribution, for use with Google Test-based unit tests. The option value is the path to the distribution Zip file. Alternatively, set theWITH_GMOCK environment variable to the path name. It is also possible to use -DENABLE_DOWNLOADS=1 and CMake will download the distribution from GitHub.

  If you build MySQL without the Google Test-based unit tests (by configuring wihout WITH_GMOCK), CMake displays a message indicating how to download it.

• -DWITH_INNODB_MEMCACHED=bool

  Whether to generate memcached shared libraries (libmemcached.so and innodb_engine.so).

• -DWITH_JEMALLOC=bool

  Whether to link with -ljemalloc. If enabled, built-in malloc(), calloc(), realloc(), and free() routines are disabled. The default is OFF.

  This option was added in MySQL 8.0.16.

• -DWITH_KEYRING_TEST=bool

  Whether to build the test program that accompanies the keyring_file plugin. The default is OFF. Test file source code is located in the plugin/keyring/keyring-test directory.

• -DWITH_LIBEVENT=string

  Which libevent library to use. Permitted values are bundled (default), system, and yes. If you specify system or yes, the system libevent library is used if present. If the system library is not found, the bundled libevent library is used. The libevent library is required by InnoDB memcached.

• -DWITH_LIBWRAP=bool

  Whether to include libwrap (TCP wrappers) support.

• -DWITH_LOCK_ORDER=bool

  Whether to enable LOCK_ORDER tooling. By default, this option is disabled and server builds contain no tooling. If tooling is enabled, the LOCK_ORDER tool is available and can be used as described in Section 29.5.3, “The LOCK_ORDER Tool”.

  Note

  With the WITH_LOCK_ORDER option enabled, MySQL builds require the flex program.

  This option was added in MySQL 8.0.17.

• -DWITH_LSAN=bool

  Whether to run LeakSanitizer, without AddressSanitizer. The default is OFF.

  This option was added in MySQL 8.0.16.

• -DWITH_LTO=bool

  Whether to enable the link-time optimizer, if the compiler supports it. The default is OFF unless FPROFILE_USE is enabled.

  This option was added in MySQL 8.0.13.

• -DWITH_LZ4=lz4_type

  The WITH_LZ4 indicates the source of zlib support:

  • bundled: Use the lz4 library bundled with the distribution. This is the default.

  • system: Use the system lz4 library. If WITH_LZ4 is set to this value, the lz4_decompress utility is not built. In this case, the system lz4 command can be used instead.

• -DWITH_MSAN=bool

  Whether to enable MemorySanitizer, for compilers that support it. The default is off.

  For this option to have an effect if enabled, all libraries linked to MySQL must also have been compiled with the option enabled.

• -DWITH_MECAB={disabled|system|path_name}

  Use this option to compile the MeCab parser. If you have installed MeCab to its default installation directory, set -DWITH_MECAB=system. The system option applies to MeCab installations performed from source or from binaries using a native package management utility. If you installed MeCab to a custom installation directory, specify the path to the MeCab installation. For example, -DWITH_MECAB=/opt/mecab. If the system option does not work, specifying the MeCab installation path should work in all cases.

  For related information, see Section 12.9.9, “MeCab Full-Text Parser Plugin”.

• -DWITH_MSCRT_DEBUG=bool

  Whether to enable Visual Studio CRT memory leak tracing. The default is OFF.

• -DWITH_MYSQLX=bool

  Whether to build with support for X Plugin. Default ON. See Chapter 20, Using MySQL as a Document Store.

• -DWITH_NUMA=bool

  Explicitly set the NUMA memory allocation policy. CMake sets the default WITH_NUMA value based on whether the current platform has NUMA support. For platforms without NUMA support, CMake behaves as follows:

  • With no NUMA option (the normal case), CMake continues normally, producing only this warning: NUMA library missing or required version not available

  • With -DWITH_NUMA=ON, CMake aborts with this error: NUMA library missing or required version not available

• -DWITH_PROTOBUF=protobuf_type

  Which Protocol Buffers package to use. protobuf_type can be one of the following values:

  • bundled: Use the package bundled with the distribution. This is the default. Optionally use INSTALL_PRIV_LIBDIR to modify the dynamic Protobuf library directory.

  • system: Use the package installed on the system.

  Other values are ignored, with a fallback to bundled.

• -DWITH_RAPID=bool

  Whether to build the rapid development cycle plugins. When enabled, a rapid directory is created in the build tree containing these plugins. When disabled, no rapiddirectory is created in the build tree. The default is ON, unless the rapid directory is removed from the source tree, in which case the default becomes OFF.

• -DWITH_RAPIDJSON=rapidjson_type

  The type of RapidJSON library support to include. rapidjson_type can be one of the following values:

  • bundled: Use the RapidJSON library bundled with the distribution. This is the default.

  • system: Use the system RapidJSON library. Version 1.1.0 or higher is required.

  This option was added in MySQL 8.0.13.

• -DWITH_LZMA=lzma_type

  The type of LZMA library support to include. lzma_type can be one of the following values:

  • bundled: Use the LZMA library bundled with the distribution. This is the default.

  • system: Use the system LZMA library.

  This option was removed in MySQL 8.0.16.

• -DWITH_RE2=re2_type

  The type of RE2 library support to include. re2_type can be one of the following values:

  • bundled: Use the RE2 library bundled with the distribution. This is the default.

  • system: Use the system RE2 library.

  As of MySQL 8.0.18, MySQL no longer uses the RE2 library and this option was removed.

• -DWITH_ROUTER=bool

  Whether to build MySQL Router. The default is ON.

  This option was added in MySQL 8.0.16.

• -DWITH_SSL={ssl_type|path_name}

  For support of encrypted connections, entropy for random number generation, and other encryption-related operations, MySQL must be built using an SSL library. This option specifies which SSL library to use.

  • ssl_type can be one of the following values:

    • system: Use the system OpenSSL library. This is the default.

      On macOS and Windows, using system configures MySQL to build as if CMake was invoked with path_name points to a manually installed OpenSSL library. This is because they do not have system SSL libraries. On macOS, brew install openssl installs to /usr/local/opt/openssl and system will find it. On Windows, it checks %ProgramFiles%/OpenSSL, %ProgramFiles%/OpenSSL-Win32, %ProgramFiles%/OpenSSL-Win64, C:/OpenSSL, C:/OpenSSL-Win32, and C:/OpenSSL-Win64.

    • yes: This is a synonym for system.

  • path_name is the path name to the OpenSSL installation to use. This can be preferable to using the ssl_type value of system because it can prevent CMake from detecting and using an older or incorrect OpenSSL version installed on the system. (Another permitted way to do the same thing is to set WITH_SSL to system and set the CMAKE_PREFIX_PATH option to path_name.)

  For additional information about configuring the SSL library, see Section 2.9.6, “Configuring SSL Library Support”.

• -DWITH_SYSTEMD=bool

  Whether to enable installation of systemd support files. By default, this option is disabled. When enabled, systemd support files are installed, and scripts such asmysqld_safe and the System V initialization script are not installed. On platforms where systemd is not available, enabling WITH_SYSTEMD results in an error from CMake.

  For more information about using systemd, see Section 2.5.9, “Managing MySQL Server with systemd”. That section also includes information about specifying options previously specified in [mysqld_safe] option groups. Because mysqld_safe is not installed when systemd is used, such options must be specified another way.

• -DWITH_SYSTEM_LIBS=bool

  This option serves as an “umbrella” option to set the system value of any of the following CMake options that are not set explicitly: WITH_CURL, WITH_EDITLINE,WITH_ICU, WITH_LIBEVENT, WITH_LZ4, WITH_LZMA, WITH_PROTOBUF, WITH_RE2, WITH_SSL, WITH_ZLIB, WITH_ZSTD.

• -DWITH_TEST_TRACE_PLUGIN=bool

  Whether to build the test protocol trace client plugin (see Section 29.2.4.11.1, “Using the Test Protocol Trace Plugin”). By default, this option is disabled. Enabling this option has no effect unless the WITH_CLIENT_PROTOCOL_TRACING option is enabled. If MySQL is configured with both options enabled, the libmysqlclient client library is built with the test protocol trace plugin built in, and all the standard MySQL clients load the plugin. However, even when the test plugin is enabled, it has no effect by default. Control over the plugin is afforded using environment variables; see Section 29.2.4.11.1, “Using the Test Protocol Trace Plugin”.

  Note

  Do not enable the WITH_TEST_TRACE_PLUGIN option if you want to use your own protocol trace plugins because only one such plugin can be loaded at a time and an error occurs for attempts to load a second one. If you have already built MySQL with the test protocol trace plugin enabled to see how it works, you must rebuild MySQL without it before you can use your own plugins.

  For information about writing trace plugins, see Section 29.2.4.11, “Writing Protocol Trace Plugins”.

• -DWITH_TSAN=bool

  Whether to enable the ThreadSanitizer, for compilers that support it. The default is off.

• -DWITH_UBSAN=bool

  Whether to enable the Undefined Behavior Sanitizer, for compilers that support it. The default is off.

• -DWITH_UNIT_TESTS={ON|OFF}

  If enabled, compile MySQL with unit tests. The default is ON unless the server is not being compiled.

• -DWITH_UNIXODBC=1

  Enables unixODBC support, for Connector/ODBC.

• -DWITH_VALGRIND=bool

  Whether to compile in the Valgrind header files, which exposes the Valgrind API to MySQL code. The default is OFF.

  To generate a Valgrind-aware debug build, -DWITH_VALGRIND=1 normally is combined with -DWITH_DEBUG=1. See Building Debug Configurations.

• -DWITH_ZLIB=zlib_type

  Some features require that the server be built with compression library support, such as the COMPRESS() and UNCOMPRESS() functions, and compression of the client/server protocol. The WITH_ZLIB indicates the source of zlib support:

  • bundled: Use the zlib library bundled with the distribution. This is the default.

  • system: Use the system zlib library. If WITH_ZLIB is set to this value, the zlib_decompress utility is not built. In this case, the system openssl zlib command can be used instead.

• -DWITH_ZSTD=zstd_type

  Connection compression using the zstd algorithm (see Section 4.2.6, “Connection Compression Control”) requires that the server be built with zstd library support. The WITH_ZSTD indicates the source of zstd support:

  • bundled: Use the zstd library bundled with the distribution. This is the default.

  • system: Use the system zstd library.

  This option was added in MySQL 8.0.18.

• -DCMAKE_C_FLAGS="flags"

  Flags for the C Compiler.

• -DCMAKE_CXX_FLAGS="flags"

  Flags for the C++ Compiler.

• -DWITH_DEFAULT_COMPILER_OPTIONS=bool

  Whether to use the flags from cmake/build_configurations/compiler_options.cmake.

  Note

  All optimization flags were carefully chosen and tested by the MySQL build team. Overriding them can lead to unexpected results and is done at your own risk.

mkdir bld
cd bld
cmake .. -DCMAKE_C_FLAGS=-m32 \
  -DCMAKE_CXX_FLAGS=-m32 \
  -DCMAKE_BUILD_TYPE=RelWithDebInfo

cmake .. -DCMAKE_C_FLAGS_RELWITHDEBINFO="-O3 -g" \
-DCMAKE_CXX_FLAGS_RELWITHDEBINFO="-O3 -g"

• -DMEMCACHED_HOME=dir_name

  Perform the build using the memcached (version 1.6 or later) installed in the system directory indicated by dir_name. Files from this installation that are used in the build include the memcached binary, header files, and libraries, as well as the memcached_utilities library and the header file engine_testapp.h.

  You must leave this option unset when building ndbmemcache using the bundled memcached sources (WITH_BUNDLED_MEMCACHED option); in other words, the bundled sources are used by default).

  While additional CMake options—such as for SASL authorization and for providing dtrace support—are available for use when compiling memcached from external sources, these options are currently not enabled for the memcached sources bundled with NDB Cluster.

• -DWITH_BUNDLED_LIBEVENT={ON|OFF}

  Use the libevent included in the NDB Cluster sources when building NDB Cluster with ndbmemcached support. Enabled by default. OFF causes the system's libeventto be used instead.

• -DWITH_BUNDLED_MEMCACHED={ON|OFF}

  Build the memcached sources included in the NDB Cluster source tree, then use the resulting memcached server when building the ndbmemcache engine. In this case, make install places the memcached binary in the installation bin directory, and the ndbmemcache engine shared library file ndb_engine.so in the installation libdirectory.

  This option is ON by default.

• -DWITH_CLASSPATH=path

  Sets the classpath for building NDB Cluster Connector for Java. The default is empty. This option is ignored if -DWITH_NDB_JAVA=OFF is used.

• -DWITH_ERROR_INSERT={ON|OFF}

  Enables error injection in the NDB kernel. For testing only; not intended for use in building production binaries. The default is OFF.

• -DWITH_NDBCLUSTER_STORAGE_ENGINE={ON|OFF}

  This is an alias for WITH_NDBCLUSTER.

• -DWITH_NDBCLUSTER={ON|OFF}

  Build and link in support for the NDB (NDBCLUSTER) storage engine in mysqld. The default is ON.

• -DWITH_NDBMTD={ON|OFF}

  Build the multithreaded data node executable ndbmtd. The default is ON.

• -DWITH_NDB_BINLOG={ON|OFF}

  Enable binary logging by default in the mysqld built using this option. ON by default.

• -DWITH_NDB_DEBUG={ON|OFF}

  Enable building the debug versions of the NDB Cluster binaries. OFF by default.

• -DWITH_NDB_JAVA={ON|OFF}

  Enable building NDB Cluster with Java support, including ClusterJ.

  This option is ON by default. If you do not wish to compile NDB Cluster with Java support, you must disable it explicitly by specifying -DWITH_NDB_JAVA=OFF when running CMake. Otherwise, if Java cannot be found, configuration of the build fails.

• -DWITH_NDB_PORT=port

  Causes the NDB Cluster management server (ndb_mgmd) that is built to use this port by default. If this option is unset, the resulting management server tries to use port 1186 by default.

• -DWITH_NDB_TEST={ON|OFF}

  If enabled, include a set of NDB API test programs. The default is OFF.

• -DWITH_PLUGIN_NDBCLUSTER={ON|OFF}

  Alias for WITH_NDBCLUSTER.