MySQL 源配置选项

MySQL 源配置选项

CMake程序提供了对如何配置 MySQL 源代码分发的大量控制。通常，您可以使用 CMake命令行上的选项来执行此操作。有关CMake支持的选项的信息，请在顶级源目录中运行以下命令之一：

$> cmake . -LH
$> ccmake .

您还可以使用某些环境变量影响CMake 。请参见 第 6.9 节“环境变量”。

对于布尔选项，可以将该值指定为 1或ON来启用该选项，或者指定为0或OFF来禁用该选项。

许多选项配置编译时默认值，可以在服务器启动时覆盖这些默认值。例如， CMAKE_INSTALL_PREFIX配置 默认安装基目录位置、TCP/IP 端口号和 Unix 套接字文件的 、 和MYSQL_TCP_PORT选项 可以在服务器启动时使用mysqld 的、 和 选项 进行更改。在适用的情况下，配置选项描述指示相应的mysqld 启动选项。 MYSQL_UNIX_ADDR--basedir--port--socket

以下部分提供有关 CMake选项的更多信息。

• CMake 选项参考

• 常规选项

• 安装布局选项

• 存储引擎选项

• 功能选项

• 编译器标志

• 用于编译 NDB Cluster 的 CMake 选项

CMake 选项参考

下表显示了可用的CMake 选项。其中Default， PREFIX代表 CMAKE_INSTALL_PREFIX选项的值，指定安装基目录。该值用作多个安装子目录的父位置。

表 2.13 MySQL 源配置选项参考 (CMake)

常规选项

• -DBUILD_CONFIG=mysql_release

  此选项使用与 Oracle 用于生成官方 MySQL 版本的二进制发行版相同的构建选项来配置源发行版。

• -DWITH_BUILD_ID=bool

  在 Linux 系统上，生成一个唯一的构建 ID，用作 build_id系统变量的值并在启动时写入 MySQL 服务器日志。将此选项设置为OFF禁用此功能。

  该选项对 Linux 以外的平台没有影响。

• -DBUNDLE_RUNTIME_LIBRARIES=bool

  是否将运行时库与 Windows 的服务器 MSI 和 Zip 包捆绑在一起。

• -DCMAKE_BUILD_TYPE=type

  要生成的构建类型：

  不支持 选项值None和 。MinSizeRel

• RelWithDebInfo：启用优化并生成调试信息。这是默认的 MySQL 构建类型。

• Release：启用优化但省略调试信息以减少构建大小。

• Debug：禁用优化并生成调试信息。如果WITH_DEBUG 启用该选项，也会使用此构建类型。即与 -DWITH_DEBUG=1具有相同的效果 -DCMAKE_BUILD_TYPE=Debug。

• -DCPACK_MONOLITHIC_INSTALL=bool

  该选项影响make package操作是生成多个安装包文件还是单个文件。如果禁用，该操作会生成多个安装包文件，如果您只想安装完整 MySQL 安装的子集，这可能很有用。如果启用，它会生成一个用于安装所有内容的文件。

• -DFORCE_INSOURCE_BUILD=bool

  定义是否强制进行源内构建。建议使用源外构建，因为它们允许来自同一源的多个构建，并且可以通过删除构建目录来快速执行清理。要强制进行源内构建，请 使用-DFORCE_INSOURCE_BUILD=ON.

• -DFORCE_COLORED_OUTPUT=bool

  定义在命令行编译时 是否启用 gcc和clang的彩色编译器输出。默认为 OFF.

安装布局选项

该CMAKE_INSTALL_PREFIX选项指示基本安装目录。名称形式 指示组件位置的其他选项是相对于前缀进行解释的，它们的值是相对路径名。它们的值不应包含前缀。 INSTALL_xxx

• -DCMAKE_INSTALL_PREFIX=dir_name

  安装基目录。

  可以在服务器启动时使用该选项设置该值 --basedir。

• -DINSTALL_BINDIR=dir_name

  安装用户程序的位置。

• -DINSTALL_DOCDIR=dir_name

  在哪里安装文档。

• -DINSTALL_DOCREADMEDIR=dir_name

  安装文件的位置README。

• -DINSTALL_INCLUDEDIR=dir_name

  安装头文件的位置。

• -DINSTALL_INFODIR=dir_name

  安装信息文件的位置。

• -DINSTALL_LAYOUT=name

  选择预定义的安装布局：

  您可以选择预定义的布局，但可以通过指定其他选项来修改各个组件的安装位置。例如：

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

  该值决定、 和 系统变量INSTALL_LAYOUT的默认值 。请参阅第 7.1.8 节“服务器系统变量”和 第 8.4.4.19 节“密钥环系统变量”中对这些变量的描述 。 secure_file_privkeyring_encrypted_file_datakeyring_file_data

• STANDALONE：与 .tar.gz和 .zip包使用的布局相同。这是默认设置。

• RPM：布局类似于 RPM 包。

• SVR4：Solaris 软件包布局。

• DEB：DEB 包布局（实验性）。

• -DINSTALL_LIBDIR=dir_name

  安装库文件的位置。

• -DINSTALL_MANDIR=dir_name

  安装手册页的位置。

• -DINSTALL_MYSQLKEYRINGDIR=dir_path

  用作 keyring_file插件数据文件位置的默认目录。默认值是特定于平台的，并且取决于CMake选项的值；请参阅第 7.1.8 节“服务器系统变量”中系统变量的描述 。 INSTALL_LAYOUT keyring_file_data

• -DINSTALL_MYSQLSHAREDIR=dir_name

  在哪里安装共享数据文件。

• -DINSTALL_MYSQLTESTDIR=dir_name

  安装目录在哪里mysql-test 。要禁止安装此目录，请显式将该选项设置为空值 ( -DINSTALL_MYSQLTESTDIR=)。

