Skip to main content
Common Reference

tpm Configuration Options

tpm supports a large range of configuration options, which can be specified either:

  • In an INI file, i.e. repl-thl-log-retention=3d
  • On the command-line, using a double-dash prefix, i.e. --repl-thl-log-retention=3d

A full list of all the available options supported is provided below.

tip
  • The Product flag indicates the scope for the option.
    • CT = Tungsten Clustering
    • TR = Tungsten Replicator
  • The version indicates from which version of the product the option was introduced
315 of 315
OptionDescriptionProductVersion
application-passwordDatabase password for the connector.CT
application-portPort for the connector to listen on.
Default: 9999
CT
application-readonly-portPort for the connector to listen for read-only connections on.CT
application-userDatabase username for the connector.CT
auto-enableDatabase username for the connector.
Valid: true, false
CTTR
auto-recovery-delay-intervalDelay between going OFFLINE and attempting to go ONLINE.
Default: 5s | Valid: #s, #m, #h
CTTR
auto-recovery-max-attemptsMaximum number of attempts at automatic recovery.
Default: 0
CTTR
auto-recovery-reset-intervalDelay before autorecovery is deemed to have succeeded.
Default: 5s | Valid: #s, #m, #h
CTTR
backup-directoryPermanent backup storage directory.
Default: [home directory]/backups
CTTR
backup-dump-directoryBackup temporary dump directory.
Default: /tmp
CTTR
backup-methodDatabase backup method.
Valid: mysqldump, xtrabackup, xtrabackup-incremental, script, file-copy-snapshot, ebs-snapshot, xtrabackup-full, mariabackup, mariabackup-incremental
CTTR
backup-onlineDoes the backup script support backing up a datasource while it is ONLINE.
Default: false | Valid: true, false
CTTR
backup-optionsSpace separated list of options to pass directly to the underlying backup binary in use.CTTR
backup-retentionNumber of backups to retain.
Default: 3
CTTR
backup-scriptWhat is the path to the backup script.CTTR
batch-enabledShould the replicator service use a batch applier.
Default: false | Valid: true, false
CTTR
batch-load-languageWhich script language to use for batch loading.
Default: sql | Valid: js, sql
CTTR
batch-load-templateValue for the loadBatchTemplate property.
Default: mysql | Valid: nonothing, file, hadoop_basefs, hadoop_kerberos, hadoop_single, hadoop, hdfs, mysql, postgres, redshift_singleschema, redshift, s3, vertica_singleschema, vertica
CTTR
block-commit-policySets the commit policy of the replicator.
Default: strict | Valid: lax, strict
CTTR
bridgeServerToClientForcedCloseTimeoutSets the commit policy of the replicator.
Default: 50
CTTR
buffer-sizeReplicator queue size between stages (min 1)
Default: 10
CTTR
cctrl-column-widthSets the minimum column width for service names within cctrl
Default: 80
CT
channels
Aliases: repl-channels
Number of replication channels to use for parallel apply.
Default: 1
CTTR
cloud-installWhen 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.
Default: false | Valid: true, false
TR8.0.0
cluster-slave-auto-recovery-delay-intervalDefault value for auto-recover-delay-interval when topology=cluster-slave
Default: 5s | Valid: #s, #m, #h
CTTR
cluster-slave-auto-recovery-max-attemptsDefault value for auto-recover-max-attempts when topology=cluster-slave
Default: 0
CTTR
cluster-slave-auto-recovery-reset-intervalDefault value for auto-recover-reset-interval when topology=cluster-slave
Default: 5s | Valid: #s, #m, #h
CTTR
composite-datasourcesData services that should be added to this composite data service.CT
conn-java-enable-concurrent-gcConnector Java uses concurrent garbage collection. Default dependant upon host Java version. See Notes.
Default: See Notes | Valid: true, false
CT
conn-java-mem-sizeConnector Java heap memory size used to buffer data between clients and databases.
Default: 256
CT
conn-round-robin-include-masterShould the Connector include the Primary in round-robin load balancing.
Default: false | Valid: true, false
CT
connection.keepAlive.intervalThe 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.
Default: autodetect
CT
connector-affinitySpecify default affinity for all connections in the format of writeCluster:readClusterCT
connector-allow-cross-site-reconnects-for-readsWhether or not to reject reconnections that follow a read operation (RO_RELAXED or SmartScale after a read)
Default: true | Valid: true, false
CT
connector-allow-cross-site-reconnects-for-writesWhether or not to reject reconnections that follow a write operation (RW_STRICT connection or SmartScale after a write)
Default: false | Valid: true, false
CT
connector-autoreconnectEnable auto-reconnect in the connector.
Default: true | Valid: true, false
CT
connector-autoreconnect-killed-connectionsEnable autoreconnect for connections killed within the connector.
Default: true | Valid: true, false
CT
connector-bridge-modeEnable the Tungsten Connector bridge mode.
Default: true | Valid: true, false
CT
connector-client-ssl
Enables/Disables SSL between the client application and the connector.
Default: See Notes | Valid: true, false
CT
connector-db-versionServer version as advertised by the Connector (proxy-mode only).
Default: autodetect
CT
connector-default-schemaDefault schema for the connector to use.
Default: none
CT
connector-delay-before-offlineAfter a connector goes to the ON HOLD state, this property sets numbers of seconds before going OFFLINE.
Default: 30
CT
connector-delay-before-onholdWhen the connector loses sight of the managers, delay (in seconds) before going ON HOLD, default of 0 means no delay.
Default: 0
CT
connector-delete-user-mapOverwrite an existing user.map file.
Default: false | Valid: true, false
CT
connector-disable-connection-warningsHide Connector warnings in log files.
Default: true | Valid: true, false
CT
connector-disconnect-timeoutTime (in seconds) to wait for active connection to disconnect before forcing them closed.
Default: 5
CT
connector-driver-optionsJDBC 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.
Default: false | Valid: true, false
CT
connector-drop-after-max-connectionsIf 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.
Default: false | Valid: true, false
CT
connector-enable-proxy-protocolEnable Proxy Protocol in the Connector.
Default: false | Valid: true, false
CT
connector-generate-eofSet to true if using the GO MySQL Driver.
Default: true
CT7.1.0
connector-keepalive-timeoutDelay (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.
Default: 30000 | Valid: <=300000
CT
connector-listen-interfaceListen interface to use for the connector.CT
connector-manager-use-ssl
Manager<>Connector connections can be encrypted with TLS by setting this to true or with thedisable-security-controls=false flags.
Note that when enabled, managers still accept unencrypted connector connections in order to allow upgrades from older versions or unencrypted setups.
Default: See Notes | Valid: true, false
CT
connector-max-connectionsThe maximum number of connections the connector should allow at any time. Default of -1 disables limits.
Default: -1
CT
connector-max-slave-latencyThe maximum applied latency for replica connections. Disabled by default (-1).
Default: -1
CT
connector-read-affinitySpecify default affinity for all read-only connections. Specify as a single servicename, or a comma separated list.CT
connector-readonlyEnable the Tungsten Connector read-only mode.
Default: false | Valid: true, false
CT
connector-relative-slave-statusDetermines 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.
Default: dataservice-use-relative-latency | Valid: true, false
CT
connector-reset-when-affinity-backForces reconnection of clients to datasources with the configured affinity when they become available.
Default: false | Valid: true, false
CT
connector-rest-apiEnable (default) or Disable the API.
Default: true | Valid: true, false
CT7.0.0
connector-rest-api-addressAddress for the API to bind too.
Default: 127.0.0.1
CT7.0.0
connector-rest-api-authenticationEnforce authentication for the API.
Default: true | Valid: true, false
CT7.0.0
connector-rest-api-portPort for the Connector API.
Default: 8096
CT7.0.0
connector-rest-api-sslEnable SSL for the API.
Default: true | Valid: true, false
CT7.0.0
connector-ro-addressesConnector addresses that should receive a r/o connection.CT
connector-rw-addressesConnector addresses that should receive a r/w connection.CT
connector-rwsplittingEnable Direct Reads R/W splitting in the connector. See "Direct Routing"
Default: false | Valid: true, false
CT
connector-server-sslEnable SSL encryption of traffic from the connector to the database.
Default: See Notes | Valid: true, false
CT
connector-server-ssl
Enables/Disabes SSL between the connector and the database server.
Default: See Notes | Valid: true, false
CT
connector-server-ssl-ciphers

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.

CT
connector-server-ssl-protocolsConfigures protocols the connector uses for SSL communications to the dbatabase server.
Default: TLSv1,TLSv1.1,TLSv1.2
CT
connector-smartscaleEnable SmartScale R/W splitting in the connector.
Default: false | Valid: true, false
CT
connector-smartscale-sessionidThe default session ID to use with SmartScale.
Default: DATABASE | Valid: DATABASE, USER, CONNECTION, PROVIDED_IN_DBNAME
CT
connector-sslEnable SSL encryption of connector traffic to the database.
Default: See Notes | Valid: true, false
CT
connector-ssl
Enable/Disable Connector<>Database SSL. Alias for connector-client-ssl and connector-server-ssl.
Default: See Notes | Valid: true, false
CT
connector-ssl-capableDefines whether connector ports are advertised as being capable of SSL.
Default: true | Valid: true, false
CT
connector-thread-stack-sizeSet value in Kb of the Connector thread stack size. By defalt, uses JVM default of 1024.CT
connector-write-affinitySpecify default affinity for all write connections. Specify as a single servicename, or a comma separated list.CT
connectorsHostnames for the dataservice connectors.CT
consistency-policyDetermines the behavior of the replicator should a consistency check fail.
Default: stop | Valid: stop, warn
CTTR
dataservice-relay-enabledMake this dataservice a replica of another.
Default: false | Valid: true, false
CT
dataservice-schemaThe db schema to hold dataservice details.CTTR
dataservice-thl-portPort to use for THL operations.
Default: 2112
CTTR
dataservice-use-relative-latencyEnable the cluster to operate on relative latency.
Default: false | Valid: true, false
CT
dataservice-vip-enabledIs VIP management enabled?
Default: false | Valid: true, false
CT
dataservice-vip-ipaddressVIP IP address.CT
dataservice-vip-netmaskVIP netmask.
Default: 255.255.255.0
CT
datasource-boot-scriptDatabase start script.CTTR
datasource-enable-sslEnable SSL connection to DBMS server.
Default: See note
CTTR
datasource-group-idAll nodes within a cluster that share the same datasource-group-id will form a Distributed Datasource Group (DDG).
Default: 0
CT
datasource-log-directorySet MySQL Binary log directory if different from MySQL default.
Default: Taken from MySQL configuration
CTTR
datasource-log-patternSet MySQL Binary log filename pattern if different from MySQL default.
Default: Taken from MySQL configuration
CTTR
datasource-mysql-confMySQL Configuration file.
Default: /etc/my.cnf
CTTR
datasource-mysql-data-directorySet MySQL data directory if different from MySQL default.
Default: Taken from MySQL configuration
CTTR
datasource-mysql-ibdata-directorySet MySQL InnoDB data directory if different from MySQL default.
Default: Taken from MySQL configuration
CTTR
datasource-mysql-iblog-directorySet MySQL InnoDB log directory if different from MySQL default.
Default: Taken from MySQL configuration
CTTR
datasource-mysql-ssl-caSet MySQL SSL CA File.
Default: Taken from MySQL configuration
CTTR
datasource-mysql-ssl-certSet MySQL SSL Certificate File.
Default: Taken from MySQL configuration
CTTR
datasource-mysql-ssl-keySet MySQL SSL Key File.
Default: Taken from MySQL configuration
CTTR
datasource-oracle-serviceOracle Service Name.TR
datasource-oracle-serviceOracle Service Name.TR
datasource-systemctl-serviceDatabase systemctl script.CTTR
datasource-typeSpecify the database type. For replicator extractors and cluster nodes, this value can only be set to mysql. Other options are applicable to standalone hetergeneous replicator appliers (including cluster-slave appliers) only.
Default: mysql | Valid: mysql, mongodb, vertica, oracle, hdfs, kafka, postgres, file
CTTR
defaultAuthPluginOverride the default authentication plugin for MySQL.
Valid: mysql_native_password, caching_sha2_password
CTTR
deploy-systemdSetting to true will deploy and configure software to be controlled by systemd.
Default: false | Valid: true, false
CTTR7.1.0
direct-datasource-log-directorySet MySQL Binary log directory if different from MySQL default.
Default: Taken from MySQL configuration
TR
direct-datasource-log-patternSet MySQL Binary log filename pattern if different from MySQL default.
Default: Taken from MySQL configuration
TR
direct-datasource-typeSpecify the database type. For replicator extractors and cluster nodes, this value can only be set to mysql. Other options are applicable to standalone hetergeneous replicator appliers (including cluster-slave appliers) only.
Default: mysql | Valid: mysql, mongodb, vertica, oracle, hdfs, kafka, postgres, file
TR
direct-replication-hostDatabase server hostname.TR
direct-replication-passwordPassword for datasource connection.TR
direct-replication-portDatabase server port.TR
direct-replication-userDatabase login for Tungsten.TR
disable-relay-logsDisable the use of relay-logs.
Default: true | Valid: true, false
CTTR
disable-security-controlsDisables all forms of security, including SSL, TLS and authentication.
Default: false | Valid: true, false
CTTR
disable-slave-extractorShould replica servers support the primary role?
Valid: true, false
CTTR
drop-static-columns-in-updatesThis will modify UPDATE transactions in row-based replication and eliminate any columns that were not modified.
Default: false | Valid: true, false
CTTR
enable-active-witnessesEnable active witness hosts.
Default: false | Valid: true, false
CT
enable-batch-masterEnable batch operation for the primary.
Default: false | Valid: true, false
TR
enable-batch-serviceEnables batch mode for a service.
Default: false | Valid: true, false
TR
enable-batch-slaveEnable batch operation for the replica.
Default: false | Valid: true, false
TR
enable-connector-client-sslEnable SSL encryption of traffic from the client to the connector.
Default: See Notes | Valid: true, false
CT
enable-heterogeneous-masterEnable heterogeneous operation for the primary.
Default: false | Valid: true, false
CTTR
enable-heterogeneous-serviceEnable heterogeneous operation.
Default: false | Valid: true, false
CTTR
enable-heterogeneous-slaveEnable heterogeneous operation for the replica.
Default: false | Valid: true, false
CTTR
enable-slave-thl-listenerShould this service allow THL connections.
Default: true | Valid: true, false
CTTR
enable-sudo-accessShould this service allow THL connections.
Valid: true, false
CTTR
enable-validation-checkEnable a specific validation check, overriding any configured skipped checks.CTTR
enable-validation-warningsEnable a specific validation warning, overriding any configured skipped warning.CTTR
executable-prefixAdds a prefix to command aliases.CTTR
file-protection-levelProtection level for Continuent files.
Default: See Notes | Valid: none, group, user
CTTR
host-nameDNS hostname.CTTR
hubWhat is the hub host for this all-masters dataservice?TR
hub-serviceThe data service to use for the hub of a star topology?TR
installConfigures services with systemd during installation. The same as executing deployall after installation.
Default: false | Valid: true, false
CTTR
install-directoryInstallation directory.CTTR
java-connector-keystore-passwordSet the password for unlocking the tungsten_connector_keystore.jks file in the security directory. Specific to connector<->mysql communication only.CT
java-connector-keystore-pathLocal path to the Java Connector Keystore file. Specific to connector<->mysql communication only.
Default: [install-directoy]/share
CT
java-connector-truststore-passwordSet the password for unlocking the tungsten_connector_truststore.jks file in the security directory. Specific to connector<->mysql communication only.CT
java-connector-truststore-pathLocal path to the Java Connector Truststore file. Specific to connector<->mysql communication only.
Default: [install-directoy]/share
CT
java-enable-concurrent-gcReplicator Java uses concurrent garbage collection. Default dependant upon host Java version. See Notes.
Default: See Notes | Valid: true, false
CTTR
java-file-encodingJava platform charset (esp. for heterogeneous replication)
Default: utf8
CTTR
java-jgroups-keyThe alias to use for the JGroups TLS key in the keystore.
Default: jgroups
CTTR
java-jgroups-keystore-pathLocal path to the JGroups Java Keystore file.
Default: [install-directoy]/share
CT
java-jmxremote-access-pathLocal path to the Java JMX Remote Access file.
Default: [SECURITY_DIRECTORY]/jmxremote.access
CTTR
java-keystore-passwordSet the password for unlocking the tungsten_keystore.jks file in the security directory. Specific for intra cluster communication.
Default: tungsten
CTTR
java-keystore-pathLocal 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.
Default: [install-directoy]/share
CTTR
java-mem-sizeReplicator Java heap memory size in Mb (min 128)
Default: 1024
CTTR
java-mysql-aliasSpecify the alias used for the mysql certificate in the tungsten_keystore and the tungsten_connector_keystore. Must be specified when supplying custom keystores.
Default: mysql
CTTR
java-passwordstore-pathLocal path to the Java Password Store file
Default: [install-directoy]/share
CTTR
java-thl-keystore-pathLocal path to the Java THL Keystore file
Default: [install-directoy]/share
CTTR
java-thl-truststore-pathLocal path to the Java THL Truststore file.
Default: [install-directoy]/share
CTTR
java-tls-aliasThe alias to use for the TLS key/certificate in the keystore and truststore.
Default: tls
CTTR
java-tls-key-lifetimeLifetime for the Java TLS key (in days)
Default: 3650
CTTR
java-tls-keystore-pathThe keystore holding a certificate to use for all Continuent TLS encryption.
Default: [install-directoy]/share
CTTR
java-truststore-passwordThe password for unlocking the tungsten_truststore.jks file in the security directory.
Default: tungsten
CTTR
java-truststore-pathLocal path to the Java Truststore file.
Default: [install-directoy]/share
CTTR
jgroups-sslEnable SSL encryption of JGroups communication on this host.
Default: See Notes
CTTR
log-slave-updatesWhen enabled, transactions written to a replica will be logged to the replicas binary logs.
Default: false | Valid: true, false
CTTR
manager-replicator-offline-timeoutTimeout (in seconds) for the manager to wait until the replicator goes offline.
Default: 180
CT
manager-rest-api
Aliases: mgr-api
Enable (default) or Disable API.
Default: true | Valid: true, false
CT
manager-rest-api-addressAddress for the API to bind too.
Default: 127.0.0.1
CT7.0.0
manager-rest-api-authenticationEnforce authentication for the API.
Default: true | Valid: true, false
CT7.0.0
manager-rest-api-port
Aliases: mgr-api-port
Port for the manager API.
Default: 8090
CT7.0.0
manager-rest-api-sslEnable SSL for the API.
Default: true | Valid: true, false
CT7.0.0
manager.failover.thl.apply.wait.timeoutHow long should the manager wait until the failover candidate replica has applied all stored THL. Default of 0 equates to waiting indefinitely.
Default: 0
CT
masterHostname of the primary (or relay) host within this service.CTTR
master-preferred-rolePreferred role for primary THL when connecting as a replica.
Valid: master, slave
CTTR
master-servicesData service names that should be used on each primary.CTTR
master-thl-hostPrimary THL Hostname.CTTR
master-thl-portPrimary THL Port. Default will be the same as the value for thl-port, 2112 if neither set.
Default: 2112
CTTR
membersHostnames for the dataservice members.CTTR
metadata-directoryReplicator metadata directory.
Default: [install-directory]/metadata
CTTR
mgr-api-full-accessEnable all Manager API (v1) commands. Only the status command will be enabled without it.
Default: true | Valid: true, false
CT
mgr-group-communication-portPort to use for manager group communication.
Default: 7800
CT
mgr-heap-thresholdJava memory usage (MB) that will force a Manager restart.
Default: 200
CT
mgr-java-enable-concurrent-gcManager Java uses concurrent garbage collection. Default dependant upon host Java version. See Notes.
Default: See Notes | Valid: true, false
CT
mgr-java-mem-sizeManager Java heap memory size in Mb (min 128)
Default: 250
CT
mgr-listen-interfaceListen interface to use for the manager.CT
mgr-monitor-intervalFrequency, in milliseconds, at which managers monitor the database and replicator.
Default: 3000
CT
mgr-ping-methodMechanism to use when identifying the liveness of other datasources (ping, echo)
Default: ping | Valid: ping, echo
CT
mgr-policy-fence-slaveSet 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.
Default: 60
CT
mgr-policy-modeManager Policy mode.
Default: automatic | Valid: automatic, manual, maintenance
CT
mgr-rmi-portPort to use for the manager RMI server.
Default: 9997
CT
mgr-rmi-remote-portPort to use for calling the remote manager RMI server.
Default: 12000
CT
mgr-ro-slaveMake replicas read-only.
Default: true | Valid: true, false
CT
mgr-vip-arp-pathPath to the arp binary.CT
mgr-vip-deviceVIP network device.CT
mgr-vip-ifconfig-pathPath to the ifconfig binary.CT
mgr-wait-for-membersWait for all datasources to be available before completing installation.
Default: false | Valid: true, false
CT
mon-db-query-timeoutDefines the timeout (in secs) for the managers mysql_checker_query.sql call.
Default: 5
CT
mysql-allow-intensive-checksFor MySQL installation, enables detailed checks on the supported data types within the MySQL database to confirm compatibility.
Default: false | Valid: true, false
CTTR
mysql-driverMySQL Driver Vendor.
Default: drizzle
CTTR
mysql-enable-ansiquotesEnables ANSI_QUOTES mode as a filter on the applier stages.
Default: false | Valid: true, false
CTTR
mysql-enable-enumtostringEnable a filter to convert ENUM values to strings.
Valid: true, false
CTTR
mysql-enable-noonlykeywordsEnables an applier filter to translate DELETE FROM ONLY to DELETE FROM andUPDATE ONLY to UPDATE
Default: false | Valid: true, false
CTTR
mysql-enable-settostringEnable a filter to convert SET types to strings.
Valid: true, false
CTTR
mysql-ro-slaveReplicas are read-only.
Default: true | Valid: true, false
CTTR
mysql-server-idSetting 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.CTTR
mysql-use-bytes-for-stringTransfer strings as their byte representation.CTTR
mysql-xtrabackup-dirDirectory to use for storing xtrabackup full & incremental backups.
Default: [BACKUP-DIRECTORY]/xtrabackup
CTTR
native-slave-takeoverTakeover native replication.
Default: false | Valid: true, false
CTTR
optimize-row-eventsEnables or disables optimized row updates. Enabled by default.
Default: true | Valid: true, false
CTTR
optimize-row-events-limit-delete-rowsLimits 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
Default: 100
CTTR7.0.2
optimize-row-events-limit-insert-rowsLimits the number of inserts grouped per event when optimize-row-events is enabled.
Default: 50
CTTR
policy-relay-from-slaveCross-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.
Default: false | Valid: true, false
CT
policy.fence.masterReplicatorIf set to true, a failover will occur 70 seconds after initial detection of a replicator failure.
Default: false
CT
policy.fence.masterReplicator.thresholdSets the number of iterations to try to recover the replicator, one iteration every 10 seconds, after which the fencing occurs.
Default: 6
CT
policy.invalid.membership.retry.thresholdSet the delay, in seconds, before a FAILSAFE-SHUN is invoked.
Default: 3
CT
policy.liveness.dbping.fail.thresholdIf 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.
Default: 1
CT
policy.liveness.hostPing.fail.threshold
Default: 2
CT
policy.replica.promotion.max.synchronizing.durationSets 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.
Default: 0
CT
policy.slave.promotion.latency.thresholdThe upper threshold, in seconds, for appliedLatency when deciding on the validity of a replica for promotion during a switch/failover.
Default: 900
CT
postgresql-dbnameName of the database to replicate.TR
prefer-ip-stackSwitch between IPv4 and IPv6 support.
Default: 4 | Valid: 4, 6
CTTR7.0.0
preferred-pathAdditional command path.CTTR
prefetch-schemaSchema to watch for timing prefetch progress.
Default: tungsten_[servicename]
CTTR
privileged-masterWhen 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.
Default: true | Valid: true, false
CTTR
privileged-slaveWhen 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.
Default: true | Valid: true, false
CTTR
profile-scriptAppend commands to include env.sh in this profile script.CTTR
property=key=valueModify specific property values for the key in any file that the configure script touches.CTTR
protect-configuration-filesWhen enabled, configuration files are protected to be only readable and updatable by the configured user.
Default: true | Valid: true, false
CTTR
readAutodetectConfigFromPrimaryThe 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.
Default: true | Valid: true, false
CT7.2.0
redshift-dbnameName of the Redshift database to replicate into.TR
relay-directoryDirectory for logs transferred from the primary.
Default: [INSTALL-DIRECTORY]/relay
CTTR
relay-enabledShould the replicator service be setup as a relay.
Default: false | Valid: true, false
CTTR
relay-sourceDataservice name to use as a relay source.CTTR
repl-allow-bidi-unsafeAllow unsafe SQL from remote service.
Default: false | Valid: true, false
CTTR
repl-store-thl-compressedEnable (true) or disable (false) compression of THL on disk.
Default: false | Valid: true, false
CTTR7.0.0
repl-store-thl-encryptedEnable (true) or disable (false) encryption of THL on disk.
Default: false | Valid: true, false
CTTR7.0.0
repl-svc-extractor-multi-frag-service-detectionForce extraction to read ahead to last fragment to detect service name.
Default: false | Valid: true, false
CTTR7.0.0
repl-svc-extractor-multi-frag-service-detectionReplace the TLS certificate.
Default: false | Valid: true, false
CTTR
repl-thl-client-serializationComma Separated list of THL compression protocols to enable on downstream Replication Appliers.
Default: LEGACY,JAVA,PROTOBUF,DEFALTE | Valid: LEGACY, JAVA, PROTOBUF, DEFALTE
CTTR7.0.0
repl-thl-server-serializationComma Separated list of THL compression protocols to enable on the thl-server (Extractor).
Default: LEGACY,JAVA,PROTOBUF,DEFALTE | Valid: LEGACY, JAVA, PROTOBUF, DEFALTE
CTTR7.0.0
repl-time-zone
Aliases: time-zone
Replicator Time Zone.
Default: GMT
CTTR
replica-tx-commit-levelIf set, determines the value of the underlying database property innodb_flush_log_at_trx_commit when a node becomes a replica.
Default: 1 | Valid: 1, 2
CT7.0.0
replication-hostHostname of the datasource.CTTR
replication-passwordDatabase password.CTTR
replication-portDatabase network port.
Default: See Notes
CTTR
replication-userUser for database connection.CTTR
replicator-rest-apiEnable or Disable API.
Default: true | Valid: true, false
CTTR7.0.0
replicator-rest-api-addressAddress for the API to bind too.
Default: 127.0.0.1
CTTR7.0.0
replicator-rest-api-authenticationEnforce authentication for the API.
Default: true | Valid: true, false
CTTR7.0.0
replicator-rest-api-portPort for the Replicator API.
Default: 8097
CTTR7.0.0
replicator-rest-api-sslEnable or Disable SSL for the API.
Default: true | Valid: true, false
CTTR7.0.0
replicator.extractor.dbms.transaction_frag_sizeControls 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.
Default: 1000000
CTTR
replicator.store.thl.stopOnDBErrorWhen 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.
Default: false | Valid: true, false
CTTR
rest-api-addressAddress 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.
Default: 127.0.0.1
CTTR7.2.0
rest-api-admin-passSpecify the initial Admin User Password for API access. rest-api-admin-password alias only available from version 7.1.2 onwards.CTTR7.0.0
rest-api-admin-userSpecify the initial Admin Username for API access.CTTR7.0.0
rest-api-authenticationEnable 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.
Default: true | Valid: true, false
CTTR7.2.0
rest-api-sslEnable 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.
Default: true | Valid: true, false
CTTR7.2.0
rest-apisEnable or Disable API. Setting this property acts as a group alias forconnector-rest-api, manager-rest-api and replicator-rest-api.
Default: true | Valid: true, false
CTTR7.2.0
rmi-authenticationEnable RMI authentication for the services running on this host.
Default: See Notes
CTTR
rmi-port
Aliases: repl-rmi-port
Replication RMI listen port.
Default: 10001
CTTR
rmi-sslEnable SSL encryption of RMI communication on this host.
Default: See Notes | Valid: true, false
CTTR
rmi-userThe username for RMI authentication.CTTR
role
Aliases: repl-role
What is the replication role for this service?
Default: See Notes | Valid: master, slave, relay
CTTR
router-gateway-portThe router gateway port.
Default: 11999
CT
router-jmx-portThe router jmx port.
Default: 10999
CT
security-directoryStorage directory for the Java security/encryption files.
Default: [INSTALL-DIRECTORY]/share
CTTR
selective.rwsplittingUse to enable Connector SQL Based routing. See "SQL Routing".CT
server.listen.addressIP Address to force the connector to be bound too.
Default: 0.0.0.0
CT
service-aliasReplication alias of this dataservice.CTTR
service-typeWhat is the replication service type?
Valid: local, remote
CTTR
skip-statemapDo not copy the cluster-home/conf/statemap.properties from the previous install.
Default: false | Valid: true, false
CTTR
skip-validation-checkDo not run the specified validation check.CTTR
skip-validation-warningsDo not display warnings for the specified validation check.CTTR
slave-dataserviceDataservice to use to determine the source configuration. Used when combining cluster-slave and cluster-alias configuration blocks within a Multi-Site/Active-Active topology.CTTR
slavesWhat are the replicas for this dataservice?CTTR
startStart the services after configuration.CTTR
start-and-reportStart the services and report out the status after configuration.CTTR
svc-allow-any-remote-serviceReplicate from any service.
Default: false | Valid: true, false
CTTR
svc-applier-block-commit-intervalMinimum interval between commits. Note default will be 15s if batch-enabled=true.
Default: 0 | Valid: #s, #m, #h, #d
CTTR
svc-applier-block-commit-sizeApplier 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.
Default: See Notes
CTTR
svc-applier-filtersReplication service applier filters. See "Filter Reference" for a full list of possible options.CTTR
svc-applier-last-applied-write-intervalInterval (in seconds) to store the last known applied seqno and latency. Default of 0 is disabled.
Default: 0
CTTR6.1.16
svc-applier-ldi-temp-dirSpecify the tmp directory to use for LOAD DATA INFILE commands, overides the default mysql value of /tmp
Default: /tmp
CTTR7.2.1
svc-applier-ldi-use-localForce the use of LOCAL when using LOAD DATA INFILE - useful if applying to remote hosts.
Default: false | Valid: ct, tr
CTTR7.2.1
svc-extractor-filtersReplication service extractor filters. See "Filter Reference" for a full list of possible options.CTTR
svc-fail-on-zero-row-updateHow should the replicator behave when a Row-Based Replication UPDATE or DELETE does not affect any rows.
Default: stop | Valid: stop, warn, ignore
CTTR
svc-parallelization-typeMethod for implementing parallel apply.
Default: none | Valid: disk, memory, none
CTTR
svc-remote-filtersReplication service remote download filters. See "Filter Reference" for a full list of possible options.CTTR
svc-reposition-on-source-id-changeThe 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
Default: See Notes | Valid: true, false
CTTR
svc-shard-default-dbMode for setting the shard ID from the default db.
Default: stringent | Valid: stringent, relaxed
CTTR
svc-systemd-config-connectorUsed to provide custom systemd configuration that will be used in place of the default generated on.CT
svc-systemd-config-managerUsed to provide custom systemd configuration that will be used in place of the default generated on.CT
svc-systemd-config-replicatorUsed to provide custom systemd configuration that will be used in place of the default generated on.CTTR
svc-table-engineReplication service table engine.
Default: innodb
CTTR
svc-thl-filtersReplication service THL filters. See "Filter Reference" for a full list of possible options.CTTR
temp-directoryThe 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.
Default: /tmp
CTTR
template-search-pathAdds a new template search path for configuration file generation.
Default: [INSTALL-DIRECTORY]/share/templates
CTTR
thl-directoryReplicator log directory.
Default: [INSTALL-DIRECTORY]/thl
CTTR
thl-do-checksumExecute checksum operations on THL log files.
Default: false | Valid: true, false
CTTR
thl-interfaceListen interface to use for THL operations.CTTR
thl-log-connection-timeoutNumber of seconds to wait for a connection to the THL log.
Default: 600
CTTR
thl-log-file-sizeFile size in bytes for THL disk logs.
Default: 100000000
CTTR
thl-log-fsyncFsync THL records on commit. More reliable operation but adds latency to replication when using low-performance storage.
Default: false | Valid: true, false
CTTR
thl-log-retentionHow long do you want to keep THL files.
Default: 7d | Valid: #s, #m, #h, #d
CTTR
thl-port
Aliases: repl-thl-port
Port to use for THL Operations.
Default: 2112
CTTR
thl-protocol-portProtocol to use for THL communication with this service.
Default: See Notes | Valid: thl, thls
CTTR
thl-sslEnable SSL encryption of THL communication for this service.
Default: See Notes | Valid: true, false
CTTR
tls-enabled-protocolsSet for TLS 1.3 by default for Java 8u272 onwards. Use this property to force alternative protocols.CTTR
topologyReplication topology for the dataservice.
Valid: clustered, cluster-alias, cluster-slave, master-slave, fan-in, all-masters, direct, composite-multi-master
CTTR
track-schema-changesThis 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.
Default: false | Valid: true, false
CTTR
treat.com.change.user.as.pingThe 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.
Default: false | Valid: true, false
CT
tungsten-ini-backupEnables/Disables the backup on the tungsten.ini file into a history file.
Default: false | Valid: true, false
CTTR7.2.1
tungsten-ini-history-dirSet the location for the creation of the history files of the tungsten.ini file.
Default: [INSTALL-DIRECTORY]/history/ini
CTTR7.2.1
userOS System User, for example tungsten. DO NOT use root.CTTR
vertica-dbnameName of the database to replicate into.TR
waitForDisconnectControls how the connector handles existing connections when a manual switch is invoked.
Valid: true, false
CT
waitIfDisabledWhen enabled, will make new connection requests "hang" until either the connector gets back network access to a manager OR waitIfDisabledTimeout is reached
Default: true | Valid: true, false
CT
waitIfDisabledTimeoutHow long (in seconds) to hold new requests and "hang" until either the connector gets back network access to a manager OR waitIfDisabledTimeout is reachedCT
waitIfUnavailableConnector 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.
Default: true | Valid: true, false
CT
waitIfUnavailableTimeoutIf 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) .
Default: 0
CT
witnessesWitness hosts for the dataservice. Must be provided if enable-active-witnesses is enabled.CTTR