DBMS_CATALOGの概要

この項では、Oracle Autonomous AI Databaseで提供されるDBMS_CATALOGサブプログラムについて説明します。

サブプログラムは、次の機能領域に分類されます。

カタログのマウントとアンマウント

サブプログラム	摘要
MOUNT_DATA_CATALOGプロシージャ	このプロシージャは、AWS GLUEやOCI Data Catalogなどのデータ・カタログをマウントします。
MOUNT_DB_LINKプロシージャ	このプロシージャは、データベース・リンクに基づいてカタログをマウントします。
MOUNT_ICEBERGプロシージャ	このプロシージャは、特定の構成でApache Icebergカタログをマウントします。
MOUNT_SHAREプロシージャ	この手順では、シェアに基づいて単一のカタログをマウントします。
MOUNT_SHARESプロシージャ	この手順では、シェアプロバイダから複数のカタログをマウントし、さまざまな入力タイプをサポートするためにオーバーロードします。
MOUNT_VIRTUAL_CATALOGプロシージャ	この手順では、新しい仮想カタログを作成およびマウントします。
UNMOUNTプロシージャ	このプロシージャは、既存の外部カタログをアンマウントします。

カタログ・プロパティ管理

サブプログラム	摘要
GET_CATALOG_PROPERTYプロシージャ GET_CATALOG_PROPERTY_CLOBプロシージャ	これらのプロシージャは、カタログのプロパティ値を取得します。
UPDATE_CATALOG_PROPERTYプロシージャ UPDATE_CATALOG_PROPERTY_CLOBプロシージャ	これらのプロシージャは、カタログのプロパティ値を更新します。
GET_COLUMN_PROPERTYファンクション GET_COLUMN_PROPERTY_CLOBファンクション	これらの関数は、特定の列のプロパティ値をVARCHAR2またはCLOB形式で取得します。
UPDATE_COLUMN_PROPERTYプロシージャ UPDATE_COLUMN_PROPERTY_CLOBプロシージャ	これらのプロシージャは、更新をソースにプッシュするオプションを使用して、特定の列のプロパティ値を更新します。
GET_SCHEMA_PROPERTYプロシージャ GET_SCHEMA_PROPERTY_CLOBプロシージャ	これらのプロシージャは、スキーマ・プロパティ値を取得します。
UPDATE_SCHEMA_PROPERTYプロシージャ UPDATE_SCHEMA_PROPERTY_CLOBプロシージャ	これらのプロシージャは、スキーマ・プロパティ値を更新します。
GET_TABLE_PROPERTYプロシージャ GET_TABLE_PROPERTY_CLOBプロシージャ	これらのプロシージャは、表のプロパティ値を取得します。
UPDATE_TABLE_PROPERTYプロシージャ UPDATE_TABLE_PROPERTY_CLOBプロシージャ	これらのプロシージャは、表のプロパティ値を更新します。
GET_CLOUD_STORAGE_LINK_PROPERTYファンクション GET_CLOUD_STORAGE_LINK_PROPERTY_CLOBファンクション	これらの関数は、クラウド・ストレージ・リンクのプロパティ値をVARCHAR2またはCLOB形式で取得します。
UPDATE_CLOUD_STORAGE_LINK_PROPERTYプロシージャ UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOBプロシージャ	これらのプロシージャは、クラウド・ストレージ・リンクのプロパティ値を更新します。

資格証明管理

サブプログラム	摘要
ADD_REQUIRED_CREDENTIALプロシージャ	このプロシージャは、カタログに必要な資格証明を定義します。
REMOVE_REQUIRED_CREDENTIALプロシージャ	このプロシージャは、カタログから必要な資格証明を削除します。
RENAME_REQUIRED_CREDENTIALプロシージャ	このプロシージャは、必要な資格証明の名前を変更します。
GET_REQUIRED_CREDENTIAL_PROPERTYプロシージャ	このプロシージャは、必要な資格証明のプロパティを取得します。
UPDATE_REQUIRED_CREDENTIAL_PROPERTYプロシージャ	このプロシージャは、必要な資格証明のプロパティを更新します。
GET_LOCAL_CREDENTIAL_MAP (オーバーロード)プロシージャ	このプロシージャは、必要な資格証明とローカル資格証明の間のマッピングを取得し、様々な出力形式のオーバーロードを使用します。
SET_LOCAL_CREDENTIALプロシージャ	このプロシージャは、必要な資格証明のローカル資格証明を指定します。

カタログEntity Management

サブプログラム	摘要
CREATE_CLOUD_STORAGE_LINKプロシージャ DROP_CLOUD_STORAGE_LINKプロシージャ	これらの手順は、カタログ内のクラウド・ストレージ・リンクを管理します。
GET_CLOUD_STORAGE_LINKSファンクション	このファンクションは、オプションのフィルタを使用してカタログ内のクラウド・ストレージ・リンクのメタデータを取得します。
CREATE_EXTERNAL_TABLEプロシージャ	このプロシージャは、カタログ内に外部表を作成します。
CREATE_SCHEMAプロシージャ	このプロシージャは、カタログに新しいスキーマを作成し、リモート・カタログにApache Icebergスキーマも作成します。
GET_OBJECTSプロシージャ GET_SCHEMASプロシージャ GET_TABLESプロシージャ	このプロシージャは、パイプライン・ファンクションを使用して、カタログ内の表、スキーマおよびオブジェクトのメタデータを取得します。
DROP_SCHEMAプロシージャ DROP_TABLEプロシージャ	このプロシージャは、カタログからスキーマおよび表を削除します。
GET_COLUMNSファンクション	このファンクションは、カタログ内の表またはビューの列のメタデータを取得します。
GET_TABLEプロシージャ GET_TABLEファンクション	このプロシージャおよびファンクションは、特定の表の詳細情報をレコードまたはJSON形式で取得します。

データ・アクセスとキャッシング

サブプログラム摘要

サブプログラム	摘要
GENERATE_TABLE_SELECT (オーバーロード)プロシージャ	このプロシージャは、プロシージャとファンクションの両方のオーバーロードを使用して、論理表に対して`SELECT`文を作成します。
OPEN_TABLE_CURSORプロシージャ	このプロシージャは、論理表からデータを返すカーソルをオープンします。
FLUSH_CATALOG_CACHEプロシージャ PREFILL_CATALOG_CACHEプロシージャ	これらのプロシージャは、カタログ・メタデータのキャッシュを管理します。

GENERATE_TABLE_SELECT (オーバーロード)プロシージャ

このプロシージャは、プロシージャとファンクションの両方のオーバーロードを使用して、論理表に対してSELECT文を作成します。

OPEN_TABLE_CURSORプロシージャ

このプロシージャは、論理表からデータを返すカーソルをオープンします。

FLUSH_CATALOG_CACHEプロシージャ

PREFILL_CATALOG_CACHEプロシージャ

これらのプロシージャは、カタログ・メタデータのキャッシュを管理します。

同期と共有

サブプログラム	摘要
CREATE_SYNCHRONIZED_SCHEMASプロシージャ DROP_SYNCHRONIZED_SCHEMASプロシージャ	これらのプロシージャは、リモート・カタログ定義を使用して同期スキーマを管理します。
UPDATE_SYNCHRONIZED_SCHEMA_PROPERTYプロシージャ	このプロシージャは、同期スキーマのプロパティを更新します。
SYNCHRONIZE_SHARED_CATALOGSプロシージャ	この手順では、使用できないシェアに対応するカタログをアンマウントまたは無効化するオプションとともに管理します。
CREATE_SYNCHRONIZED_VIEWSプロシージャ	このプロシージャは、制限を適用するためにカタログ表にビューを作成します。
COPY_TABLE_PROPERTIESプロシージャ	このプロシージャは、オプションの列プロパティを含め、ある表から別の表にプロパティをコピーします。
GRANT_TO_RECIPIENTプロシージャ REVOKE_FROM_RECIPIENTプロシージャ	これらのプロシージャは、カタログ受信者のアクセス権限を管理します。

イベントログ

サブプログラム	摘要
CLEAR_CATALOG_EVENTSプロシージャ	このプロシージャは、時間範囲内のカタログ・イベント・ログからイベントをクリアします。

アイスバーグ固有の管理

サブプログラム	摘要
CREATE_ICEBERG_TABLEプロシージャ	このプロシージャは、カタログ内の指定されたスキーマ内に新しいIceberg表を作成します。
ADD_ICEBERG_SNAPSHOTプロシージャ	このプロシージャは、Iceberg表にスナップショットを追加して、詳細なメタデータによるデータ変更を表します。