• -DINSTALL_PKGCONFIGDIR=dir_name

  安装pkg-configmysqlclient.pc使用的文件 的目录 。默认值为 ，除非 以 结尾 ，在这种情况下首先将其删除。 INSTALL_LIBDIR/pkgconfigINSTALL_LIBDIR/mysql

• -DINSTALL_PLUGINDIR=dir_name

  插件目录的位置。

  可以在服务器启动时使用该选项设置该值 --plugin_dir。

• -DINSTALL_PRIV_LIBDIR=dir_name

  动态库目录的位置。

  默认位置。  对于 RPM 版本，这是 /usr/lib64/mysql/private/，对于 DEB 是/usr/lib/mysql/private/，对于 TAR 是lib/private/。

  原型缓冲区。  由于这是私有位置，因此加载程序（例如 ld-linux.so在 Linux 上）在没有帮助的情况下可能找不到libprotobuf.so文件。为了引导加载程序， RPATH=$ORIGIN/../$INSTALL_PRIV_LIBDIR 添加到mysqld和 mysqlxtest。这适用于大多数情况，但当使用 资源组 功能时，mysqld是 setsuid，并且加载程序会忽略任何 RPATH包含 $ORIGIN.为了克服这个问题，在mysqld的 DEB 和 RPM 版本中设置了目录的显式完整路径，因为目标目的地是已知的。对于 tarball 安装，需要使用 patchelf等工具 修补 mysqld 。

• -DINSTALL_SBINDIR=dir_name

  在哪里安装mysqld服务器。

• -DINSTALL_SECURE_FILE_PRIVDIR=dir_name

  系统变量的默认值 secure_file_priv。默认值是特定于平台的，并且取决于CMake选项的值 ；请参阅第 7.1.8 节“服务器系统变量”中系统变量的描述 。 INSTALL_LAYOUT secure_file_priv

• -DINSTALL_SHAREDIR=dir_name

  在哪里安装aclocal/mysql.m4。

• -DINSTALL_STATIC_LIBRARIES=bool

  是否安装静态库。默认为 ON.如果设置为OFF，则不会安装这些库文件： libmysqlclient.a、 libmysqlservices.a。

• -DINSTALL_SUPPORTFILESDIR=dir_name

  在哪里安装额外的支持文件。

• -DLINK_RANDOMIZE=bool

  是否随机化mysqld二进制文件 中符号的顺序 。默认为 OFF.仅应出于调试目的启用此选项。

• -DLINK_RANDOMIZE_SEED=val

  期权的种子值 LINK_RANDOMIZE。该值是一个字符串。默认值为mysql，任意选择。

• -DMYSQL_DATADIR=dir_name

  MySQL 数据目录的位置。

  可以在服务器启动时使用该选项设置该值 --datadir。

• -DODBC_INCLUDES=dir_name

  ODBC 的位置包括目录，在配置 Connector/ODBC 时可以使用该目录。

• -DODBC_LIB_DIR=dir_name

  ODBC 库目录的位置，在配置 Connector/ODBC 时可能会使用该目录。

• -DSYSCONFDIR=dir_name

  默认my.cnf选项文件目录。

  该位置无法在服务器启动时设置，但您可以使用 选项通过给定选项文件启动服务器 ，其中是文件的完整路径名。 --defaults-file=file_namefile_name

• -DSYSTEMD_PID_DIR=dir_name

  MySQL由systemd管理时创建PID文件的目录名。默认为 /var/run/mysqld；这可能会根据 INSTALL_LAYOUT值隐式更改。

  WITH_SYSTEMD除非启用， 否则该选项将被忽略 。

• -DSYSTEMD_SERVICE_NAME=name

  当 MySQL 由systemd 管理时要使用的 MySQL 服务的名称。默认为 mysqld；这可能会根据 INSTALL_LAYOUT值隐式更改。

  WITH_SYSTEMD除非启用， 否则该选项将被忽略 。

• -DTMPDIR=dir_name

  用于 tmpdir系统变量的默认位置。如果未指定，则该值默认为 P_tmpdirin <stdio.h>。

存储引擎选项

存储引擎是作为插件构建的。您可以将插件构建为静态模块（编译到服务器中）或动态模块（构建为动态库，必须使用INSTALL PLUGIN 语句或选项将其安装到服务器中--plugin-load 才能使用）。某些插件可能不支持静态或动态构建。

InnoDB、 MyISAM、 MERGE、 MEMORY和 引擎CSV是强制性的（始终编译到服务器中）并且不需要显式安装。

要将存储引擎静态编译到服务器中，请使用 .一些允许的值为 、、 和。例子： -DWITH_engine_STORAGE_ENGINE=1engineARCHIVEBLACKHOLEEXAMPLEFEDERATED

-DWITH_ARCHIVE_STORAGE_ENGINE=1-DWITH_BLACKHOLE_STORAGE_ENGINE=1

要构建支持 NDB Cluster 的 MySQL，请使用该 WITH_NDB选项。

笔记

如果没有性能模式支持，则无法进行编译。如果希望在不使用特定类型的工具的情况下进行编译，可以使用以下 CMake选项来完成：

DISABLE_PSI_CONDDISABLE_PSI_DATA_LOCKDISABLE_PSI_ERRORDISABLE_PSI_FILEDISABLE_PSI_IDLEDISABLE_PSI_MEMORYDISABLE_PSI_METADATADISABLE_PSI_MUTEXDISABLE_PSI_PSDISABLE_PSI_RWLOCKDISABLE_PSI_SOCKETDISABLE_PSI_SPDISABLE_PSI_STAGEDISABLE_PSI_STATEMENTDISABLE_PSI_STATEMENT_DIGESTDISABLE_PSI_TABLEDISABLE_PSI_THREADDISABLE_PSI_TRANSACTION

例如，要在不使用互斥量检测的情况下进行编译，请使用 -DDISABLE_PSI_MUTEX=1.

