| Option | --cctrl-column-width | |
| Config File Options | cctrl-column-width | |
| Description | Sets the minimum column width for service names within cctrl | |
Sets the minimum column width for service names within cctrl
| Option | --channels | |
| Aliases | --repl-channels | |
| Config File Options | channels, repl-channels | |
| Description | Number of replication channels to use for parallel apply. | |
| Value Type | numeric | |
| Default | 1 | |
--cluster-slave-auto-recovery-delay-interval
| Option | --cluster-slave-auto-recovery-delay-interval | |
| Aliases | --cluster-slave-repl-auto-recovery-delay-interval | |
| Config File Options | cluster-slave-auto-recovery-delay-interval, cluster-slave-repl-auto-recovery-delay-interval | |
| Description | Default value for --auto-recovery-delay-interval when --topology=cluster-slave | |
| Value Type | string | |
--cluster-slave-auto-recovery-max-attempts
| Option | --cluster-slave-auto-recovery-max-attempts | |
| Aliases | --cluster-slave-repl-auto-recovery-max-attempts | |
| Config File Options | cluster-slave-auto-recovery-max-attempts, cluster-slave-repl-auto-recovery-max-attempts | |
| Description | Default value for --auto-recovery-max-attempts when --topology=cluster-slave | |
| Value Type | string | |
--cluster-slave-auto-recovery-reset-interval
| Option | --cluster-slave-auto-recovery-reset-interval | |
| Aliases | --cluster-slave-repl-auto-recovery-reset-interval | |
| Config File Options | cluster-slave-auto-recovery-reset-interval, cluster-slave-repl-auto-recovery-reset-interval | |
| Description | Default value for --auto-recovery-reset-interval when --topology=cluster-slave | |
| Value Type | string | |
| Option | --composite-datasources | |
| Aliases | --dataservice-composite-datasources | |
| Config File Options | composite-datasources, dataservice-composite-datasources | |
| Description | Data services that should be added to this composite data service | |
| Value Type | string | |
| Option | --config-file | |
| Config File Options | config-file | |
| Description | Display help information for content of the config file | |
| Value Type | string | |
--conn-java-enable-concurrent-gc
| Option | --conn-java-enable-concurrent-gc | |
| Config File Options | conn-java-enable-concurrent-gc | |
| Description | Connector Java uses concurrent garbage collection | |
| Value Type | string | |
| Option | --conn-java-mem-size | |
| Config File Options | conn-java-mem-size | |
| Description | Connector Java heap memory size used to buffer data between clients and databases | |
| Value Type | numeric | |
| Valid Values | 256 | |
The Connector allocates memory for each concurrent client
connection, and may use up to the size of the configured MySQL
max_allowed_packet. 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
| Option | --conn-round-robin-include-master | |
| Config File Options | conn-round-robin-include-master | |
| Description | Should the Connector include the Primary in round-robin load balancing | |
| Value Type | boolean | |
| Default | false | |
| Valid Values | false | |
| true | ||
| Option | --connector-affinity | |
| Config File Options | connector-affinity | |
| Description | The default affinity for all connections | |
| Value Type | string | |
--connector-allow-cross-site-reconnects-for-reads
| Option | --connector-allow-cross-site-reconnects-for-reads | |
| Config File Options | connector-allow-cross-site-reconnects-for-reads | |
| Description | Whether or not to reject reconnections that follow a read operation (RO_RELAXED or SmartScale after a read) | |
| Value Type | boolean | |
| Default | true | |
| Valid Values | false | |
| true | ||
--connector-allow-cross-site-reconnects-for-writes
| Option | --connector-allow-cross-site-reconnects-for-writes | |
| Config File Options | connector-allow-cross-site-reconnects-for-writes | |
| Description | Whether or not to reject reconnections that follow a write operation (RW_STRICT connection or SmartScale after a write) | |
| Value Type | boolean | |
| Default | false | |
| Valid Values | false | |
| true | ||
| Option | --connector-autoreconnect | |
| Config File Options | connector-autoreconnect | |
| Description | Enable auto-reconnect in the connector | |
| Value Type | boolean | |
| Default | true | |
| Valid Values | false | |
| true | ||
--connector-autoreconnect-killed-connections
| Option | --connector-autoreconnect-killed-connections | |
| Config File Options | connector-autoreconnect-killed-connections | |
| Description | Enable autoreconnect for connections killed within the connector | |
| Value Type | boolean | |
| Default | true | |
| Valid Values | false | |
| true | ||
By default, the connector operates as follows:
Reconnect closed connections
Retry autocommitted reads
The behavior can be modified by using the
--connector-autoreconnect-killed-connections.
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.
| Option | --connector-bridge-mode | |
| Aliases | --enable-connector-bridge-mode | |
| Config File Options | connector-bridge-mode, enable-connector-bridge-mode | |
| Description | Enable the Tungsten Connector bridge mode | |
| Value Type | boolean | |
| Default | true | |
| Valid Values | false | |
| true | ||
| Option | --connector-default-schema | |
| Aliases | --connector-forced-schema | |
| Config File Options | connector-default-schema, connector-forced-schema | |
| Description | Default schema for the connector to use | |
| Value Type | string | |
| Option | --connector-delete-user-map | |
| Config File Options | connector-delete-user-map | |
| Description | Overwrite an existing user.map file | |
| Value Type | boolean | |
--connector-disable-connection-warnings
| Option | --connector-disable-connection-warnings | |
| Config File Options | connector-disable-connection-warnings | |
| Description | Hide Connector warnings in log files | |
| Value Type | boolean | |
--connector-disconnect-timeout
| Option | --connector-disconnect-timeout | |
| Config File Options | connector-disconnect-timeout | |
| Description | Time (in seconds) to wait for active connection to disconnect before forcing them closed [default: 5] | |
| Value Type | numeric | |
| Default | 5 | |
--connector-drop-after-max-connections
| Option | --connector-drop-after-max-connections | |
| Config File Options | connector-drop-after-max-connections | |
| Description | Instantly drop connections that arrive after --connector-max-connections has been reached | |
| Value Type | boolean | |
| Option | --connector-generate-eof | |
| Config File Options | connector-generate-eof | |
| Description | 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. | |
| Value Type | boolean | |
| Default | true | |
| Option | --connector-keepalive-timeout | |
| Config File Options | connector-keepalive-timeout | |
| Description | 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 the manager has mgr-monitor-interval value set greater than this, it controls the frequency at which keep-alive commands are sent. | |
| Value Type | numeric | |
| Default | 30000 | |
| Option | --connector-listen-interface | |
| Config File Options | connector-listen-interface | |
| Description | Listen interface to use for the connector | |
| Value Type | string | |
| Option | --connector-manager-use-ssl | |
| Config File Options | connector-manager-use-ssl | |
| Description | Manager<>Connector connections can be encrypted with TLS by setting this to true or with the --disable-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 | |
| Value Type | boolean | |
| Valid Values | false | Disabled by default in v6 or earlier |
| true | Enabled by default in v7 onwards | |
| Option | --connector-max-connections | |
| Config File Options | connector-max-connections | |
| Description | The maximum number of connections the connector should allow at any time | |
| Value Type | numeric | |
| Option | --connector-max-slave-latency | |
| Aliases | --connector-max-applied-latency | |
| Config File Options | connector-max-applied-latency, connector-max-slave-latency | |
| Description | The maximum applied latency for replica connections. Disabled by default. | |
| Value Type | numeric | |
| Default | -1 | |
| Option | --connector-readonly | |
| Aliases | --enable-connector-readonly | |
| Config File Options | connector-readonly, enable-connector-readonly | |
| Description | Enable the Tungsten Connector read-only mode | |
| Value Type | boolean | |
--connector-relative-slave-status
| Option | --connector-relative-slave-status | |
| Config File Options | connector-relative-slave-status | |
| Description | Determines whether the reported latency is relative (true) or absolute (false). Default is the value of dataservice-use-relative-latency which itself has the default of false. | |
| Value Type | boolean | |
--connector-reset-when-affinity-back
| Option | --connector-reset-when-affinity-back | |
| Config File Options | connector-reset-when-affinity-back | |
| Description | Forces reconnection of clients to datasources with the configured affinity when they become available | |
| Default | false | |
| Valid Values | false | Allow connections to remain open even when correct datasource becomes available |
| true | Disconnect clients when datasource becomes available | |
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.
| Option | --connector-rest-api | |
| Config File Options | connector-rest-api | |
| Description | Enable (default) or Disable APIv2 | |
| Default | true | |
| Valid Values | false | |
| true | ||
| Option | --connector-rest-api-address | |
| Config File Options | connector-rest-api-address | |
| Description | Address for the API to bind too. | |
| Default | 127.0.0.1 | |
| Option | --connector-rest-api-port | |
| Config File Options | connector-rest-api-port | |
| Description | Port for the Connector API. | |
| Default | 8096 | |
| Option | --connector-ro-addresses | |
| Config File Options | connector-ro-addresses | |
| Description | Connector addresses that should receive a r/o connection | |
| Value Type | string | |
| Option | --connector-rw-addresses | |
| Config File Options | connector-rw-addresses | |
| Description | Connector addresses that should receive a r/w connection | |
| Value Type | string | |
| Option | --connector-rwsplitting | |
| Config File Options | connector-rwsplitting | |
| Description | Enable DirectReads R/W splitting in the connector | |
| Value Type | string | |
--connector-server-ssl-ciphers
| Option | --connector-server-ssl-ciphers | |
| Config File Options | connector-server-ssl-ciphers | |
| Description | Configures ciphers the connector uses for SSL communications to the dbatabase server. Defaults to allow all cipher suites supported by the running JVM. | |
| Value Type | string | |
--connector-server-ssl-protocols
| Option | --connector-server-ssl-protocols | |
| Config File Options | connector-server-ssl-protocols | |
| Description | Configures protocols the connector uses for SSL communications to the dbatabase server. Default value when not specified will be TLSv1,TLSv1.1,TLSv1.2 | |
| Value Type | string | |
| Default | TLSv1,TLSv1.1,TLSv1.2 | |
| Option | --connector-smartscale | |
| Config File Options | connector-smartscale | |
| Description | Enable SmartScale R/W splitting in the connector | |
| Value Type | boolean | |
| Default | false | |
| Valid Values | false | |
| true | ||
--connector-smartscale-sessionid
| Option | --connector-smartscale-sessionid | |
| Config File Options | connector-smartscale-sessionid | |
| Description | The default session ID to use with smart scale | |
| Value Type | string | |
| Default | DATABASE | |
| Valid Values | CONNECTION | |
| DATABASE | ||
| PROVIDED_IN_DBNAME | ||
| USER | ||
| Option | --connector-ssl-capable | |
| Config File Options | connector-ssl-capable | |
| Description | Defines whether connector ports are advertised as being capable of SSL | |
| Value Type | boolean | |
| Default | true | |
| Valid Values | false | Do not advertise connector ports as SSL capable |
| true | Advertise connector ports as SSL capable | |
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.
| Option | --connectors | |
| Aliases | --dataservice-connectors | |
| Config File Options | connectors, dataservice-connectors | |
| Description | Hostnames for the dataservice connectors | |
| Value Type | string | |
| Option | --consistency-policy | |
| Aliases | --repl-consistency-policy | |
| Config File Options | consistency-policy, repl-consistency-policy | |
| Description | Should the replicator stop or warn if a consistency check fails? | |
| Value Type | string | |