Common Reference

tpm Option Reference

A tpm options

`application-password`

Aliases	`connector-password`
Product	CT

Database password for the connector.

`application-port`

Aliases	`connector-listen-port`
Default	`9999`
Product	CT

Port for the connector to listen on.

`application-readonly-port`

Aliases	`connector-readonly-listen-port`
Product	CT

Port for the connector to listen for read-only connections on.

`application-user`

Aliases	`connector-user`
Product	CT

Database username for the connector.

`auto-enable`

Aliases	`repl-auto-enable`
Valid values	`truefalse`

The default will be true for standalone Tungsten Replicator installations, andfalse for Tungsten Clustering installations.

`auto-recovery-delay-interval`

Aliases	`repl-auto-recovery-delay-interval`
Default	`5s`
Valid values	`#s#m#h`

The delay between the replicator identifying that autorecovery is needed and autorecovery being attempted.

For busy MySQL installations, larger numbers may be needed to allow time for MySQL servers to restart or recover from their failure.

`auto-recovery-max-attempts`

Aliases	`repl-auto-recovery-max-attempts`
Default	`0`

Specifies the number of attempts the replicator will make to go back online. When the number of attempts has been reached, the replicator will remain in the OFFLINE state.

Autorecovery is not enabled until the value of this parameter is set to a non-zero value. The state of autorecovery can be determined using the autoRecoveryEnabled status parameter. The number of attempts made to autorecover can be tracked using the autoRecoveryTotal status parameter.

`auto-recovery-reset-interval`

Aliases	`repl-auto-recovery-reset-interval`
Default	`5s`
Valid values	`#s#m#h`

The time in ONLINE state that indicates to the replicator that the autorecovery procedure has succeeded. For servers with very large transactions, this value should be increased to allow the transaction to be successfully applied.

B tpm options

`backup-directory`

Aliases	`repl-backup-directory`
Default	`[home directory]/backups`

Permanent backup storage directory.

`backup-dump-directory`

Aliases	`repl-backup-dump-directory`
Default	`/tmp`

Backup temporary dump directory.

`backup-method`

Aliases	`repl-backup-method`
Valid values	`mysqldumpxtrabackupxtrabackup-incrementalscriptfile-copy-snapshotebs-snapshotxtrabackup-fullmariabackupmariabackup-incremental`

The default, if not supplied, will be dependant on the enviroment. During installation tpm will detect which tools are available, favouring xtrabackup-full (or mariabackup-full). If not found, then mysqldump will be the default.

Version availability

Available in 7.0.0 and later.

Options mariabackup and mariabackup-incremental are only available from v7.0.0 onwards

`backup-online`

Aliases	`repl-backup-online`
Default	`false`
Valid values	`truefalse`

Does the backup script support backing up a datasource while it is ONLINE.

`backup-options`

Options passed are not validated by Tungsten. They are specific to the backup binary you choose to use and therefore you must ensure accuracy in syntax.

`backup-retention`

Aliases	`repl-backup-retention`
Default	`3`

Number of backups to retain.

`backup-script`

Aliases	`repl-backup-script`

What is the path to the backup script.

`batch-enabled`

Default	`false`
Valid values	`truefalse`

Should the replicator service use a batch applier.

`batch-load-language`

Default	`sql`
Valid values	`jssql`

Which script language to use for batch loading.

`batch-load-template`

Default	`mysql`
Valid values	`nonothingfilehadoop_basefshadoop_kerberoshadoop_singlehadoophdfsmysqlpostgresredshift_singleschemaredshifts3vertica_singleschemavertica`

Value for the loadBatchTemplate property.

`block-commit-policy`

Default	`strict`
Valid values	`laxstrict`

When set to the default (strict) the replicator will commit blocks on service name changes, multiple fragments in a transaction, or unsafe_for_block_commit

This property must be prefixed with property=, for example:

property=replicator.stage.q-to-dbms.blockCommitPolicy=strict

`bridgeServerToClientForcedCloseTimeout`

Default	`50`

Adjust the timeout for Bridge Mode to force close connections (supplied in ms)

This property must be prefixed with property=, for example:

property=bridgeServerToClientForcedCloseTimeout=50

`buffer-size`

Aliases	`repl-buffer-size`
Default	`10`

Replicator queue size between stages (min 1)

C tpm options

`cctrl-column-width`

Default	`80`
Product	CT

Sets the minimum column width for service names within cctrl

`channels`

Aliases	`repl-channels`
Default	`1`

Number of replication channels to use for parallel apply.

`cloud-install`

Default	`false`
Valid values	`truefalse`
Product	TR
Version	`8.0.0`

When set to true (false by default) tpm will skip checks for the endpoint hostname existing in the /etc/hosts file, allowing for much smoother installations against cloud based sources or targets such as Amazon Aurora and Google Cloud SQL.

`cluster-slave-auto-recovery-delay-interval`

Aliases	`cluster-slave-repl-auto-recovery-delay-interval`
Default	`5s`
Valid values	`#s#m#h`

Default value for auto-recover-delay-interval when topology=cluster-slave

`cluster-slave-auto-recovery-max-attempts`

Aliases	`cluster-slave-repl-auto-recovery-max-attempts`
Default	`0`

Default value for auto-recover-max-attempts when topology=cluster-slave

`cluster-slave-auto-recovery-reset-interval`

Aliases	`cluster-slave-repl-auto-recovery-reset-interval`
Default	`5s`
Valid values	`#s#m#h`

Default value for auto-recover-reset-interval when topology=cluster-slave

`composite-datasources`

Aliases	`dataservice-composite-datasources`
Product	CT

Data services that should be added to this composite data service.

`conn-java-enable-concurrent-gc`

Default	`See Notes`
Valid values	`truefalse`
Product	CT

If the host is running Java 8 or earlier, then the default for this property will be true, otherwise the default will be false

`conn-java-mem-size`

Default	`256`
Product	CT

The Connector allocates memory for each concurrent client connection, and may use up to the size of the configured MySQL max_allowed_packet property. With multiple connections, the heap size should be configured to at least the combination of the number of concurrent connections multiplied by the maximum packet size.

`conn-round-robin-include-master`

Default	`false`
Valid values	`truefalse`
Product	CT

Should the Connector include the Primary in round-robin load balancing.

`connection.keepAlive.interval`

Default	`autodetect`
Product	CT

The interval used to check for idle connections. If set to a value of 0, the keep alive check is disabled. Any value greater than zero is the interval check period in seconds.

The parameter must be supplied with the property= prefix, for example:

property=connection.keepAlive.interval=120

`connector-affinity`

Product	CT

Affinity should be specified in the format of writeCluster:readCluster. Values either side of the : can be a single service name or multiple services separated by a comma.

Alternatively set connector-write-affinity and connector-read-affinity independantly.

`connector-allow-cross-site-reconnects-for-reads`

Default	`true`
Valid values	`truefalse`
Product	CT

Whether or not to reject reconnections that follow a read operation (RO_RELAXED or SmartScale after a read)

`connector-allow-cross-site-reconnects-for-writes`

Default	`false`
Valid values	`truefalse`
Product	CT

Whether or not to reject reconnections that follow a write operation (RW_STRICT connection or SmartScale after a write)

`connector-autoreconnect`

Default	`true`
Valid values	`truefalse`
Product	CT

Enable auto-reconnect in the connector.

`connector-autoreconnect-killed-connections`

Default	`true`
Valid values	`truefalse`
Product	CT

By default, the connector operates as follows:

Reconnect closed connections
Retry autocommitted reads

Setting to false disables the reconnection or retry of a connection outside of a planned switch or automatic failover. The default is true, reconnecting and retrying all connections.

`connector-bridge-mode`

Aliases	`enable-connector-bridge-mode`
Default	`true`
Valid values	`truefalse`
Product	CT

Enable the Tungsten Connector bridge mode.

`connector-client-ssl`

Default	`See Notes`
Valid values	`truefalse`
Product	CT

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is true when disable-security-controls=false, or not supplied in v7.0.0+
Default is false when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

`connector-db-version`

Default	`autodetect`
Product	CT

Server version as advertised by the Connector (proxy-mode only).

When not defined or set to autodetect, the version will be set to the same as the primary server. You can override it here, preferably keeping the actual underlying server version with "-tungsten" to indicate client applications that the connection goes through the connector. Note that this option only applies to proxy mode, since bridge mode will always forward the version of the connected node, primary or replica depending on the bridge mode setting.

`connector-default-schema`

