Root Schema : Oracle GoldenGate Distribution Path
Type: object
Title: Oracle GoldenGate Distribution Path
Show Source
{
"title":"Oracle GoldenGate Distribution Path",
"type":"object",
"properties":{
"begin":{
"description":"Starting point for data processing",
"default":"now",
"x-oneOf":[
{
"enum":[
"now"
]
},
{
"type":"string",
"pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
"minLength":20,
"maxLength":32
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"type:position/atTrailRBA"
]
},
"sequence":{
"description":"Trail file sequence number",
"type":"integer",
"minimum":0,
"maximum":999999999,
"default":0
},
"offset":{
"description":"Offset in trail sequence file",
"type":"integer",
"minimum":0,
"default":0,
"maximum":2147483647
}
},
"required":[
"sequence"
],
"additionalProperties":false
}
]
},
"name":{
"description":"distribution path name",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
"minLength":1,
"maxLength":32
},
"$schema":{
"enum":[
"ogg:distPath"
]
},
"status":{
"description":"Oracle GoldenGate Distribution Path Status",
"default":"stopped",
"enum":[
"paused",
"running",
"stopping",
"stopped",
"killed",
"uninitialized"
]
},
"ruleset":{
"description":"Ruleset for the distribution path",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRuleset"
]
},
"name":{
"description":"name of the path ruleset",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path ruleset",
"type":"string",
"minLength":1,
"maxLength":4095
},
"rules":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRule"
]
},
"name":{
"description":"name of the rule",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path rule",
"type":"string",
"minLength":1,
"maxLength":4095
},
"filters":{
"type":"array",
"items":{
"x-oneOf":[
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"objectNames":{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure"
]
},
"minItems":1,
"maxItems":3
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"columnValues":{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
"columnValue":{
"description":"column data, currently only support char and binary integer",
"x-oneOf":[
{
"type":"string",
"minLength":0,
"maxLength":32767
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":4096
},
"filterRelation":{
"description":"relationship among the filters",
"enum":[
"and",
"or"
],
"default":"or"
},
"actions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathAction"
]
},
"description":{
"description":"Description for the path action",
"type":"string",
"minLength":1,
"maxLength":4095
},
"command":{
"enum":[
"include",
"exclude"
],
"default":"include"
}
},
"required":[
"command"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":128
}
},
"required":[
"name",
"filters",
"actions"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1024
}
},
"additionalProperties":false
},
"source":{
"description":"source endpoint of the path",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpoint"
]
},
"description":{
"description":"Description for the endpoint",
"type":"string",
"minLength":1,
"maxLength":4095
},
"uri":{
"description":"endpoint URI specification",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"proxy":{
"description":"proxy to connect to target",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointProxy"
]
},
"uri":{
"description":"Uri of the proxy server",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"type":{
"description":"Type of the proxy server",
"type":"string",
"enum":[
"SOCKS5",
"HTTP"
]
},
"csAlias":{
"description":"Credential store alias",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
},
"csDomain":{
"description":"Credential store domain",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
}
},
"required":[
"uri",
"type"
],
"additionalProperties":false
},
"details":{
"description":"trail, encryption and compression information",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointTrail"
]
},
"trail":{
"description":"endpoint trail details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathTrailinfo"
]
},
"name":{
"description":"The name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]?$",
"minLength":1,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"default":"dirdat",
"type":"string",
"minLength":1,
"maxLength":255
},
"format":{
"description":"The format of output data. Default is canonical trail output",
"default":"canonical",
"x-oneOf":[
{
"enum":[
"canonical"
]
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:outputFormat"
]
},
"type":{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
},
"includeHeartBeat":{
"description":"Includes the heartbeat table records",
"type":"boolean",
"default":false
}
},
"required":[
"type"
],
"additionalProperties":false
}
]
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":500,
"minimum":1,
"maximum":4.294967295E9
},
"seqLength":{
"description":"Trail sequence number length",
"enum":[
6,
9
],
"default":9
}
},
"additionalProperties":false
},
"encryption":{
"description":"endpoint trail encryption",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEncryption"
]
},
"algorithm":{
"enum":[
"NONE",
"AES128",
"AES192",
"AES256"
],
"default":"NONE"
}
},
"required":[
"algorithm"
],
"additionalProperties":false
},
"compression":{
"description":"endpoint network compression",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathCompression"
]
},
"enabled":{
"type":"boolean",
"default":false
},
"threshold":{
"description":"compression threshold, the minimum block size(bytes) for which compression is to occur",
"type":"integer",
"default":1000,
"minimum":0,
"maximum":28000
}
},
"required":[
"enabled"
],
"additionalProperties":false
}
},
"additionalProperties":false
},
"isDynamicOggPort":{
"description":"If the trail URI starts with 'ogg://' then this property specifies if it is a static port (recvsrvr acting as a legacy collector) or a dynamic port (legacy installation, so the port in the URI is the mgr port).",
"type":"boolean",
"default":true
}
},
"additionalProperties":false
},
"target":{
"description":"target endpoint of the path",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpoint"
]
},
"description":{
"description":"Description for the endpoint",
"type":"string",
"minLength":1,
"maxLength":4095
},
"uri":{
"description":"endpoint URI specification",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"proxy":{
"description":"proxy to connect to target",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointProxy"
]
},
"uri":{
"description":"Uri of the proxy server",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"type":{
"description":"Type of the proxy server",
"type":"string",
"enum":[
"SOCKS5",
"HTTP"
]
},
"csAlias":{
"description":"Credential store alias",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
},
"csDomain":{
"description":"Credential store domain",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
}
},
"required":[
"uri",
"type"
],
"additionalProperties":false
},
"details":{
"description":"trail, encryption and compression information",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointTrail"
]
},
"trail":{
"description":"endpoint trail details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathTrailinfo"
]
},
"name":{
"description":"The name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]?$",
"minLength":1,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"default":"dirdat",
"type":"string",
"minLength":1,
"maxLength":255
},
"format":{
"description":"The format of output data. Default is canonical trail output",
"default":"canonical",
"x-oneOf":[
{
"enum":[
"canonical"
]
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:outputFormat"
]
},
"type":{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
},
"includeHeartBeat":{
"description":"Includes the heartbeat table records",
"type":"boolean",
"default":false
}
},
"required":[
"type"
],
"additionalProperties":false
}
]
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":500,
"minimum":1,
"maximum":4.294967295E9
},
"seqLength":{
"description":"Trail sequence number length",
"enum":[
6,
9
],
"default":9
}
},
"additionalProperties":false
},
"encryption":{
"description":"endpoint trail encryption",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEncryption"
]
},
"algorithm":{
"enum":[
"NONE",
"AES128",
"AES192",
"AES256"
],
"default":"NONE"
}
},
"required":[
"algorithm"
],
"additionalProperties":false
},
"compression":{
"description":"endpoint network compression",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathCompression"
]
},
"enabled":{
"type":"boolean",
"default":false
},
"threshold":{
"description":"compression threshold, the minimum block size(bytes) for which compression is to occur",
"type":"integer",
"default":1000,
"minimum":0,
"maximum":28000
}
},
"required":[
"enabled"
],
"additionalProperties":false
}
},
"additionalProperties":false
},
"isDynamicOggPort":{
"description":"If the trail URI starts with 'ogg://' then this property specifies if it is a static port (recvsrvr acting as a legacy collector) or a dynamic port (legacy installation, so the port in the URI is the mgr port).",
"type":"boolean",
"default":true
}
},
"additionalProperties":false
},
"options":{
"description":"options for the distribution path",
"type":"object",
"properties":{
"tcpSourceTimer":{
"description":"Adjusts the timestamp of data records when they are sent to other systems",
"type":"boolean",
"default":true
},
"forceStatus":{
"description":"Enforce the status change if applicable",
"type":"boolean",
"default":false
},
"network":{
"description":"Endpoint network details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:network"
]
},
"socketOptions":{
"description":"socket options",
"x-oneOf":[
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOptions"
]
},
"tcpOptions":{
"description":"tcp tuning options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOption"
]
},
"ipDscp":{
"description":"network differentiated services",
"enum":[
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
},
"ipTos":{
"description":"term of services",
"enum":[
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
},
"tcpNoDelay":{
"description":"nodelay in Nagle's option",
"type":"boolean"
},
"tcpQuickAck":{
"description":"send out acknowledgements as early as possible",
"type":"boolean"
},
"tcpCork":{
"description":"Whether use Nagle algorithm cork option or not",
"type":"boolean"
},
"tcpSndBuf":{
"description":"system send buffer size",
"type":"integer",
"minimum":1024,
"maximum":524288
},
"tcpRcvBuf":{
"description":"system receive buffer size",
"type":"integer",
"minimum":1024,
"maximum":524288
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:udpOptions"
]
},
"udpOptions":{
"description":"udp tuning options",
"type":"object",
"properties":{
"udpRcvBuf":{
"description":"UDP socket receiver buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRendezvous":{
"description":"Rendezvous connection setup.",
"type":"boolean",
"default":false
},
"udpSndBuf":{
"description":"UDP socket sender buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtSndTimeO":{
"description":"Sending call timeout (milliseconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtSndSyn":{
"description":"Synchronization mode of data sending.",
"type":"boolean"
},
"udtFC":{
"description":"Maximum window size (packets)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtCC":{
"description":"User defined congestion control algorithm.",
"enum":[
"DEFAULT"
]
},
"udtRcvTimeO":{
"description":"Receiving call timeout (milliseconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtSndBuf":{
"description":"UDT sender buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtReuseAddr":{
"description":"Reuse an existing address or create a new one.",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:udpOption"
]
},
"udtSltTimeO":{
"description":"Select call timeout (Seconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtRcvBuf":{
"description":"UDT receiver buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtMaxBW":{
"description":"Maximum bandwidth that one single UDT connection can use (bytes per second).",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRcvSyn":{
"description":"Synchronization mode for receiving.",
"type":"boolean"
},
"udtLinger":{
"description":"Linger time on close().",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtMss":{
"description":"Maximum packet size (bytes).",
"type":"integer",
"minimum":1,
"maximum":2147483647
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
]
},
"appOptions":{
"description":"application options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:appOptions"
]
},
"appFlushBytes":{
"description":"application flush size",
"type":"integer",
"default":27985,
"minimum":1024,
"maximum":524288
},
"appFlushSecs":{
"description":"application flush interval",
"type":"integer",
"default":1,
"minimum":1,
"maximum":300
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
"$schema":{
"enum":[
"ogg:distPathOptions"
]
},
"streaming":{
"description":"Asynchronous network streaming protocol where sender does not wait for an acknowledgement from the receiver.",
"type":"boolean",
"default":true
},
"critical":{
"description":"Indicates the distribution path is critical to the deployment",
"type":"boolean",
"default":false
},
"autoRestart":{
"description":"Describe if a killed path needs to be restarted automatically",
"type":"object",
"properties":{
"retries":{
"description":"maximum number of retries for restarting a killed path, disable autoRestart by setting retries to 0",
"type":"integer",
"minimum":0,
"maximum":3600,
"default":10
},
"delay":{
"description":"The amount of time, in minutes, to pause between restarting the path.",
"type":"integer",
"minimum":0,
"default":2,
"maximum":60
}
},
"required":[
"retries"
],
"additionalProperties":false
},
"eofDelayCSecs":{
"description":"EOF delay in centi-seconds before searching for source data",
"type":"integer",
"minimum":1,
"default":100,
"maximum":6000
},
"checkpointFrequency":{
"description":"Frequency in seconds for path taking routine checkpoints.",
"type":"integer",
"minimum":1,
"default":10,
"maximum":4.294967295E9
}
},
"additionalProperties":false
},
"description":{
"description":"Description for the path",
"type":"string",
"minLength":1,
"maxLength":4095
}
},
"additionalProperties":false
}
Nested Schema : begin
Starting point for data processing
Default Value: now
Match One
Show Source
-
Allowed Values: [
"now"
]
-
string
Minimum Length: 20
Maximum Length: 32
Pattern: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$
-
object begin-x-oneOf[2]
{
"description":"Starting point for data processing",
"default":"now",
"x-oneOf":[
{
"enum":[
"now"
]
},
{
"type":"string",
"pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
"minLength":20,
"maxLength":32
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"type:position/atTrailRBA"
]
},
"sequence":{
"description":"Trail file sequence number",
"type":"integer",
"minimum":0,
"maximum":999999999,
"default":0
},
"offset":{
"description":"Offset in trail sequence file",
"type":"integer",
"minimum":0,
"default":0,
"maximum":2147483647
}
},
"required":[
"sequence"
],
"additionalProperties":false
}
]
}
Nested Schema : options
Type: object
options for the distribution path
Show Source
{
"description":"options for the distribution path",
"type":"object",
"properties":{
"tcpSourceTimer":{
"description":"Adjusts the timestamp of data records when they are sent to other systems",
"type":"boolean",
"default":true
},
"forceStatus":{
"description":"Enforce the status change if applicable",
"type":"boolean",
"default":false
},
"network":{
"description":"Endpoint network details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:network"
]
},
"socketOptions":{
"description":"socket options",
"x-oneOf":[
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOptions"
]
},
"tcpOptions":{
"description":"tcp tuning options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOption"
]
},
"ipDscp":{
"description":"network differentiated services",
"enum":[
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
},
"ipTos":{
"description":"term of services",
"enum":[
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
},
"tcpNoDelay":{
"description":"nodelay in Nagle's option",
"type":"boolean"
},
"tcpQuickAck":{
"description":"send out acknowledgements as early as possible",
"type":"boolean"
},
"tcpCork":{
"description":"Whether use Nagle algorithm cork option or not",
"type":"boolean"
},
"tcpSndBuf":{
"description":"system send buffer size",
"type":"integer",
"minimum":1024,
"maximum":524288
},
"tcpRcvBuf":{
"description":"system receive buffer size",
"type":"integer",
"minimum":1024,
"maximum":524288
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:udpOptions"
]
},
"udpOptions":{
"description":"udp tuning options",
"type":"object",
"properties":{
"udpRcvBuf":{
"description":"UDP socket receiver buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRendezvous":{
"description":"Rendezvous connection setup.",
"type":"boolean",
"default":false
},
"udpSndBuf":{
"description":"UDP socket sender buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtSndTimeO":{
"description":"Sending call timeout (milliseconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtSndSyn":{
"description":"Synchronization mode of data sending.",
"type":"boolean"
},
"udtFC":{
"description":"Maximum window size (packets)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtCC":{
"description":"User defined congestion control algorithm.",
"enum":[
"DEFAULT"
]
},
"udtRcvTimeO":{
"description":"Receiving call timeout (milliseconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtSndBuf":{
"description":"UDT sender buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtReuseAddr":{
"description":"Reuse an existing address or create a new one.",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:udpOption"
]
},
"udtSltTimeO":{
"description":"Select call timeout (Seconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtRcvBuf":{
"description":"UDT receiver buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtMaxBW":{
"description":"Maximum bandwidth that one single UDT connection can use (bytes per second).",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRcvSyn":{
"description":"Synchronization mode for receiving.",
"type":"boolean"
},
"udtLinger":{
"description":"Linger time on close().",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtMss":{
"description":"Maximum packet size (bytes).",
"type":"integer",
"minimum":1,
"maximum":2147483647
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
]
},
"appOptions":{
"description":"application options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:appOptions"
]
},
"appFlushBytes":{
"description":"application flush size",
"type":"integer",
"default":27985,
"minimum":1024,
"maximum":524288
},
"appFlushSecs":{
"description":"application flush interval",
"type":"integer",
"default":1,
"minimum":1,
"maximum":300
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
"$schema":{
"enum":[
"ogg:distPathOptions"
]
},
"streaming":{
"description":"Asynchronous network streaming protocol where sender does not wait for an acknowledgement from the receiver.",
"type":"boolean",
"default":true
},
"critical":{
"description":"Indicates the distribution path is critical to the deployment",
"type":"boolean",
"default":false
},
"autoRestart":{
"description":"Describe if a killed path needs to be restarted automatically",
"type":"object",
"properties":{
"retries":{
"description":"maximum number of retries for restarting a killed path, disable autoRestart by setting retries to 0",
"type":"integer",
"minimum":0,
"maximum":3600,
"default":10
},
"delay":{
"description":"The amount of time, in minutes, to pause between restarting the path.",
"type":"integer",
"minimum":0,
"default":2,
"maximum":60
}
},
"required":[
"retries"
],
"additionalProperties":false
},
"eofDelayCSecs":{
"description":"EOF delay in centi-seconds before searching for source data",
"type":"integer",
"minimum":1,
"default":100,
"maximum":6000
},
"checkpointFrequency":{
"description":"Frequency in seconds for path taking routine checkpoints.",
"type":"integer",
"minimum":1,
"default":10,
"maximum":4.294967295E9
}
},
"additionalProperties":false
}
Nested Schema : ruleset
Type: object
Ruleset for the distribution path
Show Source
-
$schema:
Allowed Values: [
"ogg:distPathRuleset"
]
-
description:
string
Minimum Length: 1
Maximum Length: 4095
Description for the path ruleset
-
name:
string
Minimum Length: 1
Maximum Length: 30
name of the path ruleset
-
rules:
array rules
Minimum Number of Items: 1
Maximum Number of Items: 1024
{
"description":"Ruleset for the distribution path",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRuleset"
]
},
"name":{
"description":"name of the path ruleset",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path ruleset",
"type":"string",
"minLength":1,
"maxLength":4095
},
"rules":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRule"
]
},
"name":{
"description":"name of the rule",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path rule",
"type":"string",
"minLength":1,
"maxLength":4095
},
"filters":{
"type":"array",
"items":{
"x-oneOf":[
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"objectNames":{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure"
]
},
"minItems":1,
"maxItems":3
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"columnValues":{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
"columnValue":{
"description":"column data, currently only support char and binary integer",
"x-oneOf":[
{
"type":"string",
"minLength":0,
"maxLength":32767
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":4096
},
"filterRelation":{
"description":"relationship among the filters",
"enum":[
"and",
"or"
],
"default":"or"
},
"actions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathAction"
]
},
"description":{
"description":"Description for the path action",
"type":"string",
"minLength":1,
"maxLength":4095
},
"command":{
"enum":[
"include",
"exclude"
],
"default":"include"
}
},
"required":[
"command"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":128
}
},
"required":[
"name",
"filters",
"actions"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1024
}
},
"additionalProperties":false
}
Nested Schema : source
Type: object
source endpoint of the path
Show Source
-
$schema:
Allowed Values: [
"ogg:distPathEndpoint"
]
-
description:
string
Minimum Length: 1
Maximum Length: 4095
Description for the endpoint
-
details:
object details
trail, encryption and compression information
-
isDynamicOggPort:
boolean
Default Value: true
If the trail URI starts with 'ogg://' then this property specifies if it is a static port (recvsrvr acting as a legacy collector) or a dynamic port (legacy installation, so the port in the URI is the mgr port).
-
proxy:
object proxy
proxy to connect to target
-
uri:
string
Minimum Length: 2
Maximum Length: 4095
Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
endpoint URI specification
{
"description":"source endpoint of the path",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpoint"
]
},
"description":{
"description":"Description for the endpoint",
"type":"string",
"minLength":1,
"maxLength":4095
},
"uri":{
"description":"endpoint URI specification",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"proxy":{
"description":"proxy to connect to target",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointProxy"
]
},
"uri":{
"description":"Uri of the proxy server",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"type":{
"description":"Type of the proxy server",
"type":"string",
"enum":[
"SOCKS5",
"HTTP"
]
},
"csAlias":{
"description":"Credential store alias",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
},
"csDomain":{
"description":"Credential store domain",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
}
},
"required":[
"uri",
"type"
],
"additionalProperties":false
},
"details":{
"description":"trail, encryption and compression information",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointTrail"
]
},
"trail":{
"description":"endpoint trail details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathTrailinfo"
]
},
"name":{
"description":"The name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]?$",
"minLength":1,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"default":"dirdat",
"type":"string",
"minLength":1,
"maxLength":255
},
"format":{
"description":"The format of output data. Default is canonical trail output",
"default":"canonical",
"x-oneOf":[
{
"enum":[
"canonical"
]
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:outputFormat"
]
},
"type":{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
},
"includeHeartBeat":{
"description":"Includes the heartbeat table records",
"type":"boolean",
"default":false
}
},
"required":[
"type"
],
"additionalProperties":false
}
]
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":500,
"minimum":1,
"maximum":4.294967295E9
},
"seqLength":{
"description":"Trail sequence number length",
"enum":[
6,
9
],
"default":9
}
},
"additionalProperties":false
},
"encryption":{
"description":"endpoint trail encryption",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEncryption"
]
},
"algorithm":{
"enum":[
"NONE",
"AES128",
"AES192",
"AES256"
],
"default":"NONE"
}
},
"required":[
"algorithm"
],
"additionalProperties":false
},
"compression":{
"description":"endpoint network compression",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathCompression"
]
},
"enabled":{
"type":"boolean",
"default":false
},
"threshold":{
"description":"compression threshold, the minimum block size(bytes) for which compression is to occur",
"type":"integer",
"default":1000,
"minimum":0,
"maximum":28000
}
},
"required":[
"enabled"
],
"additionalProperties":false
}
},
"additionalProperties":false
},
"isDynamicOggPort":{
"description":"If the trail URI starts with 'ogg://' then this property specifies if it is a static port (recvsrvr acting as a legacy collector) or a dynamic port (legacy installation, so the port in the URI is the mgr port).",
"type":"boolean",
"default":true
}
},
"additionalProperties":false
}
Nested Schema : target
Type: object
target endpoint of the path
Show Source
-
$schema:
Allowed Values: [
"ogg:distPathEndpoint"
]
-
description:
string
Minimum Length: 1
Maximum Length: 4095
Description for the endpoint
-
details:
object details
trail, encryption and compression information
-
isDynamicOggPort:
boolean
Default Value: true
If the trail URI starts with 'ogg://' then this property specifies if it is a static port (recvsrvr acting as a legacy collector) or a dynamic port (legacy installation, so the port in the URI is the mgr port).
-
proxy:
object proxy
proxy to connect to target
-
uri:
string
Minimum Length: 2
Maximum Length: 4095
Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
endpoint URI specification
{
"description":"target endpoint of the path",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpoint"
]
},
"description":{
"description":"Description for the endpoint",
"type":"string",
"minLength":1,
"maxLength":4095
},
"uri":{
"description":"endpoint URI specification",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"proxy":{
"description":"proxy to connect to target",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointProxy"
]
},
"uri":{
"description":"Uri of the proxy server",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"type":{
"description":"Type of the proxy server",
"type":"string",
"enum":[
"SOCKS5",
"HTTP"
]
},
"csAlias":{
"description":"Credential store alias",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
},
"csDomain":{
"description":"Credential store domain",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
}
},
"required":[
"uri",
"type"
],
"additionalProperties":false
},
"details":{
"description":"trail, encryption and compression information",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointTrail"
]
},
"trail":{
"description":"endpoint trail details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathTrailinfo"
]
},
"name":{
"description":"The name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]?$",
"minLength":1,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"default":"dirdat",
"type":"string",
"minLength":1,
"maxLength":255
},
"format":{
"description":"The format of output data. Default is canonical trail output",
"default":"canonical",
"x-oneOf":[
{
"enum":[
"canonical"
]
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:outputFormat"
]
},
"type":{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
},
"includeHeartBeat":{
"description":"Includes the heartbeat table records",
"type":"boolean",
"default":false
}
},
"required":[
"type"
],
"additionalProperties":false
}
]
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":500,
"minimum":1,
"maximum":4.294967295E9
},
"seqLength":{
"description":"Trail sequence number length",
"enum":[
6,
9
],
"default":9
}
},
"additionalProperties":false
},
"encryption":{
"description":"endpoint trail encryption",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEncryption"
]
},
"algorithm":{
"enum":[
"NONE",
"AES128",
"AES192",
"AES256"
],
"default":"NONE"
}
},
"required":[
"algorithm"
],
"additionalProperties":false
},
"compression":{
"description":"endpoint network compression",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathCompression"
]
},
"enabled":{
"type":"boolean",
"default":false
},
"threshold":{
"description":"compression threshold, the minimum block size(bytes) for which compression is to occur",
"type":"integer",
"default":1000,
"minimum":0,
"maximum":28000
}
},
"required":[
"enabled"
],
"additionalProperties":false
}
},
"additionalProperties":false
},
"isDynamicOggPort":{
"description":"If the trail URI starts with 'ogg://' then this property specifies if it is a static port (recvsrvr acting as a legacy collector) or a dynamic port (legacy installation, so the port in the URI is the mgr port).",
"type":"boolean",
"default":true
}
},
"additionalProperties":false
}
Nested Schema : begin-x-oneOf[2]
Type: object
Show Source
-
$schema:
Allowed Values: [
"type:position/atTrailRBA"
]
-
offset:
integer
Minimum Value: 0
Maximum Value: 2147483647
Default Value: 0
Offset in trail sequence file
-
sequence:
integer
Minimum Value: 0
Maximum Value: 999999999
Default Value: 0
Trail file sequence number
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"type:position/atTrailRBA"
]
},
"sequence":{
"description":"Trail file sequence number",
"type":"integer",
"minimum":0,
"maximum":999999999,
"default":0
},
"offset":{
"description":"Offset in trail sequence file",
"type":"integer",
"minimum":0,
"default":0,
"maximum":2147483647
}
},
"required":[
"sequence"
],
"additionalProperties":false
}
Nested Schema : autoRestart
Type: object
Describe if a killed path needs to be restarted automatically
Show Source
-
delay:
integer
Minimum Value: 0
Maximum Value: 60
Default Value: 2
The amount of time, in minutes, to pause between restarting the path.
-
retries:
integer
Minimum Value: 0
Maximum Value: 3600
Default Value: 10
maximum number of retries for restarting a killed path, disable autoRestart by setting retries to 0
{
"description":"Describe if a killed path needs to be restarted automatically",
"type":"object",
"properties":{
"retries":{
"description":"maximum number of retries for restarting a killed path, disable autoRestart by setting retries to 0",
"type":"integer",
"minimum":0,
"maximum":3600,
"default":10
},
"delay":{
"description":"The amount of time, in minutes, to pause between restarting the path.",
"type":"integer",
"minimum":0,
"default":2,
"maximum":60
}
},
"required":[
"retries"
],
"additionalProperties":false
}
Nested Schema : network
Type: object
Endpoint network details
Show Source
{
"description":"Endpoint network details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:network"
]
},
"socketOptions":{
"description":"socket options",
"x-oneOf":[
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOptions"
]
},
"tcpOptions":{
"description":"tcp tuning options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOption"
]
},
"ipDscp":{
"description":"network differentiated services",
"enum":[
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
},
"ipTos":{
"description":"term of services",
"enum":[
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
},
"tcpNoDelay":{
"description":"nodelay in Nagle's option",
"type":"boolean"
},
"tcpQuickAck":{
"description":"send out acknowledgements as early as possible",
"type":"boolean"
},
"tcpCork":{
"description":"Whether use Nagle algorithm cork option or not",
"type":"boolean"
},
"tcpSndBuf":{
"description":"system send buffer size",
"type":"integer",
"minimum":1024,
"maximum":524288
},
"tcpRcvBuf":{
"description":"system receive buffer size",
"type":"integer",
"minimum":1024,
"maximum":524288
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:udpOptions"
]
},
"udpOptions":{
"description":"udp tuning options",
"type":"object",
"properties":{
"udpRcvBuf":{
"description":"UDP socket receiver buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRendezvous":{
"description":"Rendezvous connection setup.",
"type":"boolean",
"default":false
},
"udpSndBuf":{
"description":"UDP socket sender buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtSndTimeO":{
"description":"Sending call timeout (milliseconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtSndSyn":{
"description":"Synchronization mode of data sending.",
"type":"boolean"
},
"udtFC":{
"description":"Maximum window size (packets)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtCC":{
"description":"User defined congestion control algorithm.",
"enum":[
"DEFAULT"
]
},
"udtRcvTimeO":{
"description":"Receiving call timeout (milliseconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtSndBuf":{
"description":"UDT sender buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtReuseAddr":{
"description":"Reuse an existing address or create a new one.",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:udpOption"
]
},
"udtSltTimeO":{
"description":"Select call timeout (Seconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtRcvBuf":{
"description":"UDT receiver buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtMaxBW":{
"description":"Maximum bandwidth that one single UDT connection can use (bytes per second).",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRcvSyn":{
"description":"Synchronization mode for receiving.",
"type":"boolean"
},
"udtLinger":{
"description":"Linger time on close().",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtMss":{
"description":"Maximum packet size (bytes).",
"type":"integer",
"minimum":1,
"maximum":2147483647
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
]
},
"appOptions":{
"description":"application options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:appOptions"
]
},
"appFlushBytes":{
"description":"application flush size",
"type":"integer",
"default":27985,
"minimum":1024,
"maximum":524288
},
"appFlushSecs":{
"description":"application flush interval",
"type":"integer",
"default":1,
"minimum":1,
"maximum":300
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
Nested Schema : appOptions
Type: object
application options
Show Source
-
$schema:
Allowed Values: [
"ogg:appOptions"
]
-
appFlushBytes:
integer
Minimum Value: 1024
Maximum Value: 524288
Default Value: 27985
application flush size
-
appFlushSecs:
integer
Minimum Value: 1
Maximum Value: 300
Default Value: 1
application flush interval
{
"description":"application options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:appOptions"
]
},
"appFlushBytes":{
"description":"application flush size",
"type":"integer",
"default":27985,
"minimum":1024,
"maximum":524288
},
"appFlushSecs":{
"description":"application flush interval",
"type":"integer",
"default":1,
"minimum":1,
"maximum":300
}
},
"additionalProperties":false
}
Nested Schema : socketOptions
socket options
Match One
Show Source
{
"description":"socket options",
"x-oneOf":[
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOptions"
]
},
"tcpOptions":{
"description":"tcp tuning options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOption"
]
},
"ipDscp":{
"description":"network differentiated services",
"enum":[
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
},
"ipTos":{
"description":"term of services",
"enum":[
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
},
"tcpNoDelay":{
"description":"nodelay in Nagle's option",
"type":"boolean"
},
"tcpQuickAck":{
"description":"send out acknowledgements as early as possible",
"type":"boolean"
},
"tcpCork":{
"description":"Whether use Nagle algorithm cork option or not",
"type":"boolean"
},
"tcpSndBuf":{
"description":"system send buffer size",
"type":"integer",
"minimum":1024,
"maximum":524288
},
"tcpRcvBuf":{
"description":"system receive buffer size",
"type":"integer",
"minimum":1024,
"maximum":524288
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:udpOptions"
]
},
"udpOptions":{
"description":"udp tuning options",
"type":"object",
"properties":{
"udpRcvBuf":{
"description":"UDP socket receiver buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRendezvous":{
"description":"Rendezvous connection setup.",
"type":"boolean",
"default":false
},
"udpSndBuf":{
"description":"UDP socket sender buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtSndTimeO":{
"description":"Sending call timeout (milliseconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtSndSyn":{
"description":"Synchronization mode of data sending.",
"type":"boolean"
},
"udtFC":{
"description":"Maximum window size (packets)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtCC":{
"description":"User defined congestion control algorithm.",
"enum":[
"DEFAULT"
]
},
"udtRcvTimeO":{
"description":"Receiving call timeout (milliseconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtSndBuf":{
"description":"UDT sender buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtReuseAddr":{
"description":"Reuse an existing address or create a new one.",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:udpOption"
]
},
"udtSltTimeO":{
"description":"Select call timeout (Seconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtRcvBuf":{
"description":"UDT receiver buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtMaxBW":{
"description":"Maximum bandwidth that one single UDT connection can use (bytes per second).",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRcvSyn":{
"description":"Synchronization mode for receiving.",
"type":"boolean"
},
"udtLinger":{
"description":"Linger time on close().",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtMss":{
"description":"Maximum packet size (bytes).",
"type":"integer",
"minimum":1,
"maximum":2147483647
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
]
}
Nested Schema : socketOptions-x-oneOf[0]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOptions"
]
},
"tcpOptions":{
"description":"tcp tuning options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOption"
]
},
"ipDscp":{
"description":"network differentiated services",
"enum":[
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
},
"ipTos":{
"description":"term of services",
"enum":[
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
},
"tcpNoDelay":{
"description":"nodelay in Nagle's option",
"type":"boolean"
},
"tcpQuickAck":{
"description":"send out acknowledgements as early as possible",
"type":"boolean"
},
"tcpCork":{
"description":"Whether use Nagle algorithm cork option or not",
"type":"boolean"
},
"tcpSndBuf":{
"description":"system send buffer size",
"type":"integer",
"minimum":1024,
"maximum":524288
},
"tcpRcvBuf":{
"description":"system receive buffer size",
"type":"integer",
"minimum":1024,
"maximum":524288
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
Nested Schema : socketOptions-x-oneOf[1]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:udpOptions"
]
},
"udpOptions":{
"description":"udp tuning options",
"type":"object",
"properties":{
"udpRcvBuf":{
"description":"UDP socket receiver buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRendezvous":{
"description":"Rendezvous connection setup.",
"type":"boolean",
"default":false
},
"udpSndBuf":{
"description":"UDP socket sender buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtSndTimeO":{
"description":"Sending call timeout (milliseconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtSndSyn":{
"description":"Synchronization mode of data sending.",
"type":"boolean"
},
"udtFC":{
"description":"Maximum window size (packets)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtCC":{
"description":"User defined congestion control algorithm.",
"enum":[
"DEFAULT"
]
},
"udtRcvTimeO":{
"description":"Receiving call timeout (milliseconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtSndBuf":{
"description":"UDT sender buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtReuseAddr":{
"description":"Reuse an existing address or create a new one.",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:udpOption"
]
},
"udtSltTimeO":{
"description":"Select call timeout (Seconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtRcvBuf":{
"description":"UDT receiver buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtMaxBW":{
"description":"Maximum bandwidth that one single UDT connection can use (bytes per second).",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRcvSyn":{
"description":"Synchronization mode for receiving.",
"type":"boolean"
},
"udtLinger":{
"description":"Linger time on close().",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtMss":{
"description":"Maximum packet size (bytes).",
"type":"integer",
"minimum":1,
"maximum":2147483647
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
Nested Schema : tcpOptions
Type: object
tcp tuning options
Show Source
-
$schema:
Allowed Values: [
"ogg:tcpOption"
]
-
ipDscp:
Allowed Values: [
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
network differentiated services
-
ipTos:
Allowed Values: [
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
term of services
-
tcpCork:
boolean
Whether use Nagle algorithm cork option or not
-
tcpNoDelay:
boolean
nodelay in Nagle's option
-
tcpQuickAck:
boolean
send out acknowledgements as early as possible
-
tcpRcvBuf:
integer
Minimum Value: 1024
Maximum Value: 524288
system receive buffer size
-
tcpSndBuf:
integer
Minimum Value: 1024
Maximum Value: 524288
system send buffer size
{
"description":"tcp tuning options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOption"
]
},
"ipDscp":{
"description":"network differentiated services",
"enum":[
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
},
"ipTos":{
"description":"term of services",
"enum":[
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
},
"tcpNoDelay":{
"description":"nodelay in Nagle's option",
"type":"boolean"
},
"tcpQuickAck":{
"description":"send out acknowledgements as early as possible",
"type":"boolean"
},
"tcpCork":{
"description":"Whether use Nagle algorithm cork option or not",
"type":"boolean"
},
"tcpSndBuf":{
"description":"system send buffer size",
"type":"integer",
"minimum":1024,
"maximum":524288
},
"tcpRcvBuf":{
"description":"system receive buffer size",
"type":"integer",
"minimum":1024,
"maximum":524288
}
},
"additionalProperties":false
}
Nested Schema : udpOptions
Type: object
udp tuning options
Show Source
-
$schema:
Allowed Values: [
"ogg:udpOption"
]
-
udpRcvBuf:
integer
Minimum Value: 1
Maximum Value: 2147483647
UDP socket receiver buffer size (bytes)
-
udpSndBuf:
integer
Minimum Value: 1
Maximum Value: 2147483647
UDP socket sender buffer size (bytes)
-
udtCC:
Allowed Values: [
"DEFAULT"
]
User defined congestion control algorithm.
-
udtFC:
integer
Minimum Value: 1
Maximum Value: 2147483647
Maximum window size (packets)
-
udtLinger:
integer
Minimum Value: 0
Maximum Value: 1000000000
Linger time on close().
-
udtMaxBW:
integer
Minimum Value: 1
Maximum Value: 2147483647
Maximum bandwidth that one single UDT connection can use (bytes per second).
-
udtMss:
integer
Minimum Value: 1
Maximum Value: 2147483647
Maximum packet size (bytes).
-
udtRcvBuf:
integer
Minimum Value: 1
Maximum Value: 2147483647
UDT receiver buffer size limit (bytes)
-
udtRcvSyn:
boolean
Synchronization mode for receiving.
-
udtRcvTimeO:
integer
Minimum Value: 0
Maximum Value: 1000000000
Receiving call timeout (milliseconds).
-
udtRendezvous:
boolean
Default Value: false
Rendezvous connection setup.
-
udtReuseAddr:
boolean
Default Value: true
Reuse an existing address or create a new one.
-
udtSltTimeO:
integer
Minimum Value: 0
Maximum Value: 1000000000
Select call timeout (Seconds).
-
udtSndBuf:
integer
Minimum Value: 1
Maximum Value: 2147483647
UDT sender buffer size limit (bytes)
-
udtSndSyn:
boolean
Synchronization mode of data sending.
-
udtSndTimeO:
integer
Minimum Value: 0
Maximum Value: 1000000000
Sending call timeout (milliseconds).
{
"description":"udp tuning options",
"type":"object",
"properties":{
"udpRcvBuf":{
"description":"UDP socket receiver buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRendezvous":{
"description":"Rendezvous connection setup.",
"type":"boolean",
"default":false
},
"udpSndBuf":{
"description":"UDP socket sender buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtSndTimeO":{
"description":"Sending call timeout (milliseconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtSndSyn":{
"description":"Synchronization mode of data sending.",
"type":"boolean"
},
"udtFC":{
"description":"Maximum window size (packets)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtCC":{
"description":"User defined congestion control algorithm.",
"enum":[
"DEFAULT"
]
},
"udtRcvTimeO":{
"description":"Receiving call timeout (milliseconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtSndBuf":{
"description":"UDT sender buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtReuseAddr":{
"description":"Reuse an existing address or create a new one.",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:udpOption"
]
},
"udtSltTimeO":{
"description":"Select call timeout (Seconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtRcvBuf":{
"description":"UDT receiver buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtMaxBW":{
"description":"Maximum bandwidth that one single UDT connection can use (bytes per second).",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRcvSyn":{
"description":"Synchronization mode for receiving.",
"type":"boolean"
},
"udtLinger":{
"description":"Linger time on close().",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtMss":{
"description":"Maximum packet size (bytes).",
"type":"integer",
"minimum":1,
"maximum":2147483647
}
},
"additionalProperties":false
}
Nested Schema : rules
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1024
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRule"
]
},
"name":{
"description":"name of the rule",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path rule",
"type":"string",
"minLength":1,
"maxLength":4095
},
"filters":{
"type":"array",
"items":{
"x-oneOf":[
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"objectNames":{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure"
]
},
"minItems":1,
"maxItems":3
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"columnValues":{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
"columnValue":{
"description":"column data, currently only support char and binary integer",
"x-oneOf":[
{
"type":"string",
"minLength":0,
"maxLength":32767
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":4096
},
"filterRelation":{
"description":"relationship among the filters",
"enum":[
"and",
"or"
],
"default":"or"
},
"actions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathAction"
]
},
"description":{
"description":"Description for the path action",
"type":"string",
"minLength":1,
"maxLength":4095
},
"command":{
"enum":[
"include",
"exclude"
],
"default":"include"
}
},
"required":[
"command"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":128
}
},
"required":[
"name",
"filters",
"actions"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1024
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRule"
]
},
"name":{
"description":"name of the rule",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path rule",
"type":"string",
"minLength":1,
"maxLength":4095
},
"filters":{
"type":"array",
"items":{
"x-oneOf":[
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"objectNames":{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure"
]
},
"minItems":1,
"maxItems":3
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"columnValues":{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
"columnValue":{
"description":"column data, currently only support char and binary integer",
"x-oneOf":[
{
"type":"string",
"minLength":0,
"maxLength":32767
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":4096
},
"filterRelation":{
"description":"relationship among the filters",
"enum":[
"and",
"or"
],
"default":"or"
},
"actions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathAction"
]
},
"description":{
"description":"Description for the path action",
"type":"string",
"minLength":1,
"maxLength":4095
},
"command":{
"enum":[
"include",
"exclude"
],
"default":"include"
}
},
"required":[
"command"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":128
}
},
"required":[
"name",
"filters",
"actions"
],
"additionalProperties":false
}
Nested Schema : actions
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 128
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathAction"
]
},
"description":{
"description":"Description for the path action",
"type":"string",
"minLength":1,
"maxLength":4095
},
"command":{
"enum":[
"include",
"exclude"
],
"default":"include"
}
},
"required":[
"command"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":128
}
Nested Schema : filters
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 4096
Show Source
{
"type":"array",
"items":{
"x-oneOf":[
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"objectNames":{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure"
]
},
"minItems":1,
"maxItems":3
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"columnValues":{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
"columnValue":{
"description":"column data, currently only support char and binary integer",
"x-oneOf":[
{
"type":"string",
"minLength":0,
"maxLength":32767
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":4096
}
Nested Schema : items
Type: object
Show Source
-
$schema:
Allowed Values: [
"ogg:distPathAction"
]
-
command:
Default Value: include
Allowed Values: [
"include",
"exclude"
]
-
description:
string
Minimum Length: 1
Maximum Length: 4095
Description for the path action
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathAction"
]
},
"description":{
"description":"Description for the path action",
"type":"string",
"minLength":1,
"maxLength":4095
},
"command":{
"enum":[
"include",
"exclude"
],
"default":"include"
}
},
"required":[
"command"
],
"additionalProperties":false
}
Nested Schema : items
Match One
Show Source
{
"x-oneOf":[
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"objectNames":{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure"
]
},
"minItems":1,
"maxItems":3
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"columnValues":{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
"columnValue":{
"description":"column data, currently only support char and binary integer",
"x-oneOf":[
{
"type":"string",
"minLength":0,
"maxLength":32767
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
}
]
}
Nested Schema : items-x-oneOf[0]
Type: object
Show Source
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[1]
Type: object
Show Source
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[2]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"objectNames":{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[3]
Type: object
Show Source
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure"
]
},
"minItems":1,
"maxItems":3
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[4]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"columnValues":{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
"columnValue":{
"description":"column data, currently only support char and binary integer",
"x-oneOf":[
{
"type":"string",
"minLength":0,
"maxLength":32767
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":65535
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[5]
Type: object
Show Source
-
negate:
boolean
Default Value: false
negation of the above set
-
tags:
tags
set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[6]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
}
Nested Schema : chunkIds
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 2147483647
set of chunk ids
Show Source
{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
}
Nested Schema : chunkIdRanges
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2147483647
set of chunk id ranges
Show Source
{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
}
Nested Schema : objectNames
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 65535
set of object names
Show Source
-
[0]:
items
Qualified table name where any name component may contain wildcard characters
{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"minItems":1,
"maxItems":65535
}
Nested Schema : items
Qualified table name where any name component may contain wildcard characters
Match Any
Show Source
-
string
Minimum Length: 3
Maximum Length: 261
Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
-
string
Minimum Length: 5
Maximum Length: 392
Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
}
Nested Schema : objectTypes
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 3
set of object types
Show Source
-
[0]:
Allowed Values: [
"DML",
"DDL",
"Procedure"
]
{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure"
]
},
"minItems":1,
"maxItems":3
}
Nested Schema : columnValues
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 65535
set of column values
Show Source
{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
"columnValue":{
"description":"column data, currently only support char and binary integer",
"x-oneOf":[
{
"type":"string",
"minLength":0,
"maxLength":32767
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":65535
}
Nested Schema : items
Type: object
Show Source
-
columnName:
string
Minimum Length: 1
Maximum Length: 130
Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
name of the column
-
columnValue:
columnValue
column data, currently only support char and binary integer
-
imageType:
Default Value: before
Allowed Values: [
"before",
"after"
]
before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.
-
operator:
Default Value: equalTo
Allowed Values: [
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
]
comparison operator
-
tableName:
tableName
name of the table in which the column(s) reside
{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
"columnValue":{
"description":"column data, currently only support char and binary integer",
"x-oneOf":[
{
"type":"string",
"minLength":0,
"maxLength":32767
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
}
Nested Schema : columnValue
column data, currently only support char and binary integer
Match One
Show Source
{
"description":"column data, currently only support char and binary integer",
"x-oneOf":[
{
"type":"string",
"minLength":0,
"maxLength":32767
},
{
"type":"number"
},
{
"type":"null"
}
]
}
Nested Schema : tableName
name of the table in which the column(s) reside
Match Any
Show Source
-
string
Minimum Length: 3
Maximum Length: 261
Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
-
string
Minimum Length: 5
Maximum Length: 392
Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
}
Nested Schema : tags
set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag
Match One
Show Source
-
array tags-x-oneOf[0]
Minimum Number of Items: 1
Maximum Number of Items: 2147483647
-
Allowed Values: [
"all",
"none"
]
{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
}
Nested Schema : tags-x-oneOf[0]
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2147483647
Show Source
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":2147483647
}
Nested Schema : items
Match One
Show Source
{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
}
Nested Schema : items-x-oneOf[0]
Type: object
Binary string representing the tag value.
Show Source
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binValue"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[1]
Type: object
Hexdecimal string representing the tag value.
Show Source
-
hexValue:
string
Minimum Length: 1
Maximum Length: 2000
Pattern: [A-Fa-f0-9]{1,2000}
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexValue"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[2]
Type: object
binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.
Show Source
-
binMask:
string
Minimum Length: 1
Maximum Length: 2000
Pattern: [01]{1,2000}
binary string representing the tag mask value.
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"[01]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"binMask"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[3]
Type: object
Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.
Show Source
-
hexMask:
string
Minimum Length: 1
Maximum Length: 2000
Pattern: [A-Fa-f0-9]{1,2000}
Hexdecimal string representing the tag mask value.
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"[A-Fa-f0-9]{1,2000}",
"minLength":1,
"maxLength":2000
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
Nested Schema : procedureFeatureNames
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 32
set of procedure feature names
Show Source
-
[0]:
string
Minimum Length: 1
Maximum Length: 128
Pattern: ^[*a-zA-Z][*a-zA-Z0-9_#$]*$
{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
}
Nested Schema : details
Type: object
trail, encryption and compression information
Show Source
{
"description":"trail, encryption and compression information",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointTrail"
]
},
"trail":{
"description":"endpoint trail details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathTrailinfo"
]
},
"name":{
"description":"The name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]?$",
"minLength":1,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"default":"dirdat",
"type":"string",
"minLength":1,
"maxLength":255
},
"format":{
"description":"The format of output data. Default is canonical trail output",
"default":"canonical",
"x-oneOf":[
{
"enum":[
"canonical"
]
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:outputFormat"
]
},
"type":{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
},
"includeHeartBeat":{
"description":"Includes the heartbeat table records",
"type":"boolean",
"default":false
}
},
"required":[
"type"
],
"additionalProperties":false
}
]
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":500,
"minimum":1,
"maximum":4.294967295E9
},
"seqLength":{
"description":"Trail sequence number length",
"enum":[
6,
9
],
"default":9
}
},
"additionalProperties":false
},
"encryption":{
"description":"endpoint trail encryption",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEncryption"
]
},
"algorithm":{
"enum":[
"NONE",
"AES128",
"AES192",
"AES256"
],
"default":"NONE"
}
},
"required":[
"algorithm"
],
"additionalProperties":false
},
"compression":{
"description":"endpoint network compression",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathCompression"
]
},
"enabled":{
"type":"boolean",
"default":false
},
"threshold":{
"description":"compression threshold, the minimum block size(bytes) for which compression is to occur",
"type":"integer",
"default":1000,
"minimum":0,
"maximum":28000
}
},
"required":[
"enabled"
],
"additionalProperties":false
}
},
"additionalProperties":false
}
Nested Schema : proxy
Type: object
proxy to connect to target
Show Source
-
$schema:
Allowed Values: [
"ogg:distPathEndpointProxy"
]
-
csAlias:
string
Minimum Length: 1
Maximum Length: 30
Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Credential store alias
-
csDomain:
string
Minimum Length: 1
Maximum Length: 30
Default Value: OracleGoldenGate
Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Credential store domain
-
type:
string
Allowed Values: [
"SOCKS5",
"HTTP"
]
Type of the proxy server
-
uri:
string
Minimum Length: 2
Maximum Length: 4095
Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
Uri of the proxy server
{
"description":"proxy to connect to target",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointProxy"
]
},
"uri":{
"description":"Uri of the proxy server",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"type":{
"description":"Type of the proxy server",
"type":"string",
"enum":[
"SOCKS5",
"HTTP"
]
},
"csAlias":{
"description":"Credential store alias",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
},
"csDomain":{
"description":"Credential store domain",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
}
},
"required":[
"uri",
"type"
],
"additionalProperties":false
}
Nested Schema : compression
Type: object
endpoint network compression
Show Source
-
$schema:
Allowed Values: [
"ogg:distPathCompression"
]
-
enabled:
boolean
-
threshold:
integer
Minimum Value: 0
Maximum Value: 28000
Default Value: 1000
compression threshold, the minimum block size(bytes) for which compression is to occur
{
"description":"endpoint network compression",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathCompression"
]
},
"enabled":{
"type":"boolean",
"default":false
},
"threshold":{
"description":"compression threshold, the minimum block size(bytes) for which compression is to occur",
"type":"integer",
"default":1000,
"minimum":0,
"maximum":28000
}
},
"required":[
"enabled"
],
"additionalProperties":false
}
Nested Schema : encryption
Type: object
endpoint trail encryption
Show Source
-
$schema:
Allowed Values: [
"ogg:distPathEncryption"
]
-
algorithm:
Default Value: NONE
Allowed Values: [
"NONE",
"AES128",
"AES192",
"AES256"
]
{
"description":"endpoint trail encryption",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEncryption"
]
},
"algorithm":{
"enum":[
"NONE",
"AES128",
"AES192",
"AES256"
],
"default":"NONE"
}
},
"required":[
"algorithm"
],
"additionalProperties":false
}
Nested Schema : trail
Type: object
endpoint trail details
Show Source
-
$schema:
Allowed Values: [
"ogg:distPathTrailinfo"
]
-
format:
format
The format of output data. Default is canonical trail output
-
name:
string
Minimum Length: 1
Maximum Length: 2
Pattern: ^[A-Za-z][A-Za-z0-9]?$
The name of the trail
-
path:
string
Minimum Length: 1
Maximum Length: 255
Default Value: dirdat
The path where trail data is stored
-
seqLength:
Default Value: 9
Allowed Values: [
6,
9
]
Trail sequence number length
-
sizeMB:
integer
Minimum Value: 1
Maximum Value: 4.294967295E9
Default Value: 500
The maximum size, in megabytes, of a file in the trail.
{
"description":"endpoint trail details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathTrailinfo"
]
},
"name":{
"description":"The name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]?$",
"minLength":1,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"default":"dirdat",
"type":"string",
"minLength":1,
"maxLength":255
},
"format":{
"description":"The format of output data. Default is canonical trail output",
"default":"canonical",
"x-oneOf":[
{
"enum":[
"canonical"
]
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:outputFormat"
]
},
"type":{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
},
"includeHeartBeat":{
"description":"Includes the heartbeat table records",
"type":"boolean",
"default":false
}
},
"required":[
"type"
],
"additionalProperties":false
}
]
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":500,
"minimum":1,
"maximum":4.294967295E9
},
"seqLength":{
"description":"Trail sequence number length",
"enum":[
6,
9
],
"default":9
}
},
"additionalProperties":false
}
Nested Schema : format
The format of output data. Default is canonical trail output
Default Value: canonical
Match One
Show Source
{
"description":"The format of output data. Default is canonical trail output",
"default":"canonical",
"x-oneOf":[
{
"enum":[
"canonical"
]
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:outputFormat"
]
},
"type":{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
},
"includeHeartBeat":{
"description":"Includes the heartbeat table records",
"type":"boolean",
"default":false
}
},
"required":[
"type"
],
"additionalProperties":false
}
]
}
Nested Schema : format-x-oneOf[1]
Type: object
Show Source
-
$schema:
Allowed Values: [
"ogg:outputFormat"
]
-
includeHeartBeat:
boolean
Default Value: false
Includes the heartbeat table records
-
type:
type
Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:outputFormat"
]
},
"type":{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
},
"includeHeartBeat":{
"description":"Includes the heartbeat table records",
"type":"boolean",
"default":false
}
},
"required":[
"type"
],
"additionalProperties":false
}
Nested Schema : type
Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.
Match One
Show Source
{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
}
Nested Schema : type-x-oneOf[0]
Type: object
Show Source
-
compatibleWith:
Allowed Values: [
"BCP",
"SQLLOADER",
"COMCAST"
]
formats the output to be compatible with one of the following formats
-
delimiter:
string
Minimum Length: 1
Maximum Length: 3
Default Value: ,
output format field delimiter character. Ignored if compatibility is BCP.
-
encoding:
Allowed Values: [
"UTF-8"
]
outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.
-
extraColumns:
integer
Minimum Value: 1
Maximum Value: 99
includes placeholders for additional columns at the end of each record.
-
includeColumnName:
boolean
Default Value: true
includes the column names in the output. Ignored if compatibility is BCP.
-
includeHeaderFields:
boolean
Default Value: false
includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.
-
includeImageIndicator:
boolean
Default Value: true
includes before or after indicator (B,A). Ignored if compatibility is BCP.
-
includeObjectName:
boolean
Default Value: true
includes object name. Ignored if compatibility is BCP or includeObjectName is false.
-
includeOperationType:
boolean
Default Value: true
includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.
-
includePlaceHolder:
boolean
Default Value: false
outputs a placeholder for missing columns. Ignored if compatibility is BCP.
-
includeSyskey:
boolean
Default Value: true
includes the SYSKEY column in the output
-
includeTransactionInfo:
boolean
Default Value: true
includes transaction information. Ignored if compatibility is BCP.
-
name:
Allowed Values: [
"text"
]
-
nullIsSpace:
boolean
Default Value: false
treats the null columns as empty columns. Ignored if compatibility is BCP.
-
quoteStyle:
Default Value: single
Allowed Values: [
"single",
"none",
"embed"
]
quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.
-
timestampPrecison:
Allowed Values: [
"TS",
"DATE",
"TIME"
]
Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.
-
useQualifiedName:
boolean
Default Value: true
uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
}
Nested Schema : type-x-oneOf[1]
Type: object
Show Source
-
compatibleWith:
Allowed Values: [
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
formats the output to be compatible with one of the following formats
-
encoding:
string
Minimum Length: 1
Maximum Length: 256
specifies the encoding of SQL format using Oracle GoldenGate character set name
-
includeColumnName:
boolean
Default Value: true
includes the column names in the output
-
includeTransactionInfo:
boolean
Default Value: false
Includes the transaction information as SQL comment
-
name:
Allowed Values: [
"sql"
]
-
noPkUpdate:
boolean
Default Value: false
format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT
-
useQualifiedName:
boolean
Default Value: true
uses fully qualified object name that includes schema name
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
}
Nested Schema : type-x-oneOf[2]
Type: object
Show Source
-
closeTransaction:
boolean
Default Value: false
Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false
-
encoding:
Default Value: UTF-8
Allowed Values: [
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
]
Outputs xml file in specified encoding. Default is UTF-8.
-
includeLargeLob:
boolean
Default Value: false
includes LOB more than 4k bytes
-
includeTransactionInfo:
boolean
Default Value: false
includes transaction boundaries and commit timestamp
-
includeUserToken:
boolean
Default Value: false
includes goldengate user token
-
inlineProperties:
boolean
Default Value: true
Use inline XML properties for the metadata such as KEY column flag.
-
name:
Allowed Values: [
"xml"
]
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
Nested Schema : details
Type: object
trail, encryption and compression information
Show Source
{
"description":"trail, encryption and compression information",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointTrail"
]
},
"trail":{
"description":"endpoint trail details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathTrailinfo"
]
},
"name":{
"description":"The name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]?$",
"minLength":1,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"default":"dirdat",
"type":"string",
"minLength":1,
"maxLength":255
},
"format":{
"description":"The format of output data. Default is canonical trail output",
"default":"canonical",
"x-oneOf":[
{
"enum":[
"canonical"
]
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:outputFormat"
]
},
"type":{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
},
"includeHeartBeat":{
"description":"Includes the heartbeat table records",
"type":"boolean",
"default":false
}
},
"required":[
"type"
],
"additionalProperties":false
}
]
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":500,
"minimum":1,
"maximum":4.294967295E9
},
"seqLength":{
"description":"Trail sequence number length",
"enum":[
6,
9
],
"default":9
}
},
"additionalProperties":false
},
"encryption":{
"description":"endpoint trail encryption",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEncryption"
]
},
"algorithm":{
"enum":[
"NONE",
"AES128",
"AES192",
"AES256"
],
"default":"NONE"
}
},
"required":[
"algorithm"
],
"additionalProperties":false
},
"compression":{
"description":"endpoint network compression",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathCompression"
]
},
"enabled":{
"type":"boolean",
"default":false
},
"threshold":{
"description":"compression threshold, the minimum block size(bytes) for which compression is to occur",
"type":"integer",
"default":1000,
"minimum":0,
"maximum":28000
}
},
"required":[
"enabled"
],
"additionalProperties":false
}
},
"additionalProperties":false
}
Nested Schema : proxy
Type: object
proxy to connect to target
Show Source
-
$schema:
Allowed Values: [
"ogg:distPathEndpointProxy"
]
-
csAlias:
string
Minimum Length: 1
Maximum Length: 30
Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Credential store alias
-
csDomain:
string
Minimum Length: 1
Maximum Length: 30
Default Value: OracleGoldenGate
Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Credential store domain
-
type:
string
Allowed Values: [
"SOCKS5",
"HTTP"
]
Type of the proxy server
-
uri:
string
Minimum Length: 2
Maximum Length: 4095
Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
Uri of the proxy server
{
"description":"proxy to connect to target",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointProxy"
]
},
"uri":{
"description":"Uri of the proxy server",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"type":{
"description":"Type of the proxy server",
"type":"string",
"enum":[
"SOCKS5",
"HTTP"
]
},
"csAlias":{
"description":"Credential store alias",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
},
"csDomain":{
"description":"Credential store domain",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
}
},
"required":[
"uri",
"type"
],
"additionalProperties":false
}
Nested Schema : compression
Type: object
endpoint network compression
Show Source
-
$schema:
Allowed Values: [
"ogg:distPathCompression"
]
-
enabled:
boolean
-
threshold:
integer
Minimum Value: 0
Maximum Value: 28000
Default Value: 1000
compression threshold, the minimum block size(bytes) for which compression is to occur
{
"description":"endpoint network compression",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathCompression"
]
},
"enabled":{
"type":"boolean",
"default":false
},
"threshold":{
"description":"compression threshold, the minimum block size(bytes) for which compression is to occur",
"type":"integer",
"default":1000,
"minimum":0,
"maximum":28000
}
},
"required":[
"enabled"
],
"additionalProperties":false
}
Nested Schema : encryption
Type: object
endpoint trail encryption
Show Source
-
$schema:
Allowed Values: [
"ogg:distPathEncryption"
]
-
algorithm:
Default Value: NONE
Allowed Values: [
"NONE",
"AES128",
"AES192",
"AES256"
]
{
"description":"endpoint trail encryption",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEncryption"
]
},
"algorithm":{
"enum":[
"NONE",
"AES128",
"AES192",
"AES256"
],
"default":"NONE"
}
},
"required":[
"algorithm"
],
"additionalProperties":false
}
Nested Schema : trail
Type: object
endpoint trail details
Show Source
-
$schema:
Allowed Values: [
"ogg:distPathTrailinfo"
]
-
format:
format
The format of output data. Default is canonical trail output
-
name:
string
Minimum Length: 1
Maximum Length: 2
Pattern: ^[A-Za-z][A-Za-z0-9]?$
The name of the trail
-
path:
string
Minimum Length: 1
Maximum Length: 255
Default Value: dirdat
The path where trail data is stored
-
seqLength:
Default Value: 9
Allowed Values: [
6,
9
]
Trail sequence number length
-
sizeMB:
integer
Minimum Value: 1
Maximum Value: 4.294967295E9
Default Value: 500
The maximum size, in megabytes, of a file in the trail.
{
"description":"endpoint trail details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathTrailinfo"
]
},
"name":{
"description":"The name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]?$",
"minLength":1,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"default":"dirdat",
"type":"string",
"minLength":1,
"maxLength":255
},
"format":{
"description":"The format of output data. Default is canonical trail output",
"default":"canonical",
"x-oneOf":[
{
"enum":[
"canonical"
]
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:outputFormat"
]
},
"type":{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
},
"includeHeartBeat":{
"description":"Includes the heartbeat table records",
"type":"boolean",
"default":false
}
},
"required":[
"type"
],
"additionalProperties":false
}
]
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":500,
"minimum":1,
"maximum":4.294967295E9
},
"seqLength":{
"description":"Trail sequence number length",
"enum":[
6,
9
],
"default":9
}
},
"additionalProperties":false
}
Nested Schema : format
The format of output data. Default is canonical trail output
Default Value: canonical
Match One
Show Source
{
"description":"The format of output data. Default is canonical trail output",
"default":"canonical",
"x-oneOf":[
{
"enum":[
"canonical"
]
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:outputFormat"
]
},
"type":{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
},
"includeHeartBeat":{
"description":"Includes the heartbeat table records",
"type":"boolean",
"default":false
}
},
"required":[
"type"
],
"additionalProperties":false
}
]
}
Nested Schema : format-x-oneOf[1]
Type: object
Show Source
-
$schema:
Allowed Values: [
"ogg:outputFormat"
]
-
includeHeartBeat:
boolean
Default Value: false
Includes the heartbeat table records
-
type:
type
Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:outputFormat"
]
},
"type":{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
},
"includeHeartBeat":{
"description":"Includes the heartbeat table records",
"type":"boolean",
"default":false
}
},
"required":[
"type"
],
"additionalProperties":false
}
Nested Schema : type
Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.
Match One
Show Source
{
"description":"Oracle GoldenGate output format type. Either specifies a simple type with default setting or provide detailed specification for the output format.",
"x-oneOf":[
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}
]
}
Nested Schema : type-x-oneOf[0]
Type: object
Show Source
-
compatibleWith:
Allowed Values: [
"BCP",
"SQLLOADER",
"COMCAST"
]
formats the output to be compatible with one of the following formats
-
delimiter:
string
Minimum Length: 1
Maximum Length: 3
Default Value: ,
output format field delimiter character. Ignored if compatibility is BCP.
-
encoding:
Allowed Values: [
"UTF-8"
]
outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.
-
extraColumns:
integer
Minimum Value: 1
Maximum Value: 99
includes placeholders for additional columns at the end of each record.
-
includeColumnName:
boolean
Default Value: true
includes the column names in the output. Ignored if compatibility is BCP.
-
includeHeaderFields:
boolean
Default Value: false
includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.
-
includeImageIndicator:
boolean
Default Value: true
includes before or after indicator (B,A). Ignored if compatibility is BCP.
-
includeObjectName:
boolean
Default Value: true
includes object name. Ignored if compatibility is BCP or includeObjectName is false.
-
includeOperationType:
boolean
Default Value: true
includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.
-
includePlaceHolder:
boolean
Default Value: false
outputs a placeholder for missing columns. Ignored if compatibility is BCP.
-
includeSyskey:
boolean
Default Value: true
includes the SYSKEY column in the output
-
includeTransactionInfo:
boolean
Default Value: true
includes transaction information. Ignored if compatibility is BCP.
-
name:
Allowed Values: [
"text"
]
-
nullIsSpace:
boolean
Default Value: false
treats the null columns as empty columns. Ignored if compatibility is BCP.
-
quoteStyle:
Default Value: single
Allowed Values: [
"single",
"none",
"embed"
]
quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.
-
timestampPrecison:
Allowed Values: [
"TS",
"DATE",
"TIME"
]
Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.
-
useQualifiedName:
boolean
Default Value: true
uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.
{
"type":"object",
"properties":{
"includeColumnName":{
"description":"includes the column names in the output. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"BCP",
"SQLLOADER",
"COMCAST"
]
},
"timestampPrecison":{
"description":"Record Timestamp Precision: TS outputs the year to microseconds, DATE outputs the year to day, and TIME outputs the year to seconds. Default is not to output record timestamp. Specifies one of the precisons to output timestampin the record.",
"enum":[
"TS",
"DATE",
"TIME"
]
},
"includeOperationType":{
"description":"includes operation type indicator (I,D,U,V). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includePlaceHolder":{
"description":"outputs a placeholder for missing columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"quoteStyle":{
"description":"quotation style in the text format. Default behavior is to single quote character data, none will exclude quotation marks from character data. embed will escape quotation marks in character data by double the single-quote.",
"enum":[
"single",
"none",
"embed"
],
"default":"single"
},
"encoding":{
"description":"outputs fixed-length records in utf-8 encoding, valid only if compatibility is SQLLOADER.",
"enum":[
"UTF-8"
]
},
"name":{
"enum":[
"text"
]
},
"includeImageIndicator":{
"description":"includes before or after indicator (B,A). Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"includeObjectName":{
"description":"includes object name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"delimiter":{
"description":"output format field delimiter character. Ignored if compatibility is BCP.",
"type":"string",
"default":",",
"minLength":1,
"maxLength":3
},
"includeSyskey":{
"description":"includes the SYSKEY column in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"includes transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":true
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name. Ignored if compatibility is BCP or includeObjectName is false.",
"type":"boolean",
"default":true
},
"includeHeaderFields":{
"description":"includes any metadata such as before/after indicator or transaction information. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"nullIsSpace":{
"description":"treats the null columns as empty columns. Ignored if compatibility is BCP.",
"type":"boolean",
"default":false
},
"extraColumns":{
"description":"includes placeholders for additional columns at the end of each record.",
"type":"integer",
"minimum":1,
"maximum":99
}
},
"required":[
"name"
],
"additionalProperties":false
}
Nested Schema : type-x-oneOf[1]
Type: object
Show Source
-
compatibleWith:
Allowed Values: [
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
formats the output to be compatible with one of the following formats
-
encoding:
string
Minimum Length: 1
Maximum Length: 256
specifies the encoding of SQL format using Oracle GoldenGate character set name
-
includeColumnName:
boolean
Default Value: true
includes the column names in the output
-
includeTransactionInfo:
boolean
Default Value: false
Includes the transaction information as SQL comment
-
name:
Allowed Values: [
"sql"
]
-
noPkUpdate:
boolean
Default Value: false
format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT
-
useQualifiedName:
boolean
Default Value: true
uses fully qualified object name that includes schema name
{
"type":"object",
"properties":{
"name":{
"enum":[
"sql"
]
},
"compatibleWith":{
"description":"formats the output to be compatible with one of the following formats",
"enum":[
"ORACLE",
"SQLPLUS",
"SQLLOADER"
]
},
"includeColumnName":{
"description":"includes the column names in the output",
"type":"boolean",
"default":true
},
"includeTransactionInfo":{
"description":"Includes the transaction information as SQL comment",
"type":"boolean",
"default":false
},
"useQualifiedName":{
"description":"uses fully qualified object name that includes schema name",
"type":"boolean",
"default":true
},
"noPkUpdate":{
"description":"format PKUPDATE and UNIFIED UPDATE as DELETE plus INSERT",
"type":"boolean",
"default":false
},
"encoding":{
"description":"specifies the encoding of SQL format using Oracle GoldenGate character set name",
"type":"string",
"minLength":1,
"maxLength":256
}
},
"required":[
"name"
],
"additionalProperties":false
}
Nested Schema : type-x-oneOf[2]
Type: object
Show Source
-
closeTransaction:
boolean
Default Value: false
Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false
-
encoding:
Default Value: UTF-8
Allowed Values: [
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
]
Outputs xml file in specified encoding. Default is UTF-8.
-
includeLargeLob:
boolean
Default Value: false
includes LOB more than 4k bytes
-
includeTransactionInfo:
boolean
Default Value: false
includes transaction boundaries and commit timestamp
-
includeUserToken:
boolean
Default Value: false
includes goldengate user token
-
inlineProperties:
boolean
Default Value: true
Use inline XML properties for the metadata such as KEY column flag.
-
name:
Allowed Values: [
"xml"
]
{
"type":"object",
"properties":{
"name":{
"enum":[
"xml"
]
},
"includeTransactionInfo":{
"description":"includes transaction boundaries and commit timestamp",
"type":"boolean",
"default":false
},
"includeLargeLob":{
"description":"includes LOB more than 4k bytes",
"type":"boolean",
"default":false
},
"includeUserToken":{
"description":"includes goldengate user token",
"type":"boolean",
"default":false
},
"closeTransaction":{
"description":"Force closing opened transaction boundaries and commit timestamp upon rollover. Adds same transaction boundaries and commit timestamp tags to next XML file after rollover. ignored if includeTransactionInfo is false",
"type":"boolean",
"default":false
},
"inlineProperties":{
"description":"Use inline XML properties for the metadata such as KEY column flag.",
"type":"boolean",
"default":true
},
"encoding":{
"description":"Outputs xml file in specified encoding. Default is UTF-8.",
"enum":[
"UTF-8",
"UTF-16",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1254",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-1258",
"windows-874",
"IBM437",
"IBM775",
"IBM850",
"cp851",
"IBM852",
"IBM855",
"IBM857",
"IBM00858",
"IBM860",
"IBM861",
"IBM862",
"IBM863",
"IBM864",
"IBM865",
"IBM866",
"IBM868",
"IBM869",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-11",
"ISO-8859-12",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"KOI8-R",
"KOI8U",
"TIS-620",
"DEC-MCS",
"hp-roman8",
"Shift-JIS",
"GBK",
"KSC_5601",
"Big5",
"EUC-JP",
"GB2312",
"EUC-KR",
"GB18030",
"HZ-GB-2312",
"Big5-HKSCS"
],
"default":"UTF-8"
}
},
"required":[
"name"
],
"additionalProperties":false
}