MOUNT_DATA_CATALOGプロシージャ
このプロシージャは、データ・カタログ(AWS GLUEやOCI Data Catalogなど)をマウントします。
MOUNT_DB_LINKプロシージャ
このプロシージャは、データベース・リンクに基づいて外部カタログをマウントします。
MOUNT_ICEBERGプロシージャ
このプロシージャは、Icebergカタログをマウントします。
MOUNT_SHAREプロシージャ
このプロシージャは、単一の共有に基づいてカタログをマウントします。
MOUNT_SHARESプロシージャ
このプロシージャは、共有プロバイダからの共有に基づいて複数のカタログをマウントします。
MOUNT_VIRTUAL_CATALOGプロシージャ
このプロシージャは、新しい仮想カタログを作成およびマウントします。
UNMOUNTプロシージャ
このプロシージャは、外部カタログをアンマウントします。
GET_CATALOG_PROPERTYプロシージャ
このプロシージャは、カタログのプロパティの値を返します。
GET_CATALOG_PROPERTY_CLOBプロシージャ
このプロシージャは、カタログのプロパティの値をCLOB形式で返します。
UPDATE_CATALOG_PROPERTYプロシージャ
このプロシージャは、カタログのプロパティの値を更新します。
UPDATE_CATALOG_PROPERTY_CLOBプロシージャ
このプロシージャは、CLOBのカタログのプロパティの値を更新します。
GET_COLUMN_PROPERTYファンクション
カタログ表の列の特定のプロパティ値(PROP_CUSTOM、PROP_METADATAなど)を取得します。
GET_COLUMN_PROPERTY_CLOBファンクション
列の特定のプロパティ値をキャラクタ・ラージ・オブジェクト(CLOB)として取得します。
UPDATE_COLUMN_PROPERTYプロシージャ
ソース・オブジェクト注釈に更新をプッシュするオプションを使用して、特定の列のプロパティ値を更新します。
UPDATE_COLUMN_PROPERTY_CLOBプロシージャ
ラージ・データのキャラクタ・ラージ・オブジェクト(CLOB)として特定の列のプロパティ値を更新し、更新をソース・オブジェクト注釈にプッシュするオプションを指定します。
GET_SCHEMA_PROPERTYプロシージャ
このプロシージャは、スキーマのプロパティの値を返します。
GET_SCHEMA_PROPERTY_CLOBプロシージャ
このプロシージャは、スキーマのプロパティの値をCLOB形式で返します。
UPDATE_SCHEMA_PROPERTYプロシージャ
このプロシージャは、スキーマのプロパティの値を返します。
UPDATE_SCHEMA_PROPERTY_CLOBプロシージャ
ラージ・データのキャラクタ・ラージ・オブジェクト(CLOB)としてのスキーマのプロパティ値を更新します。
GET_TABLE_PROPERTYプロシージャ
表のプロパティの値を返します。
GET_TABLE_PROPERTY_CLOBプロシージャ
このプロシージャは、表のプロパティの値をCLOB形式で返します。
UPDATE_TABLE_PROPERTYプロシージャ
このプロシージャは、表のプロパティの値を更新します。
UPDATE_TABLE_PROPERTY_CLOBプロシージャ
キャラクタ・ラージ・オブジェクト(CLOB)データ型を使用して、表プロパティの値を更新します。
ADD_REQUIRED_CREDENTIALプロシージャ
カタログの使用に必要な資格証明を定義します。
REMOVE_REQUIRED_CREDENTIALプロシージャ
このプロシージャは、カタログから必要な資格証明を削除します。
RENAME_REQUIRED_CREDENTIALプロシージャ
このプロシージャは、カタログから必要な資格証明の名前を変更します。
GET_REQUIRED_CREDENTIAL_PROPERTYプロシージャ
このプロシージャは、名前付き必須資格証明のプロパティを取得します。
UPDATE_REQUIRED_CREDENTIAL_PROPERTYプロシージャ
このプロシージャは、名前付き必須資格証明のプロパティを更新します。
GET_LOCAL_CREDENTIAL_MAP (オーバーロード)プロシージャ
このプロシージャは、必要な資格証明とローカル資格証明のマップを取得します。
SET_LOCAL_CREDENTIALプロシージャ
このプロシージャは、カタログの使用時に使用するローカル資格証明を指定します。
GET_CLOUD_STORAGE_LINK_PROPERTYファンクション
カタログ内のクラウド・ストレージ・リンクの特定のプロパティ値(PROP_CUSTOM、PROP_METADATAなど)を取得します。
GET_CLOUD_STORAGE_LINK_PROPERTY_CLOBファンクション
クラウド・ストレージ・リンクの特定のプロパティ値をキャラクタ・ラージ・オブジェクト(CLOB)として取得します。
UPDATE_CLOUD_STORAGE_LINK_PROPERTYプロシージャ
カタログ内のクラウド・ストレージ・リンクの特定のプロパティ値を更新します。
UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOBプロシージャ
大きいデータのキャラクタ・ラージ・オブジェクト(CLOB)として、クラウド・ストレージ・リンクの特定のプロパティ値を更新します。
CREATE_CLOUD_STORAGE_LINKプロシージャ
このプロシージャは、カタログにクラウド・ストレージ・リンクを作成します。
DROP_CLOUD_STORAGE_LINKプロシージャ
このプロシージャは、カタログからクラウド・ストレージ・リンクを削除します。
GET_CLOUD_STORAGE_LINKSファンクション
カタログの特定のクラウド・ストレージ・リンクまたはすべてのクラウド・ストレージ・リンクを取得します。
GET_COLUMNSファンクション
カタログ内の表またはビューからすべての列を取得します。
CREATE_EXTERNAL_TABLEプロシージャ
カタログに外部表を作成します。
CREATE_SCHEMAプロシージャ
カタログに新しいスキーマを作成します。また、リモート・カタログにApache Icebergスキーマを作成することもできます。
DROP_SCHEMAプロシージャ
このプロシージャは、すべてのコンテンツとともにカタログからスキーマを削除します。
GET_OBJECTSプロシージャ
このプロシージャは、カタログのすべてのオブジェクトをフェッチします。
GET_SCHEMASプロシージャ
このプロシージャは、カタログのすべてのスキーマをフェッチします。
GET_TABLESプロシージャ
このプロシージャは、カタログのすべての表をフェッチします。
GET_TABLEプロシージャ
カタログ内の特定の表の詳細情報をレコードとして取得します。出力およびキャッシュに関する考慮事項をカスタマイズするオプションがあります。
GET_TABLEファンクション
キャラクタ・ラージ・オブジェクト(CLOB)として、JSON形式で特定の表の詳細情報を取得します。
DROP_TABLEプロシージャ
このプロシージャは、カタログから表を削除します。
GENERATE_TABLE_SELECT (オーバーロード)プロシージャ
このプロシージャは、論理表のSELECT文を生成します。
OPEN_TABLE_CURSORプロシージャ
このプロシージャは、論理表からデータを返すカーソルを開きます。
FLUSH_CATALOG_CACHEプロシージャ
このプロシージャは、カタログ・メタデータ・キャッシュをフラッシュします。
PREFILL_CATALOG_CACHEプロシージャ
このプロシージャは、指定したカタログのキャッシュに現在のデータを入力します。
CREATE_SYNCHRONIZED_SCHEMASプロシージャ
このプロシージャは、リモート・カタログ定義と同期されたローカル・データベース・スキーマを作成します。
DROP_SYNCHRONIZED_SCHEMASプロシージャ
このプロシージャは、1つ以上の同期スキーマを削除します。
UPDATE_SYNCHRONIZED_SCHEMA_PROPERTYプロシージャ
このプロシージャは、同期スキーマのプロパティを更新します。
SYNCHRONIZE_SHARED_CATALOGSプロシージャ
使用できなくなった共有に基づいてカタログを処理します。
CREATE_SYNCHRONIZED_VIEWSプロシージャ
制限を定義するためのビューをカタログ表に作成します。
COPY_TABLE_PROPERTIESプロシージャ
カタログおよびスキーマ間で、表プロパティおよびオプションで列プロパティをソース表からターゲット表にコピーし、プロパティ・セットを選択し、列名変更マッピングを指定するオプションを指定します。
GRANT_TO_RECIPIENTプロシージャ
このプロシージャは、カタログに対するアクセス権を特定の共有受信者に付与します。
REVOKE_FROM_RECIPIENTプロシージャ
このプロシージャは、特定の受信者からカタログに対するアクセス権を取り消します。
CLEAR_CATALOG_EVENTSプロシージャ
カタログ内の特定の表の詳細情報をレコードとして取得します。出力およびキャッシュに関する考慮事項をカスタマイズするオプションがあります。
CREATE_ICEBERG_TABLEプロシージャ
カタログ内の指定されたスキーマ内に新しいIceberg表を作成し、結果のメタデータを返します。
ADD_ICEBERG_SNAPSHOTプロシージャ
Iceberg表にスナップショットを追加して、系統およびコンテンツを追跡するための詳細なメタデータやオプションのパラメータなど、データ変更を表します。

親トピック: DBMS_CATALOGを使用したカタログの管理

MOUNT_DATA_CATALOGプロシージャ

このプロシージャは、データ・カタログ(AWS GLUEやOCI Data Catalogなど)をマウントします。

構文

PROCEDURE mount_data_catalog
(
  catalog_name 				IN VARCHAR2,
  data_catalog_type 		IN VARCHAR2,
  data_catalog_region 		IN VARCHAR2,
  data_catalog_credential 	IN VARCHAR2,
  data_catalog_id 			IN VARCHAR2 := NULL,
  data_storage_credential 	IN VARCHAR2 := NULL,
  enabled 					IN BOOLEAN := TRUE
);

パラメータ

パラメータ	摘要
`catalog_name`	新規カタログの名前。これは大文字に変換されます。
`data_catalog_type`	データ・カタログのタイプ(OCI_DCATやAWS_GLUEなど)。
`data_catalog_region`	データ・カタログのクラウド・リソース・リージョン。
`data_catalog_credential`	データ・カタログへのアクセスに使用されるローカル資格証明。
`data_catalog_id`	データ・カタログ名または識別子。デフォルトはNULL。
`data_storage_credential`	データ・アクセスのローカル資格証明を指定します。デフォルトはNULL。このフィールドはオプションです。
`enabled`	カタログが検索に使用可能かどうかを示します。デフォルトは`TRUE`です。

例

/****************** Glue Catalog ******************/
BEGIN
  -- Create a credential capable of accessing a glue catalog
  dbms_cloud.create_credential('GLUE_CATALOG_CREDENTIAL', ...); 

  -- Mount a glue catalog
  dbms_catalog.mount_data_catalog(
    catalog_name             => 'GLUE_CAT',
    data_catalog_type        => 'AWS_GLUE',
    data_catalog_region      => 'us-east-1', 
    data_catalog_credential  => 'GLUE_CATALOG_CREDENTIAL');