Aliases	`connector-forced-schema`
Default	`none`
Product	CT

Default schema for the connector to use.

`connector-delay-before-offline`

Default	`30`
Product	CT

After a connector goes to the ON HOLD state, this property sets numbers of seconds before going OFFLINE.

`connector-delay-before-onhold`

Default	`0`
Product	CT

When the connector loses sight of the managers, delay (in seconds) before going ON HOLD, default of 0 means no delay.

`connector-delete-user-map`

Default	`false`
Valid values	`truefalse`
Product	CT

Overwrite an existing user.map file.

`connector-disable-connection-warnings`

Default	`true`
Valid values	`truefalse`
Product	CT

Hide Connector warnings in log files.

`connector-disconnect-timeout`

Default	`5`
Product	CT

Time (in seconds) to wait for active connection to disconnect before forcing them closed.

`connector-driver-options`

Default	`false`
Valid values	`truefalse`
Product	CT

JDBC connection parameters to be applied to data source connections. Must begin with a question mark ("?" character) and separated by an ampersand ("&" character). In most cases, this setting should not be touched, tpm will apply appropriate values (ssl, QoS, affinity parameters) automatically.

`connector-drop-after-max-connections`

Default	`false`
Valid values	`truefalse`
Product	CT

If using the Go MySQL driver, this property should be set to false to avoid generating and sending EOF packets to client applications when CLIENT_DEPRECATE_EOF is not set on both client and mysql server sides.

`connector-enable-proxy-protocol`

Default	`false`
Valid values	`truefalse`
Product	CT

Note

Currently, Proxy Protocol is ONLY available in the Percona-5.6.25-73.0+ or MariaDB 10.3+. Neither Community edition nor Oracle Enterprise edition yet support this.

`connector-generate-eof`

Default	`true`
Product	CT
Version	`7.1.0`

Set to true if using the GO MySQL Driver.

`connector-keepalive-timeout`

Default	`30000`
Valid values	`<=300000`
Product	CT

Delay (in ms) after which a manager connection is considered broken by the connector if no keep-alive command was received. Value must be positive and lower than 300000 (5 min) or the connector will refuse to start. Make sure this value is set greater than the managermgr-monitor-interval, which controls the frequency at which keep-alive commands are sent.

`connector-listen-interface`

Product	CT

Listen interface to use for the connector.

`connector-manager-use-ssl`

Default	`See Notes`
Valid values	`truefalse`
Product	CT

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is true when disable-security-controls=false, or not supplied in v7.0.0+
Default is false when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

`connector-max-connections`

Default	`-1`
Product	CT

The maximum number of connections the connector should allow at any time. Default of -1 disables limits.

`connector-max-slave-latency`

Aliases	`connector-max-applied-latency`
Default	`-1`
Product	CT

The maximum applied latency for replica connections. Disabled by default (-1).

`connector-read-affinity`

Product	CT

Specify default affinity for all read-only connections. Specify as a single servicename, or a comma separated list.

`connector-readonly`

Aliases	`enable-connector-readonly`
Default	`false`
Valid values	`truefalse`
Product	CT

Enable the Tungsten Connector read-only mode.

`connector-relative-slave-status`

Default	`dataservice-use-relative-latency`
Valid values	`truefalse`
Product	CT

Determines whether the reported latency is relative (true) or absolute (false). Default is the value ofdataservice-use-relative-latency which itself has the default of false.

`connector-reset-when-affinity-back`

Default	`false`
Valid values	`truefalse`
Product	CT

When a site goes offline, connections to this site will be forced closed. Those connections will reconnect, as long as the site stays offline, they will be connected to remote site.

You can now enable an option so that when the site comes back online, the connector will disconnect all these connections that couldn't get to their preferred site so that they will then reconnect to the expected site with the appropriate affinity.

When not enabled, connections will continue to use the server originally configured until they disconnect through normal attribution. This is the default option.

`connector-rest-api`

Default	`true`
Valid values	`truefalse`
Product	CT
Version	`7.0.0`

Enable (default) or Disable the API.

`connector-rest-api-address`

Default	`127.0.0.1`
Product	CT
Version	`7.0.0`

Address for the API to bind too.

`connector-rest-api-authentication`

Default	`true`
Valid values	`truefalse`
Product	CT
Version	`7.0.0`

Enforce authentication for the API.

`connector-rest-api-port`

Default	`8096`
Product	CT
Version	`7.0.0`

Port for the Connector API.

`connector-rest-api-ssl`

Default	`true`
Valid values	`truefalse`
Product	CT
Version	`7.0.0`

Enable SSL for the API.

`connector-ro-addresses`

Product	CT

Connector addresses that should receive a r/o connection.

`connector-rw-addresses`

Product	CT

Connector addresses that should receive a r/w connection.

`connector-rwsplitting`

Default	`false`
Valid values	`truefalse`
Product	CT

Enables Direct Reads R/W splitting in the connector. See "Direct Routing"

Note

Setting to true will enable direct routing for the user defined by application-userwithin the /etc/tungsten/tungsten.ini

`connector-server-ssl`

Aliases	`enable-connector-server-ssl`
Default	`See Notes`
Valid values	`truefalse`
Product	CT

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is true when disable-security-controls=false, or not supplied in v7.0.0+
Default is false when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

`connector-server-ssl`

Default	`See Notes`
Valid values	`truefalse`
Product	CT

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is true when disable-security-controls=false, or not supplied in v7.0.0+
Default is false when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

`connector-server-ssl-ciphers`

Product	CT

Configures cipher suites the connector uses for SSL communications to the dbatabase server.

The default will be to allow all cipher suites supported by the running JVM.

`connector-server-ssl-protocols`

Default	`TLSv1,TLSv1.1,TLSv1.2`
Product	CT

Configures protocols the connector uses for SSL communications to the dbatabase server.

`connector-smartscale`

Default	`false`
Valid values	`truefalse`
Product	CT

Enable SmartScale R/W splitting in the connector.

`connector-smartscale-sessionid`

Default	`DATABASE`
Valid values	`DATABASEUSERCONNECTIONPROVIDED_IN_DBNAME`
Product	CT

The default session ID to use with SmartScale.

`connector-ssl`

Aliases	`enable-connector-ssl`
Default	`See Notes`
Valid values	`truefalse`
Product	CT

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is true when disable-security-controls=false, or not supplied in v7.0.0+
Default is false when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

`connector-ssl`

Default	`See Notes`
Valid values	`truefalse`
Product	CT

This porperty enables both SSL between client application and the connector, and between the connector and the database server.

Setting this to true/false has the same effext as setting the individual connector-client-ssl and connector-server-ssl properties to true/false.

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is true when disable-security-controls=false, or not supplied in v7.0.0+
Default is false when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

`connector-ssl-capable`

Default	`true`
Valid values	`truefalse`
Product	CT

When SSL is enabled, the Connector automatically advertises the ports and itself as SSL capable. With some clients, this triggers them to use SSL even if SSL has not been configured. This causes the connections to fail and not operate correctly.

`connector-thread-stack-size`

Product	CT

Set value in Kb of the Connector thread stack size. By defalt, uses JVM default of 1024.

`connector-write-affinity`

Product	CT

Specify default affinity for all write connections. Specify as a single servicename, or a comma separated list.

`connectors`

Aliases	`dataservice-connectors`
Product	CT

Hostnames for the dataservice connectors.

`consistency-policy`

Aliases	`repl-consistency-policy`
Default	`stop`
Valid values	`stopwarn`

Determines the behavior of the replicator should a consistency check fail.

D tpm options

`--dataservice-name`

Limit the command to the hosts in this dataservice Multiple data services may be specified by providing a comma separated list.

`--delete`

Delete the named data service from the configuration Data Service options.

`--directory`

Set the directory of an existing installation used during fetching an existing configuration.

`dataservice-relay-enabled`

Default	`false`
Valid values	`truefalse`
Product	CT

Make this dataservice a replica of another.

`dataservice-schema`

The db schema to hold dataservice details.

`dataservice-thl-port`

Default	`2112`

Port to use for THL operations.

`dataservice-use-relative-latency`

Aliases	`use-relative-latency`
Default	`false`
Valid values	`truefalse`
Product	CT

Enable the cluster to operate on relative latency.

`dataservice-vip-enabled`

Default	`false`
Valid values	`truefalse`
Product	CT

Is VIP management enabled?

`dataservice-vip-ipaddress`

Product	CT

VIP IP address.

`dataservice-vip-netmask`

Default	`255.255.255.0`
Product	CT

