SharePlex 11.4 - リファレンス・ガイド

stop

stopコマンドは、SharePlexレプリケーションプロセスを正常に停止し、関連するキューからの読み取りまたはキューへの書き込みを終了させるために使用します。レプリケーションプロセスが停止すると、データがキューに安全に蓄積されます。

stopコマンドで中断されたプロセスは、SharePlexをシャットダウンして再起動しても、停止したままになります。このプロセスは、startコマンドでのみ開始できます。プロセスが再び開始されると、停止した時点から処理が再開されるため、データは同期された状態を維持します。

注意: stopコマンドはabort serviceコマンドとは異なり、プロセスが関連するキューからの読み取りまたは書き込みを終了した後にレプリケーションプロセスを停止します。abort serviceコマンドは、プロセスがデータ処理中であるか否かにかかわらず、即座にプロセスを終了します。

Captureプロセスの停止

Captureプロセスを停止するときは注意してください。

以下のような場合に、ソースとターゲットのデータが同期しなくなる可能性があります。

• Captureが停止している間にユーザがソースデータの変更を続けた場合

  および…

• OracleのREDOログがその間にラップされた場合

  および…

• アーカイブログが利用できなくなった場合

特定の時点でのPostの停止

Postプロセスの停止のタイミングを制御するには、いずれかの[at sourcetime]オプションを使用します。これらのいずれかのオプションは、指定された時刻または日時のスタンプが付いた最初のメッセージを受信すると、自動的にPostを停止します。それ以降のメッセージは、Postが再開されるまでpostキューに蓄積されます。

[at sourcetime]オプションは、ジョブがソースシステムでスケジューリングされているときに、その操作が、ターゲットデータベースへの適用前にソースシステムで成功したことを確認する場合に使用できます。Postを停止するオプションは、ジョブの実行直前に設定します。

このオプションは、ターゲットシステム上でレポートを実行しているときに、Post操作の競合によりオーバーヘッドが発生しないようにする場合にも使用できます。

SharePlexは同期していないため、ターゲットシステム上でPostが実際に停止する時刻は、おそらく操作のタイムスタンプよりも後になります。このタイミングは、先行するメッセージをキューにポストするために必要な時間に左右されます。

用途

構文

構文の説明

リモートオプション

これらのオプションにより、リモートマシンにコマンドを発行したり、ログイン名、パスワード、ポート番号、またはそれらの組み合わせを含むコマンドをスクリプト化したりすることができます。

target

Target（ターゲット）

targetコマンドは、Postが特定のタイプのターゲットをサポートするよう設定するために使用します。これはターゲットの設定と呼ばれます。ターゲット設定に保存されているプロパティは、Postがレプリケートされたデータをどのように処理して、フォーマットし、出力するかを制御します。

targetコマンドは、ターゲットの設定をリセットしたり表示したりするオプションも提供します。

targetコマンドは、グローバルレベルでも、またqueueオプションが使用されている場合にはプロセスごとのレベルでも、ターゲット設定を制御するために使用することができます。

重要: このコマンドを使用した後は、必ずPostプロセスを停止してから再度開始してください。

用途

構文

構文の説明

カテゴリの説明

CDCカテゴリ

サポート対象のターゲット

Oracle変更履歴ターゲット

コマンドオプション

target c.SID [queue queuename]

table tablename

{

set cdc preimage={yes | no}

reset cdc

show cdc

}

用途

特定のテーブルのSP_OPO_TRACK_PREIMAGEパラメーターで設定されている更新のグローバル設定をオーバーライドします。これは、更新操作の更新前イメージを履歴テーブルで追跡するかどうかを制御します。有効な値は、更新前イメージを追跡する場合はyes、更新前イメージを除外する場合はnoです。

charactersetカテゴリ

サポート対象のターゲット

Open Targetデータベース

コマンドオプション

target r.database [queue queuename]

{

set characterset character_set |

reset characterset character_set |

show characterset character_set

}

用途

