1. Oracle GoldenGate 23ai Microservices Architecture REST APIドキュメンテーション
  2. タスク
  3. 分散サービス

既存のOracle GoldenGateデータ・ストリーム構成の更新

patch

/services/{version}/stream/{streamName}

必要なロール: 管理者

既存のOracle GoldenGateデータ・ストリーム構成の更新

リクエスト

サポートされるメディア・タイプ
パス・パラメータ
本文()
ルート・スキーマ : Oracle GoldenGate Data Streaming Resource Configuration
型: object
タイトル: Oracle GoldenGate Data Streaming Resource Configuration
このスキーマは、データ・ストリーミング・リソースの構成を記述します。
ソースの表示
ネストされたスキーマ: encoding
データ・エンコーディング方法
デフォルト値: json
1つに一致
ソースの表示
ネストされたスキーマ: rules
型: array
最小アイテム数: 1
最大アイテム数: 1024
ソースの表示
ネストされたスキーマ: source
型: object
データ・ストリームのソース・エンドポイント。
ソースの表示
  • 最小長: 1
    最大長: 4096
    トレイル・データが格納されるパス
  • 最小長: 2
    最大長: 512
    パターン: ^[a-zA-Z0-9_#$/-]*$
    トレイルの名前
ネストされたスキーマ: encoding-x-oneOf[0]
型: object
jsonエンコーディング構成
ソースの表示
ネストされたスキーマ: json
型: object
ソースの表示
  • 指定できる値: [ "ogg:outputFormatJson" ]
  • 最小長: 1
    最大長: 32
    デフォルト値: after
    アフター・イメージのJSON要素名(opモデルにのみ適用可能)
  • 最小長: 1
    最大長: 32
    デフォルト値: before
    ビフォア・イメージのJSON要素名(opモデルのみに適用可能)
  • 最小長: 0
    最大長: 32
    レコード間のデリミタ
  • デフォルト値: false
    イメージ列の前後のフラット化(opモデルのみに適用)
  • 最小長: 0
    最大長: 32
    イメージ列の前後の連結JSON要素名のデリミタ(opモデルのみに適用可能)
  • デフォルト値: true
    ストリーム・メタデータ・レコード、オブジェクト・メタデータ・レコード、DMLレコード、DDLレコードなど、ストリーム内のすべてのレコードを記述するJSONSchemaレコードが含まれます
  • デフォルト値: true
    列やタイプのリストなど、表を記述するメタデータ・レコードが含まれます
  • デフォルト値: true
    ソース・データベースおよびプロデューサに関連するグローバル情報を記述するメタデータ・レコードが含まれます
  • 最小値: 1
    最大値: 4294967295
    デフォルト値: 1000000
    この最大サイズ(バイト)を超えると、DDLテキストが切り捨てられます
  • 最小値: 1
    最大値: 18446744073709552000
    デフォルト値: 64000
    この最大サイズ(バイト)を超えると、LOBデータが切り捨てられます
  • 最小値: 131072
    最大値: 10485760
    デフォルト値: 1048576
    この最大サイズ(バイト)を超えると、レコードが切り捨てられるかチャンク化されます
  • metaFields
    レコードに含めるメタデータを指定します
  • デフォルト値: op
    指定できる値: [ "op", "row" ]
    レコードのモデル
  • デフォルト値: false
    null値を持つ列を除外します
  • operationStrings
    操作タイプ文字列値
  • staticFields
    レコードに静的値を含むフィールドを指定します
  • デフォルト値: false
    すべての列値をネイティブ型ではなく文字列として書き込みます。
  • デフォルト値: truncate
    指定できる値: [ "truncate", "chunk" ]
    最大レコード・サイズを超えるレコードを切り捨てるかチャンクにするか
ネストされたスキーマ: metaFields
型: object
レコードに含めるメタデータを指定します
ソースの表示
ネストされたスキーマ: operationStrings
型: object
操作タイプ文字列値
ソースの表示
ネストされたスキーマ: staticFields
型: object
レコードに静的値を含むフィールドを指定します
ネストされたスキーマ: catalog
デフォルト値: false
1つに一致
ソースの表示
ネストされたスキーマ: csn
デフォルト値: false
1つに一致
ソースの表示
ネストされたスキーマ: currentTs
デフォルト値: false
1つに一致
ソースの表示
ネストされたスキーマ: currentTsMicroSecs
デフォルト値: false
1つに一致
ソースの表示
ネストされたスキーマ: env
デフォルト値: oracle.doceng.json.BetterJsonNull@236206f8
1つに一致
ソースの表示
ネストされたスキーマ: opSeqno
デフォルト値: false
1つに一致
ソースの表示
ネストされたスキーマ: opTs
デフォルト値: true
1つに一致
ソースの表示
ネストされたスキーマ: opTsMicroSecs
デフォルト値: false
1つに一致
ソースの表示
ネストされたスキーマ: opType
デフォルト値: true
1つに一致
ソースの表示
ネストされたスキーマ: pos
デフォルト値: true
1つに一致
ソースの表示
ネストされたスキーマ: primaryKeys
デフォルト値: false
1つに一致
ソースの表示
ネストされたスキーマ: qualifiedTable
デフォルト値: true
1つに一致
ソースの表示
ネストされたスキーマ: schema
デフォルト値: false
1つに一致
ソースの表示
ネストされたスキーマ: sys
デフォルト値: oracle.doceng.json.BetterJsonNull@51bc649e
1つに一致
ソースの表示
ネストされたスキーマ: table
デフォルト値: false
1つに一致
ソースの表示
ネストされたスキーマ: tokens
デフォルト値: oracle.doceng.json.BetterJsonNull@32050628
1つに一致
ソースの表示
ネストされたスキーマ: transInd
デフォルト値: false
1つに一致
ソースの表示
ネストされたスキーマ: xid
デフォルト値: true
1つに一致
ソースの表示
ネストされたスキーマ: env-x-oneOf[1]
型: object
ネストされたスキーマ: sys-x-oneOf[1]
型: object
ネストされたスキーマ: tokens-x-oneOf[1]
型: object
ネストされたスキーマ: items
型: object
データ・ストリーミング・ルール
ソースの表示
ネストされたスキーマ: filter
データ・ストリーム・ルール・フィルタ
1つに一致
ソースの表示
ネストされたスキーマ: filter-x-oneOf[0]
型: object
データ・レコード・オブジェクト名
ソースの表示
ネストされたスキーマ: filter-x-oneOf[1]
型: object
データ・レコード操作タイプ
ソースの表示
ネストされたスキーマ: filter-x-oneOf[2]
型: object
データ・レコードの列の値
ソースの表示
ネストされたスキーマ: filter-x-oneOf[3]
型: object
データ・レコードのタグ
ソースの表示
ネストされたスキーマ: filter-x-oneOf[4]
型: object
データ・レコードのパーティション名
ソースの表示
ネストされたスキーマ: filter-x-oneOf[5]
型: object
データ・レコードのユーザー・トークン
ソースの表示
ネストされたスキーマ: objectNames
型: array
最小アイテム数: 1
最大アイテム数: 65535
一連のオブジェクト名
ソースの表示
  • items
    修飾された表名(すべての名前コンポーネントがワイルドカード文字を含むことができる)
ネストされたスキーマ: items
修飾された表名(すべての名前コンポーネントがワイルドカード文字を含むことができる)
いずれかに一致
ソースの表示
  • 最小長: 3
    最大長: 261
    パターン: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • 最小長: 5
    最大長: 392
    パターン: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
ネストされたスキーマ: operationTypes
型: array
最小アイテム数: 1
最大アイテム数: 6
操作タイプのセット
ソースの表示
  • 指定できる値: [ "DML", "DDL", "INSERT", "UPDATE", "UPSERT", "DELETE" ]
ネストされたスキーマ: columnValues
型: array
最小アイテム数: 1
最大アイテム数: 65535
一連の列値
ソースの表示
ネストされたスキーマ: items
型: object
ソースの表示
  • 最小長: 1
    最大長: 130
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])$
    列の名前
  • columnValue
    列データ。現在は文字と2進整数の型のみがサポートされています
  • デフォルト値: before
    指定できる値: [ "before", "after" ]
    列のビフォア・イメージまたはアフター・イメージ。INSERTはアフター・イメージのみ、DELETEはビフォア・イメージのみです。ビフォア・イメージとアフター・イメージの両方があるケースに適用されます。
  • デフォルト値: equalTo
    指定できる値: [ "equalTo", "notEqualTo", "lessThan", "lessThanOrEqualTo", "greaterThan", "greaterThanOrEqualTo" ]
    比較演算子
  • tableName
    列が存在する表の名前