VIP netmask.

`datasource-boot-script`

Aliases	`repl-datasource-boot-script`

Database start script.

`datasource-enable-ssl`

Aliases	`repl-datasource-enable-ssl`
Default	`See note`

Enable SSL connection to DBMS server.

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is true when disable-security-controls=false, or not supplied in v7.0.0+
Default is false when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

`datasource-group-id`

Aliases	`mgr-datasource-group-id`
Default	`0`
Product	CT

All nodes within a cluster that share the same datasource-group-id will form a Distributed Datasource Group (DDG).

`datasource-log-directory`

Aliases	`repl-datasource-log-directory`
Default	`Taken from MySQL configuration`

Set MySQL Binary log directory if different from MySQL default.

`datasource-log-pattern`

Aliases	`repl-datasource-log-pattern`
Default	`Taken from MySQL configuration`

Set MySQL Binary log filename pattern if different from MySQL default.

`datasource-mysql-conf`

Aliases	`repl-datasource-mysql-conf`
Default	`/etc/my.cnf`

MySQL Configuration file.

`datasource-mysql-data-directory`

Aliases	`repl-datasource-mysql-data-directory`
Default	`Taken from MySQL configuration`

Set MySQL data directory if different from MySQL default.

`datasource-mysql-ibdata-directory`

Aliases	`repl-datasource-mysql-ibdata-directory`
Default	`Taken from MySQL configuration`

Set MySQL InnoDB data directory if different from MySQL default.

`datasource-mysql-iblog-directory`

Aliases	`repl-datasource-mysql-iblog-directory`
Default	`Taken from MySQL configuration`

Set MySQL InnoDB log directory if different from MySQL default.

`datasource-mysql-ssl-ca`

Aliases	`repl-datasource-mysql-ssl-ca`
Default	`Taken from MySQL configuration`

Set MySQL SSL CA File.

`datasource-mysql-ssl-cert`

Aliases	`repl-datasource-mysql-ssl-cert`
Default	`Taken from MySQL configuration`

Set MySQL SSL Certificate File.

`datasource-mysql-ssl-key`

Aliases	`repl-datasource-mysql-ssl-key`
Default	`Taken from MySQL configuration`

Set MySQL SSL Key File.

`datasource-oracle-service`

Aliases	`repl-datasource-oracle-service`
Product	TR

Oracle Service Name.

`datasource-oracle-service`

Aliases	`repl-datasource-oracle-service`
Product	TR

Oracle Service Name.

`datasource-systemctl-service`

Aliases	`repl-datasource-systemctl-service`

Specifies the command name or full path of the command that should be used to control the database service, including startup, shutdown and restart. This is used by Tungsten to control the underlying database service. By default, this will be configured to the service according to your environment if it has been found during installation. For example, the systemctl command.

`datasource-type`

Aliases	`repl-datasource-type`
Default	`mysql`
Valid values	`mysqlmongodbverticaoraclehdfskafkapostgresfile`

For Replicator Extractors and Cluster nodes, this value can only be set to mysql. Other options are applicable to standalone hetergeneous replicator appliers (includeing cluster-slave appliers) only.

`defaultAuthPlugin`

Valid values	`mysql_native_passwordcaching_sha2_password`

The default mirrors the default authentication for mysql but can be overidden by setting this property

The parameter must be supplied with the property= prefix, for example:

property=defaultAuthPlugin=caching_sha2_password

`deploy-systemd`

Default	`false`
Valid values	`truefalse`
Version	`7.1.0`

Setting to true will deploy and configure software to be controlled by systemd.

`direct-datasource-log-directory`

Aliases	`repl-direct-datasource-log-directory`
Default	`Taken from MySQL configuration`
Product	TR

Set MySQL Binary log directory if different from MySQL default.

`direct-datasource-log-pattern`

Aliases	`repl-direct-datasource-log-pattern`
Default	`Taken from MySQL configuration`
Product	TR

Set MySQL Binary log filename pattern if different from MySQL default.

`direct-datasource-type`

Aliases	`repl-direct-datasource-type`
Default	`mysql`
Valid values	`mysqlmongodbverticaoraclehdfskafkapostgresfile`
Product	TR

`direct-replication-host`

Aliases	`repl-direct-datasource-hostdirect-datasource-host`
Product	TR

Database server hostname.

`direct-replication-password`

Aliases	`repl-direct-datasource-passworddirect-datasource-password`
Product	TR

Password for datasource connection.

`direct-replication-port`

Aliases	`repl-direct-datasource-portdirect-datasource-port`
Product	TR

Database server port.

`direct-replication-user`

Aliases	`repl-direct-datasource-userdirect-datasource-user`
Product	TR

Database login for Tungsten.

`disable-relay-logs`

Aliases	`repl-disable-relay-logs`
Default	`true`
Valid values	`truefalse`

Disable the use of relay-logs.

`disable-security-controls`

Aliases	`repl-disable-relay-logs`
Default	`false`
Valid values	`truefalse`

Disables all forms of security, including SSL, TLS and authentication.

Note

The behavior of this property changed in v7.0.0

In version prior to v7.0.0, the default was true

`disable-slave-extractor`

Aliases	`repl-disable-slave-extractor`
Valid values	`truefalse`

Should replica servers support the primary role?

Note

The default will be true if enable-heterogeneous-slave=true, otherwise the default will be false

`drop-static-columns-in-updates`

Aliases	`drop-static-columns`
Default	`false`
Valid values	`truefalse`

This will modify UPDATE transactions in row-based replication and eliminate any columns that were not modified.

E tpm options

`enable-active-witnesses`

Aliases	`active-witnesses`
Default	`false`
Valid values	`truefalse`
Product	CT

Enable active witness hosts.

`enable-batch-master`

Default	`false`
Valid values	`truefalse`
Product	TR

Enable batch operation for the primary.

`enable-batch-service`

Default	`false`
Valid values	`truefalse`
Product	TR

This option enables batch mode for a service, which ensures that replication services that are writing to a target database using batch mode in heterogeneous deployments (for example Hadoop, Amazon Redshift or Vertica). Setting this option enables the following settings on each host:

