Extractor Configuration #

The extractor configuration file contains all the parameters that Replicant uses while extracting data from the source database. While it is not necessary to modify most of the parameters, they can be adjusted to optimize the extraction as necessary. The sample extractor configuration file is located in the Replicant release download folder. The path to the sample extraction configuration file in the release folder is: conf/src/source_database_name.yaml The sample file is broken up into two sections- snapshot and realtime. The extraction configurations for the initial data capture must be specified under snapshot and the configurations for realtime replication must be specified under realtime

Snapshot Mode #

Replicant can run on the default extractor configurations for the data snapshot. Thus, changing the snapshot extraction configurations is not required. However, depending on the replication job, you may want to adjust or specify certain parameters under the snapshot field of the configuration file and optimize Replicant.

The following configuration parameters are available for snapshot mode:

threads: Maximum number of threads replicant should use for data extraction from source.
fetch-size-rows: Maximum number of records/documents Replicant can fetch at once from the source system.
lock: Option to do object locking on source. No locking is done by default.
- enable: false
- scope: table
- force: false
- timeout-sec: 5
This configuration is not relevant for sources such as MongoDB, Cassandra which do not support locking.
min-job-size-rows: Replicant chunks tables/collections into multiple jobs for replication. This configuration specifies the minimum size for each such job. The minimum size specified has a positive correlation with the memory footprint of Replicant.
max-jobs-per-chunk: The maximum number of jobs in a chunk.
split-key: Replicant uses this configuration to split the table/collection into multiple jobs in order to perform parallel extraction. The specified split key column must be of numeric or timestamp type.
Note: We don’t support split-keys over macro/procedure queries. Curerntly, we only support splitting jobs over split-keys for tables and views.
Splitting the work for source data extraction using the key provided here can significantly optimize Replicant if the following coniditions are met:
- The split-key has uniform data distribution in the table (and there is minimal data skew in the values of split-key) .
- An index is present on split-key on the source system.
split-method[v20.05.12.3]: Replicant supports two split methods.
- RANGE: Replicant splits the work in a range-based manner by uniformly distributing the split-key value ranges between the MIN and MAX values.
- MODULO: The split key must be of numeric type for this split-method. Each extraction job is assigned a JobID of 0 to JOB-CNT -1. Each job then pulls data from the source where MOD(split-key, JOB-CNT) = JobID.
extraction-method [v20.07.02.1]: Replicant supports the following extraction methods:
- QUERY: The default extraction method.
- TPT: Stands for Teradata Parallel Transporter Utility (TPT). Currently only supported for Teradata as a source.
- CSVLOAD: Extraction from the CSV files containing the data already exported from tables.
- DSBULK [v21.05.04.1]: Extraction using the DataStax Bulk Loader (DSBulk) tool. Currently supported only for Cassandra.
tpt-num-files-per-job [v20.07.02.1]: This parameter is only applicable when the extraction-method is TPT. It indicates how many CSV files should be exported by each TPT job (default value set to 16).
fetch-PK: Option to fetch (and replicate) primary key constraints for tables. Default value is true.
fetch-UK: Option to fetch ( and replicate) unique key constraints for tables. Default value is true..
fetch-FK: Option to fetch (and replicate) foreign key constraints for tables. Default value is true..
fetch-Indexes: Option to fetch (and replicate) indexes for table. Default value is true.
fetch-user-roles: Option to fetch (and replicate) user/roles. The default is true for homogeneous pipelines, but false otherwise.
normalize v[20.09.14.10]: This parameter is only supported for Mongo Database as a source. The configuration is used to configure the normalization of data.
- enable: Default value is false. Whether to enable normalization.
- de-duplicate: Default value is false. Whether to de-duplicate data during normalization,
- extract-upto-depth: The depth upto which the MongoDB document should be extracted. Default value is INT_MAX.
fetch-schemas-from-system-tables [v20.10.07.05]: Option to use system tables to fetch schema information. By default, the value is true, and the option is enabled. If disabled, schemas need to be provided using --src-schemas.
per-table-config: This section can be used to override certain configurations in specific tables if necessary.

