移動

• リクエスト
• レスポンス

マッピングされたオブジェクトを使用した比較ペアの生成

post

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

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

プレビューのために比較ペアを作成します。これは比較ペアをリポジトリに保存しません。このAPIはグループIDを必要としないため、比較ペアをどのグループにもマッピングせずにプレビューする場合に使用する必要があります。

リクエスト

問合せパラメータ

• includeColumnMapping: boolean
  ペイロードに列マッピングの詳細を含めます。
• sourceConnectionId(必須): integer(int64)
  ソース接続ID。
• targetConnectionId(必須): integer(int64)
  ターゲット接続ID。

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• mappedObjectWithOptions: array mappedObjectWithOptions

{
    "type":"object",
    "properties":{
        "mappedObjectWithOptions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MappedObjectWithOptions"
            }
        }
    },
    "example":{
        "mappedObjectWithOptions":[
            {
                "name":"EMPLOYEE=EMPLOYEE",
                "srcTable":[
                    {
                        "name":"EMPLOYEE",
                        "schema":"VERIDATA",
                        "catalog":"ORCL1",
                        "tablePartition":[
                            {
                                "name":"EMP_2025"
                            }
                        ]
                    }
                ],
                "tgtTable":[
                    {
                        "name":"EMPLOYEE",
                        "schema":"VERIDATA",
                        "catalog":"ORCL1",
                        "tablePartition":[
                            {
                                "name":"EMP_2025"
                            }
                        ]
                    }
                ],
                "profileId":1,
                "options":[
                    {
                        "autoPartitionInfo":[
                            {
                                "autoPartition":true,
                                "autoPartitionNumber":10
                            }
                        ]
                    }
                ],
                "rowPartition":[
                    {
                        "side":"SOURCE",
                        "name":"employee ID's greater than 100",
                        "whereClause":"ID > 100",
                        "type":"S",
                        "runtime":true
                    },
                    {
                        "side":"TARGET",
                        "name":"employee ID's greater than 100",
                        "whereClause":"ID > 100",
                        "type":"S",
                        "runtime":true
                    }
                ],
                "delta":[
                    {
                        "srcColumn":"UPDATED_DATE",
                        "tgtColumn":"UPDATED_DATE",
                        "srcDeltaQuery":"select MAX(UPDATED_DATE) from ORCL1.VERIDATA.EMPLOYEE",
                        "tgtDeltaQuery":"select MAX(UPDATED_DATE) from ORCL1.VERIDATA.EMPLOYEE",
                        "srcDeltaCols":[
                            "UPDATED_DATE, MODIFIED_TS"
                        ],
                        "tgtDeltaCols":[
                            "UPDATED_DATE, MODIFIED_TS"
                        ],
                        "columnMapping":[
                            {
                                "useSourceColsAsKeys":true,
                                "useTargetColsAsKeys":true,
                                "useAllColsAsKeys":true
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

例:

{
    "mappedObjectWithOptions":[
        {
            "name":"EMPLOYEE=EMPLOYEE",
            "srcTable":[
                {
                    "name":"EMPLOYEE",
                    "schema":"VERIDATA",
                    "catalog":"ORCL1",
                    "tablePartition":[
                        {
                            "name":"EMP_2025"
                        }
                    ]
                }
            ],
            "tgtTable":[
                {
                    "name":"EMPLOYEE",
                    "schema":"VERIDATA",
                    "catalog":"ORCL1",
                    "tablePartition":[
                        {
                            "name":"EMP_2025"
                        }
                    ]
                }
            ],
            "profileId":1,
            "options":[
                {
                    "autoPartitionInfo":[
                        {
                            "autoPartition":true,
                            "autoPartitionNumber":10
                        }
                    ]
                }
            ],
            "rowPartition":[
                {
                    "side":"SOURCE",
                    "name":"employee ID's greater than 100",
                    "whereClause":"ID > 100",
                    "type":"S",
                    "runtime":true
                },
                {
                    "side":"TARGET",
                    "name":"employee ID's greater than 100",
                    "whereClause":"ID > 100",
                    "type":"S",
                    "runtime":true
                }
            ],
            "delta":[
                {
                    "srcColumn":"UPDATED_DATE",
                    "tgtColumn":"UPDATED_DATE",
                    "srcDeltaQuery":"select MAX(UPDATED_DATE) from ORCL1.VERIDATA.EMPLOYEE",
                    "tgtDeltaQuery":"select MAX(UPDATED_DATE) from ORCL1.VERIDATA.EMPLOYEE",
                    "srcDeltaCols":[
                        "UPDATED_DATE, MODIFIED_TS"
                    ],
                    "tgtDeltaCols":[
                        "UPDATED_DATE, MODIFIED_TS"
                    ],
                    "columnMapping":[
                        {
                            "useSourceColsAsKeys":true,
                            "useTargetColsAsKeys":true,
                            "useAllColsAsKeys":true
                        }
                    ]
                }
            ]
        }
    ]
}

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

タイプ: array

ソースの表示

• 配列: object MappedObjectWithOptions

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

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

タイプ: object

ソースの表示

• options: object MappedObjectOptions
• profileId: integer (int64)
  デフォルト値: 1

  プロファイルID。

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/MappedObjectRequest"
        }
    ],
    "properties":{
        "profileId":{
            "type":"integer",
            "format":"int64",
            "default":1,
            "description":"Profile ID."
        },
        "options":{
            "$ref":"#/components/schemas/MappedObjectOptions"
        }
    }
}

すべて一致

ソースの表示

• object MappedObjectRequest

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/MappedObjectRequest"
        }
    ],
    "properties":{
        "profileId":{
            "type":"integer",
            "format":"int64",
            "default":1,
            "description":"Profile ID."
        },
        "options":{
            "$ref":"#/components/schemas/MappedObjectOptions"
        }
    }
}

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

タイプ: object

ソースの表示

• autoPartitionInfo: object AutoPartitionInfo
• columnMapping: object ColumnMappingPattern
• delta: object DeltaProcessing
  デルタ設定を定義します。NSKの場合、これは空のオブジェクトになります。
• rowPartition: array rowPartition
• srcEnscribeInfo: array srcEnscribeInfo
• tgtEnscribeInfo: array tgtEnscribeInfo

{
    "type":"object",
    "properties":{
        "autoPartitionInfo":{
            "$ref":"#/components/schemas/AutoPartitionInfo"
        },
        "rowPartition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CreateRowPartition"
            }
        },
        "delta":{
            "$ref":"#/components/schemas/DeltaProcessing"
        },
        "columnMapping":{
            "$ref":"#/components/schemas/ColumnMappingPattern"
        },
        "srcEnscribeInfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnscribeAttributeRequest"
            }
        },
        "tgtEnscribeInfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnscribeAttributeRequest"
            }
        }
    }
}

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

