2.9.4. 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:

shell> cmake . -LHshell> ccmake .

You can also affect CMake using certain environment variables. See Section 2.12, "Environment Variables".

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.13. 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_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`
`ENABLE_DEBUG_SYNC`	Whether to enable Debug Sync support	`ON`
`ENABLE_DOWNLOADS`	Whether to download optional files	`OFF`
`ENABLE_DTRACE`	Whether to include DTrace support
`ENABLE_GCOV`	Whether to include gcov support		5.6.3
`ENABLE_GPROF`	Enable gprof (optimized Linux builds only)	`OFF`	5.6.6
`ENABLED_LOCAL_INFILE`	Whether to enable LOCAL for LOAD DATA INFILE	`OFF`
`ENABLED_PROFILING`	Whether to enable query profiling code	`ON`
`IGNORE_AIO_CHECK`	With -DBUILD_CONFIG=mysql_release, ignore libaio check	`OFF`	5.6.1
`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_MYSQLSHAREDIR`	Shared data directory	`PREFIX/share`
`INSTALL_MYSQLTESTDIR`	mysql-test directory	`PREFIX/mysql-test`
`INSTALL_PLUGINDIR`	Plugin directory	`PREFIX/lib/plugin`
`INSTALL_SBINDIR`	Server executable directory	`PREFIX/bin`
`INSTALL_SCRIPTDIR`	Scripts directory	`PREFIX/scripts`
`INSTALL_SHAREDIR`	aclocal/mysql.m4 installation directory	`PREFIX/share`
`INSTALL_SQLBENCHDIR`	sql-bench directory	`PREFIX`
`INSTALL_SUPPORTFILESDIR`	Extra support files directory	`PREFIX/support-files`
`MEMCACHED_HOME`	Path to memcached	`[none]`
`MYSQL_DATADIR`	Data directory
`MYSQL_MAINTAINER_MODE`	Whether to enable MySQL maintainer-specific development environment	`OFF`
`MYSQL_PROJECT_NAME`	Windows/Mac OS X project name	`3306`	5.6.5
`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		5.6.3
`SYSCONFDIR`	Option file directory
`WITH_BUNDLED_LIBEVENT`	Use bundled libevent when building ndbmemcache	`ON`
`WITH_BUNDLED_MEMCACHED`	Use bundled memcached when building ndbmemcache	`ON`
`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`
`WITH_DEFAULT_COMPILER_OPTIONS`	Whether to use default compiler options	`ON`	5.6.6
`WITH_DEFAULT_FEATURE_SET`	Whether to use default feature set	`ON`	5.6.6
`WITH_EDITLINE`	Which libedit/editline library to use	`bundled`	5.6.12
`WITH_EMBEDDED_SERVER`	Whether to build embedded server	`OFF`
`WITH_xxx_STORAGE_ENGINE`	Compile storage engine xxx statically into server
`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_INNODB_MEMCACHED`	Whether to generate memcached shared libraries.	`OFF`
`WITH_LIBEDIT`	Use bundled libedit library	`ON`		5.6.12
`WITH_LIBWRAP`	Whether to include libwrap (TCP wrappers) support	`OFF`
`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_NDBCLUSTER_STORAGE_ENGINE`	Build the NDB storage engine	`ON`
`WITH_NDBMTD`	Build multi-threaded data node.	`ON`
`WITH_READLINE`	Use bundled readline library	`OFF`		5.6.5
`WITH_SSL`	Type of SSL support	`no`
`WITH_UNIXODBC`	Enable unixODBC support	`OFF`
`WITH_ZLIB`	Type of zlib support	`system`
`WITHOUT_xxx_STORAGE_ENGINE`	Exclude storage engine xxx from build

The following sections provide more information about CMake options.

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.

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.
-DCMAKE_BUILD_TYPE=type

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

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.

-DCMAKE_INSTALL_PREFIX=dir_name

The installation base directory.

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

Where to install user programs.
-DINSTALL_DOCDIR=dir_name

Where to install documentation.
-DINSTALL_DOCREADMEDIR=dir_name

Where to install README files.
-DINSTALL_INCLUDEDIR=dir_name

Where to install header files.
-DINSTALL_INFODIR=dir_name

Where to install Info files.
-DINSTALL_LAYOUT=name