catalog: <catalog_name>
schema: <schema_name>
tables: Multiple tables can be specified using the following parameters:
- <table_name>:
  - max-jobs-per-chunk:
  - split-key: Used to specify split-key for the specified tfetch-FKable.
  - split-method [v20.05.12.3]: Used to override the global split method in the specific table.
  - extraction-method [v20.07.02.1]: Used to override the global extraction method in the specified table.
  - tpt-num-files-per-job [v20.07.02.1]: Used to override the global Num files per TPT job in the specified table.
  - row-identifier-key: Here you can specify a list of columns which uniquely identify a row in this table. If a table does not have a PK/UK defined and if the table has a subset of columns that can uniquely identify rows in the table, it is strongly recommended to specify that subset of columns as a row-identifier-key. Specifying an identifier can significantly improve the performance of incremental replication of this table.
  - extraction-priority [v20.09.14.1]: Priority for scheduling extraction of table. Higher value is higher priority. Both positive and negative values are allowed. Default priority is 0 if unspecified.
  - normalize v[20.09.14.10]: This parameter is only supported for Mongo Database as a source. The configuration is used to configure the normalization of data.
    - de-duplicate: Default value is false. Whether to de-duplicate data during normalization,
    - extract-upto-depth: Used to specify the depth upto which the MongoDB document should be extracted (default is INT_MAX).
  You can configure as many tables as necessary and specify them under each other using the format above. For example, configuring two tables would look like the following:
```
  <table_name>:
    max-jobs-per-chunk:
    split-key:
    split-method:  
       split-method:  
    split-method:  
       split-method:  
    split-method:  
    extraction-method:
    tpt-num-files-per-job:
    row-identifier-key:
    extraction-priority:
    normalize: #Only for Mongo Database as source
      de-duplicate:
      extract-upto-depth:

  <table_name>:
    max-jobs-per-chunk:
    split-key:
    split-method:
    extraction-method:
    tpt-num-files-per-job:
    row-identifier-key:
    extraction-priority:
    normalize: #Only for Mongo Database as source   
      normalize: #Only for Mongo Database as source   
    normalize: #Only for Mongo Database as source   
      normalize: #Only for Mongo Database as source   
    normalize: #Only for Mongo Database as source   
      de-duplicate:
      extract-upto-depth:               
        extract-upto-depth:               
      extract-upto-depth:               
        extract-upto-depth:               
      extract-upto-depth:               
```

Heartbeat table #

For real-time replication, you must create a heartbeat table. Replicant periodically updates this table at a configurable frequency. This table helps forcefully flush the cdc log for all committed transactions so that Replicant can Replicate them. A few things to note: * The table must be created in the catalog/schema which is to be replicated by replicant. * The user configured for Replicant must be granted INSERT, DELETE, and UPDATE privileges to the heartbeat table. * For simplicity, it is recommended to use the exact DDL provided in the extractor configuration set up under your source database’s instructional documentation to create the heartbeat table

The configurations for the heartbeat table must be specified under the realtime section of the Extractor Configuration as explained in the proceeding section.

Realtime mode #

Unless you have given your heartbeat table different table and column names than the ones used in the provided command to create the table, the extractor configurations under the realtime section do not need to be changed. However, changing certain parameters may improve replication performance depending on the use case. Each configuration that can be altered is explained below.

The following configuration parameters are available for realtime mode:

threads: Maximum number of threads to be used by replicant for real-time extraction
fetch-size-rows: Maximum number of records/documents fetched by replicant at once from the source system
fetch-duration-per-extractor-slot-s: Number of seconds a thread should continue extraction from a given replication channel/slot. (E.g. For MongoDB source, a mongo shard is one replication channel). After a thread spends extracting from a particular replication channel, it gets scheduled to process another replication channel. This option is relevant and important to avoid starvation from any replication channel when the number of threads provided is less than the number of replication channels.
heartbeat: This configuration section is to provision a heartbeat table on the source system to the Replicant. Replicant periodically updates this table at a configurable frequency. Heartbeat table helps to forcefully flush CDC logs for all committed transactions so that Replicant can replicate them. Heartbeat table must be created in the catalog/schema that Replicant will replicate. You can create the heartbeat table with the following DDL:
```
CREATE TABLE <catalog>.<schema>.arcion_io_cdc_heartbeat(timestamp <data_type_equivalent_to_long>)
```
INSERT, UPDATE, DELETE privilege must be granted for this table to the user which has been provided to Replicant.
- enable: true or false. Enable heartbeat mechanism (required for realtime replication).
- catalog: Catalog of the heartbeat table.
- schema: Schema of the heartbeat table.
- table-name [v20.09.14.3]: Name of the heartbeat table.
- column-name [v20.10.07.9]: Name of column in heartbeat table (has only 1 column).
- interval-ms: Interval at which heartbeat table should be updated with the latest timestamp (milliseconds since epoch) by Replicant.
fetch-interval-s [v20.07.16.1]: Interval in seconds after which Replicant will try to fetch the CDC log
Not all realtime sources currently support this parameter.
start-position [v20.09.14.1]: This config is used in real-time mode to specify the starting log position for real-time replication. The structure for providing start positions for different databases is as follows:
- IBM Db2:
  - commit-time: Timestamp from source Db2 in UTC. For example, the following query will give the timestamp in UTC:
```
SELECT CURRENT TIMESTAMP - CURRENT TIMEZONE AS UTC_TIMESTAMP FROM SYSIBM.SYSDUMMY1
```
- MySQL:
  - log: Log file from where replication should start.
  - position: position within the log file from where replication should start.
- MySQL:
  - timestamp-ms: Timestamp in milliseconds from where replication should start. This corresponds to the timestamp field ts in optime. Note that ts contains timestamp in seconds which needs to be multiplied by 1000.
  - increment: Optional. The increment for the given timestamp. This corresponds to the increment section in the ts field of optime.
- Oracle:
  - start-scn: The SCN from which replication should start.
- Informix:
  - sequence-number: long type value. Specifies the start position from which replication should start.
  - timestamp-ms: long type value. Causes Replicant to discard all transactions that were committed before this timestamp.
  - create-checkpoint: boolean value. Creates a replication “checkpoint”.
- Others:
  - timestamp-ms: Timestamp from which replication should start.
idempotent-replay [v20.09.14.1]: This parameter can have the following possible values:
- ALWAYS: Means always do INSERT as REPLACE.
- NONE: Means publish operation as is.
- NEVER: Default value.
normalize [v20.09.14.12]: This parameter is only supported for MongoDB Database as a source. It is used to configure the normalization of data.
- enable: Default value is false. Whether to enable normalization.
- de-duplicate: Default value is false. It allows de-duplicating data during normalization.
- extract-upto-depth: The depth upto which the MongoDB document should be extracted. Default value is INT_MAX.
per-table-config: This section can be used to override certain configurations in specific tables if necessary.
- catalog: <catalog_name>
- schema: <shema_name>
- tables: Multiple tables can be specified using the following format
  - <table_name>:
    - normalize [v20.09.14.12]: This parameter is only supported for Mongo Database as a source. The configuration is used to configure the normalization of data.
    - de-duplicate: true/false (The default is false) To de-duplicate data during normalization
    - extract-upto-depth: true/false (The default is false) To de-duplicate data during normalization
    You can configure as many tables as necessary and specify them under each other using the format above. For example, configuring two tables would look like the following:
```
 <table_name>:
    normalize: #Only for Mongo Database as source
      de-duplicate:
      extract-upto-depth:

 <table_name>:
   normalize: #Only for Mongo Database as source     
   de-duplicate:
   extract-upto-depth:                
```

Delta snapshot mode #

Arcion supports a third mode of replication called delta-snapshot. Delta-snapshot is required when the source database does not provide access to CDC log but the customer is interested in real-time replication (for example Teradata). The delta snapshot is a recurring snapshot which replicates the delta of the records which have been inserted/updated since the previous delta snapshot iteration. The following describes parameters of the delta-snapshot section of the Extractor configuration file.

The following configuration parameters are available for delta snapshot mode:

threads: Maximum number of threads replicant should use for data extraction from source.
fetch-size-rows: Maximum number of records/documents Replicant fetches at once from the source system.
lock: Option to do object locking on source. No locking is done on MongoDB. Below are the parameters and example values:
- enable: false
- scope: table
- force: false
- timeout-sec: 5
min-job-size-rows: Replicant chunks Tables/collections into multiple jobs for replication. This configuration specifies a minimum size for each such job. This has a positive correlation with the memory footprint of replicant.
max-jobs-per-chunk: Determines the maximum number of jobs Replicant should create for each source table/collection.
split-key: Replicant uses this configuration to split a table into multiple jobs in order to do parallel extraction. It lets you specify a global split-key. Replicant will use this column to perform parallel data extraction from each table that has this column (unless this configuration is overridden in per-table-config for this table).
split-method [v20.05.12.3] : Replicant supports two split methods:
- RANGE : Performs a range based splitting of work by uniformly distributing the split-key value ranges between the MIN and MAX values.
- MODULO : Split key must be only of numeric type for this split-method. Each extraction job is assigned a JobID of 0 to JOB-CNT -1. Each job then pulls data from the source where MOD(split-key, JOB-CNT) = JobID.
extraction-method[v20.07.02.1]: Replicant supports the following extraction methods:
- QUERY: The default extraction method.
- TPT: Stands for Teradata Parallel Transporter Utility (TPT). Currently only supported for Teradata as a source.
- CSVLOAD: Extraction from the CSV files containing the data already exported from tables. Currently only supported for Cassandra as source,
- DSBULK: Extraction using the DataStax Bulk Loader (DSBulk) tool. Currently supported only for Cassandra.
- COPY: Supports bulk mode extraction for CockroachDB and Greenplum.
tpt-num-files-per-job [v20.07.02.1]: Relevant when extraction-method is TPT. This config indicates how many CSV files each TPT job should export (default value set to 16).
delta-snapshot-key: Tables requiring incremental replication must have a NON-NULL numeric/timestamp column which is updated on each insert/update on each row of that table. The value of this column must be monotonically increasing and non-repeatable. We call such a column a delta-snapshot-key. This configuration lets you specify that key. Replicant uses this column to perform its incremental replication for each table being replicated that has this column (unless this configuration is overridden in per-table-config for this table).