タイプ: 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/ReqTable"
                },
                {
                    "type":"object"
                }
            ]
        },
        "tgtTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ReqTable"
                },
                {
                    "type":"object"
                }
            ]
        }
    },
    "required":[
        "srcTable",
        "tgtTable"
    ]
}

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

タイプ: object

ソースの表示

• autoPartition: string
  指定できる値: [ false, true ]

  ブール値TRUE/FALSEを表します
• autoPartitionNumber: integer (int32)
  デフォルト値: 10

{
    "type":"object",
    "properties":{
        "autoPartition":{
            "$ref":"#/components/schemas/BooleanEnum"
        },
        "autoPartitionNumber":{
            "type":"integer",
            "format":"int32",
            "default":10
        }
    }
}

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

タイプ: object

ソースの表示

• useAllColsAsKeys: boolean
  デフォルト値: true
• useSourceColsAsKeys: boolean
  デフォルト値: true
• useTargetColsAsKeys: boolean
  デフォルト値: true

{
    "type":"object",
    "properties":{
        "useSourceColsAsKeys":{
            "type":"boolean",
            "default":true
        },
        "useTargetColsAsKeys":{
            "type":"boolean",
            "default":true
        },
        "useAllColsAsKeys":{
            "type":"boolean",
            "default":true
        }
    }
}

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