要从构建中排除存储引擎，请使用 .例子： -DWITH_engine_STORAGE_ENGINE=0

-DWITH_ARCHIVE_STORAGE_ENGINE=0-DWITH_EXAMPLE_STORAGE_ENGINE=0-DWITH_FEDERATED_STORAGE_ENGINE=0

也可以从构建中排除存储引擎 （但这 是首选）。例子： -DWITHOUT_engine_STORAGE_ENGINE=1-DWITH_engine_STORAGE_ENGINE=0

-DWITHOUT_ARCHIVE_STORAGE_ENGINE=1-DWITHOUT_EXAMPLE_STORAGE_ENGINE=1-DWITHOUT_FEDERATED_STORAGE_ENGINE=1

如果给定存储引擎既没有 指定 也没有 指定，则该引擎将构建为共享模块，如果不能构建为共享模块则将其排除。 -DWITH_engine_STORAGE_ENGINE-DWITHOUT_engine_STORAGE_ENGINE

功能选项

• -DADD_GDB_INDEX=bool

  此选项确定是否启用 .gdb_index二进制文件中的节的生成，这使得将它们更快地加载到调试器中。默认情况下该选项处于禁用状态。使用lld链接器，并通过 禁用它。如果使用 lld或 GNU gold以外的链接器，则无效 。

• -DCOMPILATION_COMMENT=string

  关于编译环境的描述性注释。当mysqld使用 时COMPILATION_COMMENT_SERVER，其他程序也使用 COMPILATION_COMMENT.

• -DCOMPRESS_DEBUG_SECTIONS=bool

  是否压缩二进制可执行文件的调试部分（仅限 Linux）。压缩可执行调试部分可以节省空间，但代价是在构建过程中需要额外的 CPU 时间。

  默认为OFF.如果未显式设置此选项但 COMPRESS_DEBUG_SECTIONS设置了环境变量，则该选项将从该变量获取其值。

• -DCOMPILATION_COMMENT_SERVER=string

  关于mysqld使用的编译环境的描述性注释（例如，设置 version_comment系统变量）。服务器以外的程序使用 COMPILATION_COMMENT。

• -DDEFAULT_CHARSET=charset_name

  服务器字符集。默认情况下，MySQL 使用该 utf8mb4字符集。

  charset_name可以 是以下之一 binary：armscii8,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, 。asciibig5cp1250cp1251cp1256cp1257cp850cp852cp866cp932dec8eucjpmseuckrgb2312gbkgeostd8greekhebrewhp8keybcs2koi8rkoi8ulatin1latin2latin5latin7maccemacromansjisswe7tis620ucs2ujisutf8mb3utf8mb4utf16utf16leutf32

  可以在服务器启动时使用该选项设置该值 --character-set-server 。

• -DDEFAULT_COLLATION=collation_name

  服务器排序规则。默认情况下，MySQL 使用 utf8mb4_0900_ai_ci.使用该 SHOW COLLATION语句确定每个字符集可用的排序规则。

  可以在服务器启动时使用该选项设置该值 --collation_server。

• -DDISABLE_PSI_COND=bool

  是否排除性能模式条件检测。默认为OFF （包含）。

• -DDISABLE_PSI_FILE=bool

  是否排除性能架构文件检测。默认为OFF （包含）。

• -DDISABLE_PSI_IDLE=bool

  是否排除性能模式空闲检测。默认为OFF （包含）。

• -DDISABLE_PSI_MEMORY=bool

  是否排除性能模式内存检测。默认为OFF （包含）。

• -DDISABLE_PSI_METADATA=bool

  是否排除性能模式元数据检测。默认为OFF （包含）。

• -DDISABLE_PSI_MUTEX=bool

  是否排除性能模式互斥检测。默认为OFF （包含）。

• -DDISABLE_PSI_RWLOCK=bool

  是否排除性能架构 rwlock 检测。默认为OFF （包含）。

• -DDISABLE_PSI_SOCKET=bool

  是否排除性能模式套接字检测。默认为OFF （包含）。

• -DDISABLE_PSI_SP=bool

  是否排除性能模式存储的程序检测。默认为OFF （包含）。

• -DDISABLE_PSI_STAGE=bool

  是否排除 Performance Schema 阶段检测。默认为OFF （包含）。

• -DDISABLE_PSI_STATEMENT=bool

  是否排除 Performance Schema 语句检测。默认为OFF （包含）。

• -DDISABLE_PSI_STATEMENT_DIGEST=bool

  是否排除性能模式语句摘要检测。默认为OFF （包含）。

• -DDISABLE_PSI_TABLE=bool

  是否排除性能模式表检测。默认为OFF （包含）。

• -DDISABLE_PSI_PS=bool

  排除性能模式准备好的语句实例检测。默认为OFF （包含）。

• -DDISABLE_PSI_THREAD=bool

  排除性能模式线程检测。默认为OFF（包含）。

  仅在没有任何检测的情况下构建时禁用线程，因为其他检测依赖于线程。

• -DDISABLE_PSI_TRANSACTION=bool

  排除性能模式事务工具。默认为OFF（包含）。

• -DDISABLE_PSI_DATA_LOCK=bool

  排除性能模式数据锁检测。默认为OFF（包含）。

• -DDISABLE_PSI_ERROR=bool

  排除性能模式服务器错误检测。默认为OFF（包含）。

• -DENABLE_EXPERIMENTAL_SYSVARS=bool

  是否启用实验InnoDB 系统变量。实验系统变量适用于那些从事 MySQL 开发的人员，只能在开发或测试环境中使用，并且可能会在未来的 MySQL 版本中删除，恕不另行通知。有关实验系统变量的信息，请参阅 /storage/innobase/handler/ha_innodb.cc MySQL 源代码树。实验系统变量可以通过搜索“ PLUGIN_VAR_EXPERIMENTAL ”来识别 。