ターゲットデータベースにポストする前に、レプリケートされたデータをローカルのOracleクライアントに送信し、指定された文字セットに変換するようPostプロセスに指示します。指定された文字セットは、Open Targetターゲットに文字データを投稿するときにPostで使用されるUnicodeのデフォルトの文字セットをオーバーライドします。

UTF8からUTF8の絵文字のレプリケーションは、OracleからOpen Posterでは問題なく機能します。ただし、UTF8形式ではない（CESU8など）Oracleソースデータベースに絵文字を挿入する場合、このようなシナリオでは、非Oracleターゲットに絵文字をレプリケートするためにターゲットSharePlexインスタンスに以下の設定を適用する必要があります。

1. データ変換のターゲットにOracleクライアントをインストールします。

2. SP_OPX_NLS_CONVERSIONパラメーターを1（デフォルト）に設定します。

3. ターゲットDBに必要な有効なUTF8バイトシーケンスにデータを変換するために、targetコマンドを使用してターゲット文字セットをAL32UTF8に設定します。

注意: このオプションを使用するには、ターゲットシステム上にOracleクライアントが存在しなければなりません。詳細については、SharePlexインストールおよびセットアップガイドの「Open Targetのチェックリスト」のセクションを参照してください。

例

GB2312文字セットのデータをターゲットにポストするには、OracleのZHS16GBK文字セットを指定します。

target r.mymss set characterset ZHS16GBK

fileカテゴリ

サポート対象のターゲット

ファイル

コマンドオプション

target x.file [queue queuename]

{

set file property=value |

reset file [property] |

show file

}

用途

ファイルターゲットのプロパティを設定します。

例

target x.file set file max_size=320

formatカテゴリ

サポート対象のターゲット

ファイル

kafka

コマンドオプション

target x.{file | kafka} [queue queuename]

{

set format property=value |

reset format [property] |

show format

}

用途

ターゲットに書き込むデータの形式を設定します。

例

target x.file set format record=sql

target x.kafka set format record=json

出力形式の説明

以下は、format record=record_formatが提供する出力形式の説明です。

SQLレコードの形式

SQL形式のファイルの各トランザクションは、SQLファイル内のトランザクションシーケンスと一意のトランザクションIDを含むコメントで始まります。SQLファイルの末尾にあるコメント行にはファイル内の行数が表示されます。例えば、以下は1つのトランザクションを持つSQLファイルです。この例では、トランザクションIDは2-113319です。ファイルには9つの行があります。

/installed/vardir> cat opx/0000000010_20140305140820_legacy.sql

-- 0000000001 2-113319 03052014140813 03052014140813

DELETE FROM "ROBIN"."TEST_TYPES" WHERE ORA_NUMBER = '22345' AND ROWNUM = 1;

INSERT INTO "ROBIN"."TEST_TYPES" (ORA_NUMBER, ORA_DATE, ORA_RAW, ORA_ROWID,

ORA_FLOAT, ORA_CHAR, ORA_VARCHAR2, ORA_TIMESTAMP, ORA_TIMESTAMP_TZ,

ORA_TIMESTAMP_LTZ) VALUES('22345', '08132066000000', '0123456789ABCDEF'

, 'AAAAAAAAAAAAAAAAAA', '12350', 'Character ', 'Variable data'

, '10201998021300.22000', '06172002080000.00000', '06172002160000.00000');

COMMIT;

-- EOF 0000000009

XMLレコードの形式

XMLフォーマットは操作とスキーマの「型」に分けられ、より簡単に利用できるようになっています。XSDの観点から見ると、これらは実際には同じであり、別個の型ではありません。テンプレートXMLは、すべての可能な属性と要素を表します。個々のXMLは、サポートされている各操作の最小限の出力を表します。

起動後、Postが初めて任意のテーブルの変更レコードを書き込む場合は、まずそのテーブルのスキーマレコードを書き込みます。各スキーマレコードには、テーブル名と各列の詳細が含まれています。スキーマレコードは、スキーマに変更がない限り、Postの実行中に各テーブルに対して1回だけ書き込まれ、その後は新しいスキーマレコードが書き込まれます。Postが停止し、開始すると、Postが各テーブルの変更レコードを受信するたびに、スキーマレコードが再度書き込まれます。

