Skip to main content

"publication"

The publication object is used to create, delete and list publications. The publication JSON object can be specified as the main target for the JSON input file or it can be used inside plan or group targets to define a publication during the creation of another target.

Properties summary

Table 1. "publication" object properties summary

Property

Description

Type

"create"

creates a new publication

object

"delete"

deletes the publication specified with the "name" parameter under the engine specified with the "engine" parameter

object

"list"

lists the files published by a publication specified with the "name" parameter under the engine specified with the "engine" parameter

object



Examples

"db" mode "create" example

Since the mode is "db", a "dbname" parameter is specified. Plus, there are additional folders that are going to be published. This feature is used because SQL databases may contain files from different folders.

{
    "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
    "pwd": "ADMIN"
    },
    "options": {
      "profile": true,
      "replace": true,
      "ignoredeploy": false,
      "recursivedel": false,
      "recursivesearch": true
    },
    "publication": {
      "actions": [
        "create"
      ],
      "name": "pubdb",
      "engine": "FAIRCOMS@HOST001",
      "mode": "db",
      "dbname": "ctreeSQL",
      "wildcards": ["*dat"],
      "items":[ 
        "E:\\sw\\eu_database\\dbf\\ML\\data\\c"
        ]
    }
  }

"folder" mode "create" example

{
    "memphis": {
      "name": "MEMPHIS",
      "host": "localhost",
      "port": "7597",
      "uid": "admin",
      "pwd": "ADMIN"
    },
    "options": {
      "profile": true,
      "replace": true,
      "ignoredeploy": false,
      "recursivedel": false,
      "recursivesearch": true
    },
    "publication": {
      "actions": [
        "create"
        ],
        "name": "pubfolder",
        "engine": "FAIRCOMS@HOST001",
        "mode": "folder",
        "item": "E:\\sw\\eu_database\\dbf\\ML\\data\\d",
        "wildcards": ["*dat"],
        "recursive": false
    }
}

"files" mode "create" example

{  
  "memphis": {
    "name": "MEMPHIS",
    "host": "localhost",
    "port": "7597",
    "uid": "admin",
    "pwd": "ADMIN"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": false,
    "recursivedel": false,
    "recursivesearch": true
  },
  "publication": {
    "actions": [
      "create"
    ],
    "name": "pubFiles",
    "engine": "FAIRCOMS@HOST001",
    "mode": "files",
    "items": [
      "E:\\sw\\eu_ldf\\dbf\\ML\\*.*dat",
      "E:\\sw\\usa_ldf\\dbf\\ML\\*.*dat",
    ]
  }
}

"delete" example

{
  "memphis": {
     "name": "MEMPHIS",
     "host": "localhost",
     "port": "7597",
     "uid": "admin",
    "pwd": "ADMIN"
  },
  "options": {
    "profile": true,
    "replace": true,
    "ignoredeploy": false,
    "recursivedel": false,
    "recursivesearch": true
  },
  "publication": {
    "actions": [
      "delete"
    ],
    "name": "pubFiles",
    "engine": "FAIRCOMS@HOST001"
  }
}

"list" example

{
  "memphis": {
    "name": "MEMPHIS",
    "uid": "admin",
    "pwd": "ADMIN"
  },
  "publication": {
    "actions": [
      "list"
    ],
    "name": "pubFiles",
    "engine": "FAIRCOMS@HOST001"
  }
}

"create"

The "create" action creates a new publication, plan, or group.

Note

The "create" action in "plan" always takes a list of subscriptions and each subscription is associated with an existing or new publication. The "create" action in the "publication" object defines new publications).

Properties summary

Table 2. "create" actions summary

Property

Description

Type

Limits (inclusive)

"name"

defines the name of the publication

string

"engine"

defines the logical name of the publication

string

"mode"

defines the mode of the publication

string

"db"
"folder"
"files"

"items"

contains a list of the objects to be published

Note

Depending on the "mode" this is a list of databases, folders, or files.

array of strings

"dbname"

contains the name of the database to be published

Note

This is for when the "mode" is "db".

string

"recursive"

controls whether the files matching the wildcard are matched recursively in sub-folders or just in the specified root

Note

This is for when the mode is "db" or "folder".

Boolean

"wildcards"

controls that the specified wildcards are used to match the files in the specified folders

Note

This is for when the mode is "db" or "folder".

array of strings

"create"

used to find an existing publication or create a new one when "publication" is not the main target of the input file

Boolean

"folderExcludes"

specifies wildcards that are used to exclude files in the designated folder, when the mode is "folder".

array of strings

"dbExcludes"

specifies wildcards that are used to exclude files in the designated folder, when the mode is "db". Each object is composed of an “item” which is a folder specified in the “items” array, and a mask which specifies the wildcard for the files to exclude.

array of JSON Objects