• -DWITHOUT_SERVER=bool

  是否构建不带MySQL Server。默认值为“关闭”，这会构建服务器。

  这被认为是一个实验性的选择；最好与服务器一起构建。

• -DENABLE_GCOV=bool

  是否包含gcov支持（仅限 Linux）。

• -DENABLE_GPROF=bool

  是否启用gprof（仅限优化的 Linux 版本）。

• -DENABLED_LOCAL_INFILE=bool

  LOCAL该选项控制MySQL 客户端库的 编译默认 功能。因此，未做出明确安排的客户端会LOCAL根据 ENABLED_LOCAL_INFILEMySQL 构建时指定的设置禁用或启用功能。

  默认情况下，MySQL 二进制发行版中的客户端库在编译时 ENABLED_LOCAL_INFILE禁用。如果您从源代码编译 MySQL，请 ENABLED_LOCAL_INFILE根据未做出明确安排的客户端是否应禁用或启用LOCAL功能分别将其配置为禁用或启用。

  ENABLED_LOCAL_INFILE控制客户端LOCAL 功能的默认值。对于服务器来说， local_infile系统变量控制服务器端的LOCAL 能力。要显式地使服务器拒绝或允许LOAD DATA LOCAL语句（无论客户端程序和库在构建时或运行时如何配置），请分别以 禁用或启用的方式启动mysqld--local-infile。 local_infile也可以在运行时设置。请参见 第 8.1.6 节“LOAD DATA LOCAL 的安全注意事项”。

• -DENABLED_PROFILING=bool

  是否启用查询分析代码（对于 SHOW PROFILE和 SHOW PROFILES语句）。

• -DFORCE_UNSUPPORTED_COMPILER=bool

  默认情况下，CMake检查支持的编译器的最低版本 ；要禁用此检查，请使用 -DFORCE_UNSUPPORTED_COMPILER=ON.

• -DSHOW_SUPPRESSED_COMPILER_WARNINGS=bool

  显示抑制的编译器警告，并且这样做不会因-Werror.默认为 OFF.

• -DFPROFILE_GENERATE=bool

  是否生成配置文件引导优化 (PGO) 数据。此选项可用于通过 GCC 试验 PGO。cmake/fprofile.cmake有关使用 FPROFILE_GENERATE和 的 信息，请参阅MySQL 源代码发行版FPROFILE_USE。这些选项已使用 GCC 8 和 9 进行了测试。

• -DFPROFILE_USE=bool

  是否使用配置文件引导优化 (PGO) 数据。此选项可用于通过 GCC 试验 PGO。cmake/fprofile.cmake有关使用 FPROFILE_GENERATE和 的 信息，请参阅MySQL 源代码发行版中的文件FPROFILE_USE。这些选项已使用 GCC 8 和 9 进行了测试。

  启用FPROFILE_USE还可以启用WITH_LTO.

• -DHAVE_PSI_MEMORY_INTERFACE=bool

  是否为过度对齐类型的动态存储中使用的 内存分配函数（库函数）启用性能模式内存跟踪模块。ut::aligned_name

• -DIGNORE_AIO_CHECK=bool

  如果 -DBUILD_CONFIG=mysql_release 在 Linux 上给出该选项，则libaio 默认情况下必须链接该库。如果您没有 libaio或不想安装它，您可以通过指定 来取消对它的检查 -DIGNORE_AIO_CHECK=1。

• -DMAX_INDEXES=num

  每个表的最大索引数。默认值为 64。最大值为 255。小于 64 的值将被忽略，并使用默认值 64。

• -DMYSQL_MAINTAINER_MODE=bool

  是否启用 MySQL 维护者特定的开发环境。如果启用，此选项会导致编译器警告变为错误。

• -DWITH_DEVELOPER_ENTITLEMENTS=bool

  是否get-task-allow 向所有可执行文件添加在服务器意外停止时生成核心转储的权利。

  在 macOS 11+ 上，核心转储仅限于具有 com.apple.security.get-task-allow 此 CMake 选项启用的权利的进程。该权利允许其他进程附加和读取/修改进程内存，并允许 --core-file按预期运行。

• -DMUTEX_TYPE=type

  所使用的互斥锁类型InnoDB。选项包括：

• event：使用事件互斥体。这是默认值和原始InnoDB 互斥体实现。

• sys：在 UNIX 系统上使用 POSIX 互斥体。使用CRITICAL_SECTIONWindows 上的对象（如果可用）。

• futex：使用 Linux futexes 而不是条件变量来调度等待线程。

• -DMYSQLX_TCP_PORT=port_num

  X Plugin 侦听 TCP/IP 连接的端口号。默认值为 33060。

  该值可以在服务器启动时使用系统变量设置 mysqlx_port。

• -DMYSQLX_UNIX_ADDR=file_name

  服务器侦听 X 插件套接字连接的 Unix 套接字文件路径。这必须是绝对路径名。默认为/tmp/mysqlx.sock.

  该值可以在服务器启动时使用系统变量设置 mysqlx_port。

• -DMYSQL_PROJECT_NAME=name

  对于 Windows 或 macOS，要合并到项目文件名中的项目名称。

• -DMYSQL_TCP_PORT=port_num

  服务器侦听 TCP/IP 连接的端口号。默认值为 3306。

  可以在服务器启动时使用该选项设置该值 --port。

• -DMYSQL_UNIX_ADDR=file_name

  服务器侦听套接字连接的 Unix 套接字文件路径。这必须是绝对路径名。默认为/tmp/mysql.sock.

  可以在服务器启动时使用该选项设置该值 --socket。

• -DOPTIMIZER_TRACE=bool

  是否支持优化器跟踪。请参阅 MySQL 内部原理：跟踪优化器。

