2.8.7 MySQL Source-Configuration Options

Skip to Main Content

MySQL 8.4 Reference Manual Including MySQL NDB Cluster 8.4

2.8.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 6.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
• General Options
• Installation Layout Options
• Storage Engine Options
• Feature Options
• Compiler Flags
• CMake Options for Compiling NDB Cluster

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

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

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

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

The option values None and MinSizeRel are not supported. - -DCPACK_MONOLITHIC_INSTALL=bool

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

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

Defines whether to enable colorized compiler output for gcc and clang when compiling on the command line. Defaults to OFF.

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 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 install README files. - -DINSTALL_INCLUDEDIR=dir_name

Where to install header files. - -DINSTALL_INFODIR=dir_name

Where to install Info files. - -DINSTALL_LAYOUT=name

Select a predefined installation layout:

• STANDALONE: Same layout as used for .tar.gz and .zip packages. This is the default.
• RPM: Layout similar to RPM packages.
• SVR4: Solaris package layout.
• DEB: DEB package layout (experimental).

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

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

The INSTALL_LAYOUT value determines the default value of the secure_file_priv system variable. See the description of this variable in Section 7.1.8, “Server System Variables”. - -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. To suppress installation of this directory, explicitly set the option to the empty value (-DINSTALL_MYSQLTESTDIR=). - -DINSTALL_PKGCONFIGDIR=dir_name

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

The location of the plugin directory.

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

The location of the dynamic library directory.

Default location. For RPM builds, this is /usr/lib64/mysql/private/, for DEB it is /usr/lib/mysql/private/, and for TAR it is lib/private/.

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

Where to install the mysqld server. - -DINSTALL_SECURE_FILE_PRIVDIR=dir_name

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

Where to install aclocal/mysql.m4. - -DINSTALL_STATIC_LIBRARIES=bool

Whether to install static libraries. The default is ON. If set to OFF, these 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 the mysqld binary. The default is OFF. This option should be enabled only for debugging purp

（本文超出站点单文档体积上限，已截断）