END;
/

親トピック: DBMS_CATALOGのサマリー

MOUNT_DB_LINKプロシージャ

このプロシージャは、データベース・リンクに基づいて外部カタログをマウントします。

構文

PROCEDURE mount_db_link
(
  catalog_name 	IN VARCHAR2,
  db_link 		IN VARCHAR2,
  enabled 		IN BOOLEAN := TRUE
);

パラメータ

パラメータ	摘要
`catalog_name`	新規カタログの名前。これは大文字に変換されます。
`db_link`	カタログのマウントに使用するデータベース・リンク。
`enabled`	カタログが検索に使用可能かどうかを示します。デフォルトは`TRUE`です。

親トピック: DBMS_CATALOGのサマリー

MOUNT_ICEBERGプロシージャ

この手順では、Icebergカタログをマウントします。

構文

Icebergカタログの詳細は、Iceberg REST Catalog Specを参照してください。

PROCEDURE mount_iceberg
(
  catalog_name 				IN VARCHAR2,
  endpoint 					IN VARCHAR2,
  catalog_credential 		IN VARCHAR2,
  data_storage_credential 	IN VARCHAR2,
  configuration 			IN SYS.JSON_OBJECT_T := NULL,
  enabled 					IN BOOLEAN := TRUE,
  catalog_type 				IN VARCHAR2 := 'ICEBERG_GENERIC'
);

パラメータ

パラメータ	摘要
`catalog_name`	新規カタログの名前。これは大文字に変換されます。
`endpoint`	IcebergベースサーバのURL
`catalog_credential`	Icebergカタログへのアクセスに使用される資格証明。
`data_storage_credential`	データへのアクセスに使用される資格証明。
`configuration`	ここでは、カタログ構成をJSONオブジェクトとして説明します。サポートされている構成は次のとおりです。 `namespacePath`: デフォルトは`NULL`です。 `namespaceSeparator`: Unityの場合はドット(.)に、他のIcebergカタログの場合は`%1F`にデフォルト設定されます。 `isCaseSensitive`: Unityの場合は`FALSE`、他のIcebergカタログの場合は`TRUE`にデフォルト設定されます) `isPublicCatalog`: デフォルトは`FALSE`です。 `bucketRegion`: デフォルトは`NULL`です。これは、カタログでS3記憶域が使用されている場合にのみ関連します。
`enabled`	これは、カタログが検索可能かどうかを示します。デフォルトは`TRUE`です。
`catalog_type`	Icebergカタログのタイプ(`ICEBERG_GENERIC`、`ICEBERG_POLARIS`、`ICEBERG_UNITY`など)。デフォルトは`ICEBERG_GENERIC`です。

例

/****************** Iceberg Catalog - Unity ******************/
DECLARE
  config      JSON_OBJECT_T := JSON_OBJECT_T();
BEGIN
  -- Create a credential capable of accessing an external iceberg REST catalog
  dbms_share.create_bearer_token_credential(
    credential_name => 'ICEBERG_CATALOG_CREDENTIAL',
    token_endpoint => 'https://.../v1/tokens',
    client_id => ...,
    client_secret => ...,
    token_scope => 'all-apis');

  -- Create a credential capable of accessing the bucket where the 
  -- iceberg data files are stored.
  dbms_cloud.create_credential('ICEBERG_STORAGE_CRED', ...); 

  -- Mount a iceberg catalog
  config.put('namespacePath', 'sales_catalog');
  dbms_catalog.mount_iceberg(
    catalog_name             => 'ICEBERG_CAT',
    endpoint                 => 'https://...//api/2.1/unity-catalog/iceberg/v1',
    catalog_credential       => 'ICEBERG_CATALOG_CREDENTIAL',
    data_storage_credential  => 'ICEBERG_STORAGE_CRED',
    configuration            => config,
    catalog_type             => 'ICEBERG_UNITY');
END;
/

/****************** Iceberg Catalog - Polaris ******************/
DECLARE
  config      JSON_OBJECT_T := JSON_OBJECT_T();
BEGIN
  -- Create a credential capable of accessing an external iceberg REST catalog
  dbms_share.create_bearer_token_credential(
    credential_name => 'ICEBERG_CATALOG_CREDENTIAL',
    token_endpoint => 'https://.../v1/oauth/tokens',
    client_id => ...,
    client_secret => ...,
    token_scope => 'PRINCIPAL_ROLE:ALL');

  -- Create a credential capable of accessing the bucket where the 
  -- iceberg data files are stored.
  dbms_cloud.create_credential('ICEBERG_STORAGE_CRED', ...); 

  -- Mount a iceberg catalog
  config.put('namespacePath', 'sales_catalog');
  dbms_catalog.mount_iceberg(
    catalog_name             => 'ICEBERG_CAT',
    endpoint                 => 'https://.../polaris/api/catalog/v1',
    catalog_credential       => 'ICEBERG_CATALOG_CREDENTIAL',
    data_storage_credential  => 'ICEBERG_STORAGE_CRED',
    configuration            => config,
    catalog_type             => 'ICEBERG_POLARIS');
END;
/

親トピック: DBMS_CATALOGのサマリー

MOUNT_SHAREプロシージャ

この手順では、単一の共有に基づいてカタログをマウントします。

構文

PROCEDURE mount_share
(
  catalog_name 				IN VARCHAR2,
  share_provider 			IN VARCHAR2,
  share_name 				IN VARCHAR2,
  share_provider_owner 		IN VARCHAR2 := NULL,
  enabled 					IN BOOLEAN := TRUE
);

パラメータ

パラメータ	摘要
`catalog_name`	新規カタログの名前。これは大文字に変換されます。
`share_provider`	共有プロバイダの名前。
`share_name`	マウントする共有の名前。
`share_provider_owner`	共有プロバイダの所有者。NULLの場合は、現在のカタログにデフォルト設定されます。
`enabled`	カタログが検索に使用可能かどうかを示します。デフォルト値はTRUEです。

例

/****************** Share Catalog ******************/
BEGIN
  -- Create a share provider
  dbms_share.create_or_replace_share_provider(
    provider_name        => 'MY_SHARE_PROVIDER',
    endpoint             => 'https://...');
  dbms_cloud.create_credential(
    credential_name      => 'SHARE_PROVIDER_CREDENTIAL', ...);
  dbms_share.set_share_provider_credential(
    provider_name        => 'MY_SHARE_PROVIDER',
    share_credential     => 'SHARE_PROVIDER_CREDENTIAL');

  -- Mount a share catalog
  dbms_catalog.mount_share(
    catalog_name         => 'SHARE_CAT',
    share_provider       => 'MY_SHARE_PROVIDER',
    share_name           => 'MY_SHARE_1');
END;
/

親トピック: DBMS_CATALOGのサマリー

MOUNT_SHARESプロシージャ

この手順では、シェアプロバイダからのシェアに基づいて複数のカタログをマウントします。

構文

PROCEDURE mount_shares
(
  share_provider 		IN VARCHAR2,
  shares 				IN SYS.JSON_ARRAY_T,
  created_catalogs 		IN OUT NOCOPY SYS.JSON_ARRAY_T,
  share_provider_owner 	IN VARCHAR2 := NULL
);

パラメータ

パラメータ	摘要
`share_provider`:	共有プロバイダの名前。
`shares`	マウントするシェアのリストを定義するJSON配列。各要素は、`shareName`、`required`、`shareNameRule`、`catalogName`、`skipExisting`、`placeholder`、`enabled`などのプロパティを指定します。
`created_catalogs`	新しく作成されたカタログのJSON配列で、`shareName`や`catalogName`などのプロパティを使用して出力として返されます。
`share_provider_owner`	共有プロバイダの所有者。NULLの場合は、現在のカタログにデフォルト設定されます。

2番目のプロシージャの構文

PROCEDURE mount_shares
(
  share_provider 		IN VARCHAR2,
  shares 				IN SYS.JSON_ARRAY_T,
  share_provider_owner 	IN VARCHAR2 := NULL
);

3番目のプロシージャの構文

PROCEDURE mount_shares
(
  share_provider 		IN VARCHAR2,
  shares 				IN CLOB := '[{shareName:"%"}]',
  share_provider_owner 	IN VARCHAR2 := NULL
);

2番目のプロシージャのパラメータ

パラメータはプロシージャ1と同じですが、created_catalogsは指定されていません。

3番目のプロシージャのパラメータ

シェアは、すべてのシェアを含むデフォルト値を持つ CLOBを除き、パラメータはシグネチャ1と同一です。

例

/****************** Share Catalog ******************/
BEGIN
  -- Create a share provider
  dbms_share.create_or_replace_share_provider(
    provider_name        => 'MY_SHARE_PROVIDER',
    endpoint             => 'https://...');
  dbms_cloud.create_credential(
    credential_name      => 'SHARE_PROVIDER_CREDENTIAL', ...);
  dbms_share.set_share_provider_credential(
    provider_name        => 'MY_SHARE_PROVIDER',
    share_credential     => 'SHARE_PROVIDER_CREDENTIAL');

  -- Mount shares as catalogs
  dbms_catalog.mount_shares(
    share_provider       => 'MY_SHARE_PROVIDER');
END;
/

親トピック: DBMS_CATALOGのサマリー

MOUNT_VIRTUAL_CATALOGプロシージャ

この手順では、新しい仮想カタログを作成およびマウントします。

構文

PROCEDURE mount_virtual_catalog
(
  catalog_name 	IN VARCHAR2,
  enabled 		IN BOOLEAN := TRUE
);

パラメータ

パラメータ	摘要
`catalog_name`	新規カタログの名前。これは大文字に変換されます。
`enabled`	カタログが検索に使用可能かどうかを示します。デフォルト値はTRUEです。