タイプ: object

デルタ設定を定義します。NSKの場合、これは空のオブジェクトになります。

ソースの表示

• srcColumn: string
  デルタ・ソース列。
• srcDeltaCols: array srcDeltaCols
  ソース・デルタ列のリスト。
• srcDeltaQuery: string
  ソース・デルタ問合せ。
• tgtColumn: string
  デルタ・ターゲット列。
• tgtDeltaCols: array tgtDeltaCols
  ターゲット・デルタ列のリスト。
• tgtDeltaQuery: string
  ターゲット・デルタ問合せ。

{
    "type":"object",
    "properties":{
        "srcColumn":{
            "type":"string",
            "description":"Delta Source column."
        },
        "tgtColumn":{
            "type":"string",
            "description":"Delta Target column."
        },
        "srcDeltaQuery":{
            "type":"string",
            "description":"Source Delta query."
        },
        "tgtDeltaQuery":{
            "type":"string",
            "description":"Target Delta query."
        },
        "srcDeltaCols":{
            "type":"array",
            "description":"List of Source Delta columns.",
            "items":{
                "type":"string"
            }
        },
        "tgtDeltaCols":{
            "type":"array",
            "description":"List of Target Delta columns.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Defines Delta Setting. For NSK this will be an empty object."
}

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

タイプ: array

ソースの表示

• 配列: CreateRowPartition

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

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

タイプ: array

ソースの表示

• 配列: object EnscribeAttributeRequest

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

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

タイプ: array

ソースの表示

• 配列: object EnscribeAttributeRequest

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

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

タイプ: array

ソース・デルタ列のリスト。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"List of Source Delta columns.",
    "items":{
        "type":"string"
    }
}

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

タイプ: array

ターゲット・デルタ列のリスト。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"List of Target Delta columns.",
    "items":{
        "type":"string"
    }
}

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

すべて一致

ソースの表示

• object RowPartitionSide
• object RowPartitionParams

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RowPartitionSide"
        },
        {
            "$ref":"#/components/schemas/RowPartitionParams"
        }
    ]
}

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

タイプ: object

ソースの表示

• side: string
  指定できる値: [ "SOURCE", "TARGET" ]

  SOURCEまたはTARGET。

{
    "type":"object",
    "properties":{
        "side":{
            "type":"string",
            "description":"SOURCE or TARGET.",
            "enum":[
                "SOURCE",
                "TARGET"
            ]
        }
    }
}

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

タイプ: object

ソースの表示

• endingKey: string
  Enscribe終了キー。
• isAscii: boolean
  EnscribeはASCIIです。
• name(必須): string
• runtime: boolean
  実行時に使用します。
• startingKey: string
  Enscribe開始キー。
• type(必須): string
  指定できる値: [ "S", "E", "A" ]

  行パーティションのタイプ(SQL{S}、Enscribe{E}、自動{A})
• whereClause: string
  SQL述語文。

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "whereClause":{
            "type":"string",
            "description":"SQL Predicate Statement."
        },
        "endingKey":{
            "type":"string",
            "description":"Enscribe ending key."
        },
        "startingKey":{
            "type":"string",
            "description":"Enscribe starting key."
        },
        "type":{
            "type":"string",
            "description":"Type of Row Partition (SQL{S} , Enscribe{E} , Auto{A})",
            "enum":[
                "S",
                "E",
                "A"
            ]
        },
        "isAscii":{
            "type":"boolean",
            "description":"Enscribe is ASCII."
        },
        "runtime":{
            "type":"boolean",
            "description":"Use at runtime."
        }
    },
    "required":[
        "type",
        "name"
    ]
}

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

