Skip to main content

"engine"

The "engine" object contains actions that can be used to interact with the database engines managed by the specified replication instance.

Examples

"info" example

{
  "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
    "pwd": "ADMIN"
  },
  "engine": {
    "name": "FAIRCOMS@HOST001",
    "actions": [ "info" ]
  }
}

"change" example

{
"memphis": {
    "name": "MEMPHIS",
    "uid": "admin",
    "pwd": "ADMIN"
    "host": "localhost"
  },
  "engine": {
    "name": "FAIRCOMS@HOST001",
    "actions": [ "change" ],
    "properties": {
      "read_only": false,
      "description": "Server running on Windows",
      "name": "FAIRCOMS@10.0.0.12",
      "accept_connections": true
    }
  }
}

"list_publications" example

{
  "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
    "pwd": "ADMIN"
  },
  "engine": {
    "name": "FAIRCOMS@HOST001",
    "actions": [ "list_publications" ]
  }
}

Property summary

Table 1. "engine" action summaries

Property

Description

Type

"info"

shows the specified server engine logical name, description, accept connections, read-only mode, serial number, working volume, working directory, and location of the main configuration file on the screen

object

"change"

allows the user to change the specified server engine logical name, description, read-only mode, and accept connections

object

"list_publications"

lists the publications currently available on the specified server

Note

  • The "name" parameter is required.

  • This can be run together with "info".

object



"change"

Allows the user to change the specified server engine logical name, description, read-only mode, and accept connections.

Things to know:

  • It requires the "name" parameter to specify which server needs to be changed.

  • The properties to be changed must be specified inside the "properties" JSON object.

  • Specify only the properties that you want to be changed. Properties not specified will remain unchanged.

Property summary

Table 2. "change" property summaries

Property

Description

Default

Type

Limits (inclusive)

"name"

defines the new logical name for the specified server

string

"description"

defines the new description for the specified server

string

"read_only"

controls the serve's read-only mode

Boolean

true
false

"accept_connections"

controls the acceptance of connections from other replication agents

Boolean

true
false