パラメータ・ファイルの使用

親トピック: 管理

管理クライアントを使用したパラメータ・ファイルの作成

パラメータ・ファイルを作成するには、管理クライアントからEDIT PARAMSコマンドを実行します。EDIT PARAMSでパラメータ・ファイルを作成すると、そのファイルはOracle GoldenGateディレクトリのdirprmサブディレクトリに保存されます。dirprm以外のディレクトリにパラメータ・ファイルを作成することは可能ですが、プロセス・グループの作成時にもADD EXTRACTまたはADD REPLICATコマンドのPARAMSオプションでそのフルパス名を指定する必要があります。パラメータ・ファイルは、ExtractグループまたはReplicatグループに一度関連付けたら、処理の開始後にOracle GoldenGateを適切に動作させるために、元の場所から移動しないでください。

EDIT PARAMSコマンドは、管理クライアントで次のテキスト・エディタを起動します。

Microsoft Windowsシステムの場合、メモ帳
UNIXおよびLinuxシステムの場合、viエディタSSHまたはxtermに接続されている場合、DB2 for iはviのみをサポートします。詳細は、テキスト・エディタでパラメータ・ファイルを作成する方法を参照してください。
ノート:
管理クライアントからデフォルト・エディタを変更するには、SET EDITORコマンドを使用します。
1. $OGG_HOME/binディレクトリから、管理クライアントを実行します。
2. CONNECTコマンドを使用して管理クライアントに接続します。
3. 管理クライアントで次のコマンドを発行して、デフォルトのテキスト・エディタを開きます。
```
EDIT PARAMS group_name
```
  説明:
  - group_nameは、ファイルが作成されるExtractまたはReplicatグループの名前です。ExtractまたはReplicatパラメータ・ファイルの名前は、プロセス・グループの名前と一致している必要があります。次の場合、extoraという名前のExtractグループのパラメータ・ファイルが作成または編集されます。
```
EDIT PARAMS extora
```
4. テキスト・エディタの編集機能を使用して、このファイルを説明するコメント行を必要な数だけ入力します(各コメント行の先頭には必ず2つのハイフン(--)を挿入してください)。
5. コメント以外の行に、Oracle GoldenGateのパラメータを入力します(パラメータ文ごとに新しい行を開始します)。
  Oracle GoldenGateのパラメータの構文は次のとおりです。
```
PARAMETER_NAME argument [,option] [&] 
```
  説明:
  - PARAMETER_NAMEは、パラメータの名前です。
  - argumentは、パラメータの必須引数です。一部のパラメータには引数がありますが、その他のパラメータにはありません。引数間のカンマはオプションです。
    EXTRACT myext USERIDALIAS ogg1 ENCRYPT AES192 KEYNAME mykey ENCRYPTTRAIL AES 192 EXTTRAIL ./dirdat/c1, PURGE CUSEREXIT userexit.dll MyUserExit, INCLUDEUPDATEBEFORES, & PARAMS "init.properties" TABLE myschema.mytable;
  - [,option]は、オプション引数です。
  - [&]は、前述の例のCUSEREXITパラメータ文のように、複数行にわたるパラメータ文の各行の最後に必要です。ただし、次のものはセミコロンで終わるため、アンパサンドの指定は可能ですが必須ではなく、例外となります。
    - MAP
    - TABLE
    - SEQUENCE
    - FILE
    - QUERY
  ノート:
  RMTHOSTおよびRMTHOSTOPTIONSパラメータを一緒に指定できます。動的IP割当てが適切に構成されている場合、RMTHOSTパラメータはRMTHOSTOPTIONSに必要ではありません。RMTHOSTOPTIONSが使用されている場合、MGRPORTオプションは無視されます。
6. 保存してファイルを閉じます。

テキスト・エディタでパラメータ・ファイルを作成する方法

親トピック: パラメータ・ファイルの使用

テキスト・エディタでパラメータ・ファイルを作成する方法

テキスト・エディタを使用して管理クライアントの外部でパラメータ・ファイルを作成できますが、次の点に注意してください。

パラメータ・ファイルは、所有するExtractまたはReplicatグループの名前で保存します。.prmというファイル拡張子を使用します。たとえば、exte.prmです。
パラメータ・ファイルは、Oracle GoldenGateホーム・ディレクトリのdirprmディレクトリに保存します。

親トピック: 管理クライアントを使用したパラメータ・ファイルの作成

パラメータ・ファイルの検証

パラメータ・ファイルは、Administration ServiceのWebインタフェースから検証できます。「レポート」タブからExtractおよびReplicatパラメータを検証できます。「レポート」タブにアクセスするには:

Administration Serviceの「概要」ページの「Extract」または「Replicat」セクションで、「アクション」をクリックし、「詳細」をクリックします。
「レポート」タブをクリックして、ExtractおよびReplicatのパラメータ、エラー・ログおよびその他の情報のレポートを表示します。

Extractパラメータの確認および編集の詳細は、「Extractの詳細へのアクセス」を参照してください。Replicatパラメータ・ファイルの編集の詳細は、Replicatプロセスの詳細へのアクセスを参照してください。「統合Replicat用のその他のパラメータ・オプション」も参照してください

コマンド行から実行するcheckprm検証用ネイティブ・コマンドを使用し、構成可能なアプリケーションと実行環境を使用して、指定されたパラメータ・ファイルのアセスメントを提供することもできます。単純にPASS/FAILを表示するか、各パラメータの値がどのように格納され解釈されるかに関する詳細を追加して表示することもできます。

