The CMake program provides a great deal of control over how you configure a MySQL source distribution. Typically, you do this using options on the CMake command line. For information about options supported by CMake, run either of these commands in the top-level source directory:
$> cmake . -LH
$> ccmake .
You can also affect CMake using certain environment variables. See Section 4.9, “Environment Variables”.
For boolean options, the value may be specified as
1
or ON
to enable the
option, or as 0
or OFF
to
disable the option.
Many options configure compile-time defaults that can be
overridden at server startup. For example, the
CMAKE_INSTALL_PREFIX
,
MYSQL_TCP_PORT
, and
MYSQL_UNIX_ADDR
options that
configure the default installation base directory location, TCP/IP
port number, and Unix socket file can be changed at server startup
with the --basedir
,
--port
, and
--socket
options for
mysqld. Where applicable, configuration option
descriptions indicate the corresponding mysqld
startup option.
The following sections provide more information about CMake options.
The following table shows the available CMake
options. In the Default
column,
PREFIX
stands for the value of the
CMAKE_INSTALL_PREFIX
option, which
specifies the installation base directory. This value is used as
the parent location for several of the installation
subdirectories.
Table 2.14 MySQL Source-Configuration Option Reference (CMake)
Formats | Description | Default | Introduced | Removed |
---|---|---|---|---|
BUILD_CONFIG |
Use same build options as official releases | |||
CMAKE_BUILD_TYPE |
Type of build to produce | RelWithDebInfo |
||
CMAKE_CXX_FLAGS |
Flags for C++ Compiler | |||
CMAKE_C_FLAGS |
Flags for C Compiler | |||
CMAKE_INSTALL_PREFIX |
Installation base directory | /usr/local/mysql |
||
COMPILATION_COMMENT |
Comment about compilation environment | |||
CPACK_MONOLITHIC_INSTALL |
Whether package build produces single file | OFF |
||
DEFAULT_CHARSET |
The default server character set | latin1 |
||
DEFAULT_COLLATION |
The default server collation | latin1_swedish_ci |
||
DISABLE_PSI_COND |
Exclude Performance Schema condition instrumentation | OFF |
||
DISABLE_PSI_FILE |
Exclude Performance Schema file instrumentation | OFF |
||
DISABLE_PSI_IDLE |
Exclude Performance Schema idle instrumentation | OFF |
||
DISABLE_PSI_MEMORY |
Exclude Performance Schema memory instrumentation | OFF |
||
DISABLE_PSI_METADATA |
Exclude Performance Schema metadata instrumentation | OFF |
||
DISABLE_PSI_MUTEX |
Exclude Performance Schema mutex instrumentation | OFF |
||
DISABLE_PSI_PS |
Exclude the performance schema prepared statements | OFF |
||
DISABLE_PSI_RWLOCK |
Exclude Performance Schema rwlock instrumentation | OFF |
||
DISABLE_PSI_SOCKET |
Exclude Performance Schema socket instrumentation | OFF |
||
DISABLE_PSI_SP |
Exclude Performance Schema stored program instrumentation | OFF |
||
DISABLE_PSI_STAGE |
Exclude Performance Schema stage instrumentation | OFF |
||
DISABLE_PSI_STATEMENT |
Exclude Performance Schema statement instrumentation | OFF |
||
DISABLE_PSI_STATEMENT_DIGEST |
Exclude Performance Schema statements_digest instrumentation | OFF |
||
DISABLE_PSI_TABLE |
Exclude Performance Schema table instrumentation | OFF |
||
DISABLE_PSI_THREAD |
Exclude the performance schema thread instrumentation | OFF |
||
DISABLE_PSI_TRANSACTION |
Exclude the performance schema transaction instrumentation | OFF |
||
DOWNLOAD_BOOST |
Whether to download the Boost library | OFF |
||
DOWNLOAD_BOOST_TIMEOUT |
Timeout in seconds for downloading the Boost library | 600 |
||
ENABLED_LOCAL_INFILE |
Whether to enable LOCAL for LOAD DATA | OFF |
||
ENABLED_PROFILING |
Whether to enable query profiling code | ON |
||
ENABLE_DOWNLOADS |
Whether to download optional files | OFF |
||
ENABLE_DTRACE |
Whether to include DTrace support | |||
ENABLE_GCOV |
Whether to include gcov support | |||
ENABLE_GPROF |
Enable gprof (optimized Linux builds only) | OFF |
||
FORCE_UNSUPPORTED_COMPILER |
Whether to permit unsupported compilers | OFF |
||
IGNORE_AIO_CHECK |
With -DBUILD_CONFIG=mysql_release, ignore libaio check | OFF |
||
INSTALL_BINDIR |
User executables directory | PREFIX/bin |
||
INSTALL_DOCDIR |
Documentation directory | PREFIX/docs |
||
INSTALL_DOCREADMEDIR |
README file directory | PREFIX |
||
INSTALL_INCLUDEDIR |
Header file directory | PREFIX/include |
||
INSTALL_INFODIR |
Info file directory | PREFIX/docs |
||
INSTALL_LAYOUT |
Select predefined installation layout | STANDALONE |
||
INSTALL_LIBDIR |
Library file directory | PREFIX/lib |
||
INSTALL_MANDIR |
Manual page directory | PREFIX/man |
||
INSTALL_MYSQLKEYRINGDIR |
Directory for keyring_file plugin data file | platform specific |
5.7.11 | |
INSTALL_MYSQLSHAREDIR |
Shared data directory | PREFIX/share |
||
INSTALL_MYSQLTESTDIR |
mysql-test directory | PREFIX/mysql-test |
||
INSTALL_PKGCONFIGDIR |
Directory for mysqlclient.pc pkg-config file | INSTALL_LIBDIR/pkgconfig |
||
INSTALL_PLUGINDIR |
Plugin directory | PREFIX/lib/plugin |
||
INSTALL_SBINDIR |
Server executable directory | PREFIX/bin |
||
INSTALL_SCRIPTDIR |
Scripts directory | PREFIX/scripts |
||
INSTALL_SECURE_FILE_PRIVDIR |
secure_file_priv default value | platform specific |
||
INSTALL_SECURE_FILE_PRIV_EMBEDDEDDIR |
secure_file_priv default value for libmysqld | |||
INSTALL_SHAREDIR |
aclocal/mysql.m4 installation directory | PREFIX/share |
||
INSTALL_SUPPORTFILESDIR |
Extra support files directory | PREFIX/support-files |
||
MAX_INDEXES |
Maximum indexes per table | 64 |
||
MEMCACHED_HOME |
Path to memcached; obsolete | [none] |
5.7.33 | |
MUTEX_TYPE |
InnoDB mutex type | event |
||
MYSQLX_TCP_PORT |
TCP/IP port number used by X Plugin | 33060 |
5.7.17 | |
MYSQLX_UNIX_ADDR |
Unix socket file used by X Plugin | /tmp/mysqlx.sock |
5.7.15 | |
MYSQL_DATADIR |
Data directory | |||
MYSQL_MAINTAINER_MODE |
Whether to enable MySQL maintainer-specific development environment | OFF |
||
MYSQL_PROJECT_NAME |
Windows/macOS project name | MySQL |
||
MYSQL_TCP_PORT |
TCP/IP port number | 3306 |
||
MYSQL_UNIX_ADDR |
Unix socket file | /tmp/mysql.sock |
||
ODBC_INCLUDES |
ODBC includes directory | |||
ODBC_LIB_DIR |
ODBC library directory | |||
OPTIMIZER_TRACE |
Whether to support optimizer tracing | |||
REPRODUCIBLE_BUILD |
Take extra care to create a build result independent of build location and time | 5.7.19 | ||
SUNPRO_CXX_LIBRARY |
Client link library on Solaris 10+ | |||
SYSCONFDIR |
Option file directory | |||
SYSTEMD_PID_DIR |
Directory for PID file under systemd | /var/run/mysqld |
||
SYSTEMD_SERVICE_NAME |
Name of MySQL service under systemd | mysqld |
||
TMPDIR |
tmpdir default value | |||
WIN_DEBUG_NO_INLINE |
Whether to disable function inlining | OFF |
||
WITHOUT_SERVER |
Do not build the server | OFF |
||
WITHOUT_xxx_STORAGE_ENGINE |
Exclude storage engine xxx from build | |||
WITH_ASAN |
Enable AddressSanitizer | OFF |
||
WITH_ASAN_SCOPE |
Enable AddressSanitizer -fsanitize-address-use-after-scope Clang flag | OFF |
5.7.21 | |
WITH_AUTHENTICATION_LDAP |
Whether to report error if LDAP authentication plugins cannot be built | OFF |
5.7.19 | |
WITH_AUTHENTICATION_PAM |
Build PAM authentication plugin | OFF |
||
WITH_AWS_SDK |
Location of Amazon Web Services software development kit | 5.7.19 | ||
WITH_BOOST |
The location of the Boost library sources | |||
WITH_BUNDLED_LIBEVENT |
Use bundled libevent when building ndbmemcache; obsolete | ON |
5.7.33 | |
WITH_BUNDLED_MEMCACHED |
Use bundled memcached when building ndbmemcache; obsolete | ON |
5.7.33 | |
WITH_CLASSPATH |
Classpath to use when building MySQL Cluster Connector for Java. Default is an empty string. |
|
||
WITH_CLIENT_PROTOCOL_TRACING |
Build client-side protocol tracing framework | ON |
||
WITH_CURL |
Location of curl library | 5.7.19 | ||
WITH_DEBUG |
Whether to include debugging support | OFF |
||
WITH_DEFAULT_COMPILER_OPTIONS |
Whether to use default compiler options | ON |
||
WITH_DEFAULT_FEATURE_SET |
Whether to use default feature set | ON |
||
WITH_EDITLINE |
Which libedit/editline library to use | bundled |
||
WITH_EMBEDDED_SERVER |
Whether to build embedded server | OFF |
||
WITH_EMBEDDED_SHARED_LIBRARY |
Whether to build a shared embedded server library | OFF |
||
WITH_ERROR_INSERT |
Enable error injection in the NDB storage engine. Should not be used for building binaries intended for production. | OFF |
||
WITH_EXTRA_CHARSETS |
Which extra character sets to include | all |
||
WITH_GMOCK |
Path to googlemock distribution | |||
WITH_INNODB_EXTRA_DEBUG |
Whether to include extra debugging support for InnoDB. | OFF |
||
WITH_INNODB_MEMCACHED |
Whether to generate memcached shared libraries. | OFF |
||
WITH_KEYRING_TEST |
Build the keyring test program | OFF |
5.7.11 | |
WITH_LDAP |
Internal use only | 5.7.29 | ||
WITH_LIBEVENT |
Which libevent library to use | bundled |
||
WITH_LIBWRAP |
Whether to include libwrap (TCP wrappers) support | OFF |
||
WITH_LZ4 |
Type of LZ4 library support | bundled |
5.7.14 | |
WITH_MECAB |
Compiles MeCab | |||
WITH_MSAN |
Enable MemorySanitizer | OFF |
||
WITH_MSCRT_DEBUG |
Enable Visual Studio CRT memory leak tracing | OFF |
||
WITH_NDBAPI_EXAMPLES |
Build API example programs. | OFF |
||
WITH_NDBCLUSTER |
NDB 8.0.30 and earlier: Build NDB storage engine. NDB 8.0.31 and later: Deprecated; use WITH_NDB instead | ON |
||
WITH_NDBCLUSTER_STORAGE_ENGINE |
Prior to NDB 8.0.31, this was for internal use only. NDB 8.0.31 and later: toggles (only) inclusion of NDBCLUSTER storage engine | ON |
||
WITH_NDBMTD |
Build multithreaded data node binary | ON |
||
WITH_NDB_BINLOG |
Enable binary logging by default by mysqld. | ON |
||
WITH_NDB_DEBUG |
Produce a debug build for testing or troubleshooting. | OFF |
||
WITH_NDB_JAVA |
Enable building of Java and ClusterJ support. Enabled by default. Supported in MySQL Cluster only. | ON |
||
WITH_NDB_PORT |
Default port used by a management server built with this option. If this option was not used to build it, the management server's default port is 1186. | [none] |
||
WITH_NDB_TEST |
Include NDB API test programs. | OFF |
||
WITH_NUMA |
Set NUMA memory allocation policy | 5.7.17 | ||
WITH_PROTOBUF |
Which Protocol Buffers package to use | bundled |
5.7.12 | |
WITH_RAPID |
Whether to build rapid development cycle plugins | ON |
5.7.12 | |
WITH_SASL |
Internal use only | 5.7.29 | ||
WITH_SSL |
Type of SSL support | system |
||
WITH_SYSTEMD |
Enable installation of systemd support files | OFF |
||
WITH_TEST_TRACE_PLUGIN |
Build test protocol trace plugin | OFF |
||
WITH_UBSAN |
Enable Undefined Behavior Sanitizer | OFF |
||
WITH_UNIT_TESTS |
Compile MySQL with unit tests | ON |
||
WITH_UNIXODBC |
Enable unixODBC support | OFF |
||
WITH_VALGRIND |
Whether to compile in Valgrind header files | OFF |
||
WITH_ZLIB |
Type of zlib support | bundled |
||
WITH_xxx_STORAGE_ENGINE |
Compile storage engine xxx statically into server |
This option configures a source distribution with the same build options used by Oracle to produce binary distributions for official MySQL releases.
The type of build to produce:
RelWithDebInfo
: Enable optimizations and generate debugging information. This is the default MySQL build type.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
.
-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.
The CMAKE_INSTALL_PREFIX
option
indicates the base installation directory. Other options with
names of the form
INSTALL_
that
indicate component locations are interpreted relative to the
prefix and their values are relative pathnames. Their values
should not include the prefix.
xxx
-DCMAKE_INSTALL_PREFIX=
dir_name
The installation base directory.
This value can be set at server startup using the
--basedir
option.Where to install user programs.
Where to install documentation.
-DINSTALL_DOCREADMEDIR=
dir_name
Where to install
README
files.Where to install header files.
Where to install Info files.
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 thesecure_file_priv
,keyring_encrypted_file_data
, andkeyring_file_data
system variables. See the descriptions of those variables in Section 5.1.7, “Server System Variables”, and Section 6.4.4.12, “Keyring System Variables”.Where to install library files.
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 theINSTALL_LAYOUT
CMake option; see the description of thekeyring_file_data
system variable in Section 5.1.7, “Server System Variables”.This option was added in MySQL 5.7.11.
-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 isINSTALL_LIBDIR/pkgconfig
, unlessINSTALL_LIBDIR
ends with/mysql
, in which case that is removed first.The location of the plugin directory.
This value can be set at server startup with the
--plugin_dir
option.Where to install the mysqld server.
Where to install mysql_install_db.
-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 theINSTALL_LAYOUT
CMake option; see the description of thesecure_file_priv
system variable in Section 5.1.7, “Server System Variables”.To set the value for the
libmysqld
embedded server, useINSTALL_SECURE_FILE_PRIV_EMBEDDEDDIR
.-DINSTALL_SECURE_FILE_PRIV_EMBEDDEDDIR=
dir_name
The default value for the
secure_file_priv
system variable, for thelibmysqld
embedded server.NoteThe
libmysqld
embedded server library is deprecated as of MySQL 5.7.19; expect it to be removed in MySQL 8.0.Where to install
aclocal/mysql.m4
.-DINSTALL_SUPPORTFILESDIR=
dir_name
Where to install extra support files.
The location of the MySQL data directory.
This value can be set at server startup with the
--datadir
option.The location of the ODBC includes directory, which may be used while configuring Connector/ODBC.
The location of the ODBC library directory, which may be used while configuring Connector/ODBC.
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=
option, wherefile_name
file_name
is the full path name to the file.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 unless
WITH_SYSTEMD
is enabled.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 theINSTALL_LAYOUT
value.This option is ignored unless
WITH_SYSTEMD
is enabled.The default location to use for the
tmpdir
system variable. If unspecified, the value defaults toP_tmpdir
in<stdio.h>
.
Storage engines are built as plugins. You can build a plugin as
a static module (compiled into the server) or a dynamic module
(built as a dynamic library that must be installed into the
server using the INSTALL PLUGIN
statement or the --plugin-load
option before it can be used). Some plugins might not support
static or dynamic building.
The InnoDB
,
MyISAM
,
MERGE
,
MEMORY
, and
CSV
engines are mandatory (always
compiled into the server) and need not be installed explicitly.
To compile a storage engine statically into the server, use
-DWITH_
.
Some permissible engine
_STORAGE_ENGINE=1engine
values are
ARCHIVE
, BLACKHOLE
,
EXAMPLE
, FEDERATED
, and
PARTITION
(partitioning support). Examples:
-DWITH_ARCHIVE_STORAGE_ENGINE=1
-DWITH_BLACKHOLE_STORAGE_ENGINE=1
To build MySQL with support for NDB Cluster, use the
WITH_NDBCLUSTER
option.
WITH_NDBCLUSTER
is supported only when
building NDB Cluster using the NDB Cluster sources. It cannot
be used to enable clustering support in other MySQL source
trees or distributions. In NDB Cluster source distributions,
it is enabled by default. See
Section 21.3.1.4, “Building NDB Cluster from Source on Linux”, and
Section 21.3.2.2, “Compiling and Installing NDB Cluster from Source on Windows”, for
more information.
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_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
-DDISABLE_PSI_MUTEX=1
.
To exclude a storage engine from the build, use
-DWITH_
.
Examples:
engine
_STORAGE_ENGINE=0
-DWITH_EXAMPLE_STORAGE_ENGINE=0
-DWITH_FEDERATED_STORAGE_ENGINE=0
-DWITH_PARTITION_STORAGE_ENGINE=0
It is also possible to exclude a storage engine from the build
using
-DWITHOUT_
(but
engine
_STORAGE_ENGINE=1-DWITH_
is preferred). Examples:
engine
_STORAGE_ENGINE=0
-DWITHOUT_EXAMPLE_STORAGE_ENGINE=1
-DWITHOUT_FEDERATED_STORAGE_ENGINE=1
-DWITHOUT_PARTITION_STORAGE_ENGINE=1
If neither
-DWITH_
nor
engine
_STORAGE_ENGINE-DWITHOUT_
are specified for a given storage engine, the engine is built as
a shared module, or excluded if it cannot be built as a shared
module.
engine
_STORAGE_ENGINE
A descriptive comment about the compilation environment.
-DDEFAULT_CHARSET=
charset_name
The server character set. By default, MySQL uses the
latin1
(cp1252
West European) 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
,utf8
,utf8mb4
,utf16
,utf16le
,utf32
. The permissible character sets are listed in thecmake/character_sets.cmake
file as the value ofCHARSETS_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
latin1_swedish_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.Whether to exclude the Performance Schema condition instrumentation. The default is
OFF
(include).Whether to exclude the Performance Schema file instrumentation. The default is
OFF
(include).Whether to exclude the Performance Schema idle instrumentation. The default is
OFF
(include).Whether to exclude the Performance Schema memory instrumentation. The default is
OFF
(include).Whether to exclude the Performance Schema metadata instrumentation. The default is
OFF
(include).Whether to exclude the Performance Schema mutex instrumentation. The default is
OFF
(include).Whether to exclude the Performance Schema rwlock instrumentation. The default is
OFF
(include).Whether to exclude the Performance Schema socket instrumentation. The default is
OFF
(include).Whether to exclude the Performance Schema stored program instrumentation. The default is
OFF
(include).Whether to exclude the Performance Schema stage instrumentation. The default is
OFF
(include).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).Whether to exclude the Performance Schema table instrumentation. The default is
OFF
(include).Exclude the Performance Schema prepared statements instances instrumentation. The default is
OFF
(include).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).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.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.
Whether to include support for DTrace probes. For information about DTrace, wee Section 5.8.4, “Tracing mysqld Using DTrace”
This option is deprecated because support for DTrace is deprecated in MySQL 5.7 and is removed in MySQL 8.0.
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.
Whether to include gcov support (Linux only).
Whether to enable gprof (optimized Linux builds only).
This option controls the compiled-in default
LOCAL
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 with
ENABLED_LOCAL_INFILE
disabled. (Prior to MySQL 5.7.6, it was enabled by default.) 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), start mysqld with--local-infile
disabled or enabled, respectively.local_infile
can also be set at runtime. See Section 6.1.6, “Security Considerations for LOAD DATA LOCAL”.Whether to enable query profiling code (for the
SHOW PROFILE
andSHOW PROFILES
statements).-DFORCE_UNSUPPORTED_COMPILER=
bool
By default, CMake checks for minimum versions of supported compilers: Visual Studio 2013 (Windows); GCC 4.4 or Clang 3.3 (Linux); Developer Studio 12.5 (Solaris server); Developer Studio 12.2 or GCC 4.4 (Solaris client library); Clang 3.3 (macOS), Clang 3.3 (FreeBSD). To disable this check, use
-DFORCE_UNSUPPORTED_COMPILER=ON
.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
.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.
Whether to enable a MySQL maintainer-specific development environment. If enabled, this option causes compiler warnings to become errors.
The mutex type used by
InnoDB
. 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.
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.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.For Windows or macOS, the project name to incorporate into the project file name.
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.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.Whether to support optimizer tracing. See MySQL Internals: Tracing the Optimizer.
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 5.7.19.
Whether to disable function inlining on Windows. The default is
OFF
(inlining enabled).Whether to enable the AddressSanitizer, for compilers that support it. The default is
OFF
.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 and libraries causes CMake to produce an error, preventing the server from being built.
For information about LDAP authentication, see Section 6.4.1.9, “LDAP Pluggable Authentication”. This option was added in MySQL 5.7.19.
-DWITH_AUTHENTICATION_PAM=
bool
Whether to build the PAM authentication plugin, for source trees that include this plugin. (See Section 6.4.1.7, “PAM Pluggable Authentication”.) If this option is specified and the plugin cannot be compiled, the build fails.
The location of the Amazon Web Services software development kit.
This option was added in MySQL 5.7.19.
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=
specifies the Boost library directory location. It is also possible to specify the Boost location by setting thepath_name
BOOST_ROOT
orWITH_BOOST
environment variable.As of MySQL 5.7.11,
-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=
specifies whether to download the Boost source if it is not present in the specified location. The default isbool
OFF
.-DDOWNLOAD_BOOST_TIMEOUT=
the timeout in seconds for downloading the Boost library. The default is 600 seconds.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 Writing Protocol Trace Plugins.
See also the
WITH_TEST_TRACE_PLUGIN
option.The location of the
curl
library.curl_type
can besystem
(use the systemcurl
library) or a path name to thecurl
library.This option was added in MySQL 5.7.19.
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 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.As of MySQL 5.7.18, enabling
WITH_DEBUG
also enables Debug Sync. 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
.Which
libedit
/editline
library to use. The permitted values arebundled
(the default) andsystem
.WITH_EDITLINE
replacesWITH_LIBEDIT
, which has been removed.Whether to build the
libmysqld
embedded server library.NoteThe
libmysqld
embedded server library is deprecated as of MySQL 5.7.17 and has been removed in MySQL 8.0.-DWITH_EMBEDDED_SHARED_LIBRARY=
bool
Whether to build a shared
libmysqld
embedded server library.NoteThe
libmysqld
embedded server library is deprecated as of MySQL 5.7.17 and has been removed in MySQL 8.0.Which extra character sets to include:
all
: All character sets. This is the default.complex
: Complex character sets.none
: No extra character sets.
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 the
WITH_GMOCK
environment variable to the path name. It is also possible to use-DENABLE_DOWNLOADS=1
, in which case CMake downloads the distribution from GitHub.If you build MySQL without the Google Test unit tests (by configuring wihout
WITH_GMOCK
), CMake displays a message indicating how to download it.-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 whenWITH_DEBUG
is enabled.Whether to generate memcached shared libraries (
libmemcached.so
andinnodb_engine.so
).Whether to build the test program that accompanies the
keyring_file
plugin. The default isOFF
. Test file source code is located in theplugin/keyring/keyring-test
directory.This option was added in MySQL 5.7.11.
Internal use only. This option was added in MySQL 5.7.29.
Which
libevent
library to use. Permitted values arebundled
(default) andsystem
. Prior to MySQL 5.7.31, if you specifysystem
, the systemlibevent
library is used if present, and an error occurs otherwise. In MySQL 5.7.31 and later, ifsystem
is specified and no systemlibevent
library can be found, an error occurs regardless, and the bundledlibevent
is not used.The
libevent
library is required byInnoDB
memcached and X Plugin.Whether to include
libwrap
(TCP wrappers) support.The
WITH_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, the lz4_decompress utility is not built. In this case, the system lz4 command can be used instead.
-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, see Section 12.9.9, “MeCab Full-Text Parser Plugin”.
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.
Whether to enable Visual Studio CRT memory leak tracing. The default is
OFF
.Explicitly set the NUMA memory allocation policy. CMake sets the default
WITH_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.
This option was added in MySQL 5.7.17.
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.system
: Use the package installed on the system.
Other values are ignored, with a fallback to
bundled
.This option was added in MySQL 5.7.12.
Whether to build the rapid development cycle plugins. When enabled, a
rapid
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
. This option was added in MySQL 5.7.12.Internal use only. This option was added in MySQL 5.7.29.
-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:yes
: Use the system OpenSSL library if present, else the library bundled with the distribution.bundled
: Use the SSL library bundled with the distribution. This is the default prior to MySQL 5.7.28. As of 5.7.28, this is no longer a permitted value and the default issystem
.system
: Use the system OpenSSL library. This is the default as of MySQL 5.7.28.
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, see Section 2.8.6, “Configuring SSL Library Support”.
Whether to enable installation of systemd support files. By default, this option is disabled. When enabled, systemd support files are installed, and scripts such as mysqld_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.10, “Managing MySQL Server with systemd”. That section also includes information about specifying options otherwise specified in
[mysqld_safe]
option groups. Because mysqld_safe is not installed when systemd is used, such options must be specified another way.Whether to build the test protocol trace client plugin (see 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, 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; see Using the Test Protocol Trace Plugin.NoteDo 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 Writing Protocol Trace Plugins.
Whether to enable the Undefined Behavior Sanitizer, for compilers that support it. The default is off.
If enabled, compile MySQL with unit tests. The default is
ON
unless the server is not being compiled.Enables unixODBC support, for Connector/ODBC.
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.Some features require that the server be built with compression library support, such as the
COMPRESS()
andUNCOMPRESS()
functions, and compression of the client/server protocol. TheWITH_ZLIB
option indicates the source ofzlib
support:bundled
: Use thezlib
library bundled with the distribution. This is the default.system
: Use the systemzlib
library.
Flags for the C compiler.
Flags for the C++ compiler.
-DWITH_DEFAULT_COMPILER_OPTIONS=
bool
Whether to use the flags from
cmake/build_configurations/compiler_options.cmake
.NoteAll 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.
-DSUNPRO_CXX_LIBRARY="
"lib_name
Enable linking against
libCstd
instead ofstlport4
on Solaris 10 or later. This works only for client code because the server depends on C++98.
To specify your own C and C++ compiler flags, for flags that do
not affect optimization, use the
CMAKE_C_FLAGS
and
CMAKE_CXX_FLAGS
CMake options.
When providing your own compiler flags, you might want to
specify CMAKE_BUILD_TYPE
as well.
For example, to create a 32-bit release build on a 64-bit Linux machine, do this:
$> mkdir build
$> cd build
$> cmake .. -DCMAKE_C_FLAGS=-m32 \
-DCMAKE_CXX_FLAGS=-m32 \
-DCMAKE_BUILD_TYPE=RelWithDebInfo
If you set flags that affect optimization
(-O
), you must
set the
number
CMAKE_C_FLAGS_
and/or
build_type
CMAKE_CXX_FLAGS_
options, where build_type
build_type
corresponds
to the CMAKE_BUILD_TYPE
value. To
specify a different optimization for the default build type
(RelWithDebInfo
) set the
CMAKE_C_FLAGS_RELWITHDEBINFO
and
CMAKE_CXX_FLAGS_RELWITHDEBINFO
options. For
example, to compile on Linux with -O3
and with
debug symbols, do this:
$> cmake .. -DCMAKE_C_FLAGS_RELWITHDEBINFO="-O3 -g" \
-DCMAKE_CXX_FLAGS_RELWITHDEBINFO="-O3 -g"
The following options are for use when building NDB Cluster with the NDB Cluster sources; they are not currently supported when using sources from the MySQL 5.7 Server tree.
NDB
support for memcached was removed in NDB 7.5.21 and NDB 7.6.17; thus, this option is no longer supported for buildingNDB
in these or later versions.-DWITH_BUNDLED_LIBEVENT={ON|OFF}
NDB
support for memcached was removed in NDB 7.5.21 and NDB 7.6.17, and thus this option is no longer supported for buildingNDB
in these or later versions.-DWITH_BUNDLED_MEMCACHED={ON|OFF}
NDB
support for memcached was removed in NDB 7.5.21 and NDB 7.6.17, and thus this option is no longer supported for buildingNDB
in these or later versions.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.Enables error injection in the
NDB
kernel. For testing only; not intended for use in building production binaries. The default isOFF
.-DWITH_NDBAPI_EXAMPLES={ON|OFF}
Build NDB API example programs in
storage/ndb/ndbapi-examples/
. See NDB API Examples, for information about these.-DWITH_NDBCLUSTER_STORAGE_ENGINE={ON|OFF}
For internal use only; may not always work as expected. To build with
NDB
support, useWITH_NDBCLUSTER
instead.Build and link in support for the
NDB
storage engine in mysqld. The default isON
.Build the multithreaded data node executable ndbmtd. The default is
ON
.Enable binary logging by default in the mysqld built using this option.
ON
by default.Enable building the debug versions of the NDB Cluster binaries. This is
OFF
by default.Enable building NDB Cluster with Java support, including support for ClusterJ (see MySQL NDB Cluster Connector for Java).
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.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.If enabled, include a set of NDB API test programs. The default is
OFF
.