Movatterモバイル変換

Table 2.14 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.

• -DWITH_BUILD_ID=bool

  On Linux systems, generates a unique build ID which is used as the value of thebuild_id system variable and written to the MySQL server log on startup. Set this option toOFF to disable this feature.

  Added in MySQL 8.0.31, this option has no effect on platforms other than Linux.

• -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 theWITH_DEBUG option is enabled. That is,-DWITH_DEBUG=1 has the same effect as-DCMAKE_BUILD_TYPE=Debug.

  The option valuesNone andMinSizeRel are not supported.

• -DCPACK_MONOLITHIC_INSTALL=bool

  This option affects whether themake 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, invokeCMake with-DFORCE_INSOURCE_BUILD=ON.

• -DFORCE_COLORED_OUTPUT=bool

  Defines whether to enable colorized compiler output forgcc andclang when compiling on the command line. Defaults toOFF.

• -DCMAKE_INSTALL_PREFIX=dir_name

  The installation base directory.

  This value can be set at server startup using 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 installREADME 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

  TheINSTALL_LAYOUT value determines the default value of thesecure_file_priv,keyring_encrypted_file_data, andkeyring_file_data system variables. See the descriptions of those variables inSection 7.1.8, “Server System Variables”, andSection 8.4.4.19, “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 thekeyring_file plugin data file. The default value is platform specific and depends on the value of theINSTALL_LAYOUTCMake option; see the description of thekeyring_file_data system variable inSection 7.1.8, “Server System Variables”.

• -DINSTALL_MYSQLSHAREDIR=dir_name

  Where to install shared data files.

• -DINSTALL_MYSQLTESTDIR=dir_name

  Where to install themysql-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 themysqlclient.pc file for use bypkg-config. The default value isINSTALL_LIBDIR/pkgconfig, unlessINSTALL_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 location.  For RPM builds, this is/usr/lib64/mysql/private/, for DEB it is/usr/lib/mysql/private/, and for TAR it islib/private/.

  Protobuf.  Because this is a private location, the loader (such asld-linux.so on Linux) may not find thelibprotobuf.so files without help. To guide the loader,RPATH=$ORIGIN/../$INSTALL_PRIV_LIBDIR is added tomysqld andmysqlxtest. This works for most cases but when using theResource Group feature,mysqld issetsuid, and the loader ignores anyRPATH which contains$ORIGIN. To overcome this, an explicit full path to the directory is set in the DEB and RPM versions ofmysqld, since the target destination is known. For tarball installs, patching ofmysqld with a tool likepatchelf is required.

  This option was added in MySQL 8.0.18.

• -DINSTALL_SBINDIR=dir_name

  Where to install themysqld server.

• -DINSTALL_SECURE_FILE_PRIVDIR=dir_name

  The default value for thesecure_file_priv system variable. The default value is platform specific and depends on the value of theINSTALL_LAYOUTCMake option; see the description of thesecure_file_priv system variable inSection 7.1.8, “Server System Variables”.

• -DINSTALL_SHAREDIR=dir_name

  Where to installaclocal/mysql.m4.

• -DINSTALL_STATIC_LIBRARIES=bool

  Whether to install static libraries. The default isON. If set toOFF, these library files 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 themysqld binary. The default isOFF. This option should be enabled only for debugging purposes.

• -DLINK_RANDOMIZE_SEED=val

  Seed value for theLINK_RANDOMIZE option. The value is a string. The default ismysql, 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, which may be used while configuring Connector/ODBC.

• -DODBC_LIB_DIR=dir_name

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

• -DSYSCONFDIR=dir_name

  The defaultmy.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, wherefile_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 theINSTALL_LAYOUT value.

  This option is ignored unlessWITH_SYSTEMD is enabled.

• -DSYSTEMD_SERVICE_NAME=name

  The name of the MySQL service to use when MySQL is managed bysystemd. The default ismysqld; this might be changed implicitly according to theINSTALL_LAYOUT value.

  This option is ignored unlessWITH_SYSTEMD is enabled.

• -DTMPDIR=dir_name

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

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 followingCMake options:

DISABLE_PSI_CONDDISABLE_PSI_DATA_LOCKDISABLE_PSI_ERRORDISABLE_PSI_FILEDISABLE_PSI_IDLEDISABLE_PSI_MEMORYDISABLE_PSI_METADATADISABLE_PSI_MUTEXDISABLE_PSI_PSDISABLE_PSI_RWLOCKDISABLE_PSI_SOCKETDISABLE_PSI_SPDISABLE_PSI_STAGEDISABLE_PSI_STATEMENTDISABLE_PSI_STATEMENT_DIGESTDISABLE_PSI_TABLEDISABLE_PSI_THREADDISABLE_PSI_TRANSACTION

For example, to compile without mutex instrumentation, configure MySQL using-DDISABLE_PSI_MUTEX=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 thanlld or GNUgold 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 usesCOMPILATION_COMMENT_SERVER. Other programs continue to useCOMPILATION_COMMENT.

• -DCOMPRESS_DEBUG_SECTIONS=bool

  Whether to compress the debug sections of binary executables (Linux only). Compressing executable debug sections saves space at the cost of extra CPU time during the build process.

  The default isOFF. If this option is not set explicitly but theCOMPRESS_DEBUG_SECTIONS environment variable is set, the option takes its value from that variable.

  This option was added in MySQL 8.0.22.

• -DCOMPILATION_COMMENT_SERVER=string

  A descriptive comment about the compilation environment for use bymysqld (for example, to set theversion_comment system variable). This option was added in MySQL 8.0.14. Prior to 8.0.14, the server usesCOMPILATION_COMMENT.

• -DDEFAULT_CHARSET=charset_name

  The server character set. By default, MySQL uses theutf8mb4 character set.

  charset_name may be one ofbinary,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,utf8mb3,utf8mb4,utf16,utf16le,utf32.

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

• -DDEFAULT_COLLATION=collation_name

  The server collation. By default, MySQL usesutf8mb4_0900_ai_ci. Use theSHOW 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 isOFF (include).

• -DDISABLE_PSI_FILE=bool

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

• -DDISABLE_PSI_IDLE=bool

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

• -DDISABLE_PSI_MEMORY=bool

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

• -DDISABLE_PSI_METADATA=bool

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

• -DDISABLE_PSI_MUTEX=bool

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

• -DDISABLE_PSI_RWLOCK=bool

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

• -DDISABLE_PSI_SOCKET=bool

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

• -DDISABLE_PSI_SP=bool

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

• -DDISABLE_PSI_STAGE=bool

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

• -DDISABLE_PSI_STATEMENT=bool

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

• -DDISABLE_PSI_STATEMENT_DIGEST=bool

  Whether to exclude the Performance Schema statement digest instrumentation. The default isOFF (include).

• -DDISABLE_PSI_TABLE=bool

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