親トピック: DBMS_CATALOGのサマリー

UNMOUNTプロシージャ

このプロシージャは、外部カタログをアンマウントします。

構文

PROCEDURE unmount
(
  catalog_name IN VARCHAR2
);

パラメータ

パラメータ	摘要
`catalog_name`	アンマウントする既存のカタログの名前。これは大文字に変換されます。

親トピック: DBMS_CATALOGのサマリー

GET_CATALOG_PROPERTYプロシージャ

このプロシージャは、カタログのプロパティの値を返します。

構文

FUNCTION get_catalog_property
(
  catalog_name 		IN VARCHAR2,
  catalog_property 	IN VARCHAR2
)
RETURN VARCHAR2;

パラメータ

パラメータ摘要

catalog_name

既存のカタログの名前。これは大文字に変換されます。

catalog_property

取得するプロパティ(PROP_CACHE_DURATION、PROP_IS_ENABLEDなど)について説明します。

値は、次のいずれかの定数です。

PROP_CACHE_ASYNC
PROP_CACHE_DURATION
PROP_CACHE_ENABLED
PROP_CONFIGURATION
PROP_CUSTOM
PROP_DCAT_TYPE
PROP_DEFAULT_SCHEMA
PROP_IS_ENABLED
PROP_METADATA

詳細は、カタログ・タイプおよび定数を参照してください。

親トピック: DBMS_CATALOGのサマリー

GET_CATALOG_PROPERTY_CLOBプロシージャ

このプロシージャは、カタログのプロパティの値をCLOB形式で返します。

構文

FUNCTION get_catalog_property_clob
(
  catalog_name 		IN VARCHAR2,
  catalog_property 	IN VARCHAR2
)
RETURN CLOB;

パラメータ

パラメータ摘要

catalog_name

既存のカタログの名前。これは大文字に変換されます。

catalog_property

これは、取得するプロパティ(PROP_CACHE_DURATION、PROP_IS_ENABLEDなど)を示します。

値は、次のいずれかの定数です。

PROP_CACHE_ASYNC
PROP_CACHE_DURATION
PROP_CACHE_ENABLED
PROP_CONFIGURATION
PROP_CUSTOM
PROP_DCAT_TYPE
PROP_DEFAULT_SCHEMA
PROP_IS_ENABLED
PROP_METADATA

詳細は、カタログ・タイプおよび定数を参照してください。

親トピック: DBMS_CATALOGのサマリー

UPDATE_CATALOG_PROPERTYプロシージャ

このプロシージャは、カタログのプロパティの値を更新します。

構文

PROCEDURE update_catalog_property
(
  catalog_name 		IN VARCHAR2,
  catalog_property 	IN VARCHAR2,
  new_value 		IN VARCHAR2
);

パラメータ

パラメータ摘要

catalog_name

既存のカタログの名前。これは大文字に変換されます。

catalog_property

これは、更新するプロパティ(PROP_CACHE_DURATION、PROP_IS_ENABLEDなど)を示します。

値は、次のいずれかの定数です。

PROP_CACHE_ASYNC
PROP_CACHE_DURATION
PROP_CACHE_ENABLED
PROP_CONFIGURATION
PROP_CUSTOM
PROP_DEFAULT_SCHEMA
PROP_IS_ENABLED
PROP_METADATA

詳細は、カタログ・タイプおよび定数を参照してください。

new_value

新しいプロパティの値

親トピック: DBMS_CATALOGのサマリー

UPDATE_CATALOG_PROPERTY_CLOBプロシージャ

このプロシージャは、CLOBのカタログのプロパティの値を更新します。

構文

PROCEDURE update_catalog_property_clob
(
  catalog_name 		IN VARCHAR2,
  catalog_property 	IN VARCHAR2,
  new_value 		IN CLOB
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`catalog_property`	これは、取得するプロパティ(`PROP_CACHE_DURATION`、`PROP_IS_ENABLED`など)を示します。
`new_value`	CLOBの新しいプロパティ値。

親トピック: DBMS_CATALOGのサマリー

GET_COLUMN_PROPERTYファンクション

カタログ表の列の特定のプロパティ値(PROP_CUSTOM、PROP_METADATAなど)を取得します。

構文

FUNCTION GET_COLUMN_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  column_name                    IN VARCHAR2,
  column_property                IN VARCHAR2
)
RETURN VARCHAR2;

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`table_name`	ソース・カタログ表の名前。
`column_name`	列の名前。
`column_property`	プロパティ値(`PROP_CUSTOM`、`PROP_METADATA`など)を返します。

ノート

GET_COLUMN_PROPERTY_CLOBファンクション

親トピック: DBMS_CATALOGのサマリー

GET_COLUMN_PROPERTY_CLOBファンクション

列の特定のプロパティ値をキャラクタ・ラージ・オブジェクト(CLOB)として取得します。

構文

FUNCTION GET_COLUMN_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  column_name                    IN VARCHAR2,
  column_property                IN VARCHAR2
)
RETURN VARCHAR2;

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`table_name`	ソース・カタログ表の名前。
`column_name`	列の名前。
`column_property`	プロパティ値(`PROP_CUSTOM`、`PROP_METADATA`など)を返します。

ノート

GET_COLUMN_PROPERTYファンクション

親トピック: DBMS_CATALOGのサマリー

UPDATE_COLUMN_PROPERTYプロシージャ

更新をソース・オブジェクト注釈にプッシュするオプションを使用して、特定の列のプロパティ値を更新します。

構文

PROCEDURE UPDATE_COLUMN_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  column_name                    IN VARCHAR2,
  column_property                IN VARCHAR2,
  new_value                      IN VARCHAR2,
  push_to_source                 IN BOOLEAN := FALSE
);

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`table_name`	ソース・カタログ表の名前。
`column_name`	列の名前。
`column_property`	プロパティ値を更新します(たとえば、`PROP_CUSTOM`、`PROP_METADATA`)。
`new_value`	プロパティに新しい値を割り当てます。
`push_to_source`	プロパティ更新をソース・オブジェクト注釈にプッシュするかどうかを示します。デフォルトはFALSE。

ノート

UPDATE_COLUMN_PROPERTY_CLOBプロシージャ

親トピック: DBMS_CATALOGのサマリー

UPDATE_COLUMN_PROPERTY_CLOBプロシージャ

ラージ・データのキャラクタ・ラージ・オブジェクト(CLOB)として特定の列のプロパティ値を更新し、更新をソース・オブジェクト注釈にプッシュするオプションを使用します。

構文

PROCEDURE UPDATE_COLUMN_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  column_name                    IN VARCHAR2,
  column_property                IN VARCHAR2,
  new_value                      IN CLOB,
  push_to_source                 IN BOOLEAN := FALSE
);

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`table_name`	ソース・カタログ表の名前。
`column_name`	列の名前。
`column_property`	プロパティ値を更新します(たとえば、`PROP_CUSTOM`、`PROP_METADATA`)。
`new_value`	CLOB形式で新しい値を割り当てます。
`push_to_source`	プロパティ更新をソース・オブジェクト注釈にプッシュするかどうかを示します。デフォルトはFALSE。

ノート

UPDATE_COLUMN_PROPERTYプロシージャ

親トピック: DBMS_CATALOGのサマリー

GET_SCHEMA_PROPERTYプロシージャ

このプロシージャは、スキーマのプロパティの値を返します。

構文

FUNCTION get_schema_property
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  schema_property 	IN VARCHAR2
)

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	このスキーマの名前。
`schema_property`	これは、取得するプロパティ(`PROP_CUSTOM`、`PROP_METADATA`など)を示します。

親トピック: DBMS_CATALOGのサマリー

GET_SCHEMA_PROPERTY_CLOBプロシージャ

このプロシージャは、スキーマのプロパティの値をCLOB形式で返します。

構文

FUNCTION get_schema_property_clob
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  schema_property 	IN VARCHAR2
)
RETURN CLOB;

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	このスキーマの名前。
`schema_property`	これは、取得するプロパティ(`PROP_CUSTOM`、`PROP_METADATA`など)を示します。

親トピック: DBMS_CATALOGのサマリー

UPDATE_SCHEMA_PROPERTYプロシージャ

このプロシージャは、スキーマのプロパティの値を返します。

構文

PROCEDURE update_schema_property
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  schema_property 	IN VARCHAR2,
  new_value 		IN VARCHAR2
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	このスキーマの名前。
`schema_property`	これは、取得するプロパティ(`PROP_CUSTOM`、`PROP_METADATA`など)を示します。
`new_value`	新しいプロパティの値

親トピック: DBMS_CATALOGのサマリー

UPDATE_SCHEMA_PROPERTY_CLOBプロシージャ

ラージ・データのキャラクタ・ラージ・オブジェクト(CLOB)としてスキーマのプロパティ値を更新します。

構文

PROCEDURE UPDATE_SCHEMA_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  schema_property                IN VARCHAR2,
  new_value                      IN CLOB
);

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`schema_property`	プロパティ値を更新します(たとえば、`PROP_CUSTOM`、`PROP_METADATA`)。
`new_value`	プロパティの新しい値を割り当てます。

ノート

UPDATE_SCHEMA_PROPERTYプロシージャ

親トピック: DBMS_CATALOGのサマリー

GET_TABLE_PROPERTYプロシージャ

テーブルのプロパティの値を返します。

構文

FUNCTION GET_TABLE_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  table_property                 IN VARCHAR2
)
RETURN VARCHAR2;

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`table_name`	ソース・カタログ表の名前。
`table_property`	取得するプロパティ。

親トピック: DBMS_CATALOGのサマリー

GET_TABLE_PROPERTY_CLOBプロシージャ

このプロシージャは、表のプロパティの値をCLOB形式で返します。

構文

