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.6, 5.7, and so forth: 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.6 5.7 8.0
ADD_GDB_INDEX 8.0.18 Some
BUILD_CONFIG Yes Yes Yes
BUNDLE_RUNTIME_LIBRARIES 8.0.11 Yes
CMAKE_BUILD_TYPE Yes Yes Yes
CMAKE_CXX_FLAGS Yes Yes Yes
CMAKE_C_FLAGS Yes Yes Yes
CMAKE_INSTALL_PREFIX Yes Yes Yes
COMPILATION_COMMENT Yes Yes Yes
COMPILATION_COMMENT_SERVER 8.0.14 Some
COMPRESS_DEBUG_SECTIONS 8.0.22 Some
CPACK_MONOLITHIC_INSTALL Yes Yes Yes
DEFAULT_CHARSET Yes Yes Yes
DEFAULT_COLLATION Yes Yes Yes
DISABLE_PSI_COND 5.7.3 Yes Yes
DISABLE_PSI_DATA_LOCK Yes
DISABLE_PSI_ERROR Yes
DISABLE_PSI_FILE 5.7.3 Yes Yes
DISABLE_PSI_IDLE 5.7.3 Yes Yes
DISABLE_PSI_MEMORY 5.7.3 Yes Yes
DISABLE_PSI_METADATA 5.7.3 Yes Yes
DISABLE_PSI_MUTEX 5.7.3 Yes Yes
DISABLE_PSI_PS 5.7.3 Yes Yes
DISABLE_PSI_RWLOCK 5.7.3 Yes Yes
DISABLE_PSI_SOCKET 5.7.3 Yes Yes
DISABLE_PSI_SP 5.7.3 Yes Yes
DISABLE_PSI_STAGE 5.7.3 Yes Yes
DISABLE_PSI_STATEMENT 5.7.3 Yes Yes
DISABLE_PSI_STATEMENT_DIGEST 5.7.3 Yes Yes
DISABLE_PSI_TABLE 5.7.3 Yes Yes
DISABLE_PSI_THREAD 5.7.3 Yes Yes
DISABLE_PSI_TRANSACTION 5.7.3 Yes Yes
DISABLE_SHARED 8.0.18 Some
DOWNLOAD_BOOST 5.7.5 Yes Yes
DOWNLOAD_BOOST_TIMEOUT 5.7.6 Yes Yes
ENABLED_LOCAL_INFILE Yes Yes Yes
ENABLED_PROFILING Yes Yes Yes
ENABLE_DEBUG_SYNC 5.6.36, 5.7.1, 8.0.1 Some
ENABLE_DOWNLOADS 8.0.26 Yes Yes Some
ENABLE_DTRACE 8.0.1 Yes Yes
ENABLE_EXPERIMENTAL_SYSVARS 8.0.11 Yes
ENABLE_GCOV 5.6.3 Yes Yes Yes
ENABLE_GPROF 5.6.6 Yes Yes Yes
FORCE_INSOURCE_BUILD 8.0.14 Some
FORCE_UNSUPPORTED_COMPILER 5.7.5 Yes Yes
FPROFILE_GENERATE 8.0.19 Some
FPROFILE_USE 8.0.19 Some
HAVE_PSI_MEMORY_INTERFACE 8.0.26 Some
IGNORE_AIO_CHECK 5.6.1 Yes Yes Yes
INNODB_PAGE_ATOMIC_REF_COUNT 5.6.16, 5.7.4 5.7.5 Some
INSTALL_BINDIR Yes Yes Yes
INSTALL_DOCDIR Yes Yes Yes
INSTALL_DOCREADMEDIR Yes Yes Yes
INSTALL_INCLUDEDIR Yes Yes Yes
INSTALL_INFODIR Yes Yes Yes
INSTALL_LAYOUT Yes Yes Yes
INSTALL_LIBDIR Yes Yes Yes
INSTALL_MANDIR Yes Yes Yes
INSTALL_MYSQLKEYRINGDIR 5.7.11 Some Yes
INSTALL_MYSQLSHAREDIR Yes Yes Yes
INSTALL_MYSQLTESTDIR Yes Yes Yes
INSTALL_PKGCONFIGDIR 5.7.9 Yes Yes
INSTALL_PLUGINDIR Yes Yes Yes
INSTALL_PRIV_LIBDIR 8.0.18 Some
INSTALL_SBINDIR Yes Yes Yes
INSTALL_SCRIPTDIR Yes Yes
INSTALL_SECURE_FILE_PRIVDIR 5.6.34, 5.7.6 Some Yes Yes
INSTALL_SECURE_FILE_PRIV_EMBEDDEDDIR 5.6.34, 5.7.8 Some Yes
INSTALL_SHAREDIR Yes Yes Yes
INSTALL_SQLBENCHDIR 5.7.8 Yes
INSTALL_STATIC_LIBRARIES Yes
INSTALL_SUPPORTFILESDIR Yes Yes Yes
LINK_RANDOMIZE 8.0.1 Yes
LINK_RANDOMIZE_SEED 8.0.1 Yes
MAX_INDEXES 5.7.1 Yes Yes
MEMCACHED_HOME 8.0.23 Yes Yes Some
MUTEX_TYPE 5.7.2 Yes Yes
MYSQLX_TCP_PORT 5.7.17 Some Yes
MYSQLX_UNIX_ADDR 5.7.15 Some Yes
MYSQL_DATADIR Yes Yes Yes
MYSQL_MAINTAINER_MODE Yes Yes Yes
MYSQL_PROJECT_NAME 5.6.5 Yes Yes Yes
MYSQL_TCP_PORT Yes Yes Yes
MYSQL_UNIX_ADDR Yes Yes Yes
NDB_UTILS_LINK_DYNAMIC 8.0.22 Some
ODBC_INCLUDES Yes Yes Yes
ODBC_LIB_DIR Yes Yes Yes
OPTIMIZER_TRACE 5.6.3 Yes Yes Yes
REPRODUCIBLE_BUILD 5.6.37, 5.7.19, 8.0.11 Some Some Yes
SUNPRO_CXX_LIBRARY 5.6.20, 5.7.5 Some Yes
SYSCONFDIR Yes Yes Yes
SYSTEMD_PID_DIR 5.7.6 Yes Yes
SYSTEMD_SERVICE_NAME 5.7.6 Yes Yes
TMPDIR 5.6.16, 5.7.4 Some Yes Yes
USE_LD_GOLD Yes
USE_LD_LLD 8.0.16 Some
WIN_DEBUG_NO_INLINE 5.7.6 Yes Yes
WITHOUT_xxx_STORAGE_ENGINE Yes Yes Yes
WITH_ANT 8.0.11 Yes
WITH_ASAN 5.6.15, 5.7.3 Some Yes Yes
WITH_ASAN_SCOPE 5.7.21, 8.0.4 Some Yes
WITH_AUTHENTICATION_CLIENT_PLUGINS 8.0.26 Some
WITH_AUTHENTICATION_LDAP 5.7.19, 8.0.2 Some Yes
WITH_AUTHENTICATION_PAM Yes Yes
WITH_AWS_SDK 5.7.19, 8.0.2 Some Yes
WITH_BOOST 5.7.5 Yes Yes
WITH_BUNDLED_LIBEVENT 8.0.23 Yes Yes Some
WITH_BUNDLED_MEMCACHED 8.0.23 Yes Yes Some
WITH_CLASSPATH Yes Yes Yes
WITH_CLIENT_PROTOCOL_TRACING 5.7.2 Yes Yes
WITH_CURL 5.7.19, 8.0.2 Some Yes
WITH_DEBUG Yes Yes Yes
WITH_DEFAULT_COMPILER_OPTIONS 5.6.6 Yes Yes Yes
WITH_DEFAULT_FEATURE_SET 5.6.6 8.0.22 Yes Yes Some
WITH_EDITLINE 5.6.12, 5.7.2 Some Yes Yes
WITH_EMBEDDED_SERVER Yes Yes
WITH_EMBEDDED_SHARED_LIBRARY 5.6.17, 5.7.4 Some Yes
WITH_ERROR_INSERT Yes Yes Yes
WITH_EXTRA_CHARSETS Yes Yes
WITH_FIDO 8.0.27 Some
WITH_GMOCK 8.0.26 Yes Yes Some
WITH_ICU 8.0.4 Yes
WITH_INNODB_EXTRA_DEBUG 5.7.2 Yes Yes
WITH_INNODB_MEMCACHED Yes Yes Yes
WITH_JEMALLOC 8.0.16 Some
WITH_KEYRING_TEST 5.7.11 Some Yes
WITH_LDAP 5.7.29 Some
WITH_LIBEDIT 5.6.12 Some
WITH_LIBEVENT 5.6.6 Yes Yes Yes
WITH_LIBWRAP Yes Yes Yes
WITH_LOCK_ORDER 8.0.17 Some
WITH_LSAN 8.0.16 Some
WITH_LTO 8.0.13 Some
WITH_LZ4 5.7.14 Some Yes
WITH_LZMA 8.0.4 8.0.16 Some
WITH_MECAB 5.7.6 Yes Yes
WITH_MSAN 5.7.4 Yes Yes
WITH_MSCRT_DEBUG 5.7.6 Yes Yes
WITH_MYSQLX 8.0.11 Yes
WITH_NDBAPI_EXAMPLES Yes Yes Yes
WITH_NDBCLUSTER Yes Yes Yes
WITH_NDBCLUSTER_STORAGE_ENGINE Yes Yes Yes
WITH_NDBMTD Yes Yes Yes
WITH_NDB_BINLOG Yes Yes
WITH_NDB_DEBUG Yes Yes Yes
WITH_NDB_JAVA Yes Yes Yes
WITH_NDB_PORT Yes Yes Yes
WITH_NDB_TEST Yes Yes Yes
WITH_NUMA 5.6.27, 5.7.17 Some Some Yes
WITH_PACKAGE_FLAGS 8.0.26 Some
WITH_PLUGIN_NDBCLUSTER 8.0.13 Some
WITH_PROTOBUF 5.7.12 Some Yes
WITH_RAPID 5.7.12 Some Yes
WITH_RAPIDJSON 8.0.13 Some
WITH_RE2 8.0.4 8.0.18 Some
WITH_READLINE 5.6.5
WITH_ROUTER 8.0.16 Some
WITH_SASL 5.7.29 Some
WITH_SSL Yes Yes Yes
WITH_SYMVER16 5.6.31 Some
WITH_SYSTEMD 5.7.6 Yes Yes
WITH_SYSTEMD_DEBUG 8.0.22 Some
WITH_SYSTEM_LIBS 8.0.11 Yes
WITH_TCMALLOC 8.0.22 Some
WITH_TEST_TRACE_PLUGIN 5.7.2 Yes Yes
WITH_TSAN Yes
WITH_UBSAN 5.7.6 Yes Yes
WITH_UNIT_TESTS Yes Yes Yes
WITH_UNIXODBC Yes Yes Yes
WITH_VALGRIND Yes Yes Yes
WITH_ZLIB Yes Yes Yes
WITH_ZSTD 8.0.18 Some
WITH_xxx_STORAGE_ENGINE Yes Yes Yes


PREV   HOME   UP