ネストされたスキーマ: columnValue
列データ。現在は文字と2進整数の型のみがサポートされています
1つに一致
ソースの表示
ネストされたスキーマ: tableName
列が存在する表の名前
いずれかに一致
ソースの表示
  • 最小長: 3
    最大長: 261
    パターン: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • 最小長: 5
    最大長: 392
    パターン: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
ネストされたスキーマ: tags
バイナリ・タグのセット
1つに一致
ソースの表示
  • tags-x-oneOf[0]
    最小アイテム数: 1
    最大アイテム数: 32767
  • 指定できる値: [ "all", "none" ]
ネストされたスキーマ: tags-x-oneOf[0]
型: array
最小アイテム数: 1
最大アイテム数: 32767
ソースの表示
ネストされたスキーマ: items
1つに一致
ソースの表示
ネストされたスキーマ: items-x-oneOf[0]
型: object
タグ値を表すバイナリ文字列。
ソースの表示
ネストされたスキーマ: items-x-oneOf[1]
型: object
タグ値を表す16進文字列。
ソースの表示
ネストされたスキーマ: items-x-oneOf[2]
型: object
バイナリ・タグ・ビットマスク値。ビットAND演算子が、LCRに関連付けられたタグに対して実行されます。
ソースの表示
  • 最小長: 1
    最大長: 2000
    パターン: ^[01]{1,2000}$
    タグ・マスク値を表すバイナリ文字列。
