Skip to main content

"options" (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,
      "rebuild": false,
      "pullrepl": true,
      "confilctdetect": true,
      "debugminlog": true,
      "rememberlogpos": true,
      "ignorepartition": true,
      "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
        }
      }
      ]
    }
  }

Property summary

Note

"plan" is the target of all properties.

Table 1. "options" target action summaries

Property

Description

Default

Type

Limits (inclusive)

"planreadtimeout"

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

5000

integer

"lockretrycount"

defines how many times to attempt a record lock

12

integer

"lockretrysleep"

defines the number of milliseconds to wait between record lock attempts

100

integer

"planbatchsize"

defines the batch size read from the source server

8192

integer

"rebuild"

controls whether the "deploy" operation will deploy the selected data and the indexes or only the data and will rebuild the index on the target server engine

true

Boolean

true to deploy the selected data and the indexes
false to deploy on the data and rebuild the index on the target server engine

"pullrepl"

controls 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

"confilctdetect"

detects replication conflicts

true

Boolean

true
false

"debugminlog"

logs the minimum log requirement updates in the ctreplagent.log

true

Boolean

true
false

"remeberlogpos"

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

true

Boolean

true
false

"ignorepartition"

converts source partitioned file to regular non-partitioned files

true

Boolean

true
false

"exceptionmode"

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

"transaction"

string

"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

"synclogwrites"

controls the flushing of local transaction logs to disk

false

Boolean

true
false

"analyzethreadscount"

defines the number of analyzer threads

1

integer

"applythreadscount"

defines the number of apply threads

8

integer