GoldenGate Veridata REST API

マッピング・ルールを使用したマッピング・オブジェクトの生成

post

http://{host}:{port}/veridata/v1/services/configuration/cps/mappings

必要なロール: Administrator、SuperUser、CommandLineOperator

表示のためにマッピング・オブジェクトを生成します。

リクエスト

この操作にはリクエスト・パラメータはありません。

サポートされるメディア・タイプ

application/json

ルート・スキーマ: schema

タイプ: object

ソースの表示

sourceConnectionId(必須): integer (int64)

接続ID。
srcCatalogObjectName: string
srcFilePattern: string

volume.subVolumeのEnscribeファイル・パターン
srcSchemaObjectName(必須): string
targetConnectionId(必須): integer (int64)

接続ID。
tgtCatalogObjectName: string
tgtFilePattern: string

volume.subVolumeのEnscribeファイル・パターン
tgtSchemaObjectName(必須): string

{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/PatternMapping" } ], "properties":{ "sourceConnectionId":{ "type":"integer", "description":"Connection Id.", "format":"int64" }, "targetConnectionId":{ "type":"integer", "description":"Connection Id.", "format":"int64" }, "srcSchemaObjectName":{ "type":"string" }, "srcCatalogObjectName":{ "type":"string" }, "tgtSchemaObjectName":{ "type":"string" }, "tgtCatalogObjectName":{ "type":"string" }, "srcFilePattern":{ "type":"string", "description":"Enscribe file pattern of volume.subVolume" }, "tgtFilePattern":{ "type":"string", "description":"Enscribe file pattern of volume.subVolume" } }, "required":[ "sourceConnectionId", "targetConnectionId", "srcSchemaObjectName", "tgtSchemaObjectName" ], "example":{ "exactName":false, "wildCard":[ { "srcLike":true, "srcPattern":"EMP%", "tgtLike":true, "tgtPattern":"EMP%" } ], "excludeViews":false, "mapTablePartitionName":true, "sourceConnectionId":1023, "targetConnectionId":1024, "srcSchemaObjectName":"VERIDATA", "srcCatalogObjectName":"ORCL1", "tgtSchemaObjectName":"VERIDATA_TGT", "tgtCatalogObjectName":"ORCL1_TGT" } }

すべて一致

ソースの表示

object PatternMapping

{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/PatternMapping" } ], "properties":{ "sourceConnectionId":{ "type":"integer", "description":"Connection Id.", "format":"int64" }, "targetConnectionId":{ "type":"integer", "description":"Connection Id.", "format":"int64" }, "srcSchemaObjectName":{ "type":"string" }, "srcCatalogObjectName":{ "type":"string" }, "tgtSchemaObjectName":{ "type":"string" }, "tgtCatalogObjectName":{ "type":"string" }, "srcFilePattern":{ "type":"string", "description":"Enscribe file pattern of volume.subVolume" }, "tgtFilePattern":{ "type":"string", "description":"Enscribe file pattern of volume.subVolume" } }, "required":[ "sourceConnectionId", "targetConnectionId", "srcSchemaObjectName", "tgtSchemaObjectName" ], "example":{ "exactName":false, "wildCard":[ { "srcLike":true, "srcPattern":"EMP%", "tgtLike":true, "tgtPattern":"EMP%" } ], "excludeViews":false, "mapTablePartitionName":true, "sourceConnectionId":1023, "targetConnectionId":1024, "srcSchemaObjectName":"VERIDATA", "srcCatalogObjectName":"ORCL1", "tgtSchemaObjectName":"VERIDATA_TGT", "tgtCatalogObjectName":"ORCL1_TGT" } }

例:

{ "exactName":false, "wildCard":[ { "srcLike":true, "srcPattern":"EMP%", "tgtLike":true, "tgtPattern":"EMP%" } ], "excludeViews":false, "mapTablePartitionName":true, "sourceConnectionId":1023, "targetConnectionId":1024, "srcSchemaObjectName":"VERIDATA", "srcCatalogObjectName":"ORCL1", "tgtSchemaObjectName":"VERIDATA_TGT", "tgtCatalogObjectName":"ORCL1_TGT" }

ネストされたスキーマ: PatternMapping

タイプ: object

ソースの表示

exactName: boolean

デフォルト値: true

完全一致名を使用してソース表とターゲット表をマップします。パターン・マッピング時に必要です。
excludeViews: boolean

デフォルト値: false
mapTablePartitionName: boolean

デフォルト値: false

表パーティションを正確な名前でマッピングします。
wildCard: object wildCard

%または*のワイルドカード・パターンを使用してソース表およびターゲット表をマッピングします。パターンの始まりまたは終わりには、%または*を使用する必要があります。これは、exactNameがfalseに設定されている場合にのみ使用されます。

{ "type":"object", "properties":{ "exactName":{ "type":"boolean", "description":"Map Source and Target Tables Using Exact Names. It is required during pattern mapping.", "default":true }, "wildCard":{ "type":"object", "properties":{ "srcLike":{ "type":"boolean", "description":"Where Source Names Like/Not Like.", "default":true }, "srcPattern":{ "type":"string", "description":"Source Pattern." }, "tgtLike":{ "type":"boolean", "description":"Where Target names Like/Not Like.", "default":true }, "tgtPattern":{ "type":"string", "description":"Target Pattern" } }, "description":"Map Source and Target Tables Using % OR * Wildcard Pattern. % or * should be used either at the start or end of the pattern. This will be used only if the exactName is set to false." }, "excludeViews":{ "type":"boolean", "default":false }, "mapTablePartitionName":{ "type":"boolean", "description":"Map Table Partition with exact name.", "default":false } } }

ネストされたスキーマ: wildCard

タイプ: object

%または*のワイルドカード・パターンを使用してソース表およびターゲット表をマッピングします。パターンの始まりまたは終わりには、%または*を使用する必要があります。これは、exactNameがfalseに設定されている場合にのみ使用されます。

ソースの表示

srcLike: boolean

デフォルト値: true

ソース名が相似している、または相似していない。
srcPattern: string

ソース・パターン。
tgtLike: boolean

デフォルト値: true

ターゲット名が相似している、または相似していない。
tgtPattern: string

ターゲット・パターン

{ "type":"object", "properties":{ "srcLike":{ "type":"boolean", "description":"Where Source Names Like/Not Like.", "default":true }, "srcPattern":{ "type":"string", "description":"Source Pattern." }, "tgtLike":{ "type":"boolean", "description":"Where Target names Like/Not Like.", "default":true }, "tgtPattern":{ "type":"string", "description":"Target Pattern" } }, "description":"Map Source and Target Tables Using % OR * Wildcard Pattern. % or * should be used either at the start or end of the pattern. This will be used only if the exactName is set to false." }

先頭に戻る

レスポンス

サポートされるメディア・タイプ

application/json

200 レスポンス

比較ペアが正常に生成されました。

ルート・スキーマ: schema

タイプ: array

ソースの表示

配列: object MappedObject

{ "type":"array", "items":{ "$ref":"#/components/schemas/MappedObject" } }

ネストされたスキーマ: MappedObject

タイプ: object

ソースの表示

name: string

マッピング名。デフォルトはソース表名 = ターゲット表名です。
srcTable(必須): srcTable

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。
tgtTable(必須): tgtTable

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。

{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Mapping name . Default is source table name = target table name." }, "srcTable":{ "description":"Represents a table in compare pair with table and row partitions info, if any.\n", "allOf":[ { "$ref":"#/components/schemas/Table" }, { "type":"object" } ] }, "tgtTable":{ "description":"Represents a table in compare pair with table and row partitions info, if any.\n", "allOf":[ { "$ref":"#/components/schemas/Table" }, { "type":"object" } ] } }, "required":[ "srcTable", "tgtTable" ] }

ネストされたスキーマ: srcTable

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。

すべて一致

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。

ソースの表示

object Table

表を定義します。
object srcTable-allOf[1]

{ "description":"Represents a table in compare pair with table and row partitions info, if any.\n", "allOf":[ { "$ref":"#/components/schemas/Table" }, { "type":"object" } ] }

ネストされたスキーマ: tgtTable

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。

すべて一致

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。

ソースの表示

object Table

表を定義します。
object tgtTable-allOf[1]

{ "description":"Represents a table in compare pair with table and row partitions info, if any.\n", "allOf":[ { "$ref":"#/components/schemas/Table" }, { "type":"object" } ] }

ネストされたスキーマ: Table

タイプ: object

表を定義します。

ソースの表示

catalog: string
filePattern: string

NSK Encribeファイル・パターン。
isView: boolean
name: string
schema: string
tablePartition: object tablePartition

{ "type":"object", "description":"Defines a table.", "properties":{ "name":{ "type":"string" }, "schema":{ "type":"string" }, "catalog":{ "type":"string" }, "isView":{ "type":"boolean" }, "filePattern":{ "type":"string", "description":"NSK Encribe file pattern." }, "tablePartition":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/TablePartition" } ] } } }

ネストされたスキーマ: srcTable-allOf[1]

タイプ: object

ネストされたスキーマ: tablePartition

タイプ: object

すべて一致

ソースの表示

object TablePartition

{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/TablePartition" } ] }

ネストされたスキーマ: TablePartition

タイプ: object

ソースの表示

name: string

{ "type":"object", "properties":{ "name":{ "type":"string" } } }

ネストされたスキーマ: tgtTable-allOf[1]

タイプ: object

400 レスポンス

不正なリクエスト。

ルート・スキーマ: Error

タイプ: object

ソースの表示

errCode: string

Veridataのエラー・コード。
errMsg: string

Veridataのエラー・メッセージ。

{ "type":"object", "properties":{ "errCode":{ "type":"string", "description":"Veridata Error Code." }, "errMsg":{ "type":"string", "description":"Veridata Error Message." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

例:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }

401 レスポンス

権限がありません。

ルート・スキーマ: Error

タイプ: object

ソースの表示

errCode: string

Veridataのエラー・コード。
errMsg: string

Veridataのエラー・メッセージ。

{ "type":"object", "properties":{ "errCode":{ "type":"string", "description":"Veridata Error Code." }, "errMsg":{ "type":"string", "description":"Veridata Error Message." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

例:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }

404 レスポンス

見つかりません。

ルート・スキーマ: Error

タイプ: object

ソースの表示

errCode: string

Veridataのエラー・コード。
errMsg: string

Veridataのエラー・メッセージ。

{ "type":"object", "properties":{ "errCode":{ "type":"string", "description":"Veridata Error Code." }, "errMsg":{ "type":"string", "description":"Veridata Error Message." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

例:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }

500 レスポンス

サーバー・エラー。

ルート・スキーマ: Error

タイプ: object

ソースの表示

errCode: string

Veridataのエラー・コード。
errMsg: string

Veridataのエラー・メッセージ。

{ "type":"object", "properties":{ "errCode":{ "type":"string", "description":"Veridata Error Code." }, "errMsg":{ "type":"string", "description":"Veridata Error Message." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

例:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }

先頭に戻る