タイプ: object

ソースの表示

• default: boolean
• name: string
  指定できる値: [ "AltKey", "Dictionary", "Record", "ExpandDDLRedefs", "ExpandDDLResolveDupAppend", "ExpandDDLResolveDupPrepend", "ExpandDDLExpandGroupArrays", "ExpandDDLFixLongNames", "ExpandDDLMaxColNameLen", "ExpandDDLSeparator", "ExpandDDLZeroFill" ]
• value: string

{
    "type":"object",
    "properties":{
        "name":{
            "$ref":"#/components/schemas/EnscribeAttributeEnum"
        },
        "default":{
            "type":"boolean"
        },
        "value":{
            "type":"string"
        }
    }
}

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

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

すべて一致

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

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

ソースの表示

• object ReqTable
  リクエスト本文に表を定義します。
• object srcTable-allOf[1]

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

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

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

すべて一致

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

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

ソースの表示

• object ReqTable
  リクエスト本文に表を定義します。
• object tgtTable-allOf[1]

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

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

タイプ: object

リクエスト本文に表を定義します。

ソースの表示

• catalog: string
• filePattern: string
  NSK Enscribeデータベースに有効です。
• name: string
• schema: string
• tablePartition: object tablePartition

{
    "type":"object",
    "description":"Defines a table in request body.",
    "properties":{
        "name":{
            "type":"string"
        },
        "schema":{
            "type":"string"
        },
        "catalog":{
            "type":"string"
        },
        "filePattern":{
            "type":"string",
            "description":"Valid for NSK Enscribe database."
        },
        "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

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

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

本文()

ルート・スキーマ: schema

タイプ: array

ソースの表示

• 配列: object ComparePairInDetailsView

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

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

タイプ: object

ソースの表示

• columnMappings: array columnMappings
• columnsSystemMapped: boolean
  デフォルト値: true

  キー列システムがマップされているかどうか。
• delta: delta
• deltaProcessingEnabled: boolean
  デフォルト値: false

  この比較ペアに対してデルタ処理が有効になります。
• enabled: boolean
  デフォルト値: true

  実行するグループで比較ペアが有効になります。
• keyColumnsSystemMapped: boolean
  デフォルト値: true

  キー列システムがマップされているかどうか。
• profile: profile
  プロファイル・オブジェクト。
• setting: object ComparePairSetting
  表内の列のマッピング。
• srcIndexName: string
• srcRowPartitions: array srcRowPartitions
• srcTable: srcTable
  比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。
• tgtIndexName: string
• tgtRowPartitions: array tgtRowPartitions
• tgtTable: tgtTable
  比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。
• validationStatus: string
  指定できる値: [ "NeverValidated", "Validated" ]

  比較ペア検証ステータスの列挙。
• validationTime: string (date-time)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject_2"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "profile":{
            "description":"Profile Object.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/BaseObject_3"
                },
                {
                    "type":"object"
                }
            ]
        },
        "srcTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/BasicTable"
                },
                {
                    "type":"object"
                }
            ]
        },
        "tgtTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/BasicTable"
                },
                {
                    "type":"object"
                }
            ]
        },
        "columnMappings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ColumnMapping"
            }
        },
        "setting":{
            "$ref":"#/components/schemas/ComparePairSetting"
        },
        "srcRowPartitions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RowPartition"
            }
        },
        "tgtRowPartitions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RowPartition"
            }
        },
        "delta":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DeltaProcessing"
                }
            ]
        },
        "keyColumnsSystemMapped":{
            "type":"boolean",
            "description":"Is the key columns system mapped.",
            "default":true
        },
        "columnsSystemMapped":{
            "type":"boolean",
            "description":"Is the key columns system mapped.",
            "default":true
        },
        "srcIndexName":{
            "type":"string"
        },
        "tgtIndexName":{
            "type":"string"
        },
        "enabled":{
            "type":"boolean",
            "description":"Compare Pair is enabled in the group to run.",
            "default":true
        },
        "deltaProcessingEnabled":{
            "type":"boolean",
            "description":"Delta processing is enabled for this compare pair.",
            "default":false
        },
        "validationTime":{
            "type":"string",
            "format":"date-time"
        },
        "validationStatus":{
            "$ref":"#/components/schemas/ComparePairValidationStatus"
        }
    }
}

