Index of wsrep_provider options

Following variables can be set and checked in the wsrep_provider_options variable. Value of the variable can be changed in the MySQL configuration file, my.cnf, or by setting the variable value in the MySQL client.

To change the value of the in the my.cnf following syntax should be used:

wsrep_provider_options="variable1=value1;[variable2=value2]"

For example to increase the size of the Galera buffer storage from the default value to 512MB, my.cnf option should look like:

wsrep_provider_options="gcache.size=512M"

Dynamic variables can be changed from the MySQL client by using the SET GLOBAL syntax. To change the value of the pc.ignore_sb following command should be used:

mysql> SET GLOBAL wsrep_provider_options="pc.ignore_sb=true";

Index

variable base_host
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:value of the wsrep_node_address

This variable sets the value of the node’s base IP. This is an IP address on which Galera listens for connections from other nodes. Setting this value incorrectly would stop the node from communicating with other nodes.

variable base_port
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:4567

This variable sets the port on which the Galera listens for connections from other nodes. Setting this value incorrectly would stop the node from communicating with other nodes.

variable cert.log_conflicts
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:no
variable evs.causal_keepalive_period
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:value of evs.keepalive_period

This variable is used for development purposes and shouldn’t be used by regular users.

variable evs.debug_log_mask
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:Yes
Default Value:0x1

This variable is used for EVS (Extended Virtual Synchrony) debugging it can be used only when wsrep_debug is set to ON.

variable evs.inactive_check_period
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:PT0.5S

This variable defines how often to check for peer inactivity.

variable evs.inactive_timeout
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:PT15S

This variable defines the inactivity limit, once this limit is reached the node will be pronounced dead.

variable evs.info_log_mask
Command Line:No
Config File:Yes
Scope:Global
Dynamic:No
Default Value:0

This variable is used for controlling the extra EVS info logging.

variable evs.install_timeout
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:Yes
Default Value:PT15S

This variable defines the timeout on waiting for install message acknowledgments.

variable evs.join_retrans_period
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:PT1S

This variable defines how often to retransmit EVS join messages when forming cluster membership.

variable evs.keepalive_period
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:PT1S

This variable defines how often will keepalive beacons will be emmited (in the absence of any other traffic).

variable evs.max_install_timeouts
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:1

This variable defines how many membership install rounds to try before giving up (total rounds will be evs.max_install_timeouts + 2).

variable evs.send_window
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:4

This variable defines the maximum number of data packets in replication at a time. For WAN setups may be set considerably higher, e.g. 512. This variable must be no less than evs.user_send_window.

variable evs.stats_report_period
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:PT1M

This variable defines the control period of EVS statistics reporting.

variable evs.suspect_timeout
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:PT5S

This variable defines the inactivity period after which the node is “suspected” to be dead. If all remaining nodes agree on that, the node will be dropped out of cluster even before evs.inactive_timeout is reached.

variable evs.use_aggregate
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:true

When this variable is enabled smaller packets will be aggregated into one.

variable evs.user_send_window
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:Yes
Default Value:2

This variable defines the maximum number of data packets in replication at a time. For WAN setups may be set considerably higher, e.g. 512.

variable evs.version
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:0
variable evs.view_forget_timeout
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:P1D

This variable defines the timeout after which past views will be dropped from history.

variable gcache.dir
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:datadir

This variable can be used to define the location of the galera.cache file.

variable gcache.keep_pages_size
Command Line:Yes
Config File:Yes
Scope:Local, Global
Dynamic:No
Default Value:0

This variable is used to specify total size of the page storage pages to keep for caching purposes. If only page storage is enabled, one page is always present.

variable gcache.mem_size
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:0
variable gcache.name
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:/var/lib/mysql/galera.cache

This variable can be used to specify the name of the Galera cache file.

variable gcache.page_size
Command Line:No
Config File:Yes
Scope:Global
Dynamic:No
Default Value:128M

This variable can be used to specify the size of the page files in the page storage.

variable gcache.size
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:128M

Size of the transaction cache for Galera replication. This defines the size of the galera.cache file which is used as source for IST. If this value is bigger there are better chances that the re-joining node will get IST instead of SST.

variable gcs.fc_debug
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:0

This variable specifies after how many writesets the debug statistics about SST flow control will be posted.

variable gcs.fc_factor
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:1

This variable is used for replication flow control. Replication will be paused till the value of this variable goes below the value of gcs.fc_factor * gcs.fc_limit.

variable gcs.fc_limit
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:16

This variable is used for replication flow control. When slave queue exceeds this limit replication will be paused.

variable gcs.fc_master_slave
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:NO

This variable is used to specify if there is only one master node in the cluster.

variable gcs.max_packet_size
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:64500

This variable is used to specify the writeset size after which they will be fragmented.

variable gcs.max_throttle
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:0.25

This variable specifies how much the replication can be throttled during the state transfer in order to avoid running out of memory. Value can be set to 0.0 if stopping replication is acceptable in order to finish state transfer.

variable gcs.recv_q_hard_limit
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:9223372036854775807

This variable specifies the maximum allowed size of the receive queue. This should normally be half of (RAM + swap). If this limit is exceeded, Galera will abort the server.

variable gcs.recv_q_soft_limit
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:0.25

This variable specifies the fraction of the gcs.recv_q_hard_limit after which replication rate will be throttled.