Select a predefined installation layout:
- STANDALONE: Same layout as used for .tar.gz and .zip packages. This is the default.
- RPM: Layout similar to RPM packages.
- SVR4: Solaris package layout.
- DEB: DEB package layout (experimental).
You can select a predefined layout but modify individual component installation locations by specifying other options. For example:
```
shell> 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.
-DINSTALL_MYSQLSHAREDIR=dir_name

Where to install shared data files.
-DINSTALL_MYSQLTESTDIR=dir_name

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

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.
-DINSTALL_SCRIPTDIR=dir_name

Where to install mysql_install_db.
-DINSTALL_SHAREDIR=dir_name

Where to install aclocal/mysql.m4.
-DINSTALL_SQLBENCHDIR=dir_name

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

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.
-DOPTIMIZER_TRACE=bool

Whether to support optimizer tracing. See MySQL Internals: Tracing the Optimizer. This option was added in MySQL 5.6.3.
-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.
-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.

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 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, INNOBASE (InnoDB), NDB or NDBCLUSTER (NDB), PARTITION (partitioning support), and PERFSCHEMA (Performance Schema). Examples:

-DWITH_INNOBASE_STORAGE_ENGINE=1-DWITH_ARCHIVE_STORAGE_ENGINE=1-DWITH_BLACKHOLE_STORAGE_ENGINE=1-DWITH_PERFSCHEMA_STORAGE_ENGINE=1

Note

WITH_NDBCLUSTER_STORAGE_ENGINE is supported only when building MySQL Cluster using the MySQL Cluster sources. It cannot be used to enable clustering support in other MySQL source trees or distributions. In MySQL Cluster NDB 7.3 source distributions, it is enabled by default. See Section 17.2.2.3, "Building MySQL Cluster from Source on Linux", and Section 17.2.3.2, "Compiling and Installing MySQL Cluster from Source on Windows", for more information.

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

-DWITHOUT_EXAMPLE_STORAGE_ENGINE=1-DWITHOUT_FEDERATED_STORAGE_ENGINE=1-DWITHOUT_PARTITION_STORAGE_ENGINE=1

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

-DCOMPILATION_COMMENT=string

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, utf16le, utf32. The permissible character sets are listed in the cmake/character_sets.cmake file as the value of CHARSETS_AVAILABLE.

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

The server collation. By default, MySQL uses 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.
-DENABLE_DEBUG_SYNC=bool

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.
-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.
-DENABLE_DTRACE=bool

Whether to include support for DTrace probes. For information about DTrace, wee Section 5.7, "Tracing mysqld Using DTrace"
-DENABLE_GCOV=bool

Whether to include gcov support (Linux only).
-DENABLE_GPROF=bool

Whether to enable gprof (optimized Linux builds only). This option was added in MySQL 5.6.6.
-DENABLED_LOCAL_INFILE=bool

Whether to enable LOCAL capability in the client library for LOAD DATA INFILE.

This option controls client-side LOCAL capability, but the capability can be set on the server side at server startup with the --local-infile option. See Section 6.1.6, "Security Issues with LOAD DATA LOCAL".
-DENABLED_PROFILING=bool

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

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

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

For Windows or Mac OS X, the project name to incorporate into the project file name. This option was added in MySQL 5.6.5.
-DMYSQL_TCP_PORT=port_num

The port number on 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.
-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.
-DWITH_DEFAULT_COMPILER_OPTIONS=bool

Whether to use the flags from cmake/build_configurations/compiler_options.cmake. This option was added in MySQL 5.6.6.
-DWITH_DEFAULT_FEATURE_SET=bool

Whether to use the flags from cmake/build_configurations/feature_set.cmake. This option was added in MySQL 5.6.6.
-DWITH_EDITLINE=value

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

WITH_EDITLINE was added in MySQL 5.6.12. It replaces WITH_LIBEDIT, which has been removed.
-DWITH_EMBEDDED_SERVER=bool

Whether to build the libmysqld embedded server library.
-DWITH_EXTRA_CHARSETS=name

Which extra character sets to include:
- all: All character sets. This is the default.
- complex: Complex character sets.
- none: No extra character sets.
-DWITH_INNODB_MEMCACHED=bool

Whether to generate memcached shared libraries (libmemcached.so and innodb_engine.so).
-DWITH_LIBEDIT=bool

Whether to use the libedit library bundled with the distribution.

WITH_LIBEDIT was removed in MySQL 5.6.12. Use WITH_EDITLINE instead.
-DWITH_LIBWRAP=bool

Whether to include libwrap (TCP wrappers) support.
-DWITH_READLINE=bool

Whether to use the readline library bundled with the distribution. This option was removed in MySQL 5.6.5 because readline is no longer bundled.
-DWITH_SSL={ssl_type|path_name}
The type of SSL support to include (if any) or the path name to the OpenSSL installation to use.
- ssl_type can be one of the following values:
  - no: No SSL support. This is the default before MySQL 5.6.6. As of 5.6.6, this is no longer a permitted value and the default is bundled.
  - yes: Use the system SSL 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.6.6.
  - system: Use the system SSL library.
- path_name, permitted for MySQL 5.6.7 and after, is the path name to the OpenSSL installation to use. Using this can be preferable to using the ssl_type value of system, for it can prevent CMake from detecting and using an older or incorrect OpenSSL version installed on the system. (Another permitted way to do the same thing is to set the CMAKE_PREFIX_PATH option to path_name.)
For information about using SSL support, see Section 6.3.9, "Using SSL for Secure Connections".
-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.
- system: Use the system zlib library. This is the default.
-DWITH_UNIXODBC=1

Enables unixODBC support, for Connector/ODBC.

Compiler Flags

To specify compiler flags, set the CFLAGS and CXXFLAGS environment variables before running CMake. Example:

shell> CFLAGS=-DHAVE_EMBEDDED_PRIVILEGE_CONTROLshell> CXXFLAGS=-DHAVE_EMBEDDED_PRIVILEGE_CONTROLshell> export CFLAGS CXXFLAGSshell> cmake
        [options]

The following flags control configuration features:

HAVE_EMBEDDED_PRIVILEGE_CONTROL

By default, authentication for connections to the embedded server is disabled. To enable connection authentication, define this flag.

CMake Options for Compiling MySQL Cluster

The following options are for use when building MySQL Cluster with the MySQL Cluster sources; they are not currently supported when using sources from the MySQL 5.6 Server tree.

-DMEMCACHED_HOME=path

Perform the build using the memcached (version 1.6 or later) installed in the system directory indicated by path. 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 Cluster NDB 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 MySQL Cluster.
-DWITH_BUNDLED_LIBEVENT={ON|OFF}

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

Build the memcached sources included in the MySQL Cluster source tree (MySQL Cluster NDB 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 object file ndb_engine.so in the installation lib directory.

This option is ON by default.
-DWITH_CLASSPATH=path

Sets the classpath for building MySQL Cluster Connector for Java. Default is empty. In MySQL Cluster NDB 7.2.9 and later, this option is ignored if -DWITH_NDB_JAVA=OFF is used.
-DWITH_ERROR_INSERT={ON|OFF}

Enables error injection in the NDB kernel. For testing only; not intended for use in building production binaries. Default is OFF.
-DWITH_NDBCLUSTER_STORAGE_ENGINE={ON|OFF}

Build and link in support for the NDB (NDBCLUSTER) storage engine in mysqld. Default is ON.
-DWITH_NDBCLUSTER={ON|OFF}

This is an alias for WITH_NDBCLUSTER_STORAGE_ENGINE.
-DWITH_NDBMTD={ON|OFF}

Build the multithreaded data node executable ndbmtd. Default is ON.
-DWITH_NDB_BINLOG={ON|OFF}

Enable binary logging by default in the mysqld built using this option. ON by default.
-DWITH_NDB_DEBUG={ON|OFF}

Enable building the debug versions of the MySQL Cluster binaries. OFF by default.
-DWITH_NDB_JAVA={ON|OFF}

Enable building MySQL Cluster with Java support, including ClusterJ.

This option was added in MySQL Cluster NDB 7.2.9, and is ON by default. If you do not wish to compile MySQL 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 MySQL Cluster management server (ndb_mgmd) that is built to use this port by default. If this option is unset, the resulting management server tries to use port 1186 by default.
-DWITH_NDB_TEST={ON|OFF}

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