スキーマレコードのテンプレート

<?xml version="1.0" encoding="UTF-8" ?>  
<?opentarget version="1.0" ?>  
<opentarget>  
    <txn  
        id="xs:integer"  
        oracleTxnId="xs:string"   
        commitTime="xs:dateTimeStamp" />  
    <tbl  
        name="xs:string"  
        utcOffset="xs:integer"
        <cmd ops="schema">  
            <schema>  
                <col  
                    name="xs:string"  
                    xmlType="xs:string"  
                    key="xs:boolean"  
                    nullable="xs:boolean"  
                    length="xs:integer"  
                  />  
            </schema>  
        </cmd>  
    </tbl>  
</opentarget>

表1: スキーマテンプレートの説明（* =オプション）

操作レコードテンプレート

<?xml version="1.0" encoding="UTF-8" ?>
<?opentarget version="1.1" ?>
<opentarget>
    <txn
        id="xs:integer" 
        msgIdx="xs:integer" 
        msgTot="xs:integer" 
        oracleTxnId="xs:string"
        commitTime="xs:dateTimeStamp"
        userId="xs:string" />

    <tbl 
        name="xs:string"
        <cmd ops="xs:string">
            <row id="xs:string">
                <col name="xs:string"></col>
                <lkup>
                    <col name="xs:string"></col>
                </lkup>
            </row>
        </cmd>
    </tbl>
</opentarget>

表2: 操作テンプレートの説明（* =オプション）

注意: idおよびmsgIdx属性を組み合わせて操作を一意に識別します。

サポートされているデータ型

Oracleのデータ型をXMLに変換する方法を示すチャートについては、『SharePlexリリースノート』を参照してください。

サンプルXMLレコード

ソーステーブル

これはサンプル操作が生成されるテーブルです。

SQL> desc products

ソースDML操作

insert into products values (230117, ‘Hamsberry vintage tee, cherry’, 4099);
commit;
update products set price=3599 where product_id=230117 and price=4099;
commit;
delete products where product_id=230117;
commit;
truncate table products;

スキーマレコード

<?xml version="1.0" encoding="UTF-8"?>
<?opentarget version="1.1"?>
<opentarget>
<txn id="2218316945" commitTime="2014-10-10T13:18:43" userId="85" oracleTxnId="3.10.1339425" />
<tbl name="MFG.PRODUCTS" utcOffset="-5:00">
<cmd ops="schema">
<schema>
<col name="PRODUCT_ID" xmlType="decimal" key="true" nullable="false" length="22" />
<col name="DESCRIPTION" xmlType="string" key="false" nullable="true" length="600" />
<col name="PRICE" xmlType="decimal" key="false" nullable="true" length="22" />
</schema>
</cmd>
</tbl>
</opentarget>

挿入レコード

<?xml version="1.0" encoding="UTF-8"?>
<?opentarget version="1.1"?>
<opentarget>
<txn id="2218316945" msgIdx="1" msgTot="1" commitTime="2014-10-10T13:18:43" userId="85" oracleTxnId="3.10.1339425" />
<tbl name="MFG.PRODUCTS">
<cmd ops="ins">
<row id="AAAmDbAAEAAApRrAAA">
<col name="PRODUCT_ID">230117</col>
<col name="DESCRIPTION">Hamsberry vintage tee, cherry</col>
<col name="PRICE">4099</col>
</row>
</cmd>
</tbl>
</opentarget>

更新レコード

<?xml version="1.0" encoding="UTF-8"?>
<?opentarget version="1.1"?>
<opentarget>
<txn id="2218318728" msgIdx="1" msgTot="1" commitTime="2014-10-10T13:19:12" userId="85" oracleTxnId="1.17.970754" />
<tbl name="MFG.PRODUCTS">
<cmd ops="upd">
<row id="AAAmDbAAEAAApRrAAA">
<col name="PRICE">3599</col>
<lkup>
<col name="PRODUCT_ID">230117</col>
<col name="PRICE">4099</col>
</lkup>
</row>
</cmd>
</tbl>
</opentarget>

削除レコード