• -DREPRODUCIBLE_BUILD=bool

  对于 Linux 系统上的构建，此选项控制是否格外小心地创建独立于构建位置和时间的构建结果。

  此选项默认用于ON构建 RelWithDebInfo。

• -DWITH_LD=string

  CMake默认使用标准链接器。可以选择传入lld或 mold来指定替代链接器。 模具必须是版本 2 或更新版本。

  此选项可用于除 Enterprise Linux 之外的基于 Linux 的系统，Enterprise Linux 始终使用 ld链接器。

  笔记

  以前，该选项USE_LD_LLD可用于启用（默认）或显式禁用 Clang 的 LLVM lld链接器。在 MySQL 8.3 中，USE_LD_LLD已被删除。

• -DWIN_DEBUG_NO_INLINE=bool

  是否在 Windows 上禁用函数内联。默认值为OFF（启用内联）。

• -DWITH_ANT=path_name

  设置 Ant 的路径，这是构建 GCS Java 包装器时所需的。设置WITH_ANT为保存 Ant tarball 或解压存档的目录路径。当 WITH_ANT未设置或使用特殊值设置时system，构建过程假定二进制文件ant存在于 中 $PATH。

• -DWITH_ASAN=bool

  是否启用AddressSanitizer，对于支持它的编译器。默认为OFF.

• -DWITH_ASAN_SCOPE=bool

  是否启用 AddressSanitizer -fsanitize-address-use-after-scopeClang 标志以进行作用域后使用检测。默认关闭。要使用此选项，-DWITH_ASAN 还必须启用。

• -DWITH_AUTHENTICATION_CLIENT_PLUGINS=bool

  如果构建了任何相应的服务器身份验证插件，则会自动启用此选项。因此，它的值取决于其他CMake选项，不应显式设置。

• -DWITH_AUTHENTICATION_LDAP=bool

  LDAP认证插件无法构建时是否报错：

• 如果禁用此选项（默认），则在找到所需的头文件和库时构建 LDAP 插件。如果不是， CMake会显示有关它的注释。

• 如果启用此选项，则无法找到所需的头文件和库会导致 CMake 产生错误，从而阻止构建服务器。

• -DWITH_AUTHENTICATION_PAM=bool

  是否为包含此插件的源树构建 PAM 身份验证插件。 （请参见 第 8.4.1.5 节“PAM 可插入身份验证”。）如果指定了此选项并且无法编译插件，则构建会失败。

• -DWITH_AWS_SDK=path_name

  Amazon Web Services 软件开发工具包的位置。

• -DWITH_CLIENT_PROTOCOL_TRACING=bool

  是否将客户端协议追踪框架构建到客户端库中。默认情况下，此选项处于启用状态。

  有关编写协议跟踪客户端插件的信息，请参阅编写协议跟踪插件。

  另请参阅 WITH_TEST_TRACE_PLUGIN选项。

• -DWITH_CURL=curl_type

  图书馆的位置curl。 curl_type可以是 system（使用系统 curl库）、库的路径名 curl、 no| off|none 禁用curl支持，或者bundled使用 extra/curl/.

• -DWITH_DEBUG=bool

  是否包含调试支持。

  通过配置 MySQL 的调试支持，您可以--debug="d,parser_debug" 在启动服务器时使用该选项。这会导致用于处理 SQL 语句的 Bison 解析器将解析器跟踪转储到服务器的标准错误输出。通常，此输出会写入错误日志。

  存储引擎的同步调试检查InnoDB 在下面定义 UNIV_DEBUG，并且在使用该选项编译调试支持时可用 WITH_DEBUG。当编译了调试支持时， innodb_sync_debug 配置选项可用于启用或禁用 InnoDB同步调试检查。

  启用WITH_DEBUG还会启用调试同步。该设施用于测试和调试。编译后，调试同步在运行时默认处于禁用状态。要启用它，请 使用以下 选项启动mysqld ，其中是大于 0 的超时值。（默认值为 0，这将禁用调试同步。）成为各个同步点的默认超时。 --debug-sync-timeout=NNN

  InnoDB 当使用该选项编译调试支持时，可以使用存储引擎 的同步调试检查WITH_DEBUG。

  有关调试同步工具以及如何使用同步点的说明，请参阅 MySQL 内部：测试同步。

• -DWITH_EDITLINE=value

  使用 哪个libedit/库。editline允许的值为 bundled（默认值） 和 system。

• -DWITH_FIDO=fido_type

  身份验证插件authentication_fido是使用 FIDO 库实现的（请参阅 第 8.4.1.12 节“FIDO 可插入身份验证”）。该 WITH_FIDO选项指示 FIDO 支持的来源：

  WITH_FIDOnone如果禁用所有身份验证插件，则被 禁用（设置为 ）。

• bundled：使用与发行版捆绑在一起的 FIDO 库。这是默认设置。

  MySQL 包含fido2版本 1.8.0。

• system：使用系统FIDO库。

• -DWITH_ICU={icu_type|path_name}

  MySQL 使用 International Components for Unicode (ICU) 来支持正则表达式操作。该 WITH_ICU选项指示要包含的 ICU 支持类型或要使用的 ICU 安装的路径名。

• bundled：使用与发行版捆绑在一起的 ICU 库。这是默认选项，也是 Windows 唯一支持的选项。

• system：使用系统ICU库。

• icu_type可以是以下值之一：

• path_name是要使用的 ICU 安装的路径名。这比使用 的icu_type值 更可取，system因为它可以防止 CMake 检测和使用系统上安装的较旧或不正确的 ICU 版本。 （执行相同操作的另一种允许方法是设置WITH_ICU 为system并将 CMAKE_PREFIX_PATH选项设置为 path_name。）

• -DWITH_INNODB_EXTRA_DEBUG=bool

  是否包含额外的 InnoDB 调试支持。

  启用WITH_INNODB_EXTRA_DEBUG会开启额外的 InnoDB 调试检查。该选项只有在WITH_DEBUG启用 时才可以启用。

