get
/services/{version}/targets/{path}
リクエスト
パス・パラメータ
- path: string
最小長:
1
最大長:32
パターン:^[A-Za-z][A-Za-z0-9-_.]*$
- version: string
Oracle GoldenGateサービスのAPIバージョン。
指定できる値:[ "v2" ]
レスポンス
サポートされるメディア・タイプ
- application/json
200レスポンス
本文()
ルート・スキーマ: Oracle GoldenGate Distribution Path
型:
object
タイトル:
ソースの表示
Oracle GoldenGate Distribution Path
- $schema(optional):
指定できる値:
[ "ogg:distPath" ]
- begin(optional): begin
データ処理の開始位置
- description(optional): string
最小長:
1
最大長:4095
パスの説明 - name(optional): string
最小長:
1
最大長:32
パターン:^[A-Za-z][A-Za-z0-9-_.]*$
分散パス名 - options(optional): object options
分散パスのオプション
- ruleset(optional): object ruleset
分散パスのルールセット
- source(optional): object source
パスのソース・エンドポイント
- status(optional):
デフォルト値:
stopped
指定できる値:[ "paused", "running", "stopping", "stopped", "killed", "uninitialized" ]
Oracle GoldenGateの分散パスのステータス - target(optional): object target
パスのターゲット・エンドポイント
{
"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
}
ネストされたスキーマ: begin
データ処理の開始位置
デフォルト値:
now
1つに一致
ソースの表示
-
指定できる値:
[ "now" ]
- string
最小長:
20
最大長:32
パターン:^[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
}
]
}
ネストされたスキーマ: options
型:
object
分散パスのオプション
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathOptions" ]
- autoRestart(optional): object autoRestart
停止されたパスを自動的に再起動する必要があるかどうかを示します
- checkpointFrequency(optional): integer
最小値:
1
最大値:4.294967295E9
デフォルト値:10
パスがルーチン・チェックポイントを使用する間隔(秒)。 - critical(optional): boolean
デフォルト値:
false
分散パスがデプロイメントにとってクリティカルであることを示します - eofDelayCSecs(optional): integer
最小値:
1
最大値:6000
デフォルト値:100
ソース・データを探すまでのEOFの遅延(センチ秒) - forceStatus(optional): boolean
デフォルト値:
false
適用可能な場合にステータスの変更を行います - network(optional): object network
エンドポイントのネットワークの詳細
- streaming(optional): boolean
デフォルト値:
true
送信側が受信側の確認応答を待機しない非同期ネットワーク・ストリーミング・プロトコル。 - tcpSourceTimer(optional): boolean
デフォルト値:
true
データ・レコードの他のシステムへの送信時のタイムスタンプを調整します
{
"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
}
ネストされたスキーマ: ruleset
型:
object
分散パスのルールセット
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathRuleset" ]
- description(optional): string
最小長:
1
最大長:4095
パスのルールセットの説明 - name(optional): string
最小長:
1
最大長:30
パスのルールセットの名前 - rules(optional): array rules
最小アイテム数:
1
最大アイテム数: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
}
ネストされたスキーマ: source
型:
object
パスのソース・エンドポイント
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathEndpoint" ]
- description(optional): string
最小長:
1
最大長:4095
エンドポイントの説明 - details(optional): object details
トレイル、暗号化および圧縮の情報
- isDynamicOggPort(optional): boolean
デフォルト値:
true
トレイルのURIがogg://で始まる場合、このプロパティは、それが静的ポート(従来のコレクタとして作動するrecvsrvr)か動的ポート(従来のインストール、URIのポートがmgrポート)かを示します。 - proxy(optional): object proxy
ターゲットに接続するためのプロキシ
- uri(optional): string
最小長:
2
最大長:4095
パターン:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
エンドポイントURIの指定
{
"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
型:
object
パスのターゲット・エンドポイント
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathEndpoint" ]
- description(optional): string
最小長:
1
最大長:4095
エンドポイントの説明 - details(optional): object details
トレイル、暗号化および圧縮の情報
- isDynamicOggPort(optional): boolean
デフォルト値:
true
トレイルのURIがogg://で始まる場合、このプロパティは、それが静的ポート(従来のコレクタとして作動するrecvsrvr)か動的ポート(従来のインストール、URIのポートがmgrポート)かを示します。 - proxy(optional): object proxy
ターゲットに接続するためのプロキシ
- uri(optional): string
最小長:
2
最大長:4095
パターン:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
エンドポイントURIの指定
{
"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
}
ネストされたスキーマ: begin-x-oneOf[2]
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "type:position/atTrailRBA" ]
- offset(optional): integer
最小値:
0
最大値:2147483647
デフォルト値:0
トレイル順序ファイルのオフセット - sequence: integer
最小値:
0
最大値:999999999
デフォルト値:0
トレイル・ファイル順序番号
{
"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
}
ネストされたスキーマ: autoRestart
型:
object
停止されたパスを自動的に再起動する必要があるかどうかを示します
ソースの表示
- delay(optional): integer
最小値:
0
最大値:60
デフォルト値:2
パスを再起動してから次に再起動するまでに一時停止する時間(分)。 - retries: integer
最小値:
0
最大値:3600
デフォルト値:10
停止されたパスを再起動する再試行の最大回数。再試行回数を0に設定すると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
}
ネストされたスキーマ: network
型:
object
エンドポイントのネットワークの詳細
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:network" ]
- appOptions(optional): object appOptions
アプリケーションのオプション
- socketOptions(optional): socketOptions
ソケットのオプション
{
"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
}
ネストされたスキーマ: appOptions
型:
object
アプリケーションのオプション
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:appOptions" ]
- appFlushBytes(optional): integer
最小値:
1024
最大値:524288
デフォルト値:27985
アプリケーションのフラッシュ・サイズ - appFlushSecs(optional): integer
最小値:
1
最大値:300
デフォルト値:1
アプリケーションのフラッシュ間隔
{
"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
}
ネストされたスキーマ: socketOptions
ソケットのオプション
1つに一致
ソースの表示
{
"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
}
]
}
ネストされたスキーマ: socketOptions-x-oneOf[0]
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:tcpOptions" ]
- tcpOptions(optional): object tcpOptions
tcpチューニング・オプション
{
"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
}
ネストされたスキーマ: socketOptions-x-oneOf[1]
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:udpOptions" ]
- udpOptions(optional): object udpOptions
udpチューニング・オプション
{
"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
}
ネストされたスキーマ: tcpOptions
型:
object
tcpチューニング・オプション
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:tcpOption" ]
- ipDscp(optional):
指定できる値:
[ "DEFAULT", "AF11", "AF12", "AF13", "AF21", "AF22", "AF23", "AF31", "AF32", "AF33", "AF41", "AF42", "AF43", "EF" ]
ネットワーク区別サービス - ipTos(optional):
指定できる値:
[ "DEFAULT", "LOWCOST", "RELIABILITY", "THROUGHPUT", "LOWDELAY" ]
サービスの条件 - tcpCork(optional): boolean
Nagleアルゴリズムのコルク・オプションを使用するかどうか
- tcpNoDelay(optional): boolean
Nagleのオプションのnodelay
- tcpQuickAck(optional): boolean
できるだけ早く確認応答を送信します
- tcpRcvBuf(optional): integer
最小値:
1024
最大値:524288
システムの受信バッファ・サイズ - tcpSndBuf(optional): integer
最小値:
1024
最大値:524288
システムの送信バッファ・サイズ
{
"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
}
ネストされたスキーマ: udpOptions
型:
object
udpチューニング・オプション
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:udpOption" ]
- udpRcvBuf(optional): integer
最小値:
1
最大値:2147483647
UDPソケットの受信側のバッファ・サイズ(バイト) - udpSndBuf(optional): integer
最小値:
1
最大値:2147483647
UDPソケットの送信側のバッファ・サイズ(バイト) - udtCC(optional):
指定できる値:
[ "DEFAULT" ]
ユーザー定義の輻輳制御アルゴリズム。 - udtFC(optional): integer
最小値:
1
最大値:2147483647
最大ウィンドウ・サイズ(パケット) - udtLinger(optional): integer
最小値:
0
最大値:1000000000
close()での遅延時間。 - udtMaxBW(optional): integer
最小値:
1
最大値:2147483647
1つのUDT接続が使用できる最大帯域幅(バイト/秒)。 - udtMss(optional): integer
最小値:
1
最大値:2147483647
最大パケット・サイズ(バイト)。 - udtRcvBuf(optional): integer
最小値:
1
最大値:2147483647
UDTの受信側のバッファ・サイズ制限(バイト) - udtRcvSyn(optional): boolean
受信のための同期モード。
- udtRcvTimeO(optional): integer
最小値:
0
最大値:1000000000
コール受信のタイムアウト(ミリ秒)。 - udtRendezvous(optional): boolean
デフォルト値:
false
ランデブー接続設定。 - udtReuseAddr(optional): boolean
デフォルト値:
true
既存のアドレスを再利用するか新しいアドレスを作成します。 - udtSltTimeO(optional): integer
最小値:
0
最大値:1000000000
コール選択のタイムアウト(秒)。 - udtSndBuf(optional): integer
最小値:
1
最大値:2147483647
UDTの送信側のバッファ・サイズ制限(バイト) - udtSndSyn(optional): boolean
データ送信のための同期モード。
- udtSndTimeO(optional): integer
最小値:
0
最大値:1000000000
コール送信のタイムアウト(ミリ秒)。
{
"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
}
ネストされたスキーマ: rules
型:
array
最小アイテム数:
1
最大アイテム数:
ソースの表示
1024
{
"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
}
ネストされたスキーマ: items
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:distPathRule" ]
- actions: array actions
最小アイテム数:
1
最大アイテム数:128
- description(optional): string
最小長:
1
最大長:4095
パス・ルールの説明 - filterRelation(optional):
デフォルト値:
or
指定できる値:[ "and", "or" ]
フィルタ間の関係 - filters: array filters
最小アイテム数:
1
最大アイテム数:4096
- name: string
最小長:
1
最大長:30
ルールの名前
{
"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
}
ネストされたスキーマ: actions
型:
array
最小アイテム数:
1
最大アイテム数:
ソースの表示
128
{
"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
}
ネストされたスキーマ: filters
型:
array
最小アイテム数:
1
最大アイテム数:
ソースの表示
4096
{
"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
}
ネストされたスキーマ: items
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:distPathAction" ]
- command:
デフォルト値:
include
指定できる値:[ "include", "exclude" ]
- description(optional): string
最小長:
1
最大長:4095
パスのアクションの説明
{
"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
}
ネストされたスキーマ: items
1つに一致
ソースの表示
- object items-x-oneOf[0]
- object items-x-oneOf[1]
- object items-x-oneOf[2]
- object items-x-oneOf[3]
- object items-x-oneOf[4]
- object items-x-oneOf[5]
- object items-x-oneOf[6]
{
"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
}
]
}
ネストされたスキーマ: items-x-oneOf[0]
型:
ソースの表示
object
- chunkIds: array chunkIds
最小アイテム数:
0
最大アイテム数:2147483647
一連のチャンクID - negate(optional): boolean
デフォルト値:
false
前述セットの否定
{
"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
}
ネストされたスキーマ: items-x-oneOf[1]
型:
ソースの表示
object
- chunkIdRanges: array chunkIdRanges
最小アイテム数:
1
最大アイテム数:2147483647
一連のチャンクID範囲 - negate(optional): boolean
デフォルト値:
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
}
ネストされたスキーマ: items-x-oneOf[2]
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:distPathObjectNames" ]
- negate(optional): boolean
デフォルト値:
false
前述セットの否定 - objectNames: array objectNames
最小アイテム数:
1
最大アイテム数:65535
一連のオブジェクト名
{
"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
}
ネストされたスキーマ: items-x-oneOf[3]
型:
ソースの表示
object
- negate(optional): boolean
デフォルト値:
false
前述セットの否定 - objectTypes: array objectTypes
最小アイテム数:
1
最大アイテム数:3
一連のオブジェクト型
{
"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
}
ネストされたスキーマ: items-x-oneOf[4]
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:distPathColumnValues" ]
- columnValues: array columnValues
最小アイテム数:
1
最大アイテム数:65535
一連の列値 - negate(optional): boolean
デフォルト値:
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
}
ネストされたスキーマ: items-x-oneOf[5]
型:
ソースの表示
object
- negate(optional): boolean
デフォルト値:
false
前述セットの否定 - tags: tags
一連のタグ。有効なタグ値を含むLCRにはall、タグなしのLCRにはnoneを指定します
{
"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
}
ネストされたスキーマ: items-x-oneOf[6]
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:distPathProcedureFeatureNames" ]
- negate(optional): boolean
デフォルト値:
false
前述セットの否定 - procedureFeatureNames: array procedureFeatureNames
最小アイテム数:
1
最大アイテム数:32
一連のプロシージャ機能名
{
"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
}
ネストされたスキーマ: chunkIds
型:
array
最小アイテム数:
0
最大アイテム数:
2147483647
一連のチャンクID
ソースの表示
- 配列: integer
最小値:
1
最大値:4.294967295E9
{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
}
ネストされたスキーマ: chunkIdRanges
型:
array
最小アイテム数:
1
最大アイテム数:
2147483647
一連のチャンクID範囲
ソースの表示
{
"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
}
ネストされたスキーマ: items
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:distPathChunkidRange" ]
- chunkIdBegin: integer
最小値:
1
最大値:4.294967295E9
- chunkIdEnd: integer
最小値:
1
最大値:4.294967295E9
{
"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
}
ネストされたスキーマ: objectNames
型:
array
最小アイテム数:
1
最大アイテム数:
65535
一連のオブジェクト名
ソースの表示
{
"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
}
ネストされたスキーマ: items
修飾された表名(すべての名前コンポーネントがワイルドカード文字を含むことができる)
いずれかに一致
ソースの表示
- string
最小長:
3
最大長:261
パターン:^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
- string
最小長:
5
最大長:392
パターン:^([^."]{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
}
]
}
ネストされたスキーマ: objectTypes
型:
array
最小アイテム数:
1
最大アイテム数:
3
一連のオブジェクト型
ソースの表示
- 配列:
指定できる値:
[ "DML", "DDL", "Procedure" ]
{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure"
]
},
"minItems":1,
"maxItems":3
}
ネストされたスキーマ: columnValues
型:
array
最小アイテム数:
1
最大アイテム数:
65535
一連の列値
ソースの表示
{
"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
}
ネストされたスキーマ: items
型:
ソースの表示
object
- columnName: string
最小長:
1
最大長:130
パターン:^([^.*?"]{1,128}|["].{1,128}["])$
列の名前 - columnValue: columnValue
列データ。現在は文字と2進整数のみがサポートされます
- imageType(optional):
デフォルト値:
before
指定できる値:[ "before", "after" ]
列のビフォア・イメージまたはアフター・イメージ。INSERTはアフター・イメージのみ、DELETEはビフォア・イメージのみです。ビフォア・イメージとアフター・イメージの両方があるケースに適用されます。 - operator(optional):
デフォルト値:
equalTo
指定できる値:[ "equalTo", "notEqualTo", "lessThan", "lessThanOrEqualTo", "greaterThan", "greaterThanOrEqualTo" ]
比較演算子 - tableName: tableName
列が存在する表の名前
{
"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
}
ネストされたスキーマ: columnValue
列データ。現在は文字と2進整数のみがサポートされます
1つに一致
ソースの表示
{
"description":"column data, currently only support char and binary integer",
"x-oneOf":[
{
"type":"string",
"minLength":0,
"maxLength":32767
},
{
"type":"number"
},
{
"type":"null"
}
]
}
ネストされたスキーマ: tableName
列が存在する表の名前
いずれかに一致
ソースの表示
- string
最小長:
3
最大長:261
パターン:^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
- string
最小長:
5
最大長:392
パターン:^([^."]{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
}
]
}
ネストされたスキーマ: tags
一連のタグ。有効なタグ値を含むLCRにはall、タグなしのLCRにはnoneを指定します
1つに一致
ソースの表示
- array tags-x-oneOf[0]
最小アイテム数:
1
最大アイテム数:2147483647
-
指定できる値:
[ "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"
]
}
]
}
ネストされたスキーマ: tags-x-oneOf[0]
型:
array
最小アイテム数:
1
最大アイテム数:
ソースの表示
2147483647
{
"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
}
ネストされたスキーマ: items
1つに一致
ソースの表示
- object items-x-oneOf[0]
タグ値を表すバイナリ文字列。
- object items-x-oneOf[1]
タグ値を表す16進文字列。
- object items-x-oneOf[2]
バイナリ・タグ・ビットマスク値。ビットAND演算子が、LCRに関連付けられたタグに対して実行されます。
- object items-x-oneOf[3]
16進タグ・ビットマスク値。ビットAND演算子が、LCRに関連付けられたタグに対して実行されます。
{
"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
}
]
}
ネストされたスキーマ: items-x-oneOf[0]
型:
object
タグ値を表すバイナリ文字列。
ソースの表示
- binValue: string
最小長:
1
最大長:2000
パターン:[01]{1,2000}
{
"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
}
ネストされたスキーマ: items-x-oneOf[1]
型:
object
タグ値を表す16進文字列。
ソースの表示
- hexValue: string
最小長:
1
最大長:2000
パターン:[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
}
ネストされたスキーマ: items-x-oneOf[2]
型:
object
バイナリ・タグ・ビットマスク値。ビットAND演算子が、LCRに関連付けられたタグに対して実行されます。
ソースの表示
- binMask: string
最小長:
1
最大長:2000
パターン:[01]{1,2000}
タグ・マスク値を表すバイナリ文字列。
{
"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
}
ネストされたスキーマ: items-x-oneOf[3]
型:
object
16進タグ・ビットマスク値。ビットAND演算子が、LCRに関連付けられたタグに対して実行されます。
ソースの表示
- hexMask: string
最小長:
1
最大長:2000
パターン:[A-Fa-f0-9]{1,2000}
タグ・マスク値を表す16進文字列。
{
"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
}
ネストされたスキーマ: procedureFeatureNames
型:
array
最小アイテム数:
1
最大アイテム数:
32
一連のプロシージャ機能名
ソースの表示
- 配列: string
最小長:
1
最大長:128
パターン:^[*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
}
ネストされたスキーマ: details
型:
object
トレイル、暗号化および圧縮の情報
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathEndpointTrail" ]
- compression(optional): object compression
エンドポイントのネットワークの圧縮
- encryption(optional): object encryption
エンドポイント・トレイルの暗号化
- trail(optional): object trail
エンドポイント・トレイルの詳細
{
"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
}
ネストされたスキーマ: proxy
型:
object
ターゲットに接続するためのプロキシ
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathEndpointProxy" ]
- csAlias(optional): string
最小長:
1
最大長:30
パターン:^[a-zA-Z][a-zA-Z0-9_#$]*$
資格証明ストアの別名 - csDomain(optional): string
最小長:
1
最大長:30
デフォルト値:OracleGoldenGate
パターン:^[a-zA-Z][a-zA-Z0-9_#$]*$
資格証明ストアのドメイン - type: string
指定できる値:
[ "SOCKS5", "HTTP" ]
プロキシ・サーバーのタイプ - uri: string
最小長:
2
最大長:4095
パターン:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
プロキシ・サーバーのURI
{
"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
}
ネストされたスキーマ: compression
型:
object
エンドポイントのネットワークの圧縮
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathCompression" ]
- enabled: boolean
デフォルト値:
false
- threshold(optional): integer
最小値:
0
最大値:28000
デフォルト値:1000
圧縮のしきい値。圧縮を行うための最小ブロック・サイズ(バイト)
{
"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
}
ネストされたスキーマ: encryption
型:
object
エンドポイント・トレイルの暗号化
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathEncryption" ]
- algorithm:
デフォルト値:
NONE
指定できる値:[ "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
}
ネストされたスキーマ: trail
型:
object
エンドポイント・トレイルの詳細
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathTrailinfo" ]
- format(optional): format
出力データの形式。デフォルトは正規トレイル出力です
- name(optional): string
最小長:
1
最大長:2
パターン:^[A-Za-z][A-Za-z0-9]?$
トレイルの名前 - path(optional): string
最小長:
1
最大長:255
デフォルト値:dirdat
トレイル・データが格納されるパス - seqLength(optional):
デフォルト値:
9
指定できる値:[ 6, 9 ]
トレイル順序番号の長さ - sizeMB(optional): integer
最小値:
1
最大値:4.294967295E9
デフォルト値:500
トレイル内のファイルの最大サイズ(MB)。
{
"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
}
ネストされたスキーマ: format
出力データの形式。デフォルトは正規トレイル出力です
デフォルト値:
canonical
1つに一致
ソースの表示
-
指定できる値:
[ "canonical" ]
- object format-x-oneOf[1]
{
"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
}
]
}
ネストされたスキーマ: format-x-oneOf[1]
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:outputFormat" ]
- includeHeartBeat(optional): boolean
デフォルト値:
false
ハートビート表レコードを含みます - type: type
Oracle GoldenGateの出力形式タイプ。デフォルト設定を使用した単純なタイプを指定するか、出力形式を詳しく指定します。
{
"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
}
ネストされたスキーマ: type
Oracle GoldenGateの出力形式タイプ。デフォルト設定を使用した単純なタイプを指定するか、出力形式を詳しく指定します。
1つに一致
ソースの表示
{
"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
}
]
}
ネストされたスキーマ: type-x-oneOf[0]
型:
ソースの表示
object
- compatibleWith(optional):
指定できる値:
[ "BCP", "SQLLOADER", "COMCAST" ]
出力が次のいずれかの形式と互換性を持つようにします - delimiter(optional): string
最小長:
1
最大長:3
デフォルト値:,
出力形式フィールドの区切り文字。互換性がBCPの場合は無視されます。 - encoding(optional):
指定できる値:
[ "UTF-8" ]
固定長レコードをutf-8エンコーディングで出力します。互換性がSQLLOADERの場合のみ有効です。 - extraColumns(optional): integer
最小値:
1
最大値:99
各レコードの末尾に追加列のためのプレースホルダを含めます。 - includeColumnName(optional): boolean
デフォルト値:
true
出力に列名を含めます。互換性がBCPの場合は無視されます。 - includeHeaderFields(optional): boolean
デフォルト値:
false
ビフォア・インジケータやアフター・インジケータまたはトランザクション情報などメタデータを含めます。互換性がBCPの場合は無視されます。 - includeImageIndicator(optional): boolean
デフォルト値:
true
ビフォア・インジケータまたはアフター・インジケータ(B、A)を含めます。互換性がBCPの場合は無視されます。 - includeObjectName(optional): boolean
デフォルト値:
true
オブジェクト名を含めます。互換性がBCPの場合またはincludeObjectNameがfalseの場合は無視されます。 - includeOperationType(optional): boolean
デフォルト値:
true
操作タイプ・インジケータ(I、D、U、V)を含めます。互換性がBCPの場合は無視されます。 - includePlaceHolder(optional): boolean
デフォルト値:
false
紛失した列に対してプレースホルダを出力します。互換性がBCPの場合は無視されます。 - includeSyskey(optional): boolean
デフォルト値:
true
出力にSYSKEY列を含めます - includeTransactionInfo(optional): boolean
デフォルト値:
true
トランザクション情報を含めます。互換性がBCPの場合は無視されます。 - name:
指定できる値:
[ "text" ]
- nullIsSpace(optional): boolean
デフォルト値:
false
NULL列を空の列として扱います。互換性がBCPの場合は無視されます。 - quoteStyle(optional):
デフォルト値:
single
指定できる値:[ "single", "none", "embed" ]
テキスト形式での引用のスタイル。デフォルトの動作(single)では、文字データが一重引用符で囲まれます。noneでは、文字データから引用符が除外されます。embedでは、文字データ内の引用符が2つの一重引用符でエスケープされます。 - timestampPrecison(optional):
指定できる値:
[ "TS", "DATE", "TIME" ]
レコードのタイムスタンプの精度: TSは年からミリ秒まで出力、DATEは年から日まで出力、TIMEは年から秒まで出力します。デフォルトではレコードのタイムスタンプは出力されません。レコードのタイムスタンプを出力する精度を1つ指定します。 - useQualifiedName(optional): boolean
デフォルト値:
true
スキーマ名を含む完全修飾オブジェクト名を使用します。互換性がBCPの場合またはincludeObjectNameが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
}
ネストされたスキーマ: type-x-oneOf[1]
型:
ソースの表示
object
- compatibleWith(optional):
指定できる値:
[ "ORACLE", "SQLPLUS", "SQLLOADER" ]
出力が次のいずれかの形式と互換性を持つようにします - encoding(optional): string
最小長:
1
最大長:256
Oracle GoldenGateのキャラクタ・セット名を使用してSQL形式のエンコーディングを指定します - includeColumnName(optional): boolean
デフォルト値:
true
出力に列名を含めます - includeTransactionInfo(optional): boolean
デフォルト値:
false
トランザクション情報をSQLコメントとして含めます - name:
指定できる値:
[ "sql" ]
- noPkUpdate(optional): boolean
デフォルト値:
false
PKUPDATEとUNIFIED UPDATEを、DELETEとINSERTを合せたものとして表記します - useQualifiedName(optional): boolean
デフォルト値:
true
スキーマ名を含む完全修飾オブジェクト名を使用します
{
"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-x-oneOf[2]
型:
ソースの表示
object
- closeTransaction(optional): boolean
デフォルト値:
false
ロールオーバー時に開いているトランザクション境界とコミット・タイムスタンプを強制的に閉じます。ロールオーバー後に、同じトランザクション境界とコミット・タイムスタンプ・タグを次のXMLファイルに追加します。includeTransactionInfoがfalseの場合は無視されます - encoding(optional):
デフォルト値:
UTF-8
指定できる値:[ "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" ]
指定されたエンコーディングでxmlファイルを出力します。デフォルトはUTF-8です。 - includeLargeLob(optional): boolean
デフォルト値:
false
4KBを超えるLOBを含めます - includeTransactionInfo(optional): boolean
デフォルト値:
false
トランザクション境界とコミット・タイムスタンプを含めます - includeUserToken(optional): boolean
デフォルト値:
false
GoldenGateユーザー・トークンを含めます - inlineProperties(optional): boolean
デフォルト値:
true
KEY列フラグなどのメタデータでインラインXMLプロパティを使用します。 - name:
指定できる値:
[ "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
}
ネストされたスキーマ: details
型:
object
トレイル、暗号化および圧縮の情報
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathEndpointTrail" ]
- compression(optional): object compression
エンドポイントのネットワークの圧縮
- encryption(optional): object encryption
エンドポイント・トレイルの暗号化
- trail(optional): object trail
エンドポイント・トレイルの詳細
{
"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
}
ネストされたスキーマ: proxy
型:
object
ターゲットに接続するためのプロキシ
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathEndpointProxy" ]
- csAlias(optional): string
最小長:
1
最大長:30
パターン:^[a-zA-Z][a-zA-Z0-9_#$]*$
資格証明ストアの別名 - csDomain(optional): string
最小長:
1
最大長:30
デフォルト値:OracleGoldenGate
パターン:^[a-zA-Z][a-zA-Z0-9_#$]*$
資格証明ストアのドメイン - type: string
指定できる値:
[ "SOCKS5", "HTTP" ]
プロキシ・サーバーのタイプ - uri: string
最小長:
2
最大長:4095
パターン:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
プロキシ・サーバーのURI
{
"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
}
ネストされたスキーマ: compression
型:
object
エンドポイントのネットワークの圧縮
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathCompression" ]
- enabled: boolean
デフォルト値:
false
- threshold(optional): integer
最小値:
0
最大値:28000
デフォルト値:1000
圧縮のしきい値。圧縮を行うための最小ブロック・サイズ(バイト)
{
"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
}
ネストされたスキーマ: encryption
型:
object
エンドポイント・トレイルの暗号化
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathEncryption" ]
- algorithm:
デフォルト値:
NONE
指定できる値:[ "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
}
ネストされたスキーマ: trail
型:
object
エンドポイント・トレイルの詳細
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:distPathTrailinfo" ]
- format(optional): format
出力データの形式。デフォルトは正規トレイル出力です
- name(optional): string
最小長:
1
最大長:2
パターン:^[A-Za-z][A-Za-z0-9]?$
トレイルの名前 - path(optional): string
最小長:
1
最大長:255
デフォルト値:dirdat
トレイル・データが格納されるパス - seqLength(optional):
デフォルト値:
9
指定できる値:[ 6, 9 ]
トレイル順序番号の長さ - sizeMB(optional): integer
最小値:
1
最大値:4.294967295E9
デフォルト値:500
トレイル内のファイルの最大サイズ(MB)。
{
"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
}
ネストされたスキーマ: format
出力データの形式。デフォルトは正規トレイル出力です
デフォルト値:
canonical
1つに一致
ソースの表示
-
指定できる値:
[ "canonical" ]
- object format-x-oneOf[1]
{
"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
}
]
}
ネストされたスキーマ: format-x-oneOf[1]
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:outputFormat" ]
- includeHeartBeat(optional): boolean
デフォルト値:
false
ハートビート表レコードを含みます - type: type
Oracle GoldenGateの出力形式タイプ。デフォルト設定を使用した単純なタイプを指定するか、出力形式を詳しく指定します。
{
"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
}
ネストされたスキーマ: type
Oracle GoldenGateの出力形式タイプ。デフォルト設定を使用した単純なタイプを指定するか、出力形式を詳しく指定します。
1つに一致
ソースの表示
{
"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
}
]
}
ネストされたスキーマ: type-x-oneOf[0]
型:
ソースの表示
object
- compatibleWith(optional):
指定できる値:
[ "BCP", "SQLLOADER", "COMCAST" ]
出力が次のいずれかの形式と互換性を持つようにします - delimiter(optional): string
最小長:
1
最大長:3
デフォルト値:,
出力形式フィールドの区切り文字。互換性がBCPの場合は無視されます。 - encoding(optional):
指定できる値:
[ "UTF-8" ]
固定長レコードをutf-8エンコーディングで出力します。互換性がSQLLOADERの場合のみ有効です。 - extraColumns(optional): integer
最小値:
1
最大値:99
各レコードの末尾に追加列のためのプレースホルダを含めます。 - includeColumnName(optional): boolean
デフォルト値:
true
出力に列名を含めます。互換性がBCPの場合は無視されます。 - includeHeaderFields(optional): boolean
デフォルト値:
false
ビフォア・インジケータやアフター・インジケータまたはトランザクション情報などメタデータを含めます。互換性がBCPの場合は無視されます。 - includeImageIndicator(optional): boolean
デフォルト値:
true
ビフォア・インジケータまたはアフター・インジケータ(B、A)を含めます。互換性がBCPの場合は無視されます。 - includeObjectName(optional): boolean
デフォルト値:
true
オブジェクト名を含めます。互換性がBCPの場合またはincludeObjectNameがfalseの場合は無視されます。 - includeOperationType(optional): boolean
デフォルト値:
true
操作タイプ・インジケータ(I、D、U、V)を含めます。互換性がBCPの場合は無視されます。 - includePlaceHolder(optional): boolean
デフォルト値:
false
紛失した列に対してプレースホルダを出力します。互換性がBCPの場合は無視されます。 - includeSyskey(optional): boolean
デフォルト値:
true
出力にSYSKEY列を含めます - includeTransactionInfo(optional): boolean
デフォルト値:
true
トランザクション情報を含めます。互換性がBCPの場合は無視されます。 - name:
指定できる値:
[ "text" ]
- nullIsSpace(optional): boolean
デフォルト値:
false
NULL列を空の列として扱います。互換性がBCPの場合は無視されます。 - quoteStyle(optional):
デフォルト値:
single
指定できる値:[ "single", "none", "embed" ]
テキスト形式での引用のスタイル。デフォルトの動作(single)では、文字データが一重引用符で囲まれます。noneでは、文字データから引用符が除外されます。embedでは、文字データ内の引用符が2つの一重引用符でエスケープされます。 - timestampPrecison(optional):
指定できる値:
[ "TS", "DATE", "TIME" ]
レコードのタイムスタンプの精度: TSは年からミリ秒まで出力、DATEは年から日まで出力、TIMEは年から秒まで出力します。デフォルトではレコードのタイムスタンプは出力されません。レコードのタイムスタンプを出力する精度を1つ指定します。 - useQualifiedName(optional): boolean
デフォルト値:
true
スキーマ名を含む完全修飾オブジェクト名を使用します。互換性がBCPの場合またはincludeObjectNameが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
}
ネストされたスキーマ: type-x-oneOf[1]
型:
ソースの表示
object
- compatibleWith(optional):
指定できる値:
[ "ORACLE", "SQLPLUS", "SQLLOADER" ]
出力が次のいずれかの形式と互換性を持つようにします - encoding(optional): string
最小長:
1
最大長:256
Oracle GoldenGateのキャラクタ・セット名を使用してSQL形式のエンコーディングを指定します - includeColumnName(optional): boolean
デフォルト値:
true
出力に列名を含めます - includeTransactionInfo(optional): boolean
デフォルト値:
false
トランザクション情報をSQLコメントとして含めます - name:
指定できる値:
[ "sql" ]
- noPkUpdate(optional): boolean
デフォルト値:
false
PKUPDATEとUNIFIED UPDATEを、DELETEとINSERTを合せたものとして表記します - useQualifiedName(optional): boolean
デフォルト値:
true
スキーマ名を含む完全修飾オブジェクト名を使用します
{
"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-x-oneOf[2]
型:
ソースの表示
object
- closeTransaction(optional): boolean
デフォルト値:
false
ロールオーバー時に開いているトランザクション境界とコミット・タイムスタンプを強制的に閉じます。ロールオーバー後に、同じトランザクション境界とコミット・タイムスタンプ・タグを次のXMLファイルに追加します。includeTransactionInfoがfalseの場合は無視されます - encoding(optional):
デフォルト値:
UTF-8
指定できる値:[ "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" ]
指定されたエンコーディングでxmlファイルを出力します。デフォルトはUTF-8です。 - includeLargeLob(optional): boolean
デフォルト値:
false
4KBを超えるLOBを含めます - includeTransactionInfo(optional): boolean
デフォルト値:
false
トランザクション境界とコミット・タイムスタンプを含めます - includeUserToken(optional): boolean
デフォルト値:
false
GoldenGateユーザー・トークンを含めます - inlineProperties(optional): boolean
デフォルト値:
true
KEY列フラグなどのメタデータでインラインXMLプロパティを使用します。 - name:
指定できる値:
[ "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
}
レスポンスの例(application/json)
{
"$schema":"api:standardResponse",
"response":{
"name":"path1",
"description":"recvsrvr-path-1",
"source":{
"uri":"ogg://slc05cve:7809/",
"details":{
"network":{
"tcpBufSize":27996,
"tcpFlushBytes":27996,
"tcpFlushSecs":1
}
}
},
"target":{
"uri":"trail://dirdat/t1",
"details":{
"trail":{
"name":"t1",
"sequence":{
"length":9
},
"sizeMB":100
}
}
},
"begin":{
"sequence":0,
"offset":0
},
"status":"running"
},
"messages":[
],
"links":[
]
}