MySQL Server Version Reference  /  Build (Configuration) Options

Chapter 8 Build (Configuration) Options

The following table details the CMake configuration options available when building MySQL Server from source. The table contains these columns:

  • Name: The item name.

  • Introduced: The version or versions in which the item was introduced. This column appears only if it applies to some item.

  • Removed: The version or versions in which the item was removed. This column appears only if it applies to some item.

  • 5.7, 8.0, 8.1, 8.2, 8.3: Whether the item is available in the corresponding MySQL Server series. The indicator links to the item description in the main reference manual if more information is available.

    An item has a row in the table if it ever existed in any series shown in the table. The value displayed for a given series indicates item availability in that series:

    • Yes: The item is available in all production-ready General Availability (GA) versions. For a series that has not reached GA status, Yes indicates that the item is available in the most recently released pre-GA version.

    • Some: The item is available in some GA versions. This is the case if the item was introduced after the first GA version, or removed from some GA version.

    • Blank: The item is not available in any GA version. Either it does not exist in the series, or existed in pre-GA versions but was removed before the series reached GA status.

Table 8.1 CMake Option Reference

Name Introduced Removed 5.7 8.0 8.1 8.2 8.3
ADD_GDB_INDEX 8.0.18 Some Yes Yes Yes
BUILD_CONFIG Yes Yes Yes Yes Yes
BUNDLE_RUNTIME_LIBRARIES 8.0.11 Yes Yes Yes Yes
CMAKE_BUILD_TYPE Yes Yes Yes Yes Yes
CMAKE_CXX_FLAGS Yes Yes Yes Yes Yes
CMAKE_C_FLAGS Yes Yes Yes Yes Yes
CMAKE_INSTALL_PREFIX Yes Yes Yes Yes Yes
COMPILATION_COMMENT Yes Yes Yes Yes Yes
COMPILATION_COMMENT_SERVER 8.0.14 Some Yes Yes Yes
COMPRESS_DEBUG_SECTIONS 8.0.22 Some Yes Yes Yes
CPACK_MONOLITHIC_INSTALL Yes Yes Yes Yes Yes
DEFAULT_CHARSET Yes Yes Yes Yes Yes
DEFAULT_COLLATION Yes Yes Yes Yes Yes
DISABLE_PSI_COND 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_DATA_LOCK Yes Yes Yes Yes
DISABLE_PSI_ERROR Yes Yes Yes Yes
DISABLE_PSI_FILE 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_IDLE 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_MEMORY 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_METADATA 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_MUTEX 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_PS 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_RWLOCK 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_SOCKET 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_SP 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_STAGE 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_STATEMENT 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_STATEMENT_DIGEST 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_TABLE 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_THREAD 5.7.3 Yes Yes Yes Yes Yes
DISABLE_PSI_TRANSACTION 5.7.3 Yes Yes Yes Yes Yes
DISABLE_SHARED 8.0.18 Some
DOWNLOAD_BOOST 5.7.5 Yes Yes Yes Yes
DOWNLOAD_BOOST_TIMEOUT 5.7.6 Yes Yes Yes Yes
ENABLED_LOCAL_INFILE Yes Yes Yes Yes Yes
ENABLED_PROFILING Yes Yes Yes Yes Yes
ENABLE_DEBUG_SYNC 5.7.1, 8.0.1
ENABLE_DOWNLOADS 8.0.26 Yes Some
ENABLE_DTRACE 8.0.1 Yes
ENABLE_EXPERIMENTAL_SYSVARS 8.0.11 Yes Yes Yes Yes
ENABLE_GCOV Yes Yes Yes Yes Yes
ENABLE_GPROF Yes Yes Yes Yes Yes
FORCE_COLORED_OUTPUT 8.0.33 Some Yes Yes Yes
FORCE_INSOURCE_BUILD 8.0.14 Some Yes Yes Yes
FORCE_UNSUPPORTED_COMPILER 5.7.5 Yes Yes Yes Yes Yes
FPROFILE_GENERATE 8.0.19 Some Yes Yes Yes
FPROFILE_USE 8.0.19 Some Yes Yes Yes
HAVE_PSI_MEMORY_INTERFACE 8.0.26 Some Yes Yes Yes
IGNORE_AIO_CHECK Yes Yes Yes Yes Yes
INNODB_PAGE_ATOMIC_REF_COUNT 5.7.4 5.7.5
INSTALL_BINDIR Yes Yes Yes Yes Yes
INSTALL_DOCDIR Yes Yes Yes Yes Yes
INSTALL_DOCREADMEDIR Yes Yes Yes Yes Yes
INSTALL_INCLUDEDIR Yes Yes Yes Yes Yes
INSTALL_INFODIR Yes Yes Yes Yes Yes
INSTALL_LAYOUT Yes Yes Yes Yes Yes
INSTALL_LIBDIR Yes Yes Yes Yes Yes
INSTALL_MANDIR Yes Yes Yes Yes Yes
INSTALL_MYSQLKEYRINGDIR 5.7.11 Some Yes Yes Yes Yes
INSTALL_MYSQLSHAREDIR Yes Yes Yes Yes Yes
INSTALL_MYSQLTESTDIR Yes Yes Yes Yes Yes
INSTALL_PKGCONFIGDIR 5.7.9 Yes Yes Yes Yes Yes
INSTALL_PLUGINDIR Yes Yes Yes Yes Yes
INSTALL_PRIV_LIBDIR 8.0.18 Some Yes Yes Yes
INSTALL_SBINDIR Yes Yes Yes Yes Yes
INSTALL_SCRIPTDIR Yes
INSTALL_SECURE_FILE_PRIVDIR 5.7.6 Yes Yes Yes Yes Yes
INSTALL_SECURE_FILE_PRIV_EMBEDDEDDIR 5.7.8 Yes
INSTALL_SHAREDIR Yes Yes Yes Yes Yes
INSTALL_SQLBENCHDIR 5.7.8
INSTALL_STATIC_LIBRARIES Yes Yes Yes Yes
INSTALL_SUPPORTFILESDIR Yes Yes Yes Yes Yes
LINK_RANDOMIZE 8.0.1 Yes Yes Yes Yes
LINK_RANDOMIZE_SEED 8.0.1 Yes Yes Yes Yes
MAX_INDEXES 5.7.1 Yes Yes Yes Yes Yes
MEMCACHED_HOME 5.7.33, 8.0.23 Some Some
MSVC_CPPCHECK 8.0.33 Some Yes Yes Yes
MUTEX_TYPE 5.7.2 Yes Yes Yes Yes Yes
MYSQLX_TCP_PORT 5.7.17 Some Yes Yes Yes Yes
MYSQLX_UNIX_ADDR 5.7.15 Some Yes Yes Yes Yes
MYSQL_DATADIR Yes Yes Yes Yes Yes
MYSQL_MAINTAINER_MODE Yes Yes Yes Yes Yes
MYSQL_PROJECT_NAME Yes Yes Yes Yes Yes
MYSQL_TCP_PORT Yes Yes Yes Yes Yes
MYSQL_UNIX_ADDR Yes Yes Yes Yes Yes
NDB_UTILS_LINK_DYNAMIC 8.0.22 Some Yes Yes Yes
ODBC_INCLUDES Yes Yes Yes Yes Yes
ODBC_LIB_DIR Yes Yes Yes Yes Yes
OPTIMIZER_TRACE Yes Yes Yes Yes Yes
OPTIMIZE_SANITIZER_BUILDS 8.0.34 Some Yes Yes Yes
REPRODUCIBLE_BUILD 5.7.19, 8.0.11 Some Yes Yes Yes Yes
SHOW_SUPPRESSED_COMPILER_WARNING 8.0.30 Some Yes Yes Yes
SUNPRO_CXX_LIBRARY 5.7.5 Yes
SYSCONFDIR Yes Yes Yes Yes Yes
SYSTEMD_PID_DIR 5.7.6 Yes Yes Yes Yes Yes
SYSTEMD_SERVICE_NAME 5.7.6 Yes Yes Yes Yes Yes
TMPDIR 5.7.4 Yes Yes Yes Yes Yes
USE_LD_GOLD 8.0.31 Some
USE_LD_LLD 8.0.16 Some Yes Yes
WIN_DEBUG_NO_INLINE 5.7.6 Yes Yes Yes Yes Yes
WITHOUT_SERVER Yes Yes Yes Yes Yes
WITHOUT_xxx_STORAGE_ENGINE Yes Yes Yes Yes Yes
WITH_ANT 8.0.11 Yes Yes Yes Yes
WITH_ASAN 5.7.3 Yes Yes Yes Yes Yes
WITH_ASAN_SCOPE 5.7.21, 8.0.4 Some Yes Yes Yes Yes
WITH_AUTHENTICATION_CLIENT_PLUGINS 8.0.26 Some Yes Yes Yes
WITH_AUTHENTICATION_LDAP 5.7.19, 8.0.2 Some Yes Yes Yes Yes
WITH_AUTHENTICATION_PAM Yes Yes Yes Yes Yes
WITH_AWS_SDK 5.7.19, 8.0.2 Some Yes Yes Yes Yes
WITH_BOOST 5.7.5 Yes Yes Yes Yes
WITH_BUILD_ID 8.0.31 Some Yes Yes Yes
WITH_BUNDLED_LIBEVENT 5.7.33, 8.0.23 Some Some
WITH_BUNDLED_MEMCACHED 5.7.33, 8.0.23 Some Some
WITH_CLASSPATH Yes Yes Yes Yes Yes
WITH_CLIENT_PROTOCOL_TRACING 5.7.2 Yes Yes Yes Yes Yes
WITH_CURL 5.7.19, 8.0.2 Some Yes Yes Yes Yes
WITH_DEBUG Yes Yes Yes Yes Yes
WITH_DEFAULT_COMPILER_OPTIONS Yes Yes Yes Yes Yes
WITH_DEFAULT_FEATURE_SET 8.0.22 Yes Some
WITH_DEVELOPER_ENTITLEMENTS 8.0.30 Some Yes Yes Yes
WITH_EDITLINE 5.7.2 Yes Yes Yes Yes Yes
WITH_EMBEDDED_SERVER Yes
WITH_EMBEDDED_SHARED_LIBRARY 5.7.4 Yes
WITH_ERROR_INSERT Yes Yes Yes Yes Yes
WITH_EXTRA_CHARSETS Yes
WITH_FIDO 8.0.27 Some Yes Yes Yes
WITH_GMOCK 8.0.26 Yes Some
WITH_ICU 8.0.4 Yes Yes Yes Yes
WITH_INNODB_EXTRA_DEBUG 5.7.2 Yes Yes Yes Yes Yes
WITH_INNODB_MEMCACHED Yes Yes Yes Yes
WITH_JEMALLOC 8.0.16 Some Yes Yes Yes
WITH_KEYRING_TEST 5.7.11 Some Yes Yes Yes Yes
WITH_LD Yes
WITH_LDAP 5.7.29 Some
WITH_LIBEVENT Yes Yes Yes Yes Yes
WITH_LIBWRAP Yes Yes Yes Yes Yes
WITH_LOCK_ORDER 8.0.17 Some Yes Yes Yes
WITH_LSAN 8.0.16 Some Yes Yes Yes
WITH_LTO 8.0.13 Some Yes Yes Yes
WITH_LZ4 5.7.14 Some Yes Yes Yes Yes
WITH_LZMA 8.0.4 8.0.16 Some
WITH_MECAB 5.7.6 Yes Yes Yes Yes Yes
WITH_MSAN 5.7.4 Yes Yes Yes Yes Yes
WITH_MSCRT_DEBUG 5.7.6 Yes Yes Yes Yes Yes
WITH_MYSQLX 8.0.11 Yes Yes Yes Yes
WITH_NDB 8.0.31 Some Yes Yes Yes
WITH_NDBAPI_EXAMPLES Yes Yes Yes Yes Yes
WITH_NDBCLUSTER Yes Yes Yes Yes Yes
WITH_NDBCLUSTER_STORAGE_ENGINE Yes Yes Yes Yes Yes
WITH_NDBMTD Yes Yes Yes Yes Yes
WITH_NDB_BINLOG Yes
WITH_NDB_DEBUG Yes Yes Yes Yes Yes
WITH_NDB_JAVA Yes Yes Yes Yes Yes
WITH_NDB_PORT Yes Yes Yes Yes Yes
WITH_NDB_TEST Yes Yes Yes Yes Yes
WITH_NDB_TLS_SEARCH_PATH Yes
WITH_NUMA 5.7.17 Some Yes Yes Yes Yes
WITH_PACKAGE_FLAGS 8.0.26 Some Yes Yes Yes
WITH_PLUGIN_NDBCLUSTER 8.0.13 8.0.31 Some
WITH_PROTOBUF 5.7.12 Some Yes Yes Yes Yes
WITH_RAPID 5.7.12 Some Yes Yes Yes Yes
WITH_RAPIDJSON 8.0.13 Some Yes Yes Yes
WITH_RE2 8.0.4 8.0.18 Some
WITH_ROUTER 8.0.16 Some Yes Yes Yes
WITH_SASL 5.7.29 Some
WITH_SHOW_PARSE_TREE Yes Yes Yes
WITH_SSL Yes Yes Yes Yes Yes
WITH_SYSTEMD 5.7.6 Yes Yes Yes Yes Yes
WITH_SYSTEMD_DEBUG 8.0.22 Some Yes Yes Yes
WITH_SYSTEM_LIBS 8.0.11 Yes Yes Yes Yes
WITH_TCMALLOC 8.0.22 Some Yes Yes Yes
WITH_TEST_TRACE_PLUGIN 5.7.2 Yes Yes Yes Yes Yes
WITH_TSAN Yes Yes Yes Yes
WITH_UBSAN 5.7.6 Yes Yes Yes Yes Yes
WITH_UNIT_TESTS Yes Yes Yes Yes Yes
WITH_UNIXODBC Yes Yes Yes Yes Yes
WITH_VALGRIND Yes Yes Yes Yes Yes
WITH_WIN_JEMALLOC 8.0.29 Some Yes Yes Yes
WITH_ZLIB Yes Yes Yes Yes Yes
WITH_ZSTD 8.0.18 Some Yes Yes Yes
WITH_xxx_STORAGE_ENGINE Yes Yes Yes Yes Yes


PREV   HOME   UP