機能コード

ファンクション・コードは、コールバック・ルーチンの出力を決定します。コールバック・ルーチンは、データ・バッファの内容が指定されたファンクション・コードの構造体と一致するとみなします。コールバック・ルーチン・ファンクション・コードとそのデータ・バッファは、次の項で説明します。次に、使用可能なファンクションの概要を示します。

表5 Oracle GoldenGateファンクション・コードの概要

機能コード	摘要
`COMPRESS_RECORD`	`COMPRESS_RECORD`ファンクションは、マッピングの後にターゲット表の列がすべてでなく一部だけ存在する場合で、個々の列値ではなくレコード全体を操作する必要があるときに使用します。
`DECOMPRESS_RECORD`	`DECOMPRESS_RECORD`ファンクションは、マッピングの後にターゲット表の列がすべてでなく一部だけ存在する場合で、個々の列値ではなくレコード全体を操作する必要があるときに使用します。
`GET_BASE_OBJECT_NAME`	`GET_BASE_OBJECT_NAME`ファンクションでは、レコード内のオブジェクトのベース・オブジェクトを完全修飾名で取得します。
`GET_BASE_OBJECT_NAME_ONLY`	`GET_BASE_OBJECT_NAME_ONLY`ファンクションでは、レコード内のオブジェクトのベース・オブジェクトの名前のみを取得します。
`GET_BASE_SCHEMA_NAME_ONLY`	`GET_BASE_SCHEMA_NAME_ONLY`ファンクションでは、レコード内オブジェクトのベース・オブジェクトのスキーマの名前のみを取得します。
`GET_BEFORE_AFTER_IND`	`GET_BEFORE_AFTER_IND`ファンクションでは、レコードがデータベース操作のビフォア・イメージかアフター・イメージかを確認します。
`GET_CATALOG_NAME_ONLY`	`GET_CATALOG_NAME_ONLY`ファンクションでは、データベース・カタログの名前を返します。
`GET_COL_METADATA_FROM_INDEX`	`GET_COL_METADATA_FROM_INDEX`ファンクションでは、特定の列索引に関連付けられている列メタデータを確認します。
`GET_COL_METADATA_FROM_NAME`	`GET_COL_METADATA_FROM_NAME`ファンクションでは、特定の列名に関連付けられている列メタデータを確認します。
`GET_COLUMN_INDEX_FROM_NAME`	`GET_COLUMN_INDEX_FROM_NAME`ファンクションでは、特定の列名に関連付けられている列索引を確認します。
`GET_COLUMN_NAME_FROM_INDEX`	`GET_COLUMN_NAME_FROM_INDEX`ファンクションでは、特定の列索引に関連付けられている列名を確認します。
`GET_COLUMN_VALUE_FROM_INDEX`	`GET_COLUMN_VALUE_FROM_INDEX`ファンクションでは、指定する列索引を使用して、データ・レコードから列値を返します。
`GET_COLUMN_VALUE_FROM_NAME`	`GET_COLUMN_VALUE_FROM_NAME`ファンクションでは、特定の列名を使用して、データ・レコードから列値を返します。
`GET_DATABASE_METADATA`	`GET_DATABASE_METADATA`ファンクションでは、データベース・メタデータを返します。
`GET_DDL_RECORD_PROPERTIES`	`GET_DDL_RECORD_PROPERTIES`ファンクションでは、`DDL`操作に関する情報を返します。
`GET_ENV_VALUE`	`GET_ENV_VALUE`ファンクションでは、Oracle GoldenGate環境に関する情報を返します。
`GET_ERROR_INFO`	`GET_ERROR_INFO`ファンクションでは、破棄レコードに関連付けられているエラー情報を返します。
`GET_GMT_TIMESTAMP`	`GET_GMT_TIMESTAMP`ファンクションでは、操作コミット・タイムスタンプをGMTフォーマットで返します。
`GET_MARKER_INFO`	`GET_MARKER_INFO`ファンクションでは、データを送信するときにマーカー情報を返します。マーカーは、ユーザー・イグジット内でカスタム処理をトリガーするために使用します。
`GET_OBJECT_NAME`	処理中のレコードと関連付けられている表または他のオブジェクトの2つまたは3つの部分からなる完全修飾名を戻します。
`GET_OBJECT_NAME_ONLY`	処理中のレコードと関連付けられている表または他のオブジェクトの修飾されていない名前を戻します。
`GET_OPERATION_TYPE`	`GET_OPERATION_TYPE`ファンクションでは、レコードに関連付けられている操作のタイプを確認します。
`GET_POSITION`	`GET_POSITION`ファンクションでは、Oracle GoldenGateトレイル内のExtractデータ・ポンプまたはReplicatの読取り位置を取得します。
`GET_RECORD_BUFFER`	`GET_RECORD_BUFFER`ファンクションでは、カスタム列変換に関する情報を取得します。
`GET_RECORD_LENGTH`	`GET_RECORD_LENGTH`ファンクションでは、データ・レコードの長さを返します。
`GET_RECORD_TYPE`	`GET_RECORD_TYPE`ファンクションでは、処理されているレコードのタイプを返します。
`GET_SCHEMA_NAME_ONLY`	`GET_SCHEMA_NAME_ONLY`ファンクションでは、表のスキーマ名のみを返します。
`GET_SESSION_CHARSET`	`GET_SESSION_CHARSET`ファンクションでは、ユーザー・イグジット・セッションの文字セットを返します。
`GET_STATISTICS`	`GET_STATISTICS`ファンクションでは、ExtractまたはReplicatプロセスの現在の処理統計を返します。
`GET_TABLE_COLUMN_COUNT`	`GET_TABLE_COLUMN_COUNT`ファンクションでは、表内の列の合計数を返します。
`GET_TABLE_METADATA`	`GET_TABLE_METADATA`ファンクションでは、処理中のレコードに関連付けられている表のメタデータを返します。
`GET_TABLE_NAME`	`GET_TABLE_NAME`ファンクションでは、処理中のレコードと関連付けられているソースまたはターゲット表の2つまたは3つの部分からなる完全修飾名を戻します。
`GET_TABLE_NAME_ONLY`	`GET_TABLE_NAME_ONLY`ファンクションでは、処理中のレコードに関連付けられている表の修飾されていない名前のみを返します。
`GET_TIMESTAMP`	`GET_TIMESTAMP`ファンクションでは、ソース・データ・レコードに関連付けられているI/Oタイムスタンプを返します。
`GET_TRANSACTION_IND`	`GET_TRANSACTION_IND`ファンクションでは、データ・レコードがトランザクションの最初、最後、または中間の操作かを確認します。
`GET_USER_TOKEN_VALUE`	`GET_USER_TOKEN_VALUE`ファンクションでは、トレイル・レコードからユーザー・トークン値を取得します。
`OUTPUT_MESSAGE_TO_REPORT`	`OUTPUT_MESSAGE_TO_REPORT`ファンクションでは、レポート・ファイルにメッセージを出力します。
`RESET_USEREXIT_STATS`	`RESET_USEREXIT_STATS`ファンクションでは、Oracle GoldenGateプロセスの統計をリセットします。
`SET_COLUMN_VALUE_BY_INDEX`	`SET_COLUMN_VALUE_BY_INDEX`ファンクションでは、データ・レコード全体を操作せず、単一の列値のみを変更します。
`@STRNCMP`	`SET_COLUMN_VALUE_BY_NAME`ファンクションでは、データ・レコード全体を操作せず、単一の列値のみを変更します。
`SET_OPERATION_TYPE`	`SET_OPERATION_TYPE`ファンクションでは、レコードに関連付けられている操作のタイプを変更します。
`SET_RECORD_BUFFER`	`SET_RECORD_BUFFER`ファンクションは、HP NonStopユーザー・イグジットとの互換性の維持、および複雑なデータ・レコード操作のために使用します。
`SET_SESSION_CHARSET`	`SET_SESSION_CHARSET`ファンクションでは、ユーザー・イグジット・セッションの文字セットを設定します。
`SET_TABLE_NAME`	`SET_TABLE_NAME`ファンクションでは、レコードに関連付けられている表名を変更します。