• -DWITH_JEMALLOC=bool

  是否链接到-ljemalloc.如果启用，内置malloc()、 calloc()、realloc()和free()例程将被禁用。默认为OFF.

  WITH_JEMALLOC并且 WITH_TCMALLOC是互斥的。

• -DWITH_WIN_JEMALLOC=string

  jemalloc.dll在 Windows 上，传入包含启用 jemalloc 功能的 目录的路径 。构建系统将其复制 到与和/或 jemalloc.dll相同的目录， 并将其用于内存管理操作。如果找不到或未导出所需的函数，则使用标准内存函数。 INFORMATION 级别的日志消息记录是否找到并使用了 jemalloc。 mysqld.exemysqld-debug.exejemalloc.dll

  此选项针对 Windows 官方 MySQL 二进制文件启用。

• -DWITH_KEYRING_TEST=bool

  是否构建插件附带的测试程序 keyring_file。默认为 OFF.测试文件源代码位于该plugin/keyring/keyring-test 目录中。

• -DWITH_LIBEVENT=string

  libevent使用 哪个库。允许的值为bundled（默认）和 system。如果system指定并且找不到系统libevent库，则无论如何都会发生错误，并且 libevent不使用捆绑的。

  memcached、X Plugin 和 MySQL Router libevent需要 该库。InnoDB

• -DWITH_LIBWRAP=bool

  是否包含libwrap（TCP 包装器）支持。

• -DWITH_LOCK_ORDER=bool

  是否启用 LOCK_ORDER 工具。默认情况下，此选项处于禁用状态，并且服务器版本不包含任何工具。如果启用了工具，则 LOCK_ORDER 工具可用，并且可以按照第 7.9.3 节 “LOCK_ORDER 工具”中所述使用。

  笔记

  启用该WITH_LOCK_ORDER 选项后，MySQL 构建需要 flex程序。

• -DWITH_LSAN=bool

  是否运行 LeakSanitizer，而不运行 AddressSanitizer。默认为OFF.

• -DWITH_LTO=bool

  是否启用链接时优化器（如果编译器支持）。默认为OFF除非 FPROFILE_USE启用。

• -DWITH_LZ4=lz4_type

  该WITH_LZ4选项指示支持来源zlib：

• bundled：使用 lz4与发行版捆绑在一起的库。这是默认设置。

• system：使用系统 lz4库。如果 WITH_LZ4设置为此值，则不会构建lz4_decompress实用程序。在这种情况下，可以使用 系统 lz4命令来代替。

• -DWITH_MECAB={disabled|system|path_name}

  使用此选项编译 MeCab 解析器。如果您已将 MeCab 安装到其默认安装目录，请设置 -DWITH_MECAB=system.该 system选项适用于使用本机包管理实用程序从源代码或二进制文件执行的 MeCab 安装。如果您将 MeCab 安装到自定义安装目录，请指定 MeCab 安装路径，例如 -DWITH_MECAB=/opt/mecab。如果该 system选项不起作用，则指定 MeCab 安装路径应该在所有情况下都有效。

  有关相关信息，请参阅 第 14.9.9 节 “MeCab 全文解析器插件”。

• -DWITH_MSAN=bool

  是否启用 MemorySanitizer，对于支持它的编译器。默认关闭。

  为了使该选项在启用后生效，链接到 MySQL 的所有库也必须在启用该选项的情况下进行编译。

• -DWITH_MSCRT_DEBUG=bool

  是否启用 Visual Studio CRT 内存泄漏跟踪。默认为OFF.

• -DMSVC_CPPCHECK=bool

  是否启用MSVC代码分析。默认为 ON.

• -DWITH_MYSQLX=bool

  是否构建支持 X Plugin。默认为 ON.请参阅第 22 章，使用 MySQL 作为文档存储。

• -DWITH_NUMA=bool

  显式设置 NUMA 内存分配策略。 CMakeWITH_NUMA根据当前平台是否支持来设置默认 值NUMA 。对于不支持 NUMA 的平台， CMake 的行为如下：

• 如果没有 NUMA 选项（正常情况）， CMake会正常继续，仅生成此警告：NUMA 库丢失或所需版本不可用。

• 使用 时-DWITH_NUMA=ON， CMake会中止并出现以下错误： NUMA 库丢失或所需版本不可用。

• -DWITH_PACKAGE_FLAGS=bool

  对于通常用于 RPM 和 Debian 软件包的标志，是否将它们添加到这些平台上的独立构建中。默认值适用ON于非调试版本。

• -DWITH_PROTOBUF=protobuf_type

  使用哪个 Protocol Buffers 包。 protobuf_type可以是以下值之一：

  其他值将被忽略，并回退到 bundled.

• bundled：使用与发行版捆绑在一起的包。这是默认设置。 （可选）用于 INSTALL_PRIV_LIBDIR修改动态 Protobuf 库目录。

• system：使用系统上安装的软件包。

• -DWITH_RAPID=bool

  是否构建快速开发周期插件。启用后，rapid将在包含这些插件的构建树中创建一个目录。禁用时，不会rapid在构建树中创建任何目录。默认值为ON，除非该 rapid目录已从源代码树中删除，在这种情况下默认值为 OFF。

• -DWITH_RAPIDJSON=rapidjson_type

  要包含的 RapidJSON 库支持的类型。 rapidjson_type可以是以下值之一：

• bundled：使用与发行版捆绑在一起的 RapidJSON 库。这是默认设置。

• system：使用系统RapidJSON库。需要 1.1.0 或更高版本。

• -DWITH_ROUTER=bool

  是否构建MySQL Router。默认为 ON.

