DBMS_CLOUD_PIPELINEパッケージ
DBMS_CLOUD_PIPELINE
パッケージでは、クラウドにデータをロードおよびエクスポートするためのデータ・パイプラインを作成できます。 このパッケージは、オブジェクト・ストア内のファイルからデータベースへの継続的な増分データ・ロードをサポートします。 DBMS_CLOUD_PIPELINE
では、タイムスタンプ列に基づいて、データベースからの表データまたは問合せ結果のオブジェクト・ストアへの継続的な増分エクスポートもサポートされます。
- DBMS_CLOUD_PIPELINEサブプログラムのサマリー
この表は、DBMS_CLOUD_PIPELINE
パッケージに含まれるサブプログラムの概要を示しています。 - DBMS_CLOUD_PIPELINE属性
属性は、データ・パイプラインの動作を制御および構成するのに役立ちます。 - DBMS_CLOUD_PIPELINEビュー
DBMS_CLOUD_PIPELINE
パッケージでは、次のビューが使用されます。
DBMS_CLOUD_PIPELINEサブプログラムのサマリー
この表は、DBMS_CLOUD_PIPELINE
パッケージに含まれるサブプログラムの概要を示しています。
サブプログラム | 説明 |
---|---|
新しいデータ・パイプラインを作成します。 |
|
既存のデータ・パイプラインを削除します。 |
|
データ・パイプラインのトラッキング状態をリセットします。 リセット・パイプラインを使用して、データ・ロードまたはエクスポートの初期状態からパイプラインを再起動します。 オプションで、パイプラインをリセットすると、パイプラインのタイプに応じて、データベースまたはオブジェクト・ストアのデータをパージできます。 |
|
スケジュール済ジョブではなく、現在のフォアグラウンド・セッションでパイプラインのオンデマンド実行を実行します。 |
|
パイプライン属性を設定します。 2つのオーバーロードされたプロシージャがあります。1つは単一の属性を設定し、もう1つは属性名/値ペアのJSONドキュメントを使用して複数の属性を設定するプロシージャです |
|
データ・パイプラインを開始します。 パイプラインが開始されると、パイプライン属性で構成された間隔に従って、パイプライン操作はスケジュールされたジョブで継続的に実行されます。 |
|
データ・パイプラインを停止します。 パイプラインが停止すると、パイプラインに対して今後のジョブはスケジュールされません。 |
- CREATE_PIPELINEプロシージャ
このプロシージャは、新しいデータ・パイプラインを作成します。 - DROP_PIPELINEプロシージャ
このプロシージャは、既存のデータ・パイプラインを削除します。 パイプラインが開始されている場合は、削除する前に停止する必要があります。 - RESET_PIPELINEプロシージャ
データ・パイプラインのトラッキング状態をリセットします。 リセット・パイプラインを使用して、データ・ロードまたはエクスポートの初期状態からパイプラインを再起動します。 オプションで、パイプラインをリセットすると、パイプラインのタイプに応じて、データベースまたはオブジェクト・ストアのデータをパージできます。 リセットするには、データ・パイプラインが停止状態である必要があります。 - RUN_PIPELINE_ONCEプロシージャ
このプロシージャは、スケジュール済ジョブで実行するのではなく、現在のフォアグラウンド・セッションでパイプラインのオンデマンド実行を実行します。 パイプラインを連続ジョブとして開始する前に、DBMS_CLOUD_PIPELINE.RUN_PIPELINE_ONCE
を使用してパイプラインをテストします。 - SET_ATTRIBUTEプロシージャ
このプロシージャは、パイプライン属性を設定します。 2つのオーバーロードされたプロシージャがあります。1つは単一の属性を設定し、もう1つは属性名/値ペアのJSONドキュメントを使用して複数の属性を設定するプロシージャです。 - START_PIPELINEプロシージャ
このプロシージャは、データ・パイプラインを開始します。 パイプラインが開始されると、パイプライン属性で構成されたinterval
に従って、パイプライン操作はスケジュールされたジョブで継続的に実行されます。 - STOP_PIPELINEプロシージャ
このプロシージャは、データ・パイプラインを停止します。 パイプラインが停止すると、パイプラインに対して今後のジョブはスケジュールされません。
親トピック: DBMS_CLOUD_PIPELINEパッケージ
CREATE_PIPELINEプロシージャ
このプロシージャは、新しいデータ・パイプラインを作成します。
構文
DBMS_CLOUD_PIPELINE.CREATE_PIPELINE
(
pipeline_name IN VARCHAR2,
pipeline_type IN VARCHAR2,
attributes IN CLOB DEFAULT NULL,
description IN VARCHAR2 DEFAULT NULL
);
パラメータ
パラメータ | 説明 |
---|---|
|
パイプラインの名前を指定します。 パイプライン名は、Oracle SQL識別子のネーミング・ルールに従う必要があります。 詳細については、「識別子」を参照してください。 このパラメータは必須です。 |
|
パイプライン・タイプを指定します。 有効な値: このパラメータは必須です。 |
|
JSON形式のパイプライン属性。 デフォルト値: 詳細については、「DBMS_CLOUD_PIPELINE属性」を参照してください。 |
|
パイプラインの説明。 デフォルト値: |
DROP_PIPELINEプロシージャ
このプロシージャは、既存のデータ・パイプラインを削除します。 パイプラインが開始されている場合は、削除する前に停止する必要があります。
構文
DBMS_CLOUD_PIPELINE.DROP_PIPELINE
(
pipeline_name IN VARCHAR2,
force IN BOOLEAN DEFAULT FALSE
);
パラメータ
パラメータ | 説明 |
---|---|
|
パイプライン名を指定します。 このパラメータは必須です。 |
|
パイプラインは、開始状態であっても強制的にドロップします。 有効な値: デフォルト値: |
使用上のノート
-
開始状態のパイプラインを削除するには、
force
パラメータをTRUE
に設定します。
RESET_PIPELINEプロシージャ
データ・パイプラインのトラッキング状態をリセットします。 リセット・パイプラインを使用して、データ・ロードまたはエクスポートの初期状態からパイプラインを再起動します。 オプションで、パイプラインをリセットすると、パイプラインのタイプに応じて、データベースまたはオブジェクト・ストアのデータをパージできます。 リセットするには、データ・パイプラインが停止状態である必要があります。
構文
DBMS_CLOUD_PIPELINE.RESET_PIPELINE
(
pipeline_name IN VARCHAR2,
purge_data IN BOOLEAN DEFAULT FALSE
);
パラメータ
パラメータ | 説明 |
---|---|
|
パイプラインの名前を指定します。 このパラメータは必須です。 |
|
パージ・データは、ロード・パイプラインまたはエクスポート・パイプラインに適用されます:
有効な値: デフォルト値: |
使用上のノート
-
リセットするには、データ・パイプラインが停止状態である必要があります。 詳細については、「STOP_PIPELINEプロシージャ」を参照してください。
-
ロード・パイプラインの場合、パイプラインをリセットすると、パイプラインによってロードされているファイルのレコードがクリアされます。 ロード・パイプラインのリセット後に
START_PIPELINE
またはRUN_PIPELINE_ONCE
をコールすると、パイプラインはデータ・ロードを繰り返し、オブジェクト・ストアのロケーションに存在するすべてのファイルを含めます。purge_data
がTRUE
に設定されている場合、DBMS_CLOUD_PIPELINE.RESET_PIPELINE
は次のことを行います:-
table_name
属性で指定したパイプライン・データベース表のデータを切り捨てます。 -
パイプライン・ステータス表、およびパイプラインの不正なファイル表とエラー表(存在する場合)を削除します。
-
-
エクスポート・パイプラインの場合、パイプラインをリセットすると、データベース表内の最後の追跡データがクリアされます。 エクスポート・パイプラインのリセット後に
START_PIPELINE
またはRUN_PIPELINE_ONCE
をコールすると、パイプラインは表または問合せからのデータのエクスポートを繰り返します。purge_data
がTRUE
に設定されている場合、DBMS_CLOUD_PIPELINE.RESET_PIPELINE
は、location
属性で指定されたオブジェクト・ストアのロケーションにある既存のファイルを削除します。
RUN_PIPELINE_ONCEプロシージャ
このプロシージャは、スケジュール済ジョブで実行するのではなく、現在のフォアグラウンド・セッションでパイプラインのオンデマンド実行を実行します。 パイプラインを連続ジョブとして開始する前に、DBMS_CLOUD_PIPELINE.RUN_PIPELINE_ONCE
を使用してパイプラインをテストします。
構文
DBMS_CLOUD_PIPELINE.RUN_PIPELINE_ONCE
(
pipeline_name IN VARCHAR2
);
パラメータ
パラメータ | 説明 |
---|---|
|
実行するパイプラインの名前を指定します。 このパラメータは必須です。 |
使用上のノート
-
パイプラインのテスト実行を実行した後、
DBMS_CLOUD_PIPELINE.RESET_PIPELINE
を使用してパイプラインの状態をリセットできます。 これにより、スケジュール済ジョブでパイプラインを開始する前にパイプラインの状態をリセットできます。 -
パイプラインが開始状態の場合は、フォアグラウンド・セッションで実行できません。
SET_ATTRIBUTEプロシージャ
このプロシージャは、パイプライン属性を設定します。 2つのオーバーロードされたプロシージャがあります。1つは単一の属性を設定し、もう1つは属性名/値ペアのJSONドキュメントを使用して複数の属性を設定するプロシージャです。
構文
PROCEDURE DBMS_CLOUD_PIPELINE.SET_ATTRIBUTE
(
pipeline_name IN VARCHAR2,
attribute_name IN VARCHAR2,
attribute_value IN CLOB
);
PROCEDURE DBMS_CLOUD_PIPELINE.SET_ATTRIBUTE
(
pipeline_name IN VARCHAR2,
attributes IN CLOB
);
パラメータ
パラメータ | 説明 |
---|---|
|
属性を設定するパイプラインの名前を指定します。 このパラメータは必須です。 |
|
設定する属性の属性名を指定します。 詳細については、「DBMS_CLOUD_PIPELINE属性」を参照してください。 |
attribute_value |
設定するパイプライン属性の値を指定します。 詳細については、「DBMS_CLOUD_PIPELINE属性」を参照してください。 |
|
属性名と値を含むJSONドキュメントを指定します。 詳細については、「DBMS_CLOUD_PIPELINE属性」を参照してください。 |
使用上のノート
-
DBMS_CLOUD_PIPELINE.SET_ATTRIBUTE
を使用してattributes
パラメータで複数の属性を設定すると、既存のすべての属性が削除され、JSONドキュメントから指定された属性で上書きされます。
START_PIPELINEプロシージャ
interval
に従って、パイプライン操作はスケジュールされたジョブで継続的に実行されます。
構文
DBMS_CLOUD_PIPELINE.START_PIPELINE
(
pipeline_name IN VARCHAR2,
start_date IN TIMESTAMP WITH TIME ZONE DEFAULT NULL
);
パラメータ
パラメータ | 説明 |
---|---|
|
パイプラインの名前を指定します。 このパラメータは必須です。 |
|
パイプライン・ジョブの開始日を指定します。 デフォルト値: |
使用上のノート
-
デフォルトでは、パイプラインが開始されるとすぐにパイプライン・ジョブが開始されます。 パイプライン・ジョブを後で開始するには、
start_date
パラメータを使用して有効な日付またはタイムスタンプを指定します。 -
パイプライン
interval
およびその他のパイプライン属性の詳細は、「DBMS_CLOUD_PIPELINE属性」を参照してください。
STOP_PIPELINEプロシージャ
このプロシージャは、データ・パイプラインを停止します。 パイプラインが停止すると、パイプラインに対して今後のジョブはスケジュールされません。
構文
DBMS_CLOUD_PIPELINE.STOP_PIPELINE
(
pipeline_name IN VARCHAR2,
force IN BOOLEAN DEFAULT FALSE
);
パラメータ
パラメータ | 説明 |
---|---|
|
パイプラインの名前を指定します。 このパラメータは必須です。 |
|
強制パラメータが 有効な値: デフォルト値: |
DBMS_CLOUD_PIPELINE属性
属性は、データ・パイプラインの動作を制御および構成するのに役立ちます。
属性
ノート:
「パイプライン・タイプ」列に示されているように、パイプライン・タイプLOAD
またはEXPORT
に応じて、パイプラインは異なる属性セットをサポートします。
属性名 | 説明 | パイプライン・タイプ | パイプライン開始後に変更可能 |
---|---|---|---|
credential_name |
ソース・クラウドのオブジェクト・ストレージにアクセスするための資格証明の名前。 リソース・プリンシパルが有効な場合は、 デフォルト値:
|
LOAD , EXPORT |
はい |
field_list |
ソース・ファイル内のフィールドとそのデータ型を識別します。 この引数構文は、通常のOracle外部表の デフォルト値: デフォルト値はフィールドを指定し、そのデータ型は |
LOAD |
はい |
format |
パイプライン・タイプの形式を説明するオプション。
データ・ポンプ この属性は、 |
LOAD , EXPORT |
はい |
interval |
スケジュール済パイプライン・ジョブの連続実行間の時間間隔(分)。 デフォルト値: 15 分 |
LOAD , EXPORT |
はい |
key_column |
新しいデータをオブジェクト・ストアに継続的にエクスポートするための、指定された デフォルト値: NULL エクスポート・パイプラインに |
EXPORT |
いいえ |
location |
オブジェクト・ストレージのロケーションを指すURIを指定します。 URIの形式は、Cloud Object Storageサービスによって異なります。 詳細については、「DBMS_CLOUD URIの書式」を参照してください。 この属性は、 |
LOAD , EXPORT |
いいえ |
priority |
パイプラインに対して実行されるパラレル操作の数を決定する文字列値を指定します。
優先度が高い操作では、より多くのデータベース・リソースが消費され、より早く完了します。 有効な値:
デフォルト値: 同時ファイル操作の最大数は64に制限されています。 |
LOAD , EXPORT |
はい |
query |
必要なデータのみがエクスポートされるように、 たとえば:
デフォルト値: エクスポート・パイプラインの場合、 |
EXPORT |
いいえ |
table_name |
データをロードまたはエクスポートするためのターゲット表の名前を指定します。 ロード・パイプラインの場合、 エクスポート・パイプラインの場合、 |
LOAD , EXPORT |
いいえ |
table_owner |
データのロードまたはエクスポートのためにターゲット表が存在するスキーマの名前。 デフォルト値:
|
LOAD , EXPORT |
いいえ |
親トピック: DBMS_CLOUD_PIPELINEパッケージ