delta-snapshot-key is deprecated. Please use delta-snapshot-keys instead.
delta-snapshot-keys [v21.12.02.1]: This config lets you specify one or more delta-snapshot-keys. Tables requiring incremental replication must have a NON-NULL numeric/timestamp column which is updated on each insert/update on each row of that table. The value of this column must be monotonically increasing and non-repeatable. We call such a column a delta-snapshot-key. This configuration lets you specify multiple delta-snapshot-keys. Replicant uses this column to perform its incremental replication for each table being replicated that has this column (unless this configuration is overridden in per-table-config for this table).

Each column in this list acts as an individual delta-snapshot-key and updating on any of the columns in this list will trigger replication. For example:
```
delta-snapshot-keys: [col1, col2, col3]`  # A list of monotonic increasing numeric/timestamp columns which gets new value on each INSERT/UPDATE
```
row-identifier-key: If a table does not have a PK/UK defined on it, then we strongly recommend that you specify a row-identifier-key: a single column or a group of columns that are ensured to be unique in the table by your applications. Arcion leverages this row-identifier-key to achieve a much better overall performance for incremental replication (in the absence of PK/UK). This configuration lets you specify a global row-identifier-key. Arcion Replicant makes use of this key to perform certain replication (unless this configuration is overridden in per-table-config for this table).
update-key: This lets users specify a key that Replicant should use to perform DELETES/UPDATES on the target system under the following scenarios:
- PK/UK does not exist.
- There’s no unique row-identifier-key present in the table.
This specifies a single column or a group of columns to be used by replicant. We strongly recommended that you create an index on update-key on the target table explicitly to get better replication performance.
delta-snapshot-interval: The interval (in seconds) between two incremental replication cycles. This configuration allows you to specify how frequently Arcion replicant should query the source database and pull incremental changes.
replicate-deletes: This configuration allows you to disable delete replication.
delta-snapshot-delete-interval: This configuration allows you to specify a different interval for delete replication that the one specified for insert/update incremental replication.
native-extract-options:
- charset: This configuration allows users to specify the charset to be used with native extraction method. Supported values are ASCII and UTF8.
- compression-type: This configuration allows users to specify the compression type to be used with native extraction method. Supported value is GZIP.
per-table-config: Use this section if you want to override certain configuration on a per table (/view/query) basis.
- catalog: <catalog_name>
- schema: <schema_name>
- tables:
  - <table_name>:
    - split-key: This configuration allows you to specify table specific split-key. If specified, it overrides the global split-key configuration.
    - split-method [v20.05.12.3]: You can override split-method on a per-table basis using this config.
    - extraction-method [v20.07.02.1]: You can override extraction-method on a per-table basis using this config.
    - num-jobs: Number of parallel jobs Replicant will use to extract the rows from a table. This value will override the number of jobs Replicant internally calculates.
    - num-delete-jobs [v21.02.01.8]: Number of parallel delete jobs that Replicant will use to replicate deletes for a table. This value will override the number of jobs Replicant internally calculates. If you don’t specify any value, then Replicant will use the value of num-jobs that you specified.
    - tpt-num-files-per-job [v20.07.02.1]: Num files per TPT job can be overridden on a per-table basis using this config.
    - delta-snapshot-key: This configuration allows you to specify table specific delta-snapshot-key. If specified, it overrides the global delta-snapshot-key.
    delta-snapshot-key is deprecated. Please use delta-snapshot-keys instead.
    - delta-snapshot-keys: This configuration allows you to specify table specific delta-snapshot-keys. If specified, it overrides the global delta-snapshot-keys
    - row-identifier-key: This configuration allows you to specify table specific row-identifier-key. If specified, it overrides the global row-identifier-key.
    - update-key: This configuration allows you to specify a table specific update-key. If specified, it overrides the global update-key.
    - replicate-deletes: This configuration allows you to enable/disable delete replication individually for a table.
    - native-extract-options:
      - charset: This configuration allows users to specify the charset to be used with native extraction method. Supported values are ASCII and UTF8.
      - compression-type: This configuration allows users to specify the compression type to be used with native extraction method. Supported value is GZIP.
      - column-size-map[v20.08.13.9]: This lets users specify column size/length to use while extracting data.