すべて一致

ソースの表示

• object BaseObject_2
• object ComparePairInDetailsView-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject_2"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "profile":{
            "description":"Profile Object.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/BaseObject_3"
                },
                {
                    "type":"object"
                }
            ]
        },
        "srcTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/BasicTable"
                },
                {
                    "type":"object"
                }
            ]
        },
        "tgtTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/BasicTable"
                },
                {
                    "type":"object"
                }
            ]
        },
        "columnMappings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ColumnMapping"
            }
        },
        "setting":{
            "$ref":"#/components/schemas/ComparePairSetting"
        },
        "srcRowPartitions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RowPartition"
            }
        },
        "tgtRowPartitions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RowPartition"
            }
        },
        "delta":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DeltaProcessing"
                }
            ]
        },
        "keyColumnsSystemMapped":{
            "type":"boolean",
            "description":"Is the key columns system mapped.",
            "default":true
        },
        "columnsSystemMapped":{
            "type":"boolean",
            "description":"Is the key columns system mapped.",
            "default":true
        },
        "srcIndexName":{
            "type":"string"
        },
        "tgtIndexName":{
            "type":"string"
        },
        "enabled":{
            "type":"boolean",
            "description":"Compare Pair is enabled in the group to run.",
            "default":true
        },
        "deltaProcessingEnabled":{
            "type":"boolean",
            "description":"Delta processing is enabled for this compare pair.",
            "default":false
        },
        "validationTime":{
            "type":"string",
            "format":"date-time"
        },
        "validationStatus":{
            "$ref":"#/components/schemas/ComparePairValidationStatus"
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: object ColumnMapping

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

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

すべて一致

ソースの表示

• object DeltaProcessing
  デルタ設定を定義します。NSKの場合、これは空のオブジェクトになります。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DeltaProcessing"
        }
    ]
}

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

プロファイル・オブジェクト。

すべて一致

プロファイル・オブジェクト。

プロファイル・オブジェクト。

ソースの表示

• object BaseObject_3
• object profile-allOf[1]

{
    "description":"Profile Object.",
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject_3"
        },
        {
            "type":"object"
        }
    ]
}

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

タイプ: object

表内の列のマッピング。

ソースの表示

• compareMethod: string
  指定できる値: [ "Key", "Hash", "Literal" ]

  マッピング・タイプを比較します。
• exclude: array exclude
  除外される列名の配列。
• keyColsMappingMethod: string
  指定できる値: [ "system", "user" ]

  列マッピング方法。
• otherColsMappingMethod: string
  指定できる値: [ "system", "user" ]

  列マッピング方法。
• srcIndexType: string
  指定できる値: [ "index", "columns" ]

  ソース/ターゲットのキー索引。
• tgtIndexType: string
  指定できる値: [ "index", "columns" ]

  ソース/ターゲットのキー索引。
• unmapped: array unmapped
  マッピングされていない列名の配列。