<?xml version="1.0" encoding="UTF-8"?>
<?opentarget version="1.1"?>
<opentarget>
<txn id="2218319446" msgIdx="1" msgTot="1" commitTime="2014-10-10T13:19:25" userId="85" oracleTxnId="5.23.1391276" />
<tbl name="MFG.PRODUCTS">
<cmd ops="del">
<row id="AAAmDbAAEAAApRrAAA">
<lkup>
<col name="PRODUCT_ID">230117</col>
</lkup>
</row>
</cmd>
</tbl>
</opentarget>

トランケートレコード

<?xml version="1.0" encoding="UTF-8"?>
<?opentarget version="1.1"?>
<opentarget>
<txn id="2218319938" commitTime="1988-01-01T00:00:00" userId="85" oracleTxnId="11.4.939801" />
<tbl name="MFG.PRODUCTS">
<cmd ops="trunc" />
</tbl>
</opentarget>

JSONレコードの形式

注意: これは、出力を読みやすくするために使用したtarget x.kafka set json indent=2を除き、デフォルトの出力です。

これはサンプル操作が生成されるテーブルです。

SQL> desc products

ソースDMLの操作

insert into products values (230117, ‘Hamsberry vintage tee, cherry’, 4099); 
commit;
update products set price=3599 where product_id=230117 and price=4099;
commit;
delete products where product_id=230117;
commit;
truncate table products;

スキーマレコード

{
  "meta":{
    "op":"schema",
    "table":""
  },
  "schema":{
    "name":"BILL.PRODUCTS",
    "utcOffset":"-7:00",
    "PRODUCT_ID":{
      "jsonType":"decimal",
      "num":1,
      "key":1,
      "nullable":1,
      "length":22,
      "precision":0,
      "scale":0,
      "src_name":"PRODUCT_ID"
    },
    "DESCRIPTION":{
      "jsonType":"string",
      "num":2,
      "key":1,
      "nullable":1,
      "length":600,
      "precision":0,
      "scale":0,
      "src_name":"DESCRIPTION"
    },
    "PRICE":{
      "jsonType":"decimal",
      "num":3,
      "key":1,
      "nullable":1,
      "length":22,
      "precision":0,
      "scale":0,
      "src_name":"PRICE"
    }
  }
}

レコードの挿入

{
  "meta":{
    "op":"ins",
    "table":"BILL.PRODUCTS"
  },
  "data":{
    "PRODUCT_ID":230117,
    "DESCRIPTION":"Hamsberry vintage tee, cherry",
    "PRICE":4099
  }
}

レコードの更新

{
  "meta":{
    "op":"upd",
    "table":"BILL.PRODUCTS"
  },
  "data":{
    "PRICE":3599
  },
  "key":{
    "PRODUCT_ID":230117,
    "DESCRIPTION":"Hamsberry vintage tee, cherry",
    "PRICE":4099
  }
}

レコードの削除

{
  "meta":{
    "op":"del",
    "table":"BILL.PRODUCTS"
  },
  "data":{
    "PRODUCT_ID":230117,
    "DESCRIPTION":"Hamsberry vintage tee, cherry",
    "PRICE":3599
  }
}

レコードの切り捨て

{
  "meta":{
    "op":"truncate",
    "table":"BILL.PRODUCTS"
  }
}

JMSカテゴリ

サポート対象のターゲット

JMS

コマンドオプション

target x.jms [queue queuename]

{

set jms property=value |

reset jms [property] |

show jms

}

用途

JMSターゲットのプロパティを設定します。

例

target x.jms set jms queuename=SharePlexJMS

JSONカテゴリ

サポート対象のターゲット

ファイル（format record=json）

Kafka（format record=json）

コマンドオプション

target x. {file | kafka } [queue queuename]

{

set json property=value |

reset json [property] |

show json

}

用途

format record =jsonのときのJSON出力のプロパティを設定します。

例

target x.kafka set json meta=no

kafkaカテゴリ

サポート対象のターゲット

kafka

コマンドオプション

target x.kafka [queue queuename]

{

set kafka property=value |

reset kafka [property] |

show kafka

}

用途

