Skip to main content

"options" (target)

The options object applies relevant, optional parameters to a target

Abstract

Any target may have an options object that applies to itself. Options parameters that do not apply to the current target are ignored. The options object applies relevant, optional parameters to a target

Any target may have an "options" object that applies to itself. Options parameters that do not apply to the current target are ignored.

Examples

This examples shows a plan creation with options

{
  "memphis": {
    "name": "MEMPHIS",
    "uid": "admin",
    "pwd": "ADMIN",
    "port": "7597"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": false,
    "recursivedel": false,
    "recursivesearch": true
  },
  "plan": {
    "actions": [
      "create",
      ],
    "options": {
      "planreadtimeout": 10000,
      "lockretrycount": 2,
      "lockretrysleep": 300,
      "planbatchsize": 16348,
      "pullrepl": true,
      "confilctdetect": true,
      "debugminlog": true,
      "rememberlogpos": true,
      "ignorepartition": true,
      "logposition": "resume",
      "exceptionmode": "transaction",
      "parallel": true,
      "synclogwrites": false,
      "analyzethreadscount": 1,
      "applythreadscount": 1
    },
    "name": "planFiles",
    "sourceEngine": "FAIRCOMS@HOST001",
    "destEngine": "FAIRCOMS@SERVER001",
    "subscriptions": [
      {
        "name": "subFiles",
      "bidirectional": false,
      "redir": [
        {
          "source": "C:\\ctreeData",
          "target": "E:\\backup\\repldata\\"
        }
        ],
        "publication": {
          "name": "pubFiles",
          "create": false
        }
      }
      ]
    }
  }

Properties summary

Note

"plan" is the target of all properties.

Table 1. "options" target actions summary

Property

Description

Default

Type

Limits (inclusive)

analyzethreadscount

specifies the number of analyzer threads

1

integer

applythreadscount

specifies the number of apply threads

8

integer

conflictdetect

detects replication conflicts

true

Boolean

true
false

debugminlog

logs the minimum log requirement updates in the ctreplagent.log

true

Boolean

true
false

exceptionmode

handles errors as a "transaction" or an "exception"

"transaction"

string

ignorepartition

converts source partitioned file to regular non-partitioned files

true

Boolean

true
false

lockretrycount

specifies how many times to attempt a record lock

12

integer

lockretrysleep

specifies the number of milliseconds to wait between record lock attempts

100

integer

logposition

Specifies the start position for log replication

"resume"

string

"current"
"resume"
"source_log_number source_log_byte_offset target_log_number target_log_byte_offset"

parallel

controls whether to use multiple apply threads to improve performance

Important

false is not yet supported by the Replication Manager.

true

Boolean

true
false

planbatchsize

specifies the batch size read from the source server

8192

integer

planreadtimeout

specifies the polling timeout value in milliseconds when reading from the source server

5000

integer

pullrepl

specifies whether the target or source server engine is run

true

Boolean

true to run the target server engine
false to run the source server engine

rebuild

when false the deployment operation of the plan deploys the selected data plus the indexes

when true the deployment operation deploys the data only and rebuilds the index on the target server engine

true

Boolean

true
false

rememberlogpos

overrides the source server's KEEP_LOG option by forcing the source server to maintain the required logs

true

Boolean

true
false

synclogwrites

controls the flushing of local transaction logs to disk

false

Boolean

true
false

syncshutdown

instructs the replication agent to perform a synchronous shutdown when set to true and specified in the script as a stop action for a replication plan. Before shutdown, all changes it has read from the source server are applied.

false

Boolean

true
false


More information

The limit "source_log_number source_log_byte_offset target_log_number target_log_byte_offset" for logposition should only be used by experienced replication users or under the direct supervision of FairCom support.