On a Primary
- mysql-use-bytes-for-string is set to false.
- colnames filter is enabled (in the binlog-to-q stage to add column names to the THL information.
- pkey filter is enabled (in the binlog-to-q andq-to-dbms stage), with the addPkeyToInsertsand addColumnsToDeletes filter options set to true. This ensures that rows have the right primary key information.
- enumtostring filter is enabled (in the q-to-thl stage), to translate ENUM values to their string equivalents.
- settostring filter is enabled (in the q-to-thl stage), to translate SET values to their string equivalents.
On a Replica
- mysql-use-bytes-for-string is set to true.
- pkey filter is enabled (q-to-dbmsstage).

`enable-batch-slave`

Default	`false`
Valid values	`truefalse`
Product	TR

Enable batch operation for the replica.

`enable-connector-client-ssl`

Aliases	`connector-client-ssl`
Default	`See Notes`
Valid values	`truefalse`
Product	CT

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is true when disable-security-controls=false, or not supplied in v7.0.0+
Default is false when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

`enable-heterogeneous-master`

Default	`false`
Valid values	`truefalse`

Enable heterogeneous operation for the primary.

`enable-heterogeneous-service`

Default	`false`
Valid values	`truefalse`

On a Primary
- mysql-use-bytes-for-string is set to false.
- colnames filter is enabled (in the binlog-to-q stage to add column names to the THL information.
- pkey filter is enabled (in the binlog-to-q andq-to-dbms stage), with the addPkeyToInserts andaddColumnsToDeletes filter options set to false.
- enumtostring filter is enabled (in the q-to-thl stage), to translate ENUM values to their string equivalents.
- settostring filter is enabled (in the q-to-thl stage), to translate SET values to their string equivalents.
On a Replica
- mysql-use-bytes-for-string is set to true.
- pkey filter is enabled (q-to-dbms stage).

`enable-heterogeneous-slave`

Default	`false`
Valid values	`truefalse`

Enable heterogeneous operation for the replica.

`enable-slave-thl-listener`

Aliases	`repl-enable-slave-thl-listener`
Default	`true`
Valid values	`truefalse`

The default behavior of this property is different in certain installs.

For a cluster node install that INCLUDES the manager process, AND where the install OS user is NOT root, the default will be true

For a Replicator only or Connector only install, the default will be false

When set to true, the property has the following effect:

During staging tpm installs, if the tungsten user is different from the ssh user on remote hosts
All startup scripts when using systemctl: replicator, connector, manager will call systemctl prefixed with sudo: for example: sudo -n systemctl start treplicator
tprovision requires sudo access for mysql and xtrabackup calls
replicator backup script for xtrabackup and other backup utilities
check_tungsten.sh utility to call xinetd
tmonitor starts exporter service with sudo
manager to restart mysql service when found stopped
tpm diagnostic operation (tpm diag)

`enable-sudo-access`

Aliases	`root-command-prefix`
Valid values	`truefalse`

Should this service allow THL connections.

`enable-validation-check`

The enable-validation-check will specifically enable a given validation check if the check had previously been set to be ignored in a previous invocation of the configuration through tpm. If a check fails, installation is canceled.

Setting both skip-validation-check and enable-validation-check is equivalent to explicitly disabling the specified check.

`enable-validation-warnings`

The enable-validation-warnings will specifically enable a given validation warning check if the check had previously been set to be ignored in a previous invocation of the configuration through tpm.

Setting both skip-validation-warnings and enable-validation-warnings is equivalent to explicitly disabling the specified check.

`executable-prefix`

When enabled, the supplied prefix is added to each command alias that is generated for a given installation. This enables multiple installations to co-exist and and be accessible through a unique alias. For example, if the executable prefix is configured as east, then an alias for the installation to trepctl will be created aseast_trepctl.

Alias information for executable prefix data is stored within the $CONTINUENT_ROOT/share/aliases.shfile for each installation.

F tpm options

`file-protection-level`

Default	`See Notes`
Valid values	`nonegroupuser`

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is group when disable-security-controls=false, or not supplied in v7.0.0+
Default is none when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

H tpm options

`--hosts`

Limit the command to the hosts listed You must use the hostname as it appears in the configuration.

`host-name`

DNS hostname.

`hub`

Aliases	`dataservice-hub-host`
Product	TR

What is the hub host for this all-masters dataservice?

`hub-service`

Aliases	`dataservice-hub-service`
Product	TR

The data service to use for the hub of a star topology?

I tpm options

`install`

Aliases	`deploy_systemd`
Default	`false`
Valid values	`truefalse`

Configures services with systemd during installation. The same as executing deployall after installation.

`install-directory`

Aliases	`home-directory`

Path to the directory where the active deployment will be installed. The configured directory will contain the software, THL and relay log information unless configured otherwise.

J tpm options

`java-connector-keystore-password`

Product	CT

Set the password for unlocking the tungsten_connector_keystore.jks file in the security directory. Specific to connector<->mysql communication only.

`java-connector-keystore-path`

Default	`[install-directoy]/share`
Product	CT

Local path to the Java Connector Keystore file. Specific to connector<->mysql communication only.

`java-connector-truststore-password`

Product	CT

Set the password for unlocking the tungsten_connector_truststore.jks file in the security directory. Specific to connector<->mysql communication only.

`java-connector-truststore-path`

Default	`[install-directoy]/share`
Product	CT

Local path to the Java Connector Truststore file. Specific to connector<->mysql communication only.

`java-enable-concurrent-gc`

Aliases	`repl-java-enable-concurrent-gc`
Default	`See Notes`
Valid values	`truefalse`

If the host is running Java 8 or earlier, then the default for this property will be true, otherwise the default will be false

`java-file-encoding`

Aliases	`repl-java-file-encoding`
Default	`utf8`

Java platform charset (esp. for heterogeneous replication)

`java-jgroups-key`

Aliases	`java-jgroups-entry-alias`
Default	`jgroups`

The alias to use for the JGroups TLS key in the keystore.

`java-jgroups-keystore-path`

Default	`[install-directoy]/share`
Product	CT

Local path to the JGroups Java Keystore file.

`java-jmxremote-access-path`

Default	`[SECURITY_DIRECTORY]/jmxremote.access`

Local path to the Java JMX Remote Access file.

`java-keystore-password`

Default	`tungsten`

Set the password for unlocking the tungsten_keystore.jks file in the security directory. Specific for intra cluster communication.

`java-keystore-path`

Default	`[install-directoy]/share`

Local path to the Java Keystore file. Specific for intra cluster communication.

Note

When java-keystore-path is passed to tpm, the keystore must contain both tls and mysql certs when appropriate. tpm will NOT add mysql cert nor generate tls cert when this flag is found, so both certs must be manually imported already. Additionally, java-mysql-alias must be specificed when using custom keystores.

`java-mem-size`

Aliases	`repl-java-mem-size`
Default	`1024`

Replicator Java heap memory size in Mb (min 128)

`java-mysql-alias`

Aliases	`java-mysql-entry-alias`
Default	`mysql`

Specify the alias used for the mysql certificate in the tungsten_keystore and the tungsten_connector_keystore. Must be specified when supplying custom keystores.

`java-passwordstore-path`

Default	`[install-directoy]/share`

Local path to the Java Password Store file

`java-thl-keystore-path`

Default	`[install-directoy]/share`

Local path to the Java THL Keystore file

`java-thl-truststore-path`

Default	`[install-directoy]/share`

Local path to the Java THL Truststore file.

`java-tls-alias`

Aliases	`java-tls-entry-alias`
Default	`tls`

The alias to use for the TLS key/certificate in the keystore and truststore.

`java-tls-key-lifetime`

Default	`3650`

Lifetime for the Java TLS key (in days)

`java-tls-keystore-path`

Default	`[install-directoy]/share`

The keystore holding a certificate to use for all Continuent TLS encryption.

`java-truststore-password`

Default	`tungsten`

The password for unlocking the tungsten_truststore.jks file in the security directory.

`java-truststore-path`

Default	`[install-directoy]/share`

Local path to the Java Truststore file.

`jgroups-ssl`

Aliases	`enable-jgroups-ssl`
Default	`See Notes`

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is true when disable-security-controls=false, or not supplied in v7.0.0+
Default is false when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

L tpm options

`log-slave-updates`

Default	`false`
Valid values	`truefalse`

When enabled, transactions written to a replica will be logged to the replicas binary logs.

Warning

This property must be enabled with care. Incorrectly enabling this could result in circular replication and data corruption.

M tpm options

`manager-replicator-offline-timeout`

Default	`180`
Product	CT

Timeout (in seconds) for the manager to wait until the replicator goes offline.

`manager-rest-api`

Aliases	`mgr-api`
Default	`true`
Valid values	`truefalse`
Product	CT

Enable (default) or Disable API.

`manager-rest-api-address`

Aliases	`mgr-api-address`
Default	`127.0.0.1`
Product	CT
Version	`7.0.0`

Address for the API to bind too.

`manager-rest-api-authentication`

Default	`true`
Valid values	`truefalse`
Product	CT
Version	`7.0.0`

Enforce authentication for the API.

`manager-rest-api-port`

Aliases	`mgr-api-port`
Default	`8090`
Product	CT
Version	`7.0.0`

Port for the manager API.

`manager-rest-api-ssl`

Default	`true`
Valid values	`truefalse`
Product	CT
Version	`7.0.0`

Enable SSL for the API.

`manager.failover.thl.apply.wait.timeout`

Default	`0`
Product	CT

How long should the manager wait until the failover candidate replica has applied all stored THL. Default of 0 equates to waiting indefinitely.

Parameter must be supplied with the property= prefix, for example:

property=manager.failover.thl.apply.wait.timeout=900

`master`

Aliases	`mastersdataservice-master-hostrelay`

Hostname of the primary (or relay) host within this service.

`master-preferred-role`

Aliases	`repl-master-preferred-role`
Valid values	`masterslave`

Preferred role for primary THL when connecting as a replica.

If the chosen topology is either cluster-slave or composite-multi-master, the default is slave, otherwise the default is not set.

`master-services`

Aliases	`repl-master-services`

Data service names that should be used on each primary.

`master-thl-host`

Primary THL Hostname.

`master-thl-port`

Default	`2112`

Primary THL Port. Default will be the same as the value for thl-port, 2112 if neither set.

`members`

Aliases	`dataservice-hostsslaves`

Hostnames for the dataservice members.

`metadata-directory`

Aliases	`repl-metadata-directory`
Default	`[install-directory]/metadata`

Replicator metadata directory.

`mgr-api-full-access`

Default	`true`
Valid values	`truefalse`
Product	CT

Enable all Manager API (v1) commands. Only the status command will be enabled without it.

`mgr-group-communication-port`

Default	`7800`
Product	CT

Port to use for manager group communication.

`mgr-heap-threshold`

Default	`200`
Product	CT

Java memory usage (MB) that will force a Manager restart.

`mgr-java-enable-concurrent-gc`

Default	`See Notes`
Valid values	`truefalse`
Product	CT

If the host is running Java 8 or earlier, then the default for this property will be true, otherwise the default will be false

`mgr-java-mem-size`

Default	`250`
Product	CT

Manager Java heap memory size in Mb (min 128)

`mgr-listen-interface`

Product	CT

Listen interface to use for the manager.

`mgr-monitor-interval`

Default	`3000`
Product	CT

Frequency, in milliseconds, at which managers monitor the database and replicator.

`mgr-ping-method`

Default	`ping`
Valid values	`pingecho`
Product	CT

Mechanism to use when identifying the liveness of other datasources (ping, echo)

ping is the default if other hosts are pingable, otherwise defaults to echo

`mgr-policy-fence-slave`

Default	`60`
Product	CT

Set the number of seconds before a replica is put offline after the replicator goes offline. This will avoid traffic routing to replicas that are stale.

`mgr-policy-mode`

Default	`automatic`
Valid values	`automaticmanualmaintenance`
Product	CT

Manager Policy mode.

`mgr-rmi-port`

Default	`9997`
Product	CT

Port to use for the manager RMI server.

`mgr-rmi-remote-port`

Default	`12000`
Product	CT

Port to use for calling the remote manager RMI server.

`mgr-ro-slave`

Default	`true`
Valid values	`truefalse`
Product	CT

Make replicas read-only.

`mgr-vip-arp-path`

Product	CT

Path to the arp binary.

The default for this is taken from the result of which arp. Should that return no results, then either one of /sbin/arp, /usr/sbin/arp or /user/local/sbin/arp

`mgr-vip-device`

Product	CT

VIP network device.

`mgr-vip-ifconfig-path`

Product	CT

Path to the ifconfig binary.

The default for this is taken from the result of which ifconfig. Should that return no results, then either one of /sbin/ifconfig, /usr/sbin/ifconfig or /user/local/sbin/ifconfig.

`mgr-wait-for-members`

Default	`false`
Valid values	`truefalse`
Product	CT

Wait for all datasources to be available before completing installation.

`mon-db-query-timeout`

Default	`5`
Product	CT

Defines the timeout (in secs) for the managers mysql_checker_query.sql call.

`mysql-allow-intensive-checks`

Default	`false`
Valid values	`truefalse`

For MySQL installation, enables detailed checks on the supported data types within the MySQL database to confirm compatibility. This includes checking each table definition individually for any unsupported data types.

`mysql-driver`

Default	`drizzle`

MySQL Driver Vendor.

`mysql-enable-ansiquotes`

Aliases	`repl-mysql-enable-ansiquotes`
Default	`false`
Valid values	`truefalse`

Enables ANSI_QUOTES mode as a filter on the applier stages.

`mysql-enable-enumtostring`

Aliases	`repl-mysql-enable-enumtostring`
Valid values	`truefalse`

Enable a filter to convert ENUM types to strings.

The default will be true if hetergogeneous replication is enabled, otherwise it will be false

`mysql-enable-noonlykeywords`

Aliases	`repl-mysql-enable-noonlykeywords`
Default	`false`
Valid values	`truefalse`

Enables an applier filter to translate DELETE FROM ONLY to DELETE FROM andUPDATE ONLY to UPDATE

`mysql-enable-settostring`

Aliases	`repl-mysql-enable-settostring`
Valid values	`truefalse`

Enable a filter to convert SET types to strings.

The default will be true if hetergogeneous replication is enabled, otherwise it will be false

`mysql-ro-slave`

Aliases	`repl-mysql-ro-slave`
Default	`true`
Valid values	`truefalse`

Replicas are read-only.

`mysql-server-id`

Aliases	`repl-mysql-server-id`

Setting this option explicitly sets the server-id information normally located in the MySQL configuration (my.cnf). This is useful in situations where there may be multiple MySQL installations and the server ID needs to be identified to prevent collisions when reading from the same primary.

`mysql-use-bytes-for-string`

Aliases	`repl-mysql-use-bytes-for-string`

Transfer strings as their byte representation.

The default will be true if hetergogeneous replication is enabled, otherwise it will be false

`mysql-xtrabackup-dir`

Aliases	`repl-mysql-xtrabackup-dir`
Default	`[BACKUP-DIRECTORY]/xtrabackup`

Directory to use for storing xtrabackup full & incremental backups.

N tpm options

`native-slave-takeover`

Aliases	`repl-native-slave-takeover`
Default	`false`
Valid values	`truefalse`

Takeover native replication.

O tpm options

`optimize-row-events`

Default	`true`
Valid values	`truefalse`

Bundles multiple row-based events into a single INSERT or DELETE statement. This increases the throughput of large batches of row-based events.

`optimize-row-events-limit-delete-rows`

Default	`100`
Version	`7.0.2`

Limits the number of deletes grouped per event when optimize-row-events is enabled. Note that deletes can only be optimized for tables with single column PK's

`optimize-row-events-limit-insert-rows`

Default	`50`

Limits the number of inserts grouped per event when optimize-row-events is enabled.

P tpm options

`policy-relay-from-slave`

Default	`false`
Valid values	`truefalse`
Product	CT

Cross-site replicators within a Composite Active/Active deployment can be configured to point to replicas by default, and to prefer replicas over primaries during operation. In a standard deployment, cross-site replicators work via primaries at each cluster site to read the remote information. To configure the service to use replicas in preference to primaries, set this property to true. Both primaries and replicas remain in the list of possible hosts, so if no replicas are available during a switch or failover event, then a primary will be used.

`policy.fence.masterReplicator`

Default	`false`
Product	CT

If set to true, a failover will occur 70 seconds after initial detection of a replicator failure.

Parameter must be supplied with the property= prefix, for example:

property=policy.fence.masterReplicator=false

`policy.fence.masterReplicator.threshold`

Default	`6`
Product	CT

Sets the number of iterations to try to recover the replicator, one iteration every 10 seconds, after which the fencing occurs.

Parameter must be supplied with the property= prefix, for example:

property=policy.fence.masterReplicator.threshold=6

`policy.invalid.membership.retry.threshold`

Default	`3`
Product	CT

Set the delay, in seconds, before a FAILSAFE-SHUN is invoked.

Parameter must be supplied with the property= prefix, for example:

property=policy.slave.promotion.latency.threshold=900

`policy.liveness.dbping.fail.threshold`

Default	`1`
Product	CT

If the database cannot respond to a tcp connect request after the configured number of attempts, the database server is flagged asSTOPPED which initiates the failover.

Parameter must be supplied with the property= prefix, for example:

property=policy.liveness.dbping.fail.threshold=1

`policy.liveness.hostPing.fail.threshold`

Default	`2`
Product	CT

Parameter must be supplied with the property= prefix, for example:

property=policy.liveness.hostPing.fail.threshold=2

`policy.replica.promotion.max.synchronizing.duration`

Default	`0`
Product	CT

Sets the threshold for a candidate node to be rejected from failover/switch promotion if the replicator is in a SYNCHRONIZING state. Specified in seconds. The default value (0) disables this check.

Parameter must be supplied with the property= prefix, for example:

property=policy.replica.promotion.max.synchronizing.duration=60

`policy.slave.promotion.latency.threshold`

Default	`900`
Product	CT

The upper threshold, in seconds, for appliedLatency when deciding on the validity of a replica for promotion during a switch/failover.

Parameter must be supplied with the property= prefix, for example:

property=policy.slave.promotion.latency.threshold=900

`postgresql-dbname`

Aliases	`repl-postgresql-dbname`
Product	TR

Name of the database to replicate.

`prefer-ip-stack`

Default	`4`
Valid values	`46`
Version	`7.0.0`

Switch between IPv4 and IPv6 support.

`preferred-path`

Specifies one or more additional directories that will be added before the current PATH environment variable when external commands are run from within the backup environment. This affects all external tools used including MySQL, Ruby, Java, and backup/restore tools such as Percona Xtrabackup.

One or more paths can be specified by separating each directory with a colon. For example:

preferred-path=/usr/local/bin:/opt/bin:/opt/percona/bin

`prefetch-schema`

Default	`tungsten_[servicename]`

Schema to watch for timing prefetch progress.

`privileged-master`

Default	`true`
Valid values	`truefalse`

When extracting from cloud based instances, or instances when you are unable to grant SUPER privileges to the tungsten replicator user, set this property to false.

`privileged-slave`

Default	`true`
Valid values	`truefalse`

When applying to cloud based instances, or instances when you are unable to grant SUPER privileges to the tungsten replicator user, set this property to false.

`profile-script`

Append commands to include env.sh in this profile script.

`property=key=value`

The property option enables you to explicitly set property values where an alias does not exist.

Throughout the reference documentation, where the property option is required, this is specified. Most common uses are when configuring replicator filters.

`protect-configuration-files`

Default	`true`
Valid values	`truefalse`

When enabled (default), the configuration files that contain user, password and other information are configured so that they are only readable by the configured user. For example:

shell> ls -al /opt/continuent/tungsten/tungsten-replicator/conf/
total 148
drwxr-xr-x 2 tungsten mysql 4096 May 14 14:32 ./
drwxr-xr-x 11 tungsten mysql 4096 May 14 14:32 ../
-rw-r--r-- 1 tungsten mysql 33 May 14 14:32 dynamic-alpha.role
-rw-r--r-- 1 tungsten mysql 5059 May 14 14:32 log4j.properties
-rw-r--r-- 1 tungsten mysql 3488 May 14 14:32 log4j-thl.properties
-rw-r--r-- 1 tungsten mysql 972 May 14 14:32 mysql-java-charsets.properties
-rw-r--r-- 1 tungsten mysql 420 May 14 14:32 replicator.service.properties
-rw-r----- 1 tungsten mysql 1590 May 14 14:35 services.properties
-rw-r----- 1 tungsten mysql 1590 May 14 14:35 .services.properties.orig
-rw-r--r-- 1 tungsten mysql 896 May 14 14:32 shard.list
-rw-r----- 1 tungsten mysql 43842 May 14 14:35 static-alpha.properties
-rw-r----- 1 tungsten mysql 43842 May 14 14:35 .static-alpha.properties.orig
-rw-r----- 1 tungsten mysql 5667 May 14 14:35 wrapper.conf
-rw-r----- 1 tungsten mysql 5667 May 14 14:35 .wrapper.conf.orig

When disabled, the files are readable by all users:

shell> ll /opt/continuent/tungsten/tungsten-replicator/conf/
total 148
drwxr-xr-x 2 tungsten mysql 4096 May 14 14:32 ./
drwxr-xr-x 11 tungsten mysql 4096 May 14 14:32 ../
-rw-r--r-- 1 tungsten mysql 33 May 14 14:32 dynamic-alpha.role
-rw-r--r-- 1 tungsten mysql 5059 May 14 14:32 log4j.properties
-rw-r--r-- 1 tungsten mysql 3488 May 14 14:32 log4j-thl.properties
-rw-r--r-- 1 tungsten mysql 972 May 14 14:32 mysql-java-charsets.properties
-rw-r--r-- 1 tungsten mysql 420 May 14 14:32 replicator.service.properties
-rw-r--r-- 1 tungsten mysql 1590 May 14 14:32 services.properties
-rw-r--r-- 1 tungsten mysql 1590 May 14 14:32 .services.properties.orig
-rw-r--r-- 1 tungsten mysql 896 May 14 14:32 shard.list
-rw-r--r-- 1 tungsten mysql 43842 May 14 14:32 static-alpha.properties
-rw-r--r-- 1 tungsten mysql 43842 May 14 14:32 .static-alpha.properties.orig
-rw-r--r-- 1 tungsten mysql 5667 May 14 14:32 wrapper.conf
-rw-r--r-- 1 tungsten mysql 5667 May 14 14:32 .wrapper.conf.orig

R tpm options

`--replace-jgroups-certificate`

Product	CT

Used to replace the JGroups Certificate as part of an update. See "Replacing the JGroups Certificate" for more information.

`--replace-tls-certificate`

Used to replace the TLS Certificate as part of an update. See "Replacing the TLS Certificate" for more information.

`--reset`

Clear the current configuration before processing any arguments.

`readAutodetectConfigFromPrimary`

Default	`true`
Valid values	`truefalse`
Product	CT
Version	`7.2.0`

The connector always reads its dynamic (auto-detect) configuration from the primary node by default. Setting this property to false will force reading from a replica. Parameter must be supplied with the property= prefix, for example:

property=readAutodetectConfigFromPrimary=false

`redshift-dbname`

Aliases	`repl-redshift-dbname`
Product	TR

Name of the Redshift database to replicate into.

`relay-directory`

Aliases	`repl-relay-directory`
Default	`[INSTALL-DIRECTORY]/relay`

Directory for logs transferred from the primary.

`relay-enabled`

Default	`false`
Valid values	`truefalse`

Should the replicator service be setup as a relay.

`relay-source`

Aliases	`master-dataservicedataservice-relay-source`

Dataservice name to use as a relay source.

`repl-allow-bidi-unsafe`

Default	`false`
Valid values	`truefalse`

Allow unsafe SQL from remote service.

`repl-store-thl-compressed`

Default	`false`
Valid values	`truefalse`
Version	`7.0.0`

Enable (true) or disable (false) compression of THL on disk.

`repl-store-thl-encrypted`

Default	`false`
Valid values	`truefalse`
Version	`7.0.0`

Enable (true) or disable (false) encryption of THL on disk.

`repl-svc-extractor-multi-frag-service-detection`

Default	`false`
Valid values	`truefalse`
Version	`7.0.0`

When working with multi-active topologies and unprivileged database access (Such as Aurora) the replicator will need to read ahead to the last fragment to ensure multi-fragmented events are correctly flagged by the BidiRemoteSlaveFilter. Disabled by default (false). Set to true to enable.

`repl-svc-extractor-multi-frag-service-detection`

Default	`false`
Valid values	`truefalse`

Replace the TLS certificate.

`repl-thl-client-serialization`

Default	`LEGACY,JAVA,PROTOBUF,DEFALTE`
Valid values	`LEGACYJAVAPROTOBUFDEFALTE`
Version	`7.0.0`

Comma Separated list of THL compression protocols to enable on downstream Replication Appliers.

`repl-thl-server-serialization`

Default	`LEGACY,JAVA,PROTOBUF,DEFALTE`
Valid values	`LEGACYJAVAPROTOBUFDEFALTE`
Version	`7.0.0`

Comma Separated list of THL compression protocols to enable on the thl-server (Extractor).

`repl-time-zone`

Aliases	`time-zone`
Default	`GMT`

Replicator Time Zone.

`replica-tx-commit-level`

Default	`1`
Valid values	`12`
Product	CT
Version	`7.0.0`

If set, determines the value of the underlying database property innodb_flush_log_at_trx_commitwhen a node becomes a replica.

It will be reset to 1 when the node is promoted to a primary.

Setting a value of 2 can improve the performance of writes during the apply stage of replication.

`replication-host`

Aliases	`repl-datasource-hostdatasource-host`

Hostname of the datasource where the database is located. If the specified hostname matches the current host or member name, the database is assumed to be local. If the hostnames do not match, extraction is assumed to be via remote access. For MySQL hosts, this configures a remote replication replica (relay) connection.

`replication-password`

Aliases	`repl-datasource-passworddatasource-password`

The password to be used when connecting to the database using the corresponding replication-user

`replication-port`

Aliases	`repl-datasource-portdatasource-port`
Default	`See Notes`

The network port used to connect to the database server. The default port used depends on the database being configured.

The defaults, based on the value of datasource-type:

3306 when datasource-type=mysql or when datasource-type not set.
5433 when datasource-type=vertica.
1521 when datasource-type=oracle.
8020 when datasource-type=hdfs.
27017 when datasource-type=kafka or datasource-type=mongodb.
5432 when datasource-type=postgres.
5439 when datasource-type=redshift.

`replication-user`

Aliases	`repl-datasource-userdatasource-user`

User for database connection.

`replicator-rest-api`

Default	`true`
Valid values	`truefalse`
Version	`7.0.0`

Enable or Disable API.

`replicator-rest-api-address`

Default	`127.0.0.1`
Version	`7.0.0`

Address for the API to bind too.

`replicator-rest-api-authentication`

Default	`true`
Valid values	`truefalse`
Version	`7.0.0`

Enforce authentication for the API.

`replicator-rest-api-port`

Default	`8097`
Version	`7.0.0`

Port for the Replicator API.

`replicator-rest-api-ssl`

Default	`true`
Valid values	`truefalse`
Version	`7.0.0`

Enable or Disable SSL for the API.

`replicator.extractor.dbms.transaction_frag_size`

Default	`1000000`

Controls the size of fragments for long transactions. Tungsten automatically breaks up long transactions into fragments. This parameter controls the number of bytes of binlog per transaction fragment.

This property must be prefixed with property=:

property=replicator.extractor.dbms.transaction_frag_size

`replicator.store.thl.stopOnDBError`

Default	`false`
Valid values	`truefalse`

When left as default, the Manager will delay failover until all remaining events have been extracted from the binary logs on the failing Primary node as a way to protect data integrity. When set to true, the Replicator will stop extracting once it is unable to update thetrep_commit_seqno table in MySQL, and the Manager will perform the failover without waiting, at the risk of possible data loss due to leaving binlog events behind.

This property must be prefixed with property=:

property=replicator.store.thl.stopOnDBError

`rest-api-address`

Default	`127.0.0.1`
Version	`7.2.0`

Address for the API to bind too. Setting this property acts as a group alias forconnector-rest-api-address, manager-rest-api-address and replicator-rest-api-address.

`rest-api-admin-pass`

Aliases	`rest-api-admin-password`
Version	`7.0.0`

Specify the initial Admin User Password for API access. rest-api-admin-password alias only available from version 7.1.2 onwards.

`rest-api-admin-user`

Version	`7.0.0`

Specify the initial Admin Username for API access.

`rest-api-authentication`

Default	`true`
Valid values	`truefalse`
Version	`7.2.0`

Enable Authentication for the API. Setting this property acts as a group alias forconnector-rest-api-authentication, manager-rest-api-authentication and replicator-rest-api-authentication.

`rest-api-ssl`

Default	`true`
Valid values	`truefalse`
Version	`7.2.0`

Enable SSL for the API. Setting this property acts as a group alias forconnector-rest-api-ssl, manager-rest-api-ssl and replicator-rest-api-ssl.

`rest-apis`

Default	`true`
Valid values	`truefalse`
Version	`7.2.0`

Enable or Disable API. Setting this property acts as a group alias forconnector-rest-api, manager-rest-api and replicator-rest-api.

`rmi-authentication`

Aliases	`enable-rmi-authentication`
Default	`See Notes`

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is true when disable-security-controls=false, or not supplied in v7.0.0+
Default is false when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

`rmi-port`

Aliases	`repl-rmi-port`
Default	`10001`

Replication RMI listen port.

`rmi-ssl`

Aliases	`enable-rmi-ssl`
Default	`See Notes`
Valid values	`truefalse`

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is true when disable-security-controls=false, or not supplied in v7.0.0+
Default is false when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

`rmi-user`

The username for RMI authentication.

`role`

Aliases	`repl-role`
Default	`See Notes`
Valid values	`masterslaverelay`

This property is used to set the role for the host. If not supplied, then the default will be established based on the following rules:

master will be the default if hostname specified for the master property is the same as the hostname you're installing on.
slave will be the default if the host you are installing on is only found within the list of hosts specified in the members or slaves property.
relay will be the default if hostname specified for the master property is the same as the hostname you're installing on AND the service is a relay service.

`router-gateway-port`

Default	`11999`
Product	CT

The router gateway port.

`router-jmx-port`

Default	`10999`
Product	CT

The router jmx port.

S tpm options

`security-directory`

Default	`[INSTALL-DIRECTORY]/share`

Storage directory for the Java security/encryption files.

`selective.rwsplitting`

Product	CT

Use to enable SQL Based routing. See "SQL Routing".

This property must be prefixed with property= :

property=selective.rwsplitting

`server.listen.address`

Default	`0.0.0.0`
Product	CT

IP Address to force the connector to be bound too.

This property must be prefixed with property= :

property=server.listen.address

`service-alias`

Aliases	`dataservice-service-alias`

Replication alias of this dataservice.

`service-type`

Aliases	`repl-service-type`
Valid values	`localremote`

What is the replication service type?

`skip-statemap`

Default	`false`
Valid values	`truefalse`

Do not copy the cluster-home/conf/statemap.properties from the previous install.

`skip-validation-check`

The skip-validation-check disables a given validation check. If any validation check fails, the installation, validation or configuration will automatically stop.

Warning

Using this option enables you to bypass the specified check, although skipping a check may lead to an invalid or non-working configuration.

You can identify a given check if an error or warning has been raised during configuration. For example, the default table type check:

ERROR >> centos >> The datasource root@centos:3306 (WITH PASSWORD) 
    uses MyISAM as the default storage engine (MySQLDefaultTableTypeCheck)

The check in this case is MySQLDefaultTableTypeCheck, and could be ignored usingskip-validation-check=MySQLDefaultTableTypeCheck.

Values can be passed as a comma-separated list, or single skip-validation-checkentries for each check to be skipped.

Setting both skip-validation-check and enable-validation-check is equivalent to explicitly disabling the specified check.

This property must be specified within the [defaults] stanza

`skip-validation-warnings`

The skip-validation-warnings disables a given validation check.

You can identify a given check by examining the warnings generated during configuration. For example, the Linux swappiness warning

ERROR >> centos >> Linux swappiness is currently set to 60, on restart it will be 60,
   consider setting this to 10 or under to avoid swapping. (SwappinessCheck)

The check in this case is SwappinessCheck, and could be ignored usingskip-validation-check=SwappinessCheck.

Values can be passed as a comma-separated list, or single skip-validation-warningsentries for each warning to be skipped.

Setting both skip-validation-warnings and enable-validation-warnings is equivalent to explicitly disabling the specified warnings.

This property must be specified within the [defaults] stanza

`slave-dataservice`

Dataservice to use to determine the source configuration. Used when combining cluster-slave and cluster-alias configuration blocks within a Multi-Site/Active-Active topology.

`slaves`

Aliases	`membersdataservice-slaves`

What are the replicas for this dataservice?

`start`

Property does not require true/false setting. Simply the existence of the property in the configuration will enable this option.

`start-and-report`

Property does not require true/false setting. Simply the existence of the property in the configuration will enable this option.

`svc-allow-any-remote-service`

Aliases	`repl-svc-allow-any-remote-service`
Default	`false`
Valid values	`truefalse`

Replicate from any service.

`svc-applier-block-commit-interval`

Aliases	`repl-svc-applier-block-commit-interval`
Default	`0`
Valid values	`#s#m#h#d`

Minimum interval between commits. Note default will be 15s if batch-enabled=true.

`svc-applier-block-commit-size`

Aliases	`repl-svc-applier-block-commit-size`
Default	`See Notes`

Applier block commit size (min 1). Note default will be 10000 if batch-enabled=true otherwise it will be set to the value of buffer-size, which, by default, is 10.

`svc-applier-filters`

Aliases	`repl-svc-applier-filters`

Replication service applier filters. See "Filter Reference" for a full list of possible options.

`svc-applier-last-applied-write-interval`

Aliases	`repl-svc-applier-last-applied-write-interval`
Default	`0`
Version	`6.1.16`

Interval (in seconds) to store the last known applied seqno and latency. Default of 0 is disabled.

`svc-applier-ldi-temp-dir`

Default	`/tmp`
Version	`7.2.1`

Specify the tmp directory to use for LOAD DATA INFILE commands, overides the default mysql value of /tmp

`svc-applier-ldi-use-local`

Default	`false`
Valid values	`cttr`
Version	`7.2.1`

Force the use of LOCAL when using LOAD DATA INFILE - useful if applying to remote hosts.

`svc-extractor-filters`

Aliases	`repl-svc-extractor-filters`

Replication service extractor filters. See "Filter Reference" for a full list of possible options.

`svc-fail-on-zero-row-update`

Aliases	`repl-svc-fail-on-zero-row-update`
Default	`stop`
Valid values	`stopwarnignore`

Warning

From release 7.0.1 the default for this property was changed to stop, previously, the default was warn.

The change in the default value may cause unexpected behavior in Active/Active topologies due to the Asynchronous nature of replication, however care should be taken if changing back to the original default of warn.

If you notice many entries in your replicator logs indicating zero row updates, and these warnings are being ignored, you may encounter data drift.

`svc-parallelization-type`

Aliases	`repl-svc-parallelization-type`
Default	`none`
Valid values	`diskmemorynone`

Method for implementing parallel apply.

`svc-remote-filters`

Aliases	`repl-svc-remote-filters`

Replication service remote download filters. See "Filter Reference" for a full list of possible options.

`svc-reposition-on-source-id-change`

Aliases	`repl-svc-reposition-on-source-id-change`
Default	`See Notes`
Valid values	`truefalse`

The Primary will come ONLINE from the current position if the stored source_id does not match the value in the static properties. true by default for Cluster installations, otherwise false

`svc-shard-default-db`

Aliases	`repl-svc-shard-default-db`
Default	`stringent`
Valid values	`stringentrelaxed`

Mode for setting the shard ID from the default db.

`svc-systemd-config-connector`

Product	CT

This property can be used to supply an alternative, custom, systemd configuration that will be used in place of the default generated one.

The value of the parameter should be specified as the name and location of the custom script to use instead, for example:

svc-systemd-config-connector=/home/tungsten/connector.service

Where connector.service file could look something like the following:

[Unit]
Description=Tungsten Connector
After=mysqld.service mysql.service mariadb.service tmanager.service treplictor.service

[Service]
User=tungsten
Type=forking
ExecStart=/opt/continuent/tungsten/tungsten-connector/bin/connector start sysd
ExecStop=/opt/continuent/tungsten/tungsten-connector/bin/connector stop sysd
ExecStartPre=/opt/my-pre-start-script.sh

[Install]
WantedBy=multi-user.target

`svc-systemd-config-manager`

Product	CT

This property can be used to supply an alternative, custom, systemd configuration that will be used in place of the default generated one.

The value of the parameter should be specified as the name and location of the custom script to use instead, for example:

svc-systemd-config-connector=/home/tungsten/manager.service

Where manager.service file could look something like the following:

[Unit]
Description=Tungsten Manager
After=mysqld.service mysql.service mariadb.service treplicator.service

[Service]
User=tungsten
Type=forking
ExecStart=/opt/continuent/tungsten/tungsten-manager/bin/manager start sysd
ExecStop=/opt/continuent/tungsten/tungsten-manager/bin/manager stop sysd
ExecStartPre=/opt/my-pre-start-script.sh

[Install]
WantedBy=multi-user.target

`svc-systemd-config-replicator`

This property can be used to supply an alternative, custom, systemd configuration that will be used in place of the default generated one.

The value of the parameter should be specified as the name and location of the custom script to use instead, for example:

svc-systemd-config-connector=/home/tungsten/replicator.service

Where replicator.service file could look something like the following:

[Unit]
Description=Tungsten Replicator
After=mysqld.service mysql.service mariadb.service

[Service]
User=tungsten
Type=forking
ExecStart=/opt/continuent/tungsten/tungsten-replicator/bin/replicator start sysd
ExecStop=/opt/continuent/tungsten/tungsten-replicator/bin/replicator stop sysd
ExecStartPre=/opt/my-pre-start-script.sh

[Install]
WantedBy=multi-user.target

`svc-table-engine`

Aliases	`repl-svc-table-engine`
Default	`innodb`

Replication service table engine.

`svc-thl-filters`

Aliases	`repl-svc-thl-filters`

Replication service THL filters. See "Filter Reference" for a full list of possible options.

T tpm options

`temp-directory`

Default	`/tmp`

The default for this property will be taken from the enviroment variables $TMPDIR,$TMP or $TEMP. If they return nothing then /tmp will be used by default if no overriding value specified.

`template-search-path`

Default	`[INSTALL-DIRECTORY]/share/templates`

Adds a new template search path for configuration file generation.

`thl-directory`

Aliases	`repl-thl-directory`
Default	`[INSTALL-DIRECTORY]/thl`

The given value should be the base directory, to which tungsten will add the service name. For example, the following entry in the /etc/tungsten/tungsten.ini:

[alpha]
...
...
thl-directory=/drv1/thl
...

Would result in the THL being placed in /drv1/thl/alpha

Note

Update of thl directory is only available when tpm is called from the staging installation directory,NOT from the running directory.

`thl-do-checksum`

Aliases	`repl-thl-do-checksum`
Default	`false`
Valid values	`truefalse`

Execute checksum operations on THL log files.

`thl-interface`

Aliases	`repl-thl-interface`

Listen interface to use for THL operations.

`thl-log-connection-timeout`

Aliases	`repl-thl-log-connection-timeout`
Default	`600`

Number of seconds to wait for a connection to the THL log.

`thl-log-file-size`

Aliases	`repl-thl-log-file-size`
Default	`100000000`

File size in bytes for THL disk logs.

`thl-log-fsync`

Aliases	`repl-thl-log-fsync`
Default	`false`
Valid values	`truefalse`

Fsync THL records on commit. More reliable operation but adds latency to replication when using low-performance storage.

`thl-log-retention`

Aliases	`repl-thl-log-retention`
Default	`7d`
Valid values	`#s#m#h#d`

How long do you want to keep THL files.

`thl-port`

Aliases	`repl-thl-port`
Default	`2112`

Port to use for THL Operations.

`thl-protocol-port`

Aliases	`repl-thl-protocol`
Default	`See Notes`
Valid values	`thlthls`

Protocol to use for THL communication with this service.

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is thls when disable-security-controls=false, or not supplied in v7.0.0+
Default is thl when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

`thl-ssl`

Aliases	`enable-thl-sslrepl-enable-thl-ssl`
Default	`See Notes`
Valid values	`truefalse`

Defaults

The default for this property is based on the version of Tungsten and the setting of disable-security-controls.

Default is true when disable-security-controls=false, or not supplied in v7.0.0+
Default is false when disable-security-controls=true, or not supplied in versions prior to v7.0.0.

`tls-enabled-protocols`

Set for TLS 1.3 by default for Java 8u272 onwards. Use this property to force alternative protocols.

`topology`

Aliases	`dataservice-topology`
Valid values	`clusteredcluster-aliascluster-slavemaster-slavefan-inall-mastersdirectcomposite-multi-master`

Replication topology for the dataservice.

`track-schema-changes`

Default	`false`
Valid values	`truefalse`

This will enable filters that track DDL statements and write the resulting change to files on replica hosts. The feature is intended for use in some batch deployments.

`treat.com.change.user.as.ping`

Default	`false`
Valid values	`truefalse`
Product	CT

The connector can be configured to respond to the COM_CHANGE_USER command from a client application. WHen enabled, rather than performing the change user operation, instead the connector will respond to the client with an acknowledgement, emulating the ping operation.

Disabled by default, the parameter must be supplied with the property= prefix, for example:

property=treat.com.change.user.as.ping=true

`tungsten-ini-backup`

Default	`false`
Valid values	`truefalse`
Version	`7.2.1`

Enables/Disables the backup on the tungsten.ini file into a history file.

`tungsten-ini-history-dir`

Default	`[INSTALL-DIRECTORY]/history/ini`
Version	`7.2.1`

Set the location for the creation of the history files of the tungsten.ini file.

U tpm options

`user`

OS System User, for example tungsten. DO NOT use root.

V tpm options

`vertica-dbname`

Aliases	`repl-vertica-dbname`
Product	TR

Name of the database to replicate into.

W tpm options

`waitForDisconnect`

Valid values	`truefalse`
Product	CT

Controls how the connector handles existing connections when a manual switch is invoked. See "Adjusting the Client Disconnect Delay During Manual Switch" for more information.

This property must be prefixed with property=, for example:

property=waitForDisconnect=true

`waitIfDisabled`

Default	`true`
Valid values	`truefalse`
Product	CT

When enabled, will make new connection requests "hang" until either the connector gets back network access to a manager OR waitIfDisabledTimeout is reached

This property must be prefixed with property=, for example:

property=waitIfDisabledTimeout=true

`waitIfDisabledTimeout`

Product	CT

How long (in seconds) to hold new requests and "hang" until either the connector gets back network access to a manager OR waitIfDisabledTimeout is reached

This property must be prefixed with property=, for example:

property=waitIfDisabledTimeout=60

`waitIfUnavailable`

Default	`true`
Valid values	`truefalse`
Product	CT

Connector will wait for up to the time period specified by waitIfUnavailableTimeout to make a connection for a given QOS. If the timeout expires, the Connector will disconnect the client application.

This property must be prefixed with property=, for example:

property=waitIfUnavailable=true

`waitIfUnavailableTimeout`

Default	`0`
Product	CT

If waitIfUnavailable is true, the Connector will wait for up to waitIfUnavailableTimeout number of seconds before disconnecting the client. IfwaitIfUnavailable is false, this parameter is ignored. If this parameter is set to zero (0) seconds, the Connector will wait indefinitely (client connection requests will hang forever) .

This property must be prefixed with property=, for example:

property=waitIfUnavailableTimeout=0

`witnesses`

Aliases	`dataservice-witnesses`

Witness hosts for the dataservice. Must be provided if enable-active-witnesses is enabled.