• -DDISABLE_SHARED=bool

  Whether to disable building build shared libraries and compile position-dependent code. The default isOFF (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 isOFF (include).

• -DDISABLE_PSI_THREAD=bool

  Exclude the Performance Schema thread instrumentation. The default isOFF (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 isOFF (include).

• -DDISABLE_PSI_DATA_LOCK=bool

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

• -DDISABLE_PSI_ERROR=bool

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

• -DDOWNLOAD_BOOST=bool

  Whether to download the Boost library. The default isOFF.

  See theWITH_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 theWITH_BOOST option for additional discussion about using Boost.

• -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 the GCS Java wrapper.

  As of MySQL 8.0.26, MySQL source distributions bundle the Google Test source code used to run unit tests. Consequently, as of that version theWITH_GMOCK andENABLE_DOWNLOADSCMake options are removed and are ignored if specified.

• -DENABLE_EXPERIMENTAL_SYSVARS=bool

  Whether to enable experimentalInnoDB 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 includegcov support (Linux only).

• -DENABLE_GPROF=bool

  Whether to enablegprof (optimized Linux builds only).

• -DENABLED_LOCAL_INFILE=bool

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

  By default, the client library in MySQL binary distributions is compiled withENABLED_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 haveLOCAL capability disabled or enabled, respectively.

  ENABLED_LOCAL_INFILE controls the default for client-sideLOCAL capability. For the server, thelocal_infile system variable controls server-sideLOCAL capability. To explicitly cause the server to refuse or permitLOAD DATA LOCAL statements (regardless of how client programs and libraries are configured at build time or runtime), startmysqld with--local-infile disabled or enabled, respectively.local_infile can also be set at runtime. SeeSection 8.1.6, “Security Considerations for LOAD DATA LOCAL”.

• -DENABLED_PROFILING=bool

  Whether to enable query profiling code (for theSHOW PROFILE andSHOW PROFILES statements).

• -DFORCE_UNSUPPORTED_COMPILER=bool

  By default,CMake checks for minimum versions ofsupported compilers; 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. Seecmake/fprofile.cmake in the MySQL source distribution for information about usingFPROFILE_GENERATE andFPROFILE_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 thecmake/fprofile.cmake file in a MySQL source distribution for information about usingFPROFILE_GENERATE andFPROFILE_USE. These options have been tested with GCC 8 and 9.

  EnablingFPROFILE_USE also enablesWITH_LTO.

  This option was added in MySQL 8.0.19.

• -DHAVE_PSI_MEMORY_INTERFACE=bool

  Whether to enable the performance schema memory tracing module for memory allocation functions (ut::aligned_name library functions) used in dynamic storage of over-aligned types.

• -DIGNORE_AIO_CHECK=bool

  If the-DBUILD_CONFIG=mysql_release option is given on Linux, thelibaio library must be linked in by default. If you do not havelibaio 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.

• -DWITH_DEVELOPER_ENTITLEMENTS=bool

  Whether to add theget-task-allow entitlement to all executables to generate a core dump in the event of an unexpected server halt.

  On macOS 11+, core dumps are limited to processes with thecom.apple.security.get-task-allow entitlement, which this CMake option enables. The entitlement allows other processes to attach and read/modify the processes memory, and allows--core-file to function as expected.

  This option was added in MySQL 8.0.30.

• -DMUTEX_TYPE=type

  The mutex type used byInnoDB. Options include:

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

  • sys: Use POSIX mutexes on UNIX systems. UseCRITICAL_SECTION objects 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 themysqlx_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 themysqlx_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. SeeSection 10.15, “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 toON forRelWithDebInfo builds.

• -DSHOW_SUPPRESSED_COMPILER_WARNINGS=bool

  Show suppressed compiler warnings, and do so without failing with-Werror. Defaults toOFF.

  This option was added in MySQL 8.0.30.

• -DUSE_LD_GOLD=bool

  GNUgold linker support was removed in MySQL 8.0.31; this CMake option was also removed.

  CMake causes the build process to link with the GNUgold 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 using the LLVMlld 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 isOFF (inlining enabled).

• -DWITH_ANT=path_name

  Set the path to Ant, required when building GCS Java wrapper. SetWITH_ANT to the path of a directory where the Ant tarball or unpacked archive is saved. WhenWITH_ANT is not set, or is set with the special valuesystem, the build process assumes a binaryant exists in$PATH.

• -DWITH_ASAN=bool

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

• -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_CLIENT_PLUGINS=bool

  This option is enabled automatically if any corresponding server authentication plugins are built. Its value thus depends on otherCMake options and it should not be set explicitly.

  This option was added in MySQL 8.0.26.

• -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 and libraries causes CMake to produce an error, preventing the server from being built.

  For information about LDAP authentication, seeSection 8.4.1.7, “LDAP Pluggable Authentication”.

• -DWITH_AUTHENTICATION_PAM=bool

  Whether to build the PAM authentication plugin, for source trees that include this plugin. (SeeSection 8.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. TheseCMake 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 theBOOST_ROOT orWITH_BOOST environment 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 isOFF.

  • -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 thebld subdirectory of your MySQL source tree, you can build with Boost like this:

  mkdir bldcd bldcmake .. -DDOWNLOAD_BOOST=ON -DWITH_BOOST=$HOME/my_boost

  This causes Boost to be downloaded into themy_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 precedingCMake 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 theCMake 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 thebld folder, recreate it, and perform thecmake 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, seeWriting Protocol Trace Plugins.

  See also theWITH_TEST_TRACE_PLUGIN option.

• -DWITH_CURL=curl_type

  The location of thecurl library.curl_type can besystem (use the systemcurl library) or a path name to thecurl 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 theInnoDB storage engine is defined underUNIV_DEBUG and is available when debugging support is compiled in using theWITH_DEBUG option. When debugging support is compiled in, theinnodb_sync_debug configuration option can be used to enable or disableInnoDB sync debug checking.

  EnablingWITH_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, startmysqld with the--debug-sync-timeout=N option, whereN is a timeout value greater than 0. (The default value is 0, which disables Debug Sync.)N becomes the default timeout for individual synchronization points.

  Sync debug checking for theInnoDB storage engine is available when debugging support is compiled in using theWITH_DEBUG option.

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

• -DWITH_DEFAULT_FEATURE_SET=bool

  Whether to use the flags fromcmake/build_configurations/feature_set.cmake. This option was removed in MySQL 8.0.22.

• -DWITH_EDITLINE=value

  Whichlibedit/editline library to use. The permitted values arebundled (the default) andsystem.

• -DWITH_FIDO=fido_type

  Theauthentication_fido authentication plugin is implemented using a FIDO library (seeSection 8.4.1.11, “FIDO Pluggable Authentication”). TheWITH_FIDO option indicates the source of FIDO support:

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

    As of MySQL 8.0.30, MySQL includesfido2 version 1.8.0. (Prior releases usedfido2 1.5.0).

  • system: Use the system FIDO library.

  WITH_FIDO is disabled (set tonone) if all authentication plugins are disabled.

  This option was added in MySQL 8.0.27.

• -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, so that CMake downloads the distribution from GitHub.

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

  As of MySQL 8.0.26, MySQL source distributions bundle the Google Test source code. Consequently, as of that version, theWITH_GMOCK andENABLE_DOWNLOADS CMake options are removed and are ignored if specified.

• -DWITH_ICU={icu_type|path_name}

  MySQL uses International Components for Unicode (ICU) to support regular expression operations. TheWITH_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 theicu_type value ofsystem 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 setWITH_ICU tosystem and set theCMAKE_PREFIX_PATH option topath_name.)

• -DWITH_INNODB_EXTRA_DEBUG=bool

  Whether to include extra InnoDB debugging support.

  EnablingWITH_INNODB_EXTRA_DEBUG turns on extra InnoDB debug checks. This option can only be enabled whenWITH_DEBUG is enabled.

• -DWITH_INNODB_MEMCACHED=bool

  Whether to generate memcached shared libraries (libmemcached.so andinnodb_engine.so).

• -DWITH_JEMALLOC=bool

  Whether to link with-ljemalloc. If enabled, built-inmalloc(),calloc(),realloc(), andfree() routines are disabled. The default isOFF.

  WITH_JEMALLOC andWITH_TCMALLOC are mutually exclusive.

  This option was added in MySQL 8.0.16.

• -DWITH_KEYRING_TEST=bool

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

• -DWITH_LIBEVENT=string

  Whichlibevent library to use. Permitted values arebundled (default) andsystem. Prior to MySQL 8.0.21, if you specifysystem, the systemlibevent library is used if present, and an error occurs otherwise. In MySQL 8.0.21 and later, ifsystem is specified and no systemlibevent library can be found, an error occurs regardless, and the bundledlibevent is not used.

  Thelibevent library is required byInnoDB memcached, X Plugin, and MySQL Router.

• -DWITH_LIBWRAP=bool

  Whether to includelibwrap (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 inSection 7.9.3, “The LOCK_ORDER Tool”.

  Note

  With theWITH_LOCK_ORDER option enabled, MySQL builds require theflex program.

  This option was added in MySQL 8.0.17.

• -DWITH_LSAN=bool

  Whether to run LeakSanitizer, without AddressSanitizer. The default isOFF.

  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 isOFF unlessFPROFILE_USE is enabled.

  This option was added in MySQL 8.0.13.

• -DWITH_LZ4=lz4_type

  TheWITH_LZ4 option indicates the source ofzlib support:

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

  • system: Use the systemlz4 library. IfWITH_LZ4 is set to this value, thelz4_decompress utility is not built. In this case, the systemlz4 command can be used instead.

• -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_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. Thesystem 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 thesystem option does not work, specifying the MeCab installation path should work in all cases.

  For related information, seeSection 14.9.9, “MeCab Full-Text Parser Plugin”.

• -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_MSCRT_DEBUG=bool

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

• -DMSVC_CPPCHECK=bool

  Whether to enable MSVC code analysis. The default isOFF.

• -DWITH_MYSQLX=bool

  Whether to build with support for X Plugin. The default isON. SeeChapter 22,Using MySQL as a Document Store.

• -DWITH_NUMA=bool

  Explicitly set the NUMA memory allocation policy.CMake sets the defaultWITH_NUMA value based on whether the current platform hasNUMA 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_PACKAGE_FLAGS=bool

  For flags typically used for RPM and Debian packages, whether to add them to standalone builds on those platforms. The default isON for nondebug builds.

  This option was added in MySQL 8.0.26.

• -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 useINSTALL_PRIV_LIBDIR to modify the dynamic Protobuf library directory.

  • system: Use the package installed on the system.

  Other values are ignored, with a fallback tobundled.

• -DWITH_RAPID=bool

  Whether to build the rapid development cycle plugins. When enabled, arapid directory is created in the build tree containing these plugins. When disabled, norapid directory is created in the build tree. The default isON, unless therapid directory is removed from the source tree, in which case the default becomesOFF.

• -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 later is required.

  This option was added in MySQL 8.0.13.

• -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 has been removed.

• -DWITH_ROUTER=bool

  Whether to build MySQL Router. The default isON.

  This option was added in MySQL 8.0.16.

• -DWITH_SASL=value

  Internal use only. This option was added in 8.0.20. Not supported on Windows.

• -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, usingsystem configures MySQL to build as if CMake was invoked withpath_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 so thatsystem can find it. On Windows, it checks%ProgramFiles%/OpenSSL,%ProgramFiles%/OpenSSL-Win32,%ProgramFiles%/OpenSSL-Win64,C:/OpenSSL,C:/OpenSSL-Win32, andC:/OpenSSL-Win64.

    • yes: This is a synonym forsystem.

    • opensslversion: (MySQL 8.0.30 and later:) Use an alternate OpenSSL system package such asopenssl11 on EL7, oropenssl3 on EL8.

      Authentication plugins, such as LDAP and Kerberos, are disabled as they do not support these alternative versions of OpenSSL.

  • path_name is the path name to the OpenSSL installation to use. This can be preferable to using thessl_type value ofsystem 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 setWITH_SSL tosystem and set theCMAKE_PREFIX_PATH option topath_name.)

  For additional information about configuring the SSL library, seeSection 2.8.6, “Configuring SSL Library Support”.

• -DWITH_SYSTEMD=bool

  Whether to enable installation ofsystemd 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 wheresystemd is not available, enablingWITH_SYSTEMD results in an error fromCMake.

  For more information about usingsystemd, seeSection 2.5.9, “Managing MySQL Server with systemd”. That section also includes information about specifying options otherwise specified in[mysqld_safe] option groups. Becausemysqld_safe is not installed whensystemd is used, such options must be specified another way.

• -DWITH_SYSTEM_LIBS=bool

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

  WITH_ZLIB was included here priot MySQL 8.0.30.

• -DWITH_SYSTEMD_DEBUG=bool

  Whether to produce additionalsystemd debugging information, for platforms on whichsystemd is used to run MySQL. The default isOFF.

  This option was added in MySQL 8.0.22.

• -DWITH_TCMALLOC=bool

  Whether to link with-ltcmalloc. If enabled, built-inmalloc(),calloc(),realloc(), andfree() routines are disabled. The default isOFF.

  Beginning with MySQL 8.0.38, atcmalloc library is included in the source; you can cause the build to use the bundled version by setting this option toBUNDLED.BUNDLED is supported on Linux systems only.

  WITH_TCMALLOC andWITH_JEMALLOC are mutually exclusive.

  This option was added in MySQL 8.0.22.

• -DWITH_TEST_TRACE_PLUGIN=bool

  Whether to build the test protocol trace client plugin (seeUsing the Test Protocol Trace Plugin). By default, this option is disabled. Enabling this option has no effect unless theWITH_CLIENT_PROTOCOL_TRACING option is enabled. If MySQL is configured with both options enabled, thelibmysqlclient 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; seeUsing the Test Protocol Trace Plugin.

  Note

  Donot enable theWITH_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, seeWriting 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 isON 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 isOFF.

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

• -DWITH_WIN_JEMALLOC=string

  On Windows, pass in a path to a directory containingjemalloc.dll to enable jemalloc functionality. The build system copiesjemalloc.dll to the same directory asmysqld.exe and/ormysqld-debug.exe and utilizes it for memory management operations. Standard memory functions are used ifjemalloc.dll is not found or does not export the required functions. An INFORMATION level log message records whether or not jemalloc is found and used.

  This option is enabled for official MySQL binaries for Windows.

  This option was added in MySQL 8.0.29.

• -DWITH_ZLIB=zlib_type

  Some features require that the server be built with compression library support, such as theCOMPRESS() andUNCOMPRESS() functions, and compression of the client/server protocol. TheWITH_ZLIB option indicates the source ofzlib support:

  In MYSQL 8.0.32 and later, the minimum supported version ofzlib is 1.2.13.

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

  • system: Use the systemzlib library. IfWITH_ZLIB is set to this value, thezlib_decompress utility is not built. In this case, the systemopenssl zlib command can be used instead.

• -DWITH_ZSTD=zstd_type

  Connection compression using thezstd algorithm (seeSection 6.2.8, “Connection Compression Control”) requires that the server be built withzstd library support. TheWITH_ZSTD option indicates the source ofzstd support:

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

  • system: Use the systemzstd library.

  This option was added in MySQL 8.0.18.

• -DWITHOUT_SERVER=bool

  Whether to build without MySQL Server. The default is OFF, which does build the server.

  This is considered an experimental option; it is preferred to build with the server.

  This option also prevents building of theNDB storage engine or anyNDB binaries including management and data node programs.

• -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 fromcmake/build_configurations/compiler_options.cmake.

  Note

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

• -DOPTIMIZE_SANITIZER_BUILDS=bool

  Whether to add-O1 -fno-inline to sanitizer builds. The default isON.

• -DMEMCACHED_HOME=dir_name

  NDB support for memcached was removed in NDB 8.0.23; thus, this option is no longer supported for buildingNDB in this or later versions.

• -DNDB_UTILS_LINK_DYNAMIC={ON|OFF}

  Controls whether NDB utilities such asndb_drop_table are linked withndbclient statically (OFF) or dynamically (ON);OFF (static linking) is the default. Normally static linking is used when building these to avoid problems withLD_LIBRARY_PATH, or when multiple versions ofndbclient are installed. This option is intended for creating Docker images and possibly other cases in which the target environment is subject to precise control and it is desirable to reduce image size.

  Added in NDB 8.0.22.

• -DWITH_BUNDLED_LIBEVENT={ON|OFF}

  NDB support for memcached was removed in NDB 8.0.23; thus, this option is no longer supported for buildingNDB in this or later versions.

• -DWITH_BUNDLED_MEMCACHED={ON|OFF}

  NDB support for memcached was removed in NDB 8.0.23; thus, this option is no longer supported for buildingNDB in this or later versions.

• -DWITH_CLASSPATH=path

  Sets the classpath for building MySQL 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 theNDB kernel. For testing only; not intended for use in building production binaries. The default isOFF.

• -DWITH_NDB={ON|OFF}

  Build MySQL NDB Cluster; build the NDB plugin and all NDB Cluster programs.

  Added in NDB 8.0.31.

• -DWITH_NDBAPI_EXAMPLES={ON|OFF}

  Build NDB API example programs instorage/ndb/ndbapi-examples/. SeeNDB API Examples, for information about these.

• -DWITH_NDBCLUSTER_STORAGE_ENGINE={ON|OFF}

  NDB 8.0.30 and earlier: For internal use only; may not always work as expected. To build withNDB support, useWITH_NDBCLUSTER instead.

  NDB 8.0.31 and later: Controls (only) whether theNDBCLUSTER storage engine is included in the build;WITH_NDB enables this option automatically, so it is recommended that you useWITH_NDB instead.

• -DWITH_NDBCLUSTER={ON|OFF} (DEPRECATED)

  Build and link in support for theNDB storage engine inmysqld.

  This option is deprecated as of NDB 8.0.31, and subject to eventual removal; useWITH_NDB instead.

• -DWITH_NDBMTD={ON|OFF}

  Build the multithreaded data node executablendbmtd. The default isON.

• -DWITH_NDB_DEBUG={ON|OFF}

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

• -DWITH_NDB_JAVA={ON|OFF}

  Enable building NDB Cluster with Java support, including support for ClusterJ (seeMySQL NDB Cluster Connector for Java).

  This option isON 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 runningCMake. 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 thisport 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 isOFF.

• -DWITH_PLUGIN_NDBCLUSTER={ON|OFF}

  For internal use only; may not always work as expected. This option was removed in NDB 8.0.31; useWITH_NDB instead to build MySQL NDB Cluster. (NDB 8.0.30 and earlier: UseWITH_NDBCLUSTER.)