--readAutodetectConfigFromPrimary
| Option | --readAutodetectConfigFromPrimary | |
| Config File Options | readAutodetectConfigFromPrimary | |
| Description | The connector always reads its dynamic (auto-detect) configuration from primary node by default. Setting this property to false will force reading from a replica. Parameter must be supplied with the property= prefix. | |
| Value Type | boolean | |
| Default | true | |
| Valid Values | false | |
| true | ||
The connector always reads its dynamic (auto-detect) configuration from 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
| Option | --redshift-dbname | |
| Aliases | --repl-redshift-dbname | |
| Config File Options | redshift-dbname, repl-redshift-dbname | |
| Description | Name of the Redshift database to replicate into | |
| Value Type | string | |
| Option | --relay-directory | |
| Aliases | --repl-relay-directory | |
| Config File Options | relay-directory, repl-relay-directory | |
| Description | Directory for logs transferred from the Primary | |
| Value Type | string | |
| Default | {home directory}/relay | |
| Option | --relay-enabled | |
| Config File Options | relay-enabled | |
| Description | Should the replicator service be setup as a relay. | |
| Value Type | boolean | |
| Default | false | |
| Valid Values | false | |
| true | ||
| Option | --relay-source | |
| Aliases | --dataservice-relay-source, --master-dataservice | |
| Config File Options | dataservice-relay-source, master-dataservice, relay-source | |
| Description | Dataservice name to use as a relay source | |
| Value Type | string | |
| Option | --repl-allow-bidi-unsafe | |
| Config File Options | repl-allow-bidi-unsafe | |
| Description | Allow unsafe SQL from remote service | |
| Value Type | boolean | |
| Default | false | |
| Valid Values | false | |
| true | ||
| Option | --repl-store-thl-compressed | |
| Config File Options | repl-store-thl-compressed | |
| Description | Enable (true) or disable (false) compression of THL on disk. | |
| Value Type | boolean | |
| Default | false | |
| Valid Values | false | Disabled |
| true | Enabled | |
Enable (true) or disable (false) compression of THL on disk.
| Option | --repl-store-thl-encrypted | |
| Config File Options | repl-store-thl-encrypted | |
| Description | Enable (true) or disable (false) encryption of THL on disk. | |
| Value Type | boolean | |
| Default | false | |
| Valid Values | false | Disabled |
| true | Enabled | |
Enable (true) or disable (false) encryption of THL on disk.
--repl-svc-extractor-multi-frag-service-detection
| Option | --repl-svc-extractor-multi-frag-service-detection | |
| Config File Options | repl-svc-extractor-multi-frag-service-detection | |
| Description | Force extraction to read ahead to last fragment to detect service name | |
| Value Type | boolean | |
| Default | false | |
| Valid Values | false | Disabled |
| true | Enabled | |
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-thl-client-serialization
| Option | --repl-thl-client-serialization | |
| Config File Options | repl-thl-client-serialization | |
| Description | Enable THL compression on downstream Replicator Appliers. | |
| Value Type | string | |
| Default | LEGACY | |
| Valid Values | DEFLATE | |
| JAVA | ||
| PROTOBUF | ||
--repl-thl-server-serialization
| Option | --repl-thl-server-serialization | |
| Config File Options | repl-thl-server-serialization | |
| Description | Comma Separated list of THL compression protocols to enable on the thl-server (Extractor). | |
| Value Type | string | |
| Default | LEGACY,JAVA,PROTOBUF,DEFALTE | |
| Valid Values | DEFLATE | |
| JAVA | ||
| PROTOBUF | ||
| Option | --replace-tls-certificate | |
| Config File Options | replace-tls-certificate | |
| Description | Replace the TLS certificate | |
| Value Type | boolean | |
| Default | false | |
| Valid Values | false | |
| true | ||
Replace the TLS certificate
| Option | --replica-tx-commit-level | |
| Config File Options | replica-tx-commit-level | |
| Description | If set, determines the value of the underlying database property innodb_flush_log_at_trx_commit when a node becomes a replica. | |
| Value Type | string | |
| Valid Values | 1 | |
| 1 | ||
| 2 | ||
If set, determines the value of the underlying database property innodb_flush_log_at_trx_commit
when 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.
| Option | --replication-host | |
| Aliases | --datasource-host, --repl-datasource-host | |
| Config File Options | datasource-host, repl-datasource-host, replication-host | |
| Description | Hostname of the datasource | |
| Value Type | string | |
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.
| Option | --replication-password | |
| Aliases | --datasource-password, --repl-datasource-password | |
| Config File Options | datasource-password, repl-datasource-password, replication-password | |
| Description | Database password | |
| Value Type | string | |
The password to be used when connecting to the database using
the corresponding
--replication-user.
| Option | --replication-port | |
| Aliases | --datasource-port, --repl-datasource-port | |
| Config File Options | datasource-port, repl-datasource-port, replication-port | |
| Description | Database network port | |
| Value Type | string | |
| Valid Values | 1521 | Oracle Default |
| 27017 | Kafka Default | |
| 27017 | MongoDB Default | |
| 3306 | MySQL Default | |
| 5432 | PostgreSQL Default | |
| 5433 | Vertica Default | |
| 5439 | Redshift Default | |
| 8020 | HDFS Default | |
The network port used to connect to the database server. The default port used depends on the database being configured.
| Option | --replication-user | |
| Aliases | --datasource-user, --repl-datasource-user | |
| Config File Options | datasource-user, repl-datasource-user, replication-user | |
| Description | User for database connection | |
| Value Type | string | |
For databases that require authentication, the username to use when connecting to the database.
--replicator.extractor.dbms.transaction_frag_size
| Option | --replicator.extractor.dbms.transaction_frag_size | |
| Config File Options | replicator.extractor.dbms.transaction_frag_size | |
| Description | 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. | |
| Value Type | numeric | |
| 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
| Option | --replicator-rest-api | |
| Config File Options | replicator-rest-api | |
| Description | Enable or Disable APIv2 | |
| Value Type | boolean | |
| Default | true | |
| Valid Values | false | |
| true | ||
| Option | --replicator-rest-api-address | |
| Config File Options | replicator-rest-api-address | |
| Description | Address for the API to bind too. | |
| Value Type | string | |
| Default | 127.0.0.1 | |
--replicator-rest-api-authentication
| Option | --replicator-rest-api-authentication | |
| Config File Options | replicator-rest-api-authentication | |
| Description | Enforce authentication for the API. | |
| Value Type | boolean | |
| Default | true | |
| Valid Values | false | |
| true | ||
| Option | --replicator-rest-api-port | |
| Config File Options | replicator-rest-api-port | |
| Description | Port for the Replicator API. | |
| Value Type | numeric | |
| Default | 8097 | |
| Option | --replicator-rest-api-ssl | |
| Config File Options | replicator-rest-api-ssl | |
| Description | Enable or Disable SSL for the API. | |
| Value Type | boolean | |
| Default | true | |
| Valid Values | false | |
| true | ||
| Option | --rest-api-address | |
| Config File Options | rest-api-address | |
| Description | Address for the API to bind too. This property acts as an group alias for connector-rest-api-address, manager-rest-api-address and replicator-rest-api-address | |
| Value Type | string | |
| Default | 127.0.0.1 | |
| Option | --rest-api-admin-pass | |
| Aliases | --rest-api-admin-password | |
| Config File Options | rest-api-admin-pass, rest-api-admin-password | |
| Description | Specify the initial Admin User Password for API access. rest-api-admin-password alias only available from version 7.1.2 onwards. | |
| Value Type | string | |
| Option | --rest-api-admin-user | |
| Config File Options | rest-api-admin-user | |
| Description | Specify the initial Admin Username for API access. | |
| Value Type | string | |
| Option | --rest-api-authentication | |
| Config File Options | rest-api-authentication | |
| Description | Enable SSL for the API. This property acts as a group alias for connector-rest-api-authentication, replicator-rest-api-authentication and manager-rest-api-authentication | |
| Value Type | boolean | |
| Default | true | |
| Valid Values | false | |
| true | ||
| Option | --rest-api-ssl | |
| Config File Options | rest-api-ssl | |
| Description | Enable SSL for the API. This property acts as a group alias for connector-rest-api-ssl, replicator-rest-api-ssl and manager-rest-api-ssl | |
| Value Type | boolean | |
| Default | true | |
| Valid Values | false | |
| true | ||
| Option | --rest-apis | |
| Config File Options | rest-apis | |
| Description | Enable or Disable APIv2. This property acts as a group alias for connector-rest-api, manager-rest-api and replicator-rest-api | |
| Value Type | boolean | |
| Default | true | |
| Valid Values | false | |
| true | ||
| Option | --rmi-port | |
| Aliases | --repl-rmi-port | |
| Config File Options | repl-rmi-port, rmi-port | |
| Description | Replication RMI listen port | |
| Value Type | numeric | |
| Default | 10001 | |
| Option | --rmi-user | |
| Config File Options | rmi-user | |
| Description | The username for RMI authentication | |
| Value Type | string | |
| Default | tungsten | |
| Option | --role | |
| Aliases | --repl-role | |
| Config File Options | repl-role, role | |
| Description | What is the replication role for this service? | |
| Value Type | string | |
| Valid Values | master | Default if value of master in service block is the same as the host you are installing on |
| relay | Default if value of master in service block is the same as the host you are installing on AND service is a relay service | |
| slave | Default if the host you are installing on is only found in the members or slaves list | |
| Option | --router-gateway-port | |
| Config File Options | router-gateway-port | |
| Description | The router gateway port | |
| Value Type | numeric | |
| Default | 11999 | |
| Option | --router-jmx-port | |
| Config File Options | router-jmx-port | |
| Description | The router jmx port | |
| Value Type | numeric | |
| Default | 10999 | |