Kafkaターゲットのプロパティを設定します。

*レイテンシを避けるために、Postはそれ以上着信メッセージがないことを検知すると、しきい値が満たされるのを待たずにKafkaに即座にパケットを送信します。

例

sp_ctrl> target x.kafka set kafka broker=host1:9092,host2:9092,host3:9092

sp_ctrl> target x.kafka set kafka topic=shareplex

metadataカテゴリ

サポート対象のターゲット

Oracleレプリケーションターゲット

Oracle変更履歴ターゲット

HANAレプリケーションターゲット

ファイル

JMS

kafka

コマンドオプション

target {o.SID | c.SID | r.database | x.file | x.jms | x.kafka} [queue queuename]

{

set metadata [colname:]property[, ...] |

reset metadata |

show metadata

}

用途

set metadataを指定してtargetコマンドを使用すると、データベースターゲット、XMLまたはJSONファイルターゲット、JMSターゲット、Kafkaターゲットに設定されているデフォルトのメタデータプロパティをオーバーライドできます。これらのターゲットタイプはすべて、Postの出力にメタデータを提供します。

• OracleおよびHANAレプリケーションターゲット: メタデータをOracleおよびHANAレプリケーションターゲットに設定できます。メタデータの列はターゲット上に存在していなければなりません。SharePlexはメタデータ列を追加しません。
• Oracle変更履歴ターゲット: targetの指定がない場合、Postはデフォルトのメタデータ列を更新します。デフォルトのメタデータ列は、レプリケーションを開始する前にデフォルトの名前で存在していなければなりません。以下のテーブルでは、プロパティがデフォルトで変更履歴ターゲットに含まれている場合、デフォルトの列名がリストされます。set metadataを使用するのは、メタデータを追加したり、列にカスタム名を割り当てる場合のみです（colnameオプションを使用）。
• XML入力をサポートするターゲット（JMS、Kafka、ファイル）の場合、メタデータはXMLスキーマに従ってフォーマットされます。以下の表に示すように、特定のメタデータはデフォルトで出力に含まれます。set metadataを使う必要はありません。set metadataは、メタデータを追加する場合にのみ使用します。
• JSON入力をサポートするターゲットの場合（Kafka）、json meta=noを設定しない限り、opおよびtableプロパティがデフォルトで含まれます。

変更履歴ターゲットデータベースをサポートするためのSharePlexの設定については、『SharePlex管理者ガイド』を参照してください。

複数のメタデータプロパティを設定するには、カンマ区切りリストとして指定します。

JMSとKafkaのset metadataの例

以下では、ソースのIPアドレスまたはホスト名、SharePlexキューの名前、およびトランザクションの操作数をJMSターゲットの出力に追加するように、すべてのPostプロセスを設定しています。

target x.jms set metadata host, queue, size

または...

target x.kafka set metadata host, queue, size

Oracleのset metadataの例

以下の例では、操作の時刻とそれを実行したユーザIDをTimestampおよびUser列に追加するように、myqueue1キューに関連付けられたPostプロセスを設定しています。これらの列は、いずれも大文字と小文字が区別されるユーザ定義の名前です。

target c.targSID queue myqueue1 set metadata time:"Timestamp", userid:"User"

resourceカテゴリ

サポート対象のターゲット

すべてのターゲット

コマンドオプション

target {o. | r. | x. | c.} target [queue queuename]

{

set resources property=value |

reset resources [property] |

show resources [for datastore]

}

用途

ターゲットシステムのリソースに影響を与えるパラメーターを設定します。

例

target r.mydb queue q1 set resources commit_frequency=10000

target r.mydb queue q1 set resources max_active_statements=10

rule | filterカテゴリ

サポート対象のターゲット

Oracle変更履歴ターゲット

コマンドオプション

target c.SID [queue queuename]

table tablename

{

set {rule | filter} { 'column_condition' | !filename }

reset {rule | filter}

show {rule | filter}

}

用途