FUNCTION get_table_property_clob
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  table_name 		IN VARCHAR2,
  table_property 	IN VARCHAR2
)
RETURN CLOB;

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	このスキーマの名前。
`table_name`	この表の名前。
`table_property`	更新するプロパティ(`PROP_CUSTOM`など)。

親トピック: DBMS_CATALOGのサマリー

UPDATE_TABLE_PROPERTYプロシージャ

このプロシージャは、表のプロパティの値を更新します。

構文

PROCEDURE update_table_property
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  table_name 		IN VARCHAR2,
  table_property 	IN VARCHAR2,
  new_value 		IN VARCHAR2
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	このスキーマの名前。
`table_name`	この表の名前。
`table_property`	更新するプロパティ。
`new_value`	新しいプロパティの値

親トピック: DBMS_CATALOGのサマリー

UPDATE_TABLE_PROPERTY_CLOBプロシージャ

文字ラージ・オブジェクト(CLOB)データ型を使用して、表プロパティの値を更新します。

構文

PROCEDURE UPDATE_TABLE_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  table_property                 IN VARCHAR2,
  new_value                      IN CLOB,
  push_to_source                 IN BOOLEAN := FALSE
);

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`table_name`	ソース・カタログ表の名前。
`table_property`	更新する表プロパティ。
`new_value`	CLOB形式で新しい値を割り当てます。
`push_to_source`	プロパティ更新をソース・オブジェクト注釈にプッシュするかどうかを示します。デフォルトはFALSE。

ノート

UPDATE_TABLE_PROPERTYプロシージャ

親トピック: DBMS_CATALOGのサマリー

ADD_REQUIRED_CREDENTIALプロシージャ

カタログの使用に必要な資格証明を定義します。

構文

PROCEDURE ADD_REQUIRED_CREDENTIAL
(
  catalog_name                   IN VARCHAR2,
  required_credential            IN VARCHAR2,
  local_credential               IN VARCHAR2 := NULL,
  credential_type                IN VARCHAR2 := NULL
);

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`required_credential`	必要な資格証明の名前。
`local_credential`	使用するオプションのローカル資格証明です。デフォルト値はNULLです。
`credential_type`	オプションこのパラメータは、オブジェクト・ストレージなどの外部サービスへのアクセスに使用される認証メカニズムのタイプを指定します。たとえば、oci、aws、azureまたはslack_credentialです。

詳細は、カタログ・タイプおよび定数を参照してください。

親トピック: DBMS_CATALOGのサマリー

REMOVE_REQUIRED_CREDENTIALプロシージャ

このプロシージャは、カタログから必要な資格証明を削除します。

構文

PROCEDURE remove_required_credential
(
  catalog_name 			IN VARCHAR2,
  required_credential 	IN VARCHAR2
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`required_credential`	削除する必要がある資格証明の名前。

親トピック: DBMS_CATALOGのサマリー

RENAME_REQUIRED_CREDENTIALプロシージャ

このプロシージャは、カタログから必要な資格証明の名前を変更します。

構文

PROCEDURE rename_required_credential
(
  catalog_name 			IN VARCHAR2,
  old_credential_name 	IN VARCHAR2,
  new_credential_name 	IN VARCHAR2
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`old_credential_name`	必要な資格証明の古い名前。
`new_credential_name`	必要な資格証明の新しい名前。

親トピック: DBMS_CATALOGのサマリー

GET_REQUIRED_CREDENTIAL_PROPERTYプロシージャ

このプロシージャは、名前付き必須資格証明のプロパティを取得します。

構文

FUNCTION get_required_credential_property
(
  catalog_name 			IN VARCHAR2,
  required_credential 	IN VARCHAR2,
  credential_property 	IN VARCHAR2
)
RETURN VARCHAR2;

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`required_credential`	必要な資格証明の名前。
`credential_property`	プロパティ名(`PROP_REQUIRED_CREDENTIAL_DESCRIPTION`、`PROP_REQUIRED_CREDENTIAL_VAULT_SECRET`など)。

親トピック: DBMS_CATALOGのサマリー

UPDATE_REQUIRED_CREDENTIAL_PROPERTYプロシージャ

このプロシージャは、名前付き必須資格証明のプロパティを更新します。

構文

PROCEDURE update_required_credential_property
(
  catalog_name 			IN VARCHAR2,
  required_credential 	IN VARCHAR2,
  credential_property 	IN VARCHAR2,
  new_value 			IN VARCHAR2
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`required_credential`	必要な資格証明の名前。
`credential_property`	プロパティ名(`PROP_REQUIRED_CREDENTIAL_DESCRIPTION`、`PROP_REQUIRED_CREDENTIAL_VAULT_SECRET`など)。
`new_value`	プロパティの新しい値。

親トピック: DBMS_CATALOGのサマリー

GET_LOCAL_CREDENTIAL_MAP (オーバーロード)プロシージャ

このプロシージャは、必要な資格証明のローカル資格証明へのマップを取得します。

構文1

PROCEDURE get_local_credential_map
(
  catalog_name 		IN VARCHAR2,
  credential_map 	OUT NOCOPY credential_info_map
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`credential_map`	資格証明の移入済マップ。

構文2

FUNCTION get_local_credential_map
(
  catalog_name 	IN VARCHAR2,
  show_errors 	IN NUMBER := 0,
  pretty_json 	IN NUMBER := 0
)
RETURN CLOB;

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。
`show_errors`	これにより、無効なローカル資格証明のエラー・メッセージが表示されます。デフォルトは0です。
`pretty_json`	JSONをPRETTYオプションでフォーマットします。デフォルトは`0`です。

構文3

PROCEDURE get_local_credential_map
(
  catalog_id 		IN NUMBER,
  credential_map 	OUT NOCOPY SYS.JSON_OBJECT_T
);

パラメータ

パラメータ	摘要
`catalog_id`	`ALL_MOUNTED_CATALOGS`の`CATALOG_ID` 列にある既存のカタログのID。
`credential_map`	JSONオブジェクトとして移入されたマップ。

親トピック: DBMS_CATALOGのサマリー

SET_LOCAL_CREDENTIALプロシージャ

このプロシージャは、カタログの使用時に使用するローカル資格証明を指定します。

構文

PROCEDURE set_local_credential
(
  catalog_name 			IN VARCHAR2,
  required_credential 	IN VARCHAR2,
  local_credential 		IN VARCHAR2
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`required_credential`	必要な資格証明の名前。
`local_credential`	使用する資格証明。

親トピック: DBMS_CATALOGのサマリー

GET_CLOUD_STORAGE_LINK_PROPERTYファンクション

カタログ内のクラウド・ストレージ・リンクの特定のプロパティ値(PROP_CUSTOM、PROP_METADATAなど)を取得します。

構文

FUNCTION GET_CLOUD_STORAGE_LINK_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  storage_link_name              IN VARCHAR2,
  storage_link_property          IN VARCHAR2
)
RETURN VARCHAR2;

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`storage_link_name`	クラウド・ストレージ・リンクをクリックします。
`storage_link_property`	プロパティ値(`PROP_CUSTOM`、`PROP_METADATA`など)を返します。

ノート

GET_CLOUD_STORAGE_LINK_PROPERTY_CLOBファンクション

親トピック: DBMS_CATALOGのサマリー

GET_CLOUD_STORAGE_LINK_PROPERTY_CLOBファンクション

クラウド・ストレージ・リンクの特定のプロパティ値をキャラクタ・ラージ・オブジェクト(CLOB)として取得します。

構文

FUNCTION GET_CLOUD_STORAGE_LINK_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  storage_link_name              IN VARCHAR2,
  storage_link_property          IN VARCHAR2
)
RETURN CLOB;

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`storage_link_name`	クラウド・ストレージ・リンクをクリックします。
`storage_link_property`	プロパティ値(`PROP_CUSTOM`、`PROP_METADATA`など)を返します。

ノート

GET_CLOUD_STORAGE_LINK_PROPERTYファンクション

親トピック: DBMS_CATALOGのサマリー

UPDATE_CLOUD_STORAGE_LINK_PROPERTYプロシージャ

カタログ内のクラウド・ストレージ・リンクの特定のプロパティ値を更新します。

構文

PROCEDURE UPDATE_CLOUD_STORAGE_LINK_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  storage_link_name              IN VARCHAR2,
  storage_link_property          IN VARCHAR2,
  new_value                      IN VARCHAR2
);

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`storage_link_name`	クラウド・ストレージ・リンクをクリックします。
`storage_link_property`	プロパティ値を更新します(たとえば、`PROP_CUSTOM`、`PROP_METADATA`)。
`new_value`	プロパティの新しい値を割り当てます。

ノート

UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOBプロシージャ

親トピック: DBMS_CATALOGのサマリー

UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOBプロシージャ

クラウド・ストレージ・リンクの特定のプロパティ値を、大きいデータのキャラクタ・ラージ・オブジェクト(CLOB)として更新します。

構文

PROCEDURE UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  storage_link_name              IN VARCHAR2,
  storage_link_property          IN VARCHAR2,
  new_value                      IN CLOB
);

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`storage_link_name`	クラウド・ストレージ・リンクをクリックします。
`storage_link_property`	プロパティ値を更新します(たとえば、`PROP_CUSTOM`、`PROP_METADATA`)。
`new_value`	CLOB形式で新しい値を割り当てます。

ノート

UPDATE_CLOUD_STORAGE_LINK_PROPERTYプロシージャ

親トピック: DBMS_CATALOGのサマリー

CREATE_CLOUD_STORAGE_LINKプロシージャ

この手順では、カタログにクラウドストレージリンクを作成します。

構文

PROCEDURE create_cloud_storage_link
(
  catalog_name 			IN VARCHAR2,
  schema_name 			IN VARCHAR2,
  storage_link_name 	IN VARCHAR2,
  uri 					IN VARCHAR2,
  required_credential 	IN VARCHAR2 := NULL,
  enabled 				IN BOOLEAN := TRUE,
  replace_if_exists 	IN BOOLEAN := FALSE
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name:`	スキーマ名。
`storage_link_name`	ストレージリンク名。
`uri`	バケットURI。
`required_credential`	必要な資格証明(またはパブリック・バケットの場合はNULL)。デフォルトはNULL。
`enabled`	ストレージ・リンクが検索に使用可能かどうかを示します。デフォルト値はTRUEです。
`replace_if_exists`	リンクがすでに存在する場合は、リンクを置き換えます。デフォルト値はFALSEです。

親トピック: DBMS_CATALOGのサマリー

DROP_CLOUD_STORAGE_LINKプロシージャ

この手順では、カタログからクラウドストレージリンクを削除します。

構文

PROCEDURE drop_cloud_storage_link
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  storage_link_name IN VARCHAR2
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name:`	スキーマ名。
`storage_link_name`	ストレージリンク名。

親トピック: DBMS_CATALOGのサマリー

GET_CLOUD_STORAGE_LINKSファンクション

カタログの特定のクラウド・ストレージ・リンクまたはすべてのクラウド・ストレージ・リンクを取得します。

構文

FUNCTION GET_CLOUD_STORAGE_LINKS
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2 := NULL,
  storage_link_name              IN VARCHAR2 := NULL,
  conditions                     IN VARCHAR2 := NULL,
  flags                          IN NUMBER := 0,
  result_limit                   IN NUMBER := NULL,
  column_flags                   IN NUMBER := 0
)
RETURN CATALOG_STORAGE_LINKS PIPELINED;

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	(オプション) ソース・カタログ・スキーマの名前。デフォルト値はNULLです。
`storage_link_name`	(オプション) クラウド・ストレージ・リンクをクリックします。デフォルト値はNULLです。
`conditions`	(オプション) 系統構文を使用した追加のフィルタ式。デフォルト値はNULLです。
`flags`	(オプション) 追加の制御のためのフラグ。デフォルトは0 (ゼロ)です。
`result_limit`	(オプション) 返す最大行数。デフォルト値はNULLです。
`column_flags`	(オプション) 列フラグ(`FETCH_PROPERTIES`、`FETCH_METADATA`など)。

ノート

CREATE_CLOUD_STORAGE_LINKプロシージャ

親トピック: DBMS_CATALOGのサマリー

GET_COLUMNSファンクション

カタログ内の表またはビューからすべての列を取得します。

構文

FUNCTION GET_COLUMNS
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2 := NULL,
  parent_type                    IN VARCHAR2 := NULL,
  column_name                    IN VARCHAR2 := NULL,
  conditions                     IN VARCHAR2 := NULL,
  flags                          IN NUMBER := 0,
  result_limit                   IN NUMBER := NULL,
  column_flags                   IN NUMBER := 0,
  table_name                     IN VARCHAR2 := NULL
)
RETURN COLUMN_RECORDS PIPELINED;

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	(オプション) ソース・カタログ・スキーマの名前。デフォルト値はNULLです。
`parent_type`	(オプション) 親オブジェクト・タイプ(表またはビュー)。デフォルト値はNULLです。
`column_name`	(オプション) 列の名前。デフォルト値はNULLです。
`conditions`	(オプション) 系統構文を使用した追加のフィルタ式。デフォルト値はNULLです。
`flags`	(オプション) 追加の制御のためのフラグ。デフォルトは0 (ゼロ)です。
`result_limit`	(オプション) 返される最大行数。デフォルト値はNULLです。
`column_flags`	(オプション) 列フラグ(`FETCH_PROPERTIES`、`FETCH_METADATA`など)。デフォルトは0 (ゼロ)です。
`table_name`	(オプション) ソース・カタログ表の名前。デフォルト値はNULLです。