ネストされたスキーマ: items-x-oneOf[3]
型: object
16進タグ・ビットマスク値。ビットAND演算子が、LCRに関連付けられたタグに対して実行されます。
ソースの表示
  • 最小長: 1
    最大長: 2000
    パターン: ^[A-Fa-f0-9]{1,2000}$
    タグ・マスク値を表す16進文字列。
ネストされたスキーマ: partitionNames
型: array
最小アイテム数: 1
最大アイテム数: 65535
一連のパーティション名
ソースの表示
  • items
    修飾されたパーティション名(すべての名前コンポーネントがワイルドカード文字を含むことができる)
ネストされたスキーマ: items
修飾されたパーティション名(すべての名前コンポーネントがワイルドカード文字を含むことができる)
いずれかに一致
ソースの表示
  • 最小長: 7
    最大長: 523
    パターン: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • 最小長: 5
    最大長: 392
    パターン: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
ネストされたスキーマ: userTokens
型: array
最小アイテム数: 1
最大アイテム数: 65535
ユーザー・トークンのセット
ソースの表示
ネストされたスキーマ: items
型: object
ソースの表示
  • デフォルト値: exactCaseSensistive
    指定できる値: [ "exactCaseSensitive", "exactCaseInsensitive", "partialCaseSensitive", "partialCaseInsensitive" ]
    フィルタ値の照合方法
  • 最小長: 1
    最大長: 30
    ユーザー・トークン名
  • 最小長: 1
    最大長: 32767
    ユーザー・トークン値
リクエストの例(application/json)
{
    "source":"trail://localhost:9012/services/v2/sources?trail=a1",
    "begin":"earliest",
    "$schema":"ogg:dataStream"
}
先頭に戻る

レスポンス

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

200レスポンス

本文()
ルート・スキーマ: RESTful API Standard Response
型: object
タイトル: RESTful API Standard Response
すべてのOracle GoldenGate RESTful APIコールの標準レスポンス
ソースの表示
ネストされたスキーマ: messages
型: array
最小アイテム数: 0
最大アイテム数: 65535
リクエストの間に発行されるGoldenGateメッセージ
ソースの表示
ネストされたスキーマ: response
型: object
リクエストのOracle GoldenGateドキュメント
ネストされたスキーマ: items
型: object
ソースの表示
  • 指定できる値: [ "ogg:message" ]
  • 最小長: 9
    最大長: 9
    パターン: ^OGG[-][0-9]{5}$
    Oracle GoldenGateメッセージ・コード
  • 最小長: 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])$
    メッセージが発行された日時
  • 指定できる値: [ "INFO", "WARNING", "ERROR" ]
    メッセージの重大度
  • 最小長: 1
    最大長: 4095
    この情報、警告またはエラーに固有の情報と詳細を提供する、人が読むための説明。
  • 最小長: 2
    最大長: 4095
    パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    情報、警告またはエラーのタイプを説明するページの絶対URI [RFC3986]。
レスポンスの例(application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "rel":"canonical",
            "href":"http://localhost:9002/services/v2/stream/mystream1",
            "mediaType":"application/json"
        },
        {
            "rel":"self",
            "href":"http://localhost:9002/services/v2/stream/mystream1",
            "mediaType":"application/json"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "title":"The data stream 'mystream1' has been updated.",
            "code":"OGG-08605",
            "severity":"INFO",
            "issued":"2021-05-05T23:24:38Z",
            "type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-08605"
        }
    ]
}
先頭に戻る