MySQL 5.5 Reference Manual Including MySQL NDB Cluster 7.2 Reference Guide

2.9.7 MySQL Source-Configuration Options

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.

CMake Option Reference

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.16 MySQL Source-Configuration Option Reference (CMake)

Formats Description Default Introduced Removed
BUILD_CONFIG Use same build options as official releases 5.5.7
CMAKE_BUILD_TYPE Type of build to produce RelWithDebInfo 5.5.7
CMAKE_CXX_FLAGS Flags for C++ Compiler
CMAKE_C_FLAGS Flags for C Compiler
CMAKE_INSTALL_PREFIX Installation base directory /usr/local/mysql 5.5.8
COMPILATION_COMMENT Comment about compilation environment 5.5.7
CPACK_MONOLITHIC_INSTALL Whether package build produces single file OFF 5.5.7
DEFAULT_CHARSET The default server character set latin1 5.5.7
DEFAULT_COLLATION The default server collation latin1_swedish_ci 5.5.7
ENABLED_PROFILING Whether to enable query profiling code ON 5.5.7
ENABLE_DEBUG_SYNC Whether to enable Debug Sync support ON 5.5.7 5.5.55
ENABLE_DOWNLOADS Whether to download optional files OFF 5.5.7
ENABLE_DTRACE Whether to include DTrace support 5.5.7
ENABLE_GCOV Whether to include gcov support 5.5.14
IGNORE_AIO_CHECK With -DBUILD_CONFIG=mysql_release, ignore libaio check OFF 5.5.9
INSTALL_BINDIR User executables directory PREFIX/bin 5.5.7
INSTALL_DOCDIR Documentation directory PREFIX/docs 5.5.7
INSTALL_INCLUDEDIR Header file directory PREFIX/include 5.5.7
INSTALL_INFODIR Info file directory PREFIX/docs 5.5.7
INSTALL_LAYOUT Select predefined installation layout STANDALONE 5.5.7
INSTALL_LIBDIR Library file directory PREFIX/lib 5.5.7
INSTALL_MANDIR Manual page directory PREFIX/man 5.5.7
INSTALL_MYSQLSHAREDIR Shared data directory PREFIX/share 5.5.7
INSTALL_MYSQLTESTDIR mysql-test directory PREFIX/mysql-test 5.5.7
INSTALL_PLUGINDIR Plugin directory PREFIX/lib/plugin 5.5.7
INSTALL_SBINDIR Server executable directory PREFIX/bin 5.5.7
INSTALL_SCRIPTDIR Scripts directory PREFIX/scripts 5.5.7
INSTALL_SECURE_FILE_PRIVDIR secure_file_priv default value platform specific 5.5.53
INSTALL_SECURE_FILE_PRIV_EMBEDDEDDIR secure_file_priv default value for libmysqld 5.5.53
INSTALL_SHAREDIR aclocal/mysql.m4 installation directory PREFIX/share 5.5.7
INSTALL_SQLBENCHDIR sql-bench directory PREFIX 5.5.7
INSTALL_SUPPORTFILESDIR Extra support files directory PREFIX/support-files 5.5.7
MEMCACHED_HOME Path to memcached [none] 5.5.16-ndb-7.2.2
MYSQL_DATADIR Data directory 5.5.7
MYSQL_MAINTAINER_MODE Whether to enable MySQL maintainer-specific development environment OFF 5.5.7
MYSQL_PROJECT_NAME Windows/OS X project name MySQL 5.5.21
MYSQL_TCP_PORT TCP/IP port number 3306 5.5.7
MYSQL_UNIX_ADDR Unix socket file /tmp/mysql.sock 5.5.7
ODBC_INCLUDES ODBC includes directory
ODBC_LIB_DIR ODBC library directory
REPRODUCIBLE_BUILD Take extra care to create a build result independent of build location and time 5.5.57
SYSCONFDIR Option file directory 5.5.7
TMPDIR tmpdir default value 5.5.36
WITHOUT_xxx_STORAGE_ENGINE Exclude storage engine xxx from build 5.5.7
WITH_ASAN Enable AddressSanitizer OFF 5.5.35
WITH_BUNDLED_LIBEVENT Use bundled libevent when building ndbmemcache ON 5.5.16-ndb-7.2.2
WITH_BUNDLED_MEMCACHED Use bundled memcached when building ndbmemcache ON 5.5.16-ndb-7.2.2
WITH_CLASSPATH Classpath to use when building MySQL Cluster Connector for Java. Default is an empty string.
WITH_DEBUG Whether to include debugging support OFF 5.5.7
WITH_EMBEDDED_SERVER Whether to build embedded server OFF 5.5.7
WITH_EMBEDDED_SHARED_LIBRARY Whether to build a shared embedded server library OFF 5.5.37
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 5.5.7
WITH_LIBEDIT Use bundled libedit library ON 5.5.7
WITH_LIBWRAP Whether to include libwrap (TCP wrappers) support OFF 5.5.7
WITH_NDBMTD Build multithreaded data node. 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 5.5.27-ndb-7.2.9
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_READLINE Use bundled readline library OFF 5.5.7
WITH_SSL Type of SSL support bundled 5.5.7
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 5.5.6
WITH_ZLIB Type of zlib support bundled 5.5.7
WITH_xxx_STORAGE_ENGINE Compile storage engine xxx statically into server 5.5.7

General Options

  • -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.


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


    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.

Installation Layout Options