• -DWITH_SSL={ssl_type| path_name}

  为了支持加密连接、随机数生成的熵以及其他与加密相关的操作，MySQL 必须使用 SSL 库构建。此选项指定要使用哪个 SSL 库。

  有关配置 SSL 库的其他信息，请参阅 第 2.8.6 节 “配置 SSL 库支持”。

• system：使用系统OpenSSL库。这是默认设置。

  在 macOS 和 Windows 上，使用 system配置 MySQL 进行构建，就像通过 path_name指向手动安装的 OpenSSL 库调用 CMake 一样。这是因为他们没有系统 SSL 库。在 macOS 上， brew install openssl会安装到，/usr/local/opt/openssl以便system可以找到它。在 Windows 上，它检查 %ProgramFiles%/OpenSSL、 %ProgramFiles%/OpenSSL-Win32、 %ProgramFiles%/OpenSSL-Win64、 C:/OpenSSL、 C:/OpenSSL-Win32和 C:/OpenSSL-Win64。

• yes: 这是 的同义词 system。

• opensslversion：使用备用 OpenSSL 系统软件包，例如 openssl11在 EL7 上，或 openssl3（或 openssl3-fips）在 EL8 上。

  身份验证插件（例如 LDAP 和 Kerberos）被禁用，因为它们不支持这些替代版本的 OpenSSL。

• ssl_type可以是以下值之一：

• path_name是要使用的 OpenSSL 安装的路径名。这比使用该ssl_type值 更可取，system因为它可以防止 CMake 检测和使用系统上安装的较旧或不正确的 OpenSSL 版本。 （执行相同操作的另一种允许方法是设置WITH_SSL 为system并将 CMAKE_PREFIX_PATH选项设置为 path_name。）

• -DWITH_SHOW_PARSE_TREE=bool

  SHOW PARSE_TREE在服务器中 启用支持，仅用于开发和调试。不用于发布版本或在生产中受支持。

• -DWITH_SYSTEMD=bool

  是否启用systemd 支持文件的安装。默认情况下，此选项处于禁用状态。启用后，将安装systemd支持文件，但不会安装mysqld_safe和 System V 初始化脚本等脚本 。在systemd不可用的 平台上 ，启用会导致CMakeWITH_SYSTEMD出错。

  当使用此选项构建服务器时，MySQL 会将所有systemd消息包含在服务器的错误日志中（请参见第 7.4.2 节“错误日志”）。

  有关使用systemd 的更多信息，请参阅第 2.5.9 节 “使用 systemd 管理 MySQL 服务器”。该部分还包括有关指定选项组中其他指定选项的信息[mysqld_safe]。由于使用systemd时未安装 mysqld_safe，因此必须以其他方式指定此类选项。

• -DWITH_SYSTEM_LIBS=bool

  此选项充当“伞”选项，用于设置system以下任何未显式设置的CMakeWITH_CURL选项的值： , WITH_EDITLINE, WITH_FIDO, WITH_ICU, WITH_LIBEVENT, WITH_LZ4, WITH_LZMA, WITH_PROTOBUF, WITH_RE2, WITH_SSL, WITH_ZLIB, WITH_ZSTD。

• -DWITH_SYSTEMD_DEBUG=bool

  对于使用systemd运行 MySQL的平台， 是否生成额外的systemd 调试信息 。默认为. OFF

• -DWITH_TCMALLOC=bool

  是否链接到-ltcmalloc.如果启用，内置malloc()、 calloc()、realloc()和free()例程将被禁用。默认为OFF.

  WITH_TCMALLOC并且 WITH_JEMALLOC是互斥的。

• -DWITH_TEST_TRACE_PLUGIN=bool

  是否构建测试协议跟踪客户端插件（请参阅 使用测试协议跟踪插件）。默认情况下，此选项处于禁用状态。除非WITH_CLIENT_PROTOCOL_TRACING 启用该选项，否则启用该选项不会产生任何效果 。如果 MySQL 配置为启用这两个选项，则libmysqlclient客户端库将使用内置的测试协议跟踪插件构建，并且所有标准 MySQL 客户端都会加载该插件。然而，即使启用了测试插件，默认情况下也没有效果。使用环境变量可以控制插件；请参阅 使用测试协议跟踪插件。

  笔记

  如果您想使用自己的协议跟踪插件，请不要启用该 WITH_TEST_TRACE_PLUGIN 选项，因为一次只能加载一个此类插件，并且尝试加载第二个插件时会发生错误。如果您已经构建了 MySQL，并启用了测试协议跟踪插件以查看其工作原理，则必须在不使用它的情况下重建 MySQL，然后才能使用自己的插件。

  有关编写跟踪插件的信息，请参阅 编写协议跟踪插件。

• -DWITH_TSAN=bool

  是否启用 ThreadSanitizer（对于支持它的编译器）。默认关闭。

• -DWITH_UBSAN=bool

  是否为支持未定义行为清理程序的编译器启用它。默认关闭。

• -DWITH_UNIT_TESTS={ON|OFF}

  如果启用，则使用单元测试编译 MySQL。默认值是 ON除非服务器没有被编译。

• -DWITH_UNIXODBC=1

  为 Connector/ODBC 启用 unixODBC 支持。

• -DWITH_VALGRIND=bool

  是否在 Valgrind 头文件中进行编译，这会将 Valgrind API 公开给 MySQL 代码。默认为 OFF.

  要生成 Valgrind 感知的调试版本， -DWITH_VALGRIND=1通常与-DWITH_DEBUG=1.请参阅 构建调试配置。

• -DWITH_ZLIB=zlib_type

  某些功能要求服务器构建有压缩库支持，例如 COMPRESS()和 UNCOMPRESS()函数以及客户端/服务器协议的压缩。该 WITH_ZLIB选项指示支持来源zlib：

  最低支持版本zlib是 1.2.13。

• bundled：使用 zlib与发行版捆绑在一起的库。这是默认设置。

