diff --git a/galeracluster/source/documentation/mysql-wsrep-options.rst b/galeracluster/source/documentation/mysql-wsrep-options.rst index 1c7c629a..f652230d 100644 --- a/galeracluster/source/documentation/mysql-wsrep-options.rst +++ b/galeracluster/source/documentation/mysql-wsrep-options.rst @@ -77,54 +77,54 @@ and an explanation. ":ref:`innodb-wsrep-applier-lock-wait-timeout `", "``0``", "Yes", "Yes" ":ref:`wsrep_applier_FK_failure_retries `", "``1``", "Yes", "Yes" - ":ref:`wsrep_auto_increment_control `", "``ON``", "Yes", "" - ":ref:`wsrep_causal_reads `", "``OFF``", "", "" - ":ref:`wsrep_certify_nonPK `", "``ON``", "", "Yes" - ":ref:`wsrep_certification_rules `", "", "", "Yes" - ":ref:`wsrep_cluster_address `", "``ON``", "Yes", "" - ":ref:`wsrep_cluster_name `", "``example_cluster``", "Yes", "" - ":ref:`wsrep_convert_LOCK_to_trx `", "``OFF``", "Yes", "" - ":ref:`wsrep_data_home_dir `", "``/path/to/datadir``", "Yes", "" - ":ref:`wsrep_dbug_option `", "", "Yes", "" - ":ref:`wsrep_debug `", "``OFF``", "Yes", "" - ":ref:`wsrep_desync `", "``OFF``", "Yes", "" + ":ref:`wsrep_auto_increment_control `", "``ON``", "Yes", "Yes" + ":ref:`wsrep_causal_reads `", "``OFF``", "Session", "Yes" + ":ref:`wsrep_certify_nonPK `", "``ON``", "Yes", "Yes" + ":ref:`wsrep_certification_rules `", "``STRICT``", "Yes", "Yes" + ":ref:`wsrep_cluster_address `", "``ON``", "Yes", "No" + ":ref:`wsrep_cluster_name `", "``example_cluster``", "Yes", "Yes" + ":ref:`wsrep_convert_LOCK_to_trx `", "``OFF``", "Yes", "Yes" + ":ref:`wsrep_data_home_dir `", "``/path/to/datadir``", "Yes", "No" + ":ref:`wsrep_dbug_option `", "", "Yes", "Yes" + ":ref:`wsrep_debug `", "``OFF``", "Yes", "Yes" + ":ref:`wsrep_desync `", "``OFF``", "Yes", "Yes" ":ref:`wsrep_dirty_reads `", "``OFF``", "Yes", "Yes" - ":ref:`wsrep_drupal_282555_workaround `", "``ON``", "Yes", "" - ":ref:`wsrep_forced_binlog_format `", "``NONE``", "Yes", "" + ":ref:`wsrep_drupal_282555_workaround `", "``ON``", "Yes", "Yes" + ":ref:`wsrep_forced_binlog_format `", "``NONE``", "Yes", "Yes" ":ref:`wsrep_ignore_apply_errors `", "``7``", "Yes", "Yes" ":ref:`wsrep_info_level `", "``0``", "Yes", "Yes" - ":ref:`wsrep_load_data_splitting `", "``ON``", "Yes", "" - ":ref:`wsrep_log_conflicts `", "``OFF``", "Yes", "" - ":ref:`wsrep_max_ws_rows `", "``0``", "Yes", "" - ":ref:`wsrep_max_ws_size `", "``1G``", "Yes", "" + ":ref:`wsrep_load_data_splitting `", "``ON``", "Yes", "Yes" + ":ref:`wsrep_log_conflicts `", "``OFF``", "Yes", "Yes" + ":ref:`wsrep_max_ws_rows `", "``0``", "Yes", "Yes" + ":ref:`wsrep_max_ws_size `", "``2G``", "Yes", "Yes" ":ref:`wsrep_mode `", "``ON``", "Yes", "Yes" - ":ref:`wsrep_node_address `", "*host address:default port*", "Yes", "" - ":ref:`wsrep_node_incoming_address `", "*host address:mysqld port*", "Yes", "" - ":ref:`wsrep_node_name `", "````", "Yes", "" - ":ref:`wsrep_notify_cmd `", "", "Yes", "" - ":ref:`wsrep_on `", "``ON``", "Yes", "" + ":ref:`wsrep_node_address `", "*host address:default port*", "Yes", "No" + ":ref:`wsrep_node_incoming_address `", "*host address:mysqld port*", "Yes", "No" + ":ref:`wsrep_node_name `", "````", "Yes", "Yes" + ":ref:`wsrep_notify_cmd `", "(empty)", "Yes", "Yes" + ":ref:`wsrep_on `", "``ON``", "Yes", "Yes" ":ref:`wsrep_OSU_method `", "``TOI``", "", "Yes" - ":ref:`wsrep_preordered `", "``OFF``", "Yes", "" - ":ref:`wsrep_provider `", "``NONE``", "Yes", "" - ":ref:`wsrep_provider_options `", "", "Yes", "" + ":ref:`wsrep_preordered `", "``OFF``", "Yes", "Yes" + ":ref:`wsrep_provider `", "``NONE``", "Yes", "No" + ":ref:`wsrep_provider_options `", "(empty)", "Yes", "No" ":ref:`wsrep_recover `", "``OFF``", "Yes", "No" ":ref:`wsrep_reject_queries `", "``NONE``", "Yes", "Yes" ":ref:`wsrep_restart_replica `", "``OFF``", "Yes", "Yes" ":ref:`wsrep_restart_slave `", "``OFF``", "Yes", "Yes" - ":ref:`wsrep_retry_autocommit `", "``1``", "Yes", "" + ":ref:`wsrep_retry_autocommit `", "``1``", "Yes", "No" ":ref:`wsrep_applier_FK_checks `", "``ON``", "Yes", "Yes" ":ref:`wsrep_slave_FK_checks `", "``ON``", "Yes", "Yes" ":ref:`wsrep_applier_threads `", "``1``", "Yes", "Yes" - ":ref:`wsrep_slave_threads `", "``1``", "Yes", "" + ":ref:`wsrep_slave_threads `", "``1``", "Yes", "Yes" ":ref:`wsrep_applier_UK_checks `", "``OFF``", "Yes", "Yes" ":ref:`wsrep_slave_UK_checks `", "``OFF``", "Yes", "Yes" - ":ref:`wsrep_sst_auth `", "", "Yes", "" - ":ref:`wsrep_sst_donor `", "", "Yes", "" - ":ref:`wsrep_sst_donor_rejects_queries `", "``OFF``", "Yes", "" - ":ref:`wsrep_sst_method `", "``mysqldump``", "Yes", "" + ":ref:`wsrep_sst_auth `", "(empty)", "Yes", "Yes" + ":ref:`wsrep_sst_donor `", "", "Yes", "Yes" + ":ref:`wsrep_sst_donor_rejects_queries `", "``OFF``", "Yes", "Yes" + ":ref:`wsrep_sst_method `", "``mysqldump``", "Yes", "Yes" ":ref:`wsrep_sst_receive_address `", "*node IP address*", "Yes", "Yes" - ":ref:`wsrep_start_position `", "*see reference entry*", "Yes", "" - ":ref:`wsrep_status_file `", "", "Yes", "No" + ":ref:`wsrep_start_position `", "*see reference entry*", "Yes", "Yes" + ":ref:`wsrep_status_file `", "None", "Yes", "No" ":ref:`wsrep_sync_server_uuid `", "``0``", "Yes", "Yes" ":ref:`wsrep_sync_wait `", "``0``", "Yes", "Yes" ":ref:`wsrep_trx_fragment_size `", "``0``", "Yes", "Yes" @@ -233,7 +233,7 @@ This parameter enables the automatic adjustment of auto increment system variabl "Command-line Format", "``--wsrep-auto-increment-control``" "System Variable", "``wsrep_auto_increment_control``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "Boolean" "Default Value", "``ON`` " "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -270,11 +270,11 @@ This parameter enables the enforcement of strict cluster-wide ``READ COMMITTED`` "Command-line Format", "``--wsrep-causal-reads``" "System Variable", "``wsrep_causal_reads``" "Variable Scope", "Session" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "Boolean" "Default Value", "``OFF`` " "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" - "Deprecated Version", "MySQL-wsrep: 5.5.42-25.12" + "Deprecated Version", "MySQL-wsrep: 5.5.42-25.12, MariaDB 10.1.3, removed from MariaDB 11.3.0" You can execute the following ``SHOW VARIABLES`` statement with a ``LIKE`` operator to see how this variable is set: @@ -336,7 +336,7 @@ This parameter is used to define whether the node should generate primary keys o "Command-line Format", "``--wsrep-certify-nonpk``" "System Variable", "``wsrep_certify_nonpk``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "Boolean" "Default Value", "``ON`` " "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -373,7 +373,7 @@ This parameter sets the back-end schema, IP addresses, ports and options the nod "Command-line Format", "``--wsrep-cluster-address``" "System Variable", "``wsrep_cluster_address``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "No" "Permitted Values", "String" "Default Value", "" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -430,7 +430,7 @@ This parameter defines the logical cluster name for the node. "Command-line Format", "``--wsrep-cluster-name``" "System Variable", "``wsrep_cluster_name``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "String" "Default Value", "``exmaple_cluster``" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -465,7 +465,7 @@ This parameter is used to set whether the node converts ``LOCK/UNLOCK TABLES`` s "Command-line Format", "``--wsrep-convert-lock-to-trx``" "System Variable", "``wsrep_convert_lock_to_trx``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "Boolean" "Default Value", "``OFF``" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -502,10 +502,10 @@ Use this parameter to set the directory the wsrep Provider uses for its files. .. csv-table:: :class: doc-options - "Command-line Format", "???" + "Command-line Format", "``--wsrep_data_home_dir``" "System Variable", "``wsrep_data_home_dir``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "No" "Permitted Values", "Directory" "Default Value", "/path/mysql_datadir" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -540,7 +540,7 @@ You can set debug options to pass to the wsrep Provider with this parameter. "Command-line Format", "``--wsrep-dbug-option``" "System Variable", "``wsrep_dbug_option``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "String" "Default Value", "" "Initial Version", "MySQL-wsrep: 5.5.15-21.1, MariaDB: 5.5.21" @@ -573,7 +573,7 @@ This parameter enables additional debugging output for the database server error "Command-line Format", "``--wsrep-debug``" "System Variable", "``wsrep_debug``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "Boolean" "Default Value", "``OFF``" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -607,10 +607,10 @@ This parameter is used to set whether or not the node participates in Flow Contr .. csv-table:: :class: doc-options - "Command-line Format", "???" + "Command-line Format", "``--wsrep_desync``" "System Variable", "``wsrep_desync``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "Boolean" "Default Value", "``OFF``" "Initial Version", "MySQL-wsrep: 5.5.33-23.7.6, MariaDB: 5.5.33" @@ -693,7 +693,7 @@ This parameter enables workaround for a bug in MySQL InnoDB that affects Drupal "Command-line Format", "``--wsrep-drupal-282555-workaround``" "System Variable", "``wsrep_drupal_282555_workaround``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "Boolean" "Default Value", "``ON``" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -730,7 +730,7 @@ This parameter defines the binary log format for all transactions. "Command-line Format", "``--wsrep-forced-binlog-format``" "System Variable", "``wsrep_forced_binlog_format``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "Enumeration" "Default Value", "``NONE``" "Valid Values", "``ROW``, ``STATEMENT``, ``MIXED``, ``NONE``" @@ -813,7 +813,7 @@ This parameter defines how to log ``INFO``-level wsrep messages. "Command-line Format", "``--wsrep_info_level``" "System Variable", "``wsrep_info_level``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "Numeric" "Default Value", "``0``" "Initial Version", "MySQL-wsrep: 8.0.34" @@ -859,10 +859,11 @@ This parameter defines whether the node splits large ``LOAD DATA`` commands into "Command-line Format", "``--wsrep-load-data-splitting``" "System Variable", "``wsrep_load_data_splitting``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "Boolean" - "Default Value", "``ON``" + "Default Value", "``ON``, defaults to ``OFF`` from MariaDB 10.4.3" "Initial Version", "MySQL-wsrep: 5.5.34-25.29, MariaDB: 5.5.32" + "Deprecated Version", "MariaDB: 10.4.2, removed in MariaDB 11.5" When loading huge amounts of data creates problems for Galera Cluster, in that they eventually reach a size that is too large for the node to rollback completely the operation in the event of a conflict and whatever gets committed stays committed. @@ -896,7 +897,7 @@ This parameter defines whether the node logs additional information about confli "Command-line Format", "``--wsrep-log-conflicts``" "System Variable", "``wsrep_log_conflicts``" "Variable Scope", "Global" - "Dynamic Variable", "No" + "Dynamic Variable", "Yes" "Permitted Values", "Boolean" "Default Value", "``OFF`` " "Initial Version", "MySQL-wsrep: 5.5.28-23.7, MariaDB: 5.5.27" @@ -935,7 +936,7 @@ With this parameter you can set the maximum number of rows the node allows in a "Command-line Format", "``--wsrep-max-ws-rows``" "System Variable", "``wsrep_max_ws_rows``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "String" "Default Value", "``0``" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -970,7 +971,7 @@ You can set the maximum size the node allows for write-sets with this parameter. "Command-line Format", "``--wsrep-max-ws-size``" "System Variable", "``wsrep_max_ws_size``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "String" "Default Value", "``2G``" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -1069,7 +1070,7 @@ This parameter is used to note the IP address and port of the node. "Command-line Format", "``--wsrep-node-address``" "System Variable", "``wsrep_node_address``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "No" "Permitted Values", "String" "Default Value", "Server IP Address, Port ``4567``" "Initial Version", "MySQL-wsrep: 5.5.20-23.4, MariaDB: 5.5.21" @@ -1119,12 +1120,12 @@ This parameter is used to provide the IP address and port from which the node sh "Command-line Format", "``--wsrep-node-incoming-address``" "System Variable", "``wsrep_node_incoming_address``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "No" "Permitted Values", "String" "Default Value", "" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" -This parameter defines the IP address and port number at which the node should expect to receive client connections. It's intended for integration with load balancers. For now, it's otherwise unused by the node. +This parameter defines the IP address and port number at which the node should expect to receive client connections. It is intended for integration with load balancers. For now, it is otherwise unused by the node. You can execute the ``SHOW VARIABLES`` statement with the ``LIKE`` operator as shown below to get the IP address and port setting of this parameter: @@ -1154,7 +1155,7 @@ You can set the logical name that the node uses for itself with this parameter. "Command-line Format", "``--wsrep-node-name``" "System Variable", "``wsrep_node_name``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "No" "Permitted Values", "String" "Default Value", "Server Hostname" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -1191,9 +1192,9 @@ Defines the command the node runs whenever cluster membership or the state of th "Command-line Format", "``--wsrep-notify-cmd``" "System Variable", "``wsrep_notify_cmd``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "String" - "Default Value", "" + "Default Value", "(empty)" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" Whenever the node registers changes in cluster membership or its own state, this parameter allows you to send information about that change to an external script defined by the value. You can use this to reconfigure load balancers, raise alerts and so on, in response to node and cluster activity. @@ -1245,10 +1246,10 @@ Defines whether replication takes place for updates from the current session. .. csv-table:: :class: doc-options - "Command-line Format", "???" + "Command-line Format", "``--wsrep_on``" "System Variable", "``wsrep_on``" "Variable Scope", "Session" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "Boolean" "Default Value", "``ON``" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -1360,9 +1361,9 @@ Defines the path to the :term:`Galera Replication Plugin`. "Command-line Format", "``--wsrep-provider``" "System Variable", "``wsrep_provider``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "No" "Permitted Values", "File" - "Default Value", "" + "Default Value", "None" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" When the node starts, it needs to load the wsrep Provider in order to enable replication functions. The path defined in this parameter tells it what file it needs to load and where to find it. In the event that you do not define this path or you give it an invalid value, the node bypasses all calls to the wsrep Provider and behaves as a standard standalone instance of MySQL. @@ -1393,9 +1394,9 @@ Defines optional settings the node passes to the wsrep Provider. "Command-line Format", "``--wsrep-provider-options``" "System Variable", "``wsrep_provider_options``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "No" "Permitted Values", "String" - "Default Value", "" + "Default Value", "(empty)" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" When the node loads the wsrep Provider, there are several configuration options available that affect how it handles certain events. These allow you to fine tune how it handles various situations. @@ -1552,7 +1553,7 @@ Defines the number of retries the node attempts when an autocommit query fails. "Command-line Format", "``--wsrep-retry-autocommit``" "System Variable", "``wsrep_retry_autocommit``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "No" "Permitted Values", "Integer" "Default Value", "``1``" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -1677,7 +1678,7 @@ Instead of concrete recommendations, there are some general guidelines that you "Command-line Format", "``--wsrep-slave-threads``" "System Variable", "``wsrep_slave_threads``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "Integer" "Default Value", "``1``" "Initial Version", "MySQL-wsrep: 5.1.58-25.11, MariaDB: 5.5.21" @@ -1754,9 +1755,9 @@ Defines the authentication information to use in :term:`State Snapshot Transfer` "Command-line Format", "``--wsrep-sst-auth``" "System Variable", "``wsrep_sst_auth``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "String" - "Default Value", "" + "Default Value", "(empty)" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" When the node attempts a state snapshot transfer using the :term:`Logical State Transfer Method`, the transfer script uses a client connection to the database server in order to obtain the data it needs to send. This parameter provides the authentication information, (that is, the username and password), that the script uses to access the database servers of both sending and receiving nodes. @@ -1791,7 +1792,7 @@ Defines the name of the node that this node uses as a donor in state transfers. "Command-line Format", "``--wsrep-sst-donor``" "System Variable", "``wsrep_sst_donor``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "String" "Default Value", "" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -1843,7 +1844,7 @@ Defines whether the node rejects blocking client sessions on a node when it is s "Command-line Format", "``--wsrep-sst-donor-rejects-queries``" "System Variable", "``wsrep_sst_donor_rejects_queries``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "Boolean" "Default Value", "``OFF``" "Initial Version", "MySQL-wsrep: 5.5.28-23.7, MariaDB: 5.5.28" @@ -1880,7 +1881,7 @@ Defines the method or script the node uses in a :term:`State Snapshot Transfer`. "Command-line Format", "``--wsrep-sst-method``" "System Variable", "``wsrep_sst_method``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "String" "Default Value", "``rsync``" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -1980,7 +1981,7 @@ Defines the node start position. "Command-line Format", "``--wsrep-start-position``" "System Variable", "``wsrep_start_position``" "Variable Scope", "Global" - "Dynamic Variable", "" + "Dynamic Variable", "Yes" "Permitted Values", "String" "Default Value", "``00000000-0000-0000-0000-000000000000:-1/0/0/00000000-0000-0000-0000-000000000000``" "Initial Version", "MySQL-wsrep: 5.1.58-21.1, MariaDB: 5.5.21" @@ -2017,7 +2018,7 @@ Defines the file name for node status output. "Variable Scope", "Global" "Dynamic Variable", "No" "Permitted Values", "String" - "Default Value", "" + "Default Value", "None" "Initial Version", "MySQL-wsrep 8.0.26-26.8" If defined, the file will contain JSON formatted output of node status. The purpose of the file is to provide