{
    "type":"object",
    "properties":{
        "compareMethod":{
            "$ref":"#/components/schemas/CompareMappingType"
        },
        "keyColsMappingMethod":{
            "$ref":"#/components/schemas/ColumnMappingMethod"
        },
        "otherColsMappingMethod":{
            "$ref":"#/components/schemas/ColumnMappingMethod"
        },
        "srcIndexType":{
            "$ref":"#/components/schemas/KeyIndexType"
        },
        "tgtIndexType":{
            "$ref":"#/components/schemas/KeyIndexType"
        },
        "unmapped":{
            "type":"array",
            "description":"Array of column names which are unmapped.",
            "items":{
                "type":"string"
            }
        },
        "exclude":{
            "type":"array",
            "description":"Array of column names which are excluded.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Mapping of a column in a table."
}

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

タイプ: array

ソースの表示

• 配列: RowPartition

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

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

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

すべて一致

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

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

ソースの表示

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

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

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

タイプ: array

ソースの表示

• 配列: RowPartition

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

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

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

すべて一致

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

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

ソースの表示

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

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

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

タイプ: object

ソースの表示

• createdOn: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• id: integer (int64)
  オブジェクトID。
• name: string
  オブジェクト名。
• updatedOn: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Object Id.",
            "format":"int64"
        },
        "name":{
            "type":"string",
            "description":"Object Name."
        },
        "createdOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "updatedOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        }
    }
}

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

タイプ: object

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

タイプ: object

ソースの表示

• compareFormat: string
  指定できる値: [ "string", "string_en", "binary", "timestamp", "timestamp_tz", "date", "time", "datetime", "smalldatetime", "clob", "blob", "Float", "dec_float", "interval", "number", "binary_timestamp", "string_nfc", "clob_nfc", "sybtime", "bit", "Double" ]

  比較形式。
• dataType: string
• mappingType: string
  指定できる値: [ "Key", "Hash", "Literal" ]

  マッピング・タイプを比較します。
• precision: integer (int32)
  デフォルト値: 0
• scale: integer (int32)
  デフォルト値: 0
• srcColumn: object Column
  列を定義します。
• supportedCompareFormats: array supportedCompareFormats
• tgtColumn: object Column
  列を定義します。
• timezone: string

{
    "type":"object",
    "properties":{
        "srcColumn":{
            "$ref":"#/components/schemas/Column"
        },
        "tgtColumn":{
            "$ref":"#/components/schemas/Column"
        },
        "compareFormat":{
            "$ref":"#/components/schemas/CompareFormat"
        },
        "mappingType":{
            "$ref":"#/components/schemas/CompareMappingType"
        },
        "dataType":{
            "type":"string"
        },
        "precision":{
            "type":"integer",
            "format":"int32",
            "default":0
        },
        "scale":{
            "type":"integer",
            "format":"int32",
            "default":0
        },
        "timezone":{
            "type":"string"
        },
        "supportedCompareFormats":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompareFormat"
            }
        }
    }
}

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

タイプ: object

列を定義します。

ソースの表示

• columnName: string
  列名。
• dataType: string
  列のデータ型。
• jdbcType: integer (int32)
  java.sql.Typesのタイプ番号。
• lob: boolean
• precision: integer (int32)
  デフォルト値: 0
• scale: integer (int32)
  デフォルト値: 0
• timezone: string
• typeNum: integer (int32)
  内部列タイプ番号。