特定のテーブルに追跡ルールやフィルターを適用する条件文を指定します。UPDATE操作に適用されます。追跡するデータをターゲットテーブルに限定し、関心のないデータは除外する条件付きロジックを適用します。1つのターゲットテーブルごとに1つのruleまたはfilterだけを指定できますが、括弧を使用した入れ子にした式や、AND、OR、およびNOTの論理結合子と組み合わせてさまざまな条件を作成することができます。

注意: rule/filter機能では、バッチおよび直接ロード操作はサポートされていません。

例

これらのコマンドは、式を組み合わせてさまざまなルールを設定する方法の例を示しています。

target c.mySIDtable mytable set rule '(col3 is not changed) and (col5 is not changed)'

target c.mySIDtable mytable set rule '([col1, col3] matches change_list)'

target c.mySIDtable mytable set rule 'not ([col2, col5] contains change_list)'

次の表は、行を含めたり破棄したりするためにruleとfilterを機能させるさまざまな方法を示しています。

sourceカテゴリ

サポート対象のターゲット

Oracle変更履歴ターゲット

コマンドオプション

target c.SID [queue queuename]

{

set source sourceID |

reset source |

show source

}

用途

SHAREPLEX_SOURCE_IDメタデータ列のユーザ定義のソース識別子を設定します。set metadata sourceオプションを指定してtargetを使用し、この列を入力するようにPostを設定します。任意の英数字文字列を1つ指定します。

例

以下に、set sourceを使用して、複数のソースデータベースのデータを同じターゲットデータベースにレプリケートする設定をサポートするための方法を示します。このターゲットの設定により、各Postプロセスは、ターゲットデータベース内のデータを区別するために、ソースデータベースに応じて異なるソースIDでSHAREPLEX_SOURCE_ID列を更新します。この例では4つのPostプロセスを使用しています。

target c.target1 queue source718 set source east

target c.target1 queue source92 set source south

target c.target1 queue source101 set source west

target c.target1 queue source75 set source north

キュー「source718」のPostプロセスは、ストリーム内のテーブルへの挿入または更新のたびに、列SHAREPLEX_SOURCE_IDを値「east」で更新します。キュー「source92」のPostプロセスは、列SHAREPLEX_SOURCE_IDを値「south」で更新します。

SQLカテゴリ

サポート対象のターゲット

ファイル（format record=sql）

コマンドオプション

target x.file [queue queuename]

{

set sql property=value |

reset sql [property] |

show sql

}

用途

formatrecord=sqlのときのSQL出力のプロパティを設定します。

例

target x.file set sql comment=#

trace capture

trace captureコマンドは、Captureによる処理とパフォーマンスの統計情報をトレースファイルに出力するために使用します。

Captureのトレースには以下が含まれます。

• トレース自体の詳細
• Captureが、さまざまなタスク全体とスレッドごとに費やした時間

用途

構文

構文の説明

リモートオプション

これらのオプションにより、リモートマシンにコマンドを発行したり、ログイン名、パスワード、ポート番号、またはそれらの組み合わせを含むコマンドをスクリプト化したりすることができます。

出力

トレースが完了すると、プロセスは、変数データディレクトリのlogサブディレクトリにあるファイルにトレースデータを以下の形式で書き込みます。

例:

例

以下のコマンドは、データソースmyoraのトレースを1分間実行します。

trace capture 1 for myora

このコマンドは、以下のようなトレース出力を生成します。

trace post

trace postコマンドは、Postによる処理とパフォーマンスの統計情報をトレースファイルに出力するために使用します。

Postのトレースには以下が含まれます。

• トレース自体の詳細
• トランザクション活動に関する統計情報
• 操作タイプごとの詳細な統計情報

用途

構文

構文の説明

リモートオプション

これらのオプションにより、リモートマシンにコマンドを発行したり、ログイン名、パスワード、ポート番号、またはそれらの組み合わせを含むコマンドをスクリプト化したりすることができます。

出力

トレースが完了すると、プロセスは、変数データディレクトリのlogサブディレクトリにあるファイルにトレースデータを以下の形式で書き込みます。

例:

例

以下のコマンドは、データソースmyoraとmyora2のトレースを1分間実行します。

trace post 1 for myora-myora2

このコマンドは、以下のようなトレース出力を生成します。