• system：使用系统 zlib库。如果 WITH_ZLIB设置为此值，则不会构建zlib_decompress实用程序。在这种情况下，可以使用 系统openssl zlib命令来代替。

• -DWITH_ZSTD=zstd_type

  使用该算法的连接压缩zstd （请参见 第 6.2.8 节“连接压缩控制”）要求服务器构建有zstd 库支持。该WITH_ZSTD 选项指示支持来源zstd ：

• bundled：使用 zstd与发行版捆绑在一起的库。这是默认设置。

• system：使用系统 zstd库。

编译器标志

• -DCMAKE_C_FLAGS="flags”

  C 编译器的标志。

• -DCMAKE_CXX_FLAGS="flags”

  C++ 编译器的标志。

• -DWITH_DEFAULT_COMPILER_OPTIONS=bool

  是否使用来自 的标志 cmake/build_configurations/compiler_options.cmake。

  笔记

  所有优化标志均由 MySQL 构建团队精心选择和测试。覆盖它们可能会导致意外结果，您需要自行承担风险。

• -DOPTIMIZE_SANITIZER_BUILDS=bool

  是否添加-O1 -fno-inline到消毒剂版本中。默认为ON.

要指定您自己的 C 和 C++ 编译器标志，对于不影响优化的标志，请使用 CMAKE_C_FLAGS和 CMAKE_CXX_FLAGSCMake 选项。

CMAKE_BUILD_TYPE当提供您自己的编译器标志时，您可能还 需要指定。

例如，要在 64 位 Linux 计算机上创建 32 位发行版本，请执行以下操作：

$> mkdir build$> cd build$> cmake .. -DCMAKE_C_FLAGS=-m32 \  -DCMAKE_CXX_FLAGS=-m32 \  -DCMAKE_BUILD_TYPE=RelWithDebInfo

如果设置影响优化的标志 ( )，则必须设置 和/或 选项，其中对应于值。要为默认构建类型 ( ) 指定不同的优化，请设置 和 选项。例如，要在 Linux 上使用调试符号进行编译，请执行以下操作： -OnumberCMAKE_C_FLAGS_build_typeCMAKE_CXX_FLAGS_build_typebuild_typeCMAKE_BUILD_TYPERelWithDebInfoCMAKE_C_FLAGS_RELWITHDEBINFOCMAKE_CXX_FLAGS_RELWITHDEBINFO-O3

$> cmake .. -DCMAKE_C_FLAGS_RELWITHDEBINFO="-O3 -g" \  -DCMAKE_CXX_FLAGS_RELWITHDEBINFO="-O3 -g"

用于编译 NDB Cluster 的 CMake 选项

以下选项可在构建具有 NDB Cluster 支持的 MySQL 源时使用。

• -DNDB_UTILS_LINK_DYNAMIC={ON|OFF}

  控制 NDB 实用程序（例如 ndb_drop_table）ndbclient是静态（OFF）还是动态（ON）链接 ； OFF（静态链接）是默认值。通常在构建这些版本时使用静态链接以避免出现问题 ，或者在安装LD_LIBRARY_PATH多个版本时使用静态链接。ndbclient此选项旨在创建 Docker 映像以及可能的其他情况，其中目标环境受到精确控制并且需要减小映像大小。

• -DWITH_CLASSPATH=path

  设置用于构建 Java 的 MySQL NDB Cluster Connector 的类路径。默认为空。如果-DWITH_NDB_JAVA=OFF使用 该选项，则忽略该选项 。

• -DWITH_ERROR_INSERT={ON|OFF}

  在内核中启用错误注入 NDB。仅用于测试；不适用于构建生产二进制文件。默认为OFF.

• -DWITH_NDB={ON|OFF}

  构建MySQL NDB集群；构建 NDB 插件和所有 NDB Cluster 程序。

• -DWITH_NDBAPI_EXAMPLES={ON|OFF}

  在 storage/ndb/ndbapi-examples/.有关这些的信息， 请参阅 NDB API 示例。

• -DWITH_NDBCLUSTER_STORAGE_ENGINE={ON|OFF}

  （仅）控制ndbcluster 插件是否包含在构建中； WITH_NDB自动启用此选项，因此建议您 WITH_NDB改为使用。

• -DWITH_NDBCLUSTER={ON|OFF}

  构建和链接以支持 mysqldNDB中的存储引擎 。

  此选项已被弃用，并可能最终被删除；代替使用WITH_NDB。

• -DWITH_NDBMTD={ON|OFF}

  构建多线程数据节点可执行文件 ndbmtd。默认为 ON.

• -DWITH_NDB_DEBUG={ON|OFF}

  启用构建 NDB Cluster 二进制文件的调试版本。这是OFF默认情况。

• -DWITH_NDB_JAVA={ON|OFF}

  启用使用 Java 支持构建 NDB Cluster，包括对 ClusterJ 的支持（请参阅适用于 Java 的 MySQL NDB Cluster Connector）。

  此选项ON为默认选项。如果您不希望编译具有 Java 支持的 NDB Cluster，则必须通过 -DWITH_NDB_JAVA=OFF在运行 CMake时指定来显式禁用它。否则，如果找不到 Java，则构建配置将失败。

• -DWITH_NDB_PORT=port

  导致 NDB Cluster 管理服务器（ndb_mgmd）默认使用它 port。如果未设置此选项，则生成的管理服务器默认尝试使用端口 1186。

• -DWITH_NDB_TEST={ON|OFF}

  如果启用，请包含一组 NDB API 测试程序。默认为OFF.

• -DWITH_NDB_TLS_SEARCH_PATH=path

  设置ndb_sign_keys和其他 NDB程序搜索TLS证书和密钥文件的 默认路径 。

  Windows 平台的默认值是 $HOMEDIR/ndb-tls；对于其他平台，例如 Linux，它是$HOME/ndb-tls.