{
    "type":"object",
    "description":"Defines a column.",
    "properties":{
        "columnName":{
            "type":"string",
            "description":"Column Name."
        },
        "dataType":{
            "type":"string",
            "description":"Data type of the column."
        },
        "precision":{
            "type":"integer",
            "format":"int32",
            "default":0
        },
        "scale":{
            "type":"integer",
            "format":"int32",
            "default":0
        },
        "timezone":{
            "type":"string"
        },
        "jdbcType":{
            "type":"integer",
            "format":"int32",
            "description":"java.sql.Types type number."
        },
        "typeNum":{
            "type":"integer",
            "format":"int32",
            "description":"internal column type number."
        },
        "lob":{
            "type":"boolean"
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: string
  指定できる値: [ "string", "string_en", "binary", "timestamp", "timestamp_tz", "date", "time", "datetime", "smalldatetime", "clob", "blob", "Float", "dec_float", "interval", "number", "binary_timestamp", "string_nfc", "clob_nfc", "sybtime", "bit", "Double" ]

  比較形式。

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

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

タイプ: object

デルタ設定を定義します。NSKの場合、これは空のオブジェクトになります。

ソースの表示

• srcColumn: string
  デルタ・ソース列。
• srcDeltaCols: array srcDeltaCols
  ソース・デルタ列のリスト。
• srcDeltaQuery: string
  ソース・デルタ問合せ。
• tgtColumn: string
  デルタ・ターゲット列。
• tgtDeltaCols: array tgtDeltaCols
  ターゲット・デルタ列のリスト。
• tgtDeltaQuery: string
  ターゲット・デルタ問合せ。

{
    "type":"object",
    "properties":{
        "srcColumn":{
            "type":"string",
            "description":"Delta Source column."
        },
        "tgtColumn":{
            "type":"string",
            "description":"Delta Target column."
        },
        "srcDeltaQuery":{
            "type":"string",
            "description":"Source Delta query."
        },
        "tgtDeltaQuery":{
            "type":"string",
            "description":"Target Delta query."
        },
        "srcDeltaCols":{
            "type":"array",
            "description":"List of Source Delta columns.",
            "items":{
                "type":"string"
            }
        },
        "tgtDeltaCols":{
            "type":"array",
            "description":"List of Target Delta columns.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Defines Delta Setting. For NSK this will be an empty object."
}

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

タイプ: array

ソース・デルタ列のリスト。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"List of Source Delta columns.",
    "items":{
        "type":"string"
    }
}

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

タイプ: array

ターゲット・デルタ列のリスト。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"List of Target Delta columns.",
    "items":{
        "type":"string"
    }
}

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

タイプ: object

ソースの表示

• id: integer (int64)
  オブジェクトID。
• name: string
  オブジェクト名。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Object Id.",
            "format":"int64"
        },
        "name":{
            "type":"string",
            "description":"Object Name."
        }
    }
}

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

タイプ: object

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

タイプ: array

除外される列名の配列。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"Array of column names which are excluded.",
    "items":{
        "type":"string"
    }
}

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

タイプ: array

マッピングされていない列名の配列。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"Array of column names which are unmapped.",
    "items":{
        "type":"string"
    }
}

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

すべて一致

ソースの表示

• object BaseRowPartition
• object RowPartitionParams

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseRowPartition"
        },
        {
            "$ref":"#/components/schemas/RowPartitionParams"
        }
    ]
}

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

タイプ: object

ソースの表示

• id: integer (int64)
  行パーティションID

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Row Partition ID",
            "format":"int64"
        }
    }
}

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

タイプ: object

ソースの表示

• endingKey: string
  Enscribe終了キー。
• isAscii: boolean
  EnscribeはASCIIです。
• name(必須): string
• runtime: boolean
  実行時に使用します。
• startingKey: string
  Enscribe開始キー。
• type(必須): string
  指定できる値: [ "S", "E", "A" ]

  行パーティションのタイプ(SQL{S}、Enscribe{E}、自動{A})
• whereClause: string
  SQL述語文。

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "whereClause":{
            "type":"string",
            "description":"SQL Predicate Statement."
        },
        "endingKey":{
            "type":"string",
            "description":"Enscribe ending key."
        },
        "startingKey":{
            "type":"string",
            "description":"Enscribe starting key."
        },
        "type":{
            "type":"string",
            "description":"Type of Row Partition (SQL{S} , Enscribe{E} , Auto{A})",
            "enum":[
                "S",
                "E",
                "A"
            ]
        },
        "isAscii":{
            "type":"boolean",
            "description":"Enscribe is ASCII."
        },
        "runtime":{
            "type":"boolean",
            "description":"Use at runtime."
        }
    },
    "required":[
        "type",
        "name"
    ]
}

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

タイプ: object

表を定義します。

ソースの表示

• catalog: string
• 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"
        },
        "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"
}

先頭に戻る