The CMAKE_INSTALL_PREFIX option indicates the base installation directory. Other options with names of the form INSTALL_xxx that indicate component locations are interpreted relative to the prefix and their values are relative pathnames. Their values should not include the prefix.


    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.


    Where to install README files.


    Where to install header files.

  • -DINSTALL_INFODIR=dir_name

    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
  • -DINSTALL_LIBDIR=dir_name

    Where to install library files.

  • -DINSTALL_MANDIR=dir_name

    Where to install manual pages.


    Where to install shared data files.


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


    The location of the plugin directory.

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

  • -DINSTALL_SBINDIR=dir_name

    Where to install the mysqld server.


    Where to install mysql_install_db.


    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.7, “Server System Variables”.

    This option was added in MySQL 5.5.53. To set the value for the libmysqld embedded server, use INSTALL_SECURE_FILE_PRIV_EMBEDDEDDIR.


    The default value for the secure_file_priv system variable, for the libmysqld embedded server. This option was added in MySQL 5.5.53.


    Where to install aclocal/mysql.m4.


    Where to install the sql-bench directory. To suppress installation of this directory, explicitly set the option to the empty value (-DINSTALL_SQLBENCHDIR=).


    Where to install extra support files.

  • -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.

  • -DTMPDIR=dir_name

    The default location to use for the tmpdir system variable. If unspecified, the value defaults to P_tmpdir in <stdio.h>. This option was added in MySQL 5.6.16.

Storage Engine Options

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_engine_STORAGE_ENGINE=1. Some permissible engine values are ARCHIVE, BLACKHOLE, EXAMPLE, FEDERATED, NDBCLUSTER (NDB), PARTITION (partitioning support), and PERFSCHEMA (Performance Schema). Examples:


WITH_NDBCLUSTER_STORAGE_ENGINE 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 MySQL NDB Cluster 7.2 source distributions, it is enabled by default. See Section, “Building NDB Cluster from Source on Linux”, and Section, “Compiling and Installing NDB Cluster from Source on Windows”, for more information.

To exclude a storage engine from the build, use -DWITHOUT_engine_STORAGE_ENGINE=1. Examples:


If neither -DWITH_engine_STORAGE_ENGINE nor -DWITHOUT_engine_STORAGE_ENGINE 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.

Feature Options


    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 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, 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 latin1_swedish_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.



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

    Whether to compile the Debug Sync facility into the server. This facility is used for testing and debugging. This option is enabled by default, but has no effect unless MySQL is configured with debugging enabled. If debugging is enabled and you want to disable Debug Sync, use -DENABLE_DEBUG_SYNC=0.

    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.) N becomes the default timeout for individual synchronization points.

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


    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, “Tracing mysqld Using DTrace”

  • -DENABLE_GCOV=bool

    Whether to include gcov support (Linux only).


    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 enabled. If you compile MySQL from source, configure it with ENABLED_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”.


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


    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.


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


    For Windows or macOS, the project name to incorporate into the project file name. This option was added in MySQL 5.5.21.

  • -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.


    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.5.55.

  • -DWITH_ASAN=bool

    Whether to enable AddressSanitizer, for compilers that support it. The default is off. This option was added in MySQL 5.5.35.

  • -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.

    As of MySQL 5.5.55, 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.


    Whether to build the libmysqld embedded server library.


    Whether to build a shared libmysqld embedded server library. This option was added in MySQL 5.5.37.


    Which extra character sets to include:

    • all: All character sets. This is the default.

    • complex: Complex character sets.

    • none: No extra character sets.


    Whether to use the libedit library bundled with the distribution.


    Whether to include libwrap (TCP wrappers) support.


    Whether to use the readline library bundled with the distribution.

  • -DWITH_SSL=ssl_type

    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:

    • no: No SSL support. This is the default before MySQL 5.5.56. As of 5.5.56, this is no longer a permitted value and the default is bundled.

    • 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 as of MySQL 5.5.56.

    • system: Use the system OpenSSL library.

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


    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.

  • -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.

Compiler Flags

  • -DCMAKE_C_FLAGS="flags"

    Flags for the C Compiler.

  • -DCMAKE_CXX_FLAGS="flags"

    Flags for the C++ Compiler.

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 bld
cd bld
cmake .. -DCMAKE_C_FLAGS=-m32 \

If you set flags that affect optimization (-Onumber), you must set the CMAKE_C_FLAGS_build_type and/or CMAKE_CXX_FLAGS_build_type options, where 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 Options for Compiling NDB Cluster

The following options are for use when building MySQL NDB Cluster 7.2 or later. These options are supported only with the MySQL NDB Cluster 7.2 and later NDB Cluster sources; they are not supported when using sources from the MySQL 5.5 Server tree.

  • -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).

    This option was added in MySQL NDB Cluster 7.2.2.

    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.


    Use the libevent included in the NDB Cluster sources when building NDB Cluster with ndbmemcached support (MySQL NDB Cluster 7.2.2 and later). Enabled by default. OFF causes the system's libevent to be used instead.


    Build the memcached sources included in the NDB Cluster source tree (MySQL NDB Cluster 7.2.3 and later), 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 in the installation lib directory.

    This option is ON by default.


    Sets the classpath for building NDB Cluster Connector for Java. The default is empty. In MySQL NDB Cluster 7.2.9 and later, 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 is OFF.


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


    This is an alias for WITH_NDBCLUSTER_STORAGE_ENGINE.


    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. OFF by default.


    Enable building NDB Cluster with Java support, including ClusterJ.

    This option was added in MySQL NDB Cluster 7.2.9, and 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.


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