CHECKPRM実行可能ファイルは、Microservices Architectureの$OGG_HOME/binディレクトリにあります。『Oracle GoldenGateリファレンス』のcheckprmを参照してください。checkprmへの入力は大/小文字を区別しません。値文字列にスペースが含まれている場合、checkprmは意味のある値を認識できるので、引用符で囲む必要はありません。checkprmにモードが指定されていない場合は、コンポーネントのあらゆるモードに適用可能なすべてのパラメータが使用されます。

checkprmの出力は、想定される次の4つのセクションにまとめられます。

ヘルプ・メッセージ
事前検証エラー
検証結果
パラメータの詳細

一般に事前検証エラーとは、通常のパラメータ検証が実行できなくなるエラー(オプションの欠落やアクセス不可能なパラメータ・ファイルなど)のことです。オプションの値が間違って指定されている場合、そのオプションに対して考えられる入力のリストが表示されます。結果がFAILの場合、各エラーが最終結果メッセージに表示されます。結果がPASSの場合、一部のパラメータに対してさらに実行時検証が行われることを示すメッセージが表示されます。パラメータの詳細出力には、検証コンテキストと指定されたパラメータが含まれます。パラメータとオプションは、これらの関係がわかるよう、適切にインデントして出力されます。

「CHECKPARAMS」パラメータを参照してください。

親トピック: パラメータ・ファイルの使用

パラメータ・ファイルの作成の簡略化

次の時間節約ツールを使用することで、パラメータを指定する回数を減らすことができます。

トピック:

親トピック: パラメータ・ファイルの使用

ワイルドカードの使用

オブジェクト名を使用するパラメータの場合、アスタリスク(*)および疑問符(?)のワイルドカードを使用できます。ワイルドカードを使用することで、多数のオブジェクト名または特定のスキーマ内のすべてのオブジェクトを指定する必要がなくなります。ワイルドカードの使用方法の詳細は、「データベース・オブジェクト名でのワイルドカードの使用」を参照してください。

親トピック: パラメータ・ファイルの作成の簡略化

OBEYの使用

よく使用するパラメータ設定が含まれるテキスト・ファイルのライブラリを作成し、その後、OBEYパラメータを使用して、アクティブなパラメータ・ファイルからそれらのファイルを呼び出すことができます。OBEYの構文は次のとおりです。

OBEY file_name

説明:

file_nameは、ファイルの相対名またはフルパス名です。

Oracle GoldenGateは、アクティブなパラメータ・ファイル内でOBEYパラメータを検出すると、その参照先ファイルのパラメータを処理してから、アクティブなファイルに戻って残りのパラメータを処理します。GLOBALSパラメータ・ファイルではOBEYはサポートされていません。

OBEYパラメータを含むパラメータ・ファイルでCHARSETパラメータを使用する場合、参照先のパラメータ・ファイルはCHARSETの文字セットを継承しません。CHARSETの文字セットは参照先ファイル内のワイルドカードを使用したオブジェクト名の読取りに使用しますが、参照先ファイルにおけるその他すべてのマルチバイト指定については、エスケープ・シーケンス(\uX)を使用する必要があります。

OBEYの詳細は、『Oracle GoldenGateリファレンス』を参照してください。

CHARSETの詳細は、『Oracle GoldenGateリファレンス』を参照してください。

親トピック: パラメータ・ファイルの作成の簡略化

マクロの使用

マクロを使用して、パラメータ文を自動的に複数回使用できます。「Oracle GoldenGateマクロによる作業の簡略化および自動化」を参照してください。

親トピック: パラメータ・ファイルの作成の簡略化

パラメータ置換の使用

パラメータ置換を使用すると、パラメータ・ファイルの作成時に静的な値を割り当てるかわりに、実行時に自動的にOracle GoldenGateのパラメータに値を割り当てることができます。この方法であれば、実行ごとに値が変化する場合に、パラメータ・ファイルを編集したり、異なる設定を含む複数のファイルを管理する必要がなくなります。必要な値は、実行時に簡単にエクスポートできます。パラメータ置換は、任意のOracle GoldenGateプロセスで使用できます。

パラメータ置換を使用する手順

置換を実行する各パラメータに対して、値のかわりにランタイム・パラメータを宣言します。次の例のように、ランタイム・パラメータ名の前に疑問符(?)を付けます。
```
SOURCEISFILE
EXTFILE ?EXTFILE
MAP scott?TABNAME, TARGET tiger ACCOUNT_TARG;
```
Oracle GoldenGateプロセスを起動する前に、次の例で示すように、オペレーティング・システムのシェルを使用して環境変数によってランタイム値を渡します。

例11-2 Windowsでのパラメータ置換

C:\GGS> set EXTFILE=C:\ggs\extfile
C:\GGS> set TABNAME=PROD.ACCOUNTS
C:\GGS> replicat paramfile c:\ggs\dirprm\parmfl

例11-3 UNIX (Kornシェル)でのパラメータ置換

$ EXTFILE=/ggs/extfile
$ export EXTFILE
$ TABNAME=PROD.ACCOUNTS
$ export TABNAME
$ replicat paramfile ggs/dirprm/parmfl

UNIXでは、大/小文字が区別されるため、大/小文字の使用については、パラメータ・ファイルのパラメータ宣言とシェルの変数割当てで同じである必要があります。

親トピック: パラメータ・ファイルの作成の簡略化