variable gcs.sync_donor
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:NO

This variable controls if the rest of the cluster should be in sync with the donor node. When this variable is set to Yes whole cluster will be blocked if the donor node is blocked with SST.

variable gmcast.listen_addr
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:tcp://0.0.0.0:4567

This variable defines the address on which node listens to connections from other nodes in the cluster.

variable gmcast.mcast_addr
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:None

This variable should be set up if UDP multicast should be used for replication.

variable gmcast.mcast_ttl
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:1

This variable can be used to define TTL for multicast packets.

variable gmcast.peer_timeout
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:PT3S

This variable specifies the connection timeout to initiate message relaying.

variable gmcast.segment
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:0

This variable specifies the group segment this member should be a part of. Same segment members are treated as equally physically close.

variable gmcast.time_wait
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:PT5S

This variable specifies the time to wait until allowing peer declared outside of stable view to reconnect.

variable gmcast.version
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:0
variable ist.recv_addr
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:value of wsrep_node_address

This variable specifies the address on which nodes listens for Incremental State Transfer (IST).

variable pc.checksum
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:true

This variable controls will the replicated messages will be checksummed or not.

variable pc.ignore_quorum
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:Yes
Default Value:false

When this variable is set to TRUE node will completely ignore the quorum calculations. This should be used with extreme caution even in master-slave setups, because slaves won’t automatically reconnect to master in this case.

variable pc.ignore_sb
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:Yes
Default Value:false

When this variable us set ti TRUE node will process updates even in the case of split brain. This should be used with extreme caution in multi-master setup, but should simplify things in master-slave cluster (especially if only 2 nodes are used).

variable pc.linger
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:PT20S

This variable specifies the period which PC protocol waits for EVS termination.

variable pc.npvo
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:false

When this variable is set to TRUE more recent primary component overrides older ones in case of conflicting prims.

variable pc.recovery
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:true

When this variable is set to true the node stores the Primary Component state to disk. The Primary Component can then recover automatically when all nodes that were part of the last saved state re-establish communications with each other. This feature allows automatic recovery from full cluster crashes, such as in the case of a data center power outage and graceful full cluster restarts without the need for explicitly bootstrapping a new Primary Component.

variable pc.version
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:0
variable pc.weight
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:Yes
Default Value:1

This variable specifies the node weight that’s going to be used for Weighted Quorum calculations.

variable protonet.backend
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:asio

This variable is used to define which transport backend should be used. Currently only ASIO is supported.

variable protonet.version
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:0
variable repl.causal_read_timeout
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:Yes
Default Value:PT30S

This variable specifies the causal read timeout.

variable repl.commit_order
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:3

This variable is used to specify Out-Of-Order committing (which is used to improve parallel applying performance). Allowed values are:

  • 0 – BYPASS: all commit order monitoring is turned off (useful for measuring performance penalty)
  • 1 – OOOC: allow out of order committing for all transactions
  • 2 – LOCAL_OOOC: allow out of order committing only for local transactions
  • 3 – NO_OOOC: no out of order committing is allowed (strict total order committing)
variable repl.key_format
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:Yes
Default Value:FLAT8

This variable is used to specify the replication key format. Allowed values are:

  • FLAT8 shorter - higher probability of key match false positives
  • FLAT16 longer - lower probability of false positives.
  • FLAT8A - same as FLAT8 but with annotations for debug purposes.
  • FLAT16A - same as FLAT16 but with annotations for debug purposes.
variable repl.proto_max
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:5

This variable is used to specify the highest communication protocol version to accept in the cluster. This variable is used only for debugging.

variable socket.checksum
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:2

This variable is used to choose the checksum algorithm for network packets. Available options are:

  • 0 - disable checksum
  • 1 - plain CRC32 (used in Galera 2.x)
  • 2 - hardware accelerated CRC32-C
variable socket.ssl
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:No

This variable is used to specify if the SSL encryption should be used.

variable socket.ssl_cert
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No

This variable is used to specify the path (absolute or relative to working directory) to an SSL certificate (in PEM format).

variable socket.ssl_key
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No

This variable is used to specify the path (absolute or relative to working directory) to an SSL private key for the certificate (in PEM format).

variable socket.ssl_compression
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:Yes

This variable is used to specify if the SSL compression is to be used.

variable socket.ssl_cipher
Command Line:Yes
Config File:Yes
Scope:Global
Dynamic:No
Default Value:AES128-SHA

This variable is used to specify what cypher will be used for encryption.

Percona XtraDB Cluster
Call Us
+1-888-316-9775 (USA - Sales)
+1-208-473-2904 (USA - Sales)
+44-208-133-0309 (UK - Sales)
0-800-051-8984 (UK - Sales)
0-800-181-0665 (GER - Sales)
+1-877-862-4316 (Emergency)
+1-855-55TRAIN (Training)
+1-925-271-5054 (Training)

Table Of Contents

Previous topic

Index of wsrep system variables

Next topic

Index of files created by PXC

This Page



© Copyright Percona LLC and/or its affiliates 2009-2014.
Except where otherwise noted, this documentation is licensed under the following license:
CC Attribution-ShareAlike 2.0 Generic
Created using Sphinx 1.2.2.
This documentation is developed in Launchpad as part of the Percona XtraDB Cluster source code.
If you spotted innacuracies, errors, don't understood it or you think something is missing or should be improved, please file a bug.
]]>