ノート

CREATE_CLOUD_STORAGE_LINKプロシージャ

親トピック: DBMS_CATALOGのサマリー

CREATE_EXTERNAL_TABLEプロシージャ

カタログに外部表を作成します。

構文

PROCEDURE CREATE_EXTERNAL_TABLE
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  storage_link_name              IN VARCHAR2 := NULL,
  file_uri_list                  IN CLOB,
  column_list                    IN CLOB := NULL,
  field_list                     IN CLOB := NULL,
  table_format                   IN CLOB := NULL,
  credential_name                IN VARCHAR2 := NULL,
  replace_if_exists              IN BOOLEAN := FALSE
);

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`table_name`	ソース・カタログ表の名前。
`storage_link_name`	(オプション) クラウド・ストレージ・リンクをクリックします。デフォルト値はNULLです。
`file_uri_list`	CLOBとしての相対ファイル・リスト。
`column_list`	(オプション) 列リスト。デフォルト値はNULLです。
`field_list`	(オプション) 「フィールド」リストデフォルト値はNULLです。
`table_format`	(オプション) CSV、ParquetまたはAvro、デリミタ、ヘッダー、スキーマ導出設定など、外部ファイルを読み取るための形式またはオプション。JSONキーと値のペアで表されます。デフォルト値はNULLです。
`credential_name`	資格証明の名前。デフォルト値はNULLです。
`replace_if_exists`	オブジェクトがすでに存在する場合に置換するかどうかを示します。デフォルトはFALSE。

親トピック: DBMS_CATALOGのサマリー

CREATE_SCHEMAプロシージャ

カタログに新しいスキーマを作成します。リモート・カタログにApache Icebergスキーマを作成することもできます。

構文

PROCEDURE CREATE_SCHEMA
(
  catalog_name          IN VARCHAR2,
  schema_name           IN VARCHAR2,
  schema_definition     IN CLOB := NULL
);

パラメータ

パラメータ摘要

catalog_name

ソース・カタログの名前。値は大文字です。

schema_name

ソース・カタログ・スキーマの名前。

schema_definition

(オプション)

スキーマ定義ペイロード。

デフォルト値はNULLです。

ノート

DROP_SCHEMAプロシージャ

親トピック: DBMS_CATALOGのサマリー

DROP_SCHEMAプロシージャ

このプロシージャは、すべてのコンテンツとともにカタログからスキーマを削除します。

構文

PROCEDURE drop_schema
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name:`	削除するスキーマ名。

親トピック: DBMS_CATALOGのサマリー

GET_OBJECTSプロシージャ

このプロシージャは、カタログのすべてのオブジェクトをフェッチします。

構文

FUNCTION get_objects
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2 := NULL,
  object_name 	IN VARCHAR2 := NULL,
  conditions 	IN VARCHAR2 := NULL,
  flags 		IN NUMBER := 0,
  result_limit 	IN NUMBER := NULL
)
RETURN catalog_objects PIPELINED;

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	オプションのスキーマ名。デフォルトは`NULL`です。
`object_name`	オプションのオブジェクト名。デフォルトは`NULL`です。
`conditions`	系統構文を使用したオプションの追加条件。デフォルトは`NULL`です。
`result_limit`	オプションの結果制限。デフォルトはNULL。

親トピック: DBMS_CATALOGのサマリー

GET_SCHEMASプロシージャ

このプロシージャは、カタログのすべてのスキーマをフェッチします。

構文

FUNCTION get_schemas
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2 := NULL,
  conditions 	IN VARCHAR2 := NULL,
  flags 		IN NUMBER := 0,
  result_limit 	IN NUMBER := NULL,
  column_flags 	IN NUMBER := 0
)
RETURN catalog_schemas PIPELINED;

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	オプションのスキーマ名。デフォルトは`NULL`です。
`conditions`	系統構文を使用したオプションの追加条件。デフォルトは`NULL`です。
`result_limit`	オプションの結果制限。デフォルトはNULL。
`column_flags`	オプションの列フラグ(`FETCH_PROPERTIES`、`FETCH_METADATA`など)。デフォルトは0です。

親トピック: DBMS_CATALOGのサマリー

GET_TABLESプロシージャ

このプロシージャは、カタログのすべての表をフェッチします。

構文

FUNCTION get_tables
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2 := NULL,
  table_name 		IN VARCHAR2 := NULL,
  conditions 		IN VARCHAR2 := NULL,
  flags 			IN NUMBER := 0,
  result_limit 		IN NUMBER := NULL,
  column_flags 		IN NUMBER := 0
)
RETURN catalog_tables PIPELINED;

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	オプションのスキーマ名。デフォルトは`NULL`です。
`table_name`	オプションの表名。デフォルトは`NULL`です。
`conditions`	系統構文を使用したオプションの追加条件。デフォルトは`NULL`です。
`result_limit`	オプションの結果制限。デフォルトはNULL。
`column_flags`	オプションの列フラグ(`FETCH_PROPERTIES`、`FETCH_METADATA`など)。デフォルトは0です。

ノート

RECORD型は、データベース内の名前付きフィールドを含む構造化データを記述します。
データベースの情報スキーマ、システム・カタログを問い合せるか、データベース・イントロスペクション・ツールを使用してRECORD型の構造を確認する必要があります。

親トピック: DBMS_CATALOGのサマリー

GET_TABLEプロシージャ

出力およびキャッシュに関する考慮事項をカスタマイズするためのオプションとともに、カタログ内の特定の表の詳細情報をレコードとして取得します。

構文

PROCEDURE GET_TABLE
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  table_info                     OUT NOCOPY catalog_table,
  options                        IN CLOB := NULL,
  flags                          IN NUMBER := 0,
  column_flags                   IN NUMBER := 0,
  prev_gen_sql                   IN CLOB := NULL,
  prev_ts                        IN TIMESTAMP WITH TIME ZONE := NULL
);

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`table_name`	ソース・カタログ表の名前。
`options`	JSONオブジェクトとしての生成オプション(distinct、rowLimit、select、orderBy、ディレクティブなど)。デフォルト値はNULLです。
`flags`	(オプション) 追加の制御のためのフラグ。デフォルトは0 (ゼロ)です。
`column_flags`	(オプション) 列フラグ(`FETCH_PROPERTIES`、`FETCH_METADATA`など)。デフォルトは0 (ゼロ)です。
`prev_gen_sql`	増分処理用に以前に生成されたSELECT文(わかっている場合)。デフォルト値はNULLです。
`prev_ts`	前世代のタイムスタンプ(わかる場合)。デフォルト値はNULLです。

ノート

GET_TABLEファンクション

親トピック: DBMS_CATALOGのサマリー

GET_TABLEファンクション

JSON形式の特定の表の詳細情報をキャラクタ・ラージ・オブジェクト(CLOB)として取得します。

構文

FUNCTION GET_TABLE
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  options                        IN CLOB := NULL,
  flags                          IN NUMBER := 0,
  column_flags                   IN NUMBER := 0,
  prev_gen_sql                   IN CLOB := NULL,
  prev_ts                        IN TIMESTAMP WITH TIME ZONE := NULL
)
RETURN CLOB;

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`table_name`	ソース・カタログ表の名前。
`options`	JSONオブジェクトとしての生成オプション(distinct、rowLimit、select、orderBy、ディレクティブなど)。デフォルト値はNULLです。
`flags`	(オプション) 追加の制御のためのフラグ。デフォルトは0 (ゼロ)です。
`column_flags`	(オプション) 列フラグ(`FETCH_PROPERTIES`、`FETCH_METADATA`など)。デフォルトは0 (ゼロ)です。
`prev_gen_sql`	増分処理用に以前に生成されたSELECT文(既知の場合)。デフォルト値はNULLです。
`prev_ts`	前世代のタイムスタンプ(わかる場合)。デフォルト値はNULLです。

ノート

GET_TABLEプロシージャ

親トピック: DBMS_CATALOGのサマリー

DROP_TABLEプロシージャ

このプロシージャは、カタログから表を削除します。

構文

PROCEDURE drop_table
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2,
  table_name 	IN VARCHAR2
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	スキーマ名。
`table_name`	表名。

親トピック: DBMS_CATALOGのサマリー

GENERATE_TABLE_SELECT (オーバーロード)プロシージャ

このプロシージャは、論理表のSELECT文を生成します。

構文

PROCEDURE generate_table_select
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  table_name 		IN VARCHAR2,
  stmt 				IN OUT NOCOPY CLOB,
  options 			IN CLOB := NULL,
  prev_gen_sql 		IN CLOB := NULL,
  prev_ts 			IN TIMESTAMP WITH TIME ZONE := NULL
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	スキーマ名。
`table_name`	表名。
`stmt`	出力として生成されたSELECT文。
`options`	JSONオブジェクトとしての生成オプション(distinct、rowLimit、select、orderByなど)。デフォルトはNULL。
`prev_gen_sql`	以前に生成されたSELECT文がわかっている場合。デフォルトはNULL。
`prev_ts`	前の世代のタイムスタンプ(わかっている場合)。デフォルトはNULL。

構文

FUNCTION generate_table_select
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2,
  table_name 	IN VARCHAR2,
  options 		IN CLOB := NULL,
  prev_gen_sql 	IN CLOB := NULL,
  prev_ts 		IN TIMESTAMP WITH TIME ZONE := NULL
)
RETURN CLOB;

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	スキーマ名。
`table_name`	表名。
`stmt`	出力として生成されたSELECT文。
`options`	JSONオブジェクトとしての生成オプション(distinct、rowLimit、select、orderByなど)。デフォルトはNULL。
`prev_gen_sql`	以前に生成されたSELECT文がわかっている場合。デフォルトはNULL。
`prev_ts`	前の世代のタイムスタンプ(わかっている場合)。デフォルトはNULL。

親トピック: DBMS_CATALOGのサマリー

OPEN_TABLE_CURSORプロシージャ

このプロシージャは、論理表からデータを返すカーソルを開きます。

構文

PROCEDURE open_table_cursor
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2,
  table_name 	IN VARCHAR2,
  table_cursor 	IN OUT NOCOPY SYS_REFCURSOR,
  options 		IN CLOB := NULL
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	オプションのスキーマ名。デフォルトは`NULL`です。
`table_name`	オプションの表名。デフォルトは`NULL`です。
`table_cursor`	データを返すカーソル。
`options`	オプションをJSONオブジェクト(rowLimit、select、orderByなど)として生成します。デフォルトはNULL。

親トピック: DBMS_CATALOGのサマリー

FLUSH_CATALOG_CACHEプロシージャ

このプロシージャは、カタログ・メタデータ・キャッシュをフラッシュします。

構文

PROCEDURE flush_catalog_cache
(
  catalog_name 	IN VARCHAR2,
  auto_commit	IN BOOLEAN := TRUE
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`auto_commit`	変更を自動的にコミットするかどうかを示します。デフォルト値はTRUEです。

親トピック: DBMS_CATALOGのサマリー

PREFILL_CATALOG_CACHEプロシージャ

このプロシージャは、指定したカタログのキャッシュに現在のデータを入力します。

構文

PROCEDURE prefill_catalog_cache
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2 := NULL,
  auto_commit 	IN BOOLEAN := TRUE
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	このスキーマの名前。
`auto_commit`	変更を自動的にコミットするかどうかを示します。デフォルト値はTRUEです。

親トピック: DBMS_CATALOGのサマリー

CREATE_SYNCHRONIZED_SCHEMASプロシージャ

このプロシージャは、リモート・カタログ定義と同期したローカル・データベース・スキーマを作成します。

構文

PROCEDURE create_synchronized_schemas
(
  catalog_name IN VARCHAR2,
  schema_names IN VARCHAR2 := NULL,
  restrictions IN CLOB := NULL
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	スキーマ名のカンマ区切りリスト(引用符付きまたは引用符なし)。すべてのスキーマを同期するには、デフォルトでNULLに設定されます。
`restrictions`	カタログ・エンティティのスコープを指定するJSONドキュメント。デフォルトはNULL。

親トピック: DBMS_CATALOGのサマリー

DROP_SYNCHRONIZED_SCHEMASプロシージャ

このプロシージャは、1つ以上の同期スキーマを削除します。

構文

PROCEDURE drop_synchronized_schemas
(
  catalog_name IN VARCHAR2,
  schema_names IN VARCHAR2 := NULL,
  restrictions IN CLOB := NULL
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`schema_name`	スキーマ名のカンマ区切りリスト(引用符付きまたは引用符なし)。すべてのスキーマを同期するには、デフォルトでNULLに設定されます。
`restrictions`	カタログ・エンティティのスコープを指定するJSONドキュメント。デフォルトはNULL。

親トピック: DBMS_CATALOGのサマリー

UPDATE_SYNCHRONIZED_SCHEMA_PROPERTYプロシージャ

このプロシージャは、同期スキーマのプロパティを更新します。

構文

PROCEDURE update_synchronized_schema_property
(
  catalog_name 	IN VARCHAR2,
  property_name IN VARCHAR2,
  new_value 	IN CLOB
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`property_name`	更新するプロパティ名。
`new_value`	CLOBとしての新しい値。

親トピック: DBMS_CATALOGのサマリー

SYNCHRONIZE_SHARED_CATALOGSプロシージャ

使用できなくなったシェアに基づいてカタログを処理します。

構文

PROCEDURE SYNCHRONIZE_SHARED_CATALOGS
(
  provider_id                    IN NUMBER := NULL,
  remove_unavailable             IN BOOLEAN := TRUE
);

パラメータ

パラメータ摘要

provider_id

(オプション)

同期のスコープを識別します。変更は、指定されたシェアプロバイダIDに制限されます。NULLの場合は、期限切れのシェアを含むすべての登録済みシェアプロバイダが同期されます。

デフォルト値はNULLです。

remove_unavailable

共有の可用性に基づいて、カタログに対するアクションを決定します。

TRUE: 削除されたか使用できないシェアのオブジェクトをアンマウントします。
FALSE: シェアが使用できない場合、オブジェクトを無効にします。

デフォルトはTRUEです。

ノート

CREATE_SYNCHRONIZED_SCHEMASプロシージャ

親トピック: DBMS_CATALOGのサマリー

CREATE_SYNCHRONIZED_VIEWSプロシージャ

制限を定義するためのビューをカタログ表に作成します。

構文

PROCEDURE CREATE_SYNCHRONIZED_VIEWS
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2 := NULL,
  target_schema                  IN VARCHAR2 := NULL,
  table_names                    IN VARCHAR2 := NULL,
  view_prefix                    IN VARCHAR2 := NULL,
  replace_existing               IN BOOLEAN := FALSE,
  ignore_errors                  IN BOOLEAN := TRUE
);

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。デフォルト値はNULLです。
`target_schema`	ターゲット・スキーマの名前。デフォルト値はNULLです。
`table_names`	特定の表がターゲット指定されている場合は、表名のカンマ区切りリスト。デフォルト値はNULLです。
`view_prefix`	生成された各ビュー名の前に付加する文字列。デフォルト値はNULLです。
`replace_existing`	オブジェクトがすでに存在する場合に置換するかどうかを示します。デフォルトはFALSE。
`ignore_errors`	エラーを無視し、残りのオブジェクトで処理を続行するかどうかを示します。デフォルトはTRUEです。

ノート

CREATE_SYNCHRONIZED_SCHEMASプロシージャ

親トピック: DBMS_CATALOGのサマリー

COPY_TABLE_PROPERTIESプロシージャ

プロパティ・セットを選択し、列名変更マッピングを指定するオプションを使用して、カタログおよびスキーマ間で表プロパティおよびオプションで列プロパティをソース表からターゲット表にコピーします。

構文

PROCEDURE COPY_TABLE_PROPERTIES
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  target_catalog_name            IN VARCHAR2 := DEFAULT_CATALOG,
  target_schema_name             IN VARCHAR2 := NULL,
  target_table_name              IN VARCHAR2 := NULL,
  properties                     IN VARCHAR2 := PROP_CUSTOM,
  copy_column_props              IN BOOLEAN := TRUE,
  renamed_columns                IN CLOB := NULL
);

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`table_name`	ソース・カタログ表の名前。
`target_catalog_name`	ターゲット・カタログの名前。デフォルトは`DEFAULT_CATALOG`です。
`target_schema_name`	ターゲット・スキーマの名前。デフォルト値はNULLです。
`target_table_name`	ターゲット・カタログ表の名前。デフォルト値はNULLです。
`properties`	コピーするプロパティ(`CUSTOM:prop_x`など)。デフォルトは`PROP_CUSTOM`です。
`copy_column_props`	列のカスタム・プロパティをコピーするかどうかを示します。デフォルトはTRUEです。
`renamed_columns`	名前が変更されたターゲット列のJSONマッピング(`{"source_col":"target_col"}`など)。デフォルト値はNULLです。

ノート

GET_TABLE_PROPERTYプロシージャ

親トピック: DBMS_CATALOGのサマリー

GRANT_TO_RECIPIENTプロシージャ

このプロシージャは、カタログに対するアクセス権を特定の共有受信者に付与します。

構文

PROCEDURE grant_to_recipient
(
  catalog_name 		IN VARCHAR2,
  recipient_name 	IN VARCHAR2
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`recipient_name`	共有受信者の名前(`DBMS_SHARE.CREATE_SHARE_RECIPIENT`で作成)。

親トピック: DBMS_CATALOGのサマリー

REVOKE_FROM_RECIPIENTプロシージャ

このプロシージャは、特定の受信者からカタログへのアクセスを取り消します。

構文

PROCEDURE revoke_from_recipient
(
  catalog_name 		IN VARCHAR2,
  recipient_name 	IN VARCHAR2,
  owner 			IN VARCHAR2 := NULL
);

パラメータ

パラメータ	摘要
`catalog_name`	既存のカタログの名前。これは大文字に変換されます。
`recipient_name`	共有受信者の名前(`DBMS_SHARE.CREATE_SHARE_RECIPIENT`で作成)。
`owner`	カタログと受信者の両方の所有者。デフォルトは`NULL`です。

親トピック: DBMS_CATALOGのサマリー

CLEAR_CATALOG_EVENTSプロシージャ

構文

PROCEDURE CLEAR_CATALOG_EVENTS
(
  catalog_name                   IN VARCHAR2,
  from_time                      IN TIMESTAMP WITH TIME ZONE := NULL,
  to_time                        IN TIMESTAMP WITH TIME ZONE := NULL
);

パラメータ

パラメータ摘要

catalog_name

ソース・カタログの名前。値は大文字です。

from_time

オプション

クリアするイベントの範囲の開始時間。

デフォルト値はNULLです。

to_time

オプション

クリアするイベント範囲の終了時間。

デフォルト値はNULLです。

親トピック: DBMS_CATALOGのサマリー

CREATE_ICEBERG_TABLEプロシージャ

カタログ内の指定されたスキーマ内に新しいIceberg表を作成し、結果のメタデータを返します。

構文

PROCEDURE CREATE_ICEBERG_TABLE
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  table_definition               IN CLOB,
  out_metadata                   OUT NOCOPY CLOB
);

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`table_name`	新規表の名前。
`table_definition`	CLOBとしての表定義。
`out_metadata`	出力後の結果の表メタデータ。

ノート

ADD_ICEBERG_SNAPSHOTプロシージャ

親トピック: DBMS_CATALOGのサマリー

ADD_ICEBERG_SNAPSHOTプロシージャ

Iceberg表にスナップショットを追加して、データ変更(系統およびコンテンツをトラッキングするための詳細なメタデータおよびオプション・パラメータを含む)を表します。

構文

PROCEDURE ADD_ICEBERG_SNAPSHOT
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  new_snapshot_id                IN NUMBER,
  new_timestamp                  TIMESTAMP WITH TIME ZONE,
  new_manifest_list              IN VARCHAR2,
  new_summary                    IN CLOB := NULL,
  new_parent_snapshot_id         IN NUMBER := NULL,
  new_sequence_number            IN NUMBER := NULL,
  new_first_row_id               IN NUMBER := NULL,
  new_added_row_count            IN NUMBER := NULL,
  new_schema_id                  IN NUMBER := NULL,
  requirements                   IN CLOB := NULL,
  out_metadata                   OUT NOCOPY CLOB
);

パラメータ

パラメータ	摘要
`catalog_name`	ソース・カタログの名前。値は大文字です。
`schema_name`	ソース・カタログ・スキーマの名前。
`table_name`	新規表の名前。
`new_snapshot_id`	新しいスナップショットの一意の識別子。
`new_timestamp`	スナップショットが作成された時点のタイムスタンプ。
`new_manifest_list`	マニフェスト・リスト・ファイルの場所、パスまたはURI。
`new_summary`	少なくとも「操作」フィールドを含むスナップショットのメタデータサマリー。
`new_parent_snapshot_id`	このスナップショットの親のID。これはルート・スナップショットには該当しません。
`new_sequence_number`	テーブル変更の順序を追跡するための増分番号。
`new_first_row_id`	スナップショットの最初のデータファイルの最初の行に割り当てられた開始行ID。
`new_added_row_count`	スナップショットに追加された行数。
`new_schema_id`	スナップショットの作成時にアクティブな表スキーマのID。
`requirements`	コミットの事前条件(JSON配列形式)。
`out_metadata`	出力後の結果の表メタデータ。

ノート

CREATE_ICEBERG_TABLEプロシージャ

親トピック: DBMS_CATALOGのサマリー

Oracle Cloud Infrastructureドキュメント

DBMS_CATALOGの概要

MOUNT_DATA_CATALOGプロシージャ

MOUNT_DB_LINKプロシージャ

MOUNT_ICEBERGプロシージャ

MOUNT_SHAREプロシージャ

MOUNT_SHARESプロシージャ

MOUNT_VIRTUAL_CATALOGプロシージャ

UNMOUNTプロシージャ

GET_CATALOG_PROPERTYプロシージャ

GET_CATALOG_PROPERTY_CLOBプロシージャ

UPDATE_CATALOG_PROPERTYプロシージャ

UPDATE_CATALOG_PROPERTY_CLOBプロシージャ

GET_COLUMN_PROPERTYファンクション

GET_COLUMN_PROPERTY_CLOBファンクション

UPDATE_COLUMN_PROPERTYプロシージャ

UPDATE_COLUMN_PROPERTY_CLOBプロシージャ

GET_SCHEMA_PROPERTYプロシージャ

GET_SCHEMA_PROPERTY_CLOBプロシージャ

UPDATE_SCHEMA_PROPERTYプロシージャ

UPDATE_SCHEMA_PROPERTY_CLOBプロシージャ

GET_TABLE_PROPERTYプロシージャ

GET_TABLE_PROPERTY_CLOBプロシージャ

UPDATE_TABLE_PROPERTYプロシージャ

UPDATE_TABLE_PROPERTY_CLOBプロシージャ

ADD_REQUIRED_CREDENTIALプロシージャ

REMOVE_REQUIRED_CREDENTIALプロシージャ

RENAME_REQUIRED_CREDENTIALプロシージャ

GET_REQUIRED_CREDENTIAL_PROPERTYプロシージャ

UPDATE_REQUIRED_CREDENTIAL_PROPERTYプロシージャ

GET_LOCAL_CREDENTIAL_MAP (オーバーロード)プロシージャ

SET_LOCAL_CREDENTIALプロシージャ

GET_CLOUD_STORAGE_LINK_PROPERTYファンクション

GET_CLOUD_STORAGE_LINK_PROPERTY_CLOBファンクション

UPDATE_CLOUD_STORAGE_LINK_PROPERTYプロシージャ

UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOBプロシージャ

CREATE_CLOUD_STORAGE_LINKプロシージャ

DROP_CLOUD_STORAGE_LINKプロシージャ

GET_CLOUD_STORAGE_LINKSファンクション

GET_COLUMNSファンクション

CREATE_EXTERNAL_TABLEプロシージャ

CREATE_SCHEMAプロシージャ

DROP_SCHEMAプロシージャ

GET_OBJECTSプロシージャ

GET_SCHEMASプロシージャ

GET_TABLESプロシージャ

GET_TABLEプロシージャ

GET_TABLEファンクション

DROP_TABLEプロシージャ

GENERATE_TABLE_SELECT (オーバーロード)プロシージャ

OPEN_TABLE_CURSORプロシージャ

FLUSH_CATALOG_CACHEプロシージャ

PREFILL_CATALOG_CACHEプロシージャ

CREATE_SYNCHRONIZED_SCHEMASプロシージャ

DROP_SYNCHRONIZED_SCHEMASプロシージャ

UPDATE_SYNCHRONIZED_SCHEMA_PROPERTYプロシージャ

SYNCHRONIZE_SHARED_CATALOGSプロシージャ

CREATE_SYNCHRONIZED_VIEWSプロシージャ

COPY_TABLE_PROPERTIESプロシージャ

GRANT_TO_RECIPIENTプロシージャ

REVOKE_FROM_RECIPIENTプロシージャ

CLEAR_CATALOG_EVENTSプロシージャ

CREATE_ICEBERG_TABLEプロシージャ

ADD_ICEBERG_SNAPSHOTプロシージャ