DBMS_CLOUDサブプログラムおよびREST API

この項では、Autonomous Databaseで提供されるDBMS_CLOUDサブプログラムおよびREST APIについて説明します。

ノート

DBMS_CLOUDサブプログラムをADMIN以外のユーザーで実行するには、そのユーザーにEXECUTE権限を付与する必要があります。たとえば、adb_userに権限を付与するには、ADMINとして次のコマンドを実行します:
GRANT EXECUTE ON DBMS_CLOUD TO adb_user;

DBMS_CLOUDパッケージは、次で構成されます:

アクセス管理用のDBMS_CLOUD

資格証明の作成、削除および更新を含む、DBMS_CLOUDパッケージ内の資格証明管理のためのサブプログラム。

サブプログラム 説明

CREATE_CREDENTIALプロシージャ

このプロシージャは、クラウド・サービス資格証明をAutonomous Databaseに格納します。

DROP_CREDENTIALプロシージャ

このプロシージャは、既存の資格証明をAutonomous Databaseから削除します。

REFRESH_VAULT_CREDENTIALプロシージャ

このプロシージャは、ボールト・シークレット資格証明のボールト・シークレットをただちにリフレッシュして、Autonomous Databaseで指定したcredential_nameのボールト・シークレットの最新バージョンを取得します。

UPDATE_CREDENTIALプロシージャ

このプロシージャは、Autonomous Database内のクラウド・サービス資格証明属性を更新します。

CREATE_CREDENTIALプロシージャ

このプロシージャは、クラウド・サービス資格証明をAutonomous Databaseに格納します。

データのロードやクラウド内の外部データの問合せを行う場合、または他のケースでDBMS_CLOUDプロシージャをcredential_nameパラメータとともに使用する場合、格納されたクラウド・サービス資格証明を使用してクラウド・サービスにアクセスします。このプロシージャはオーバーロードされています:

  • Oracle Cloud Infrastructure関連のパラメータ(user_ocidtenancy_ocidprivate_keyおよびfingerprint)は、Oracle Cloud Infrastructure署名キー認証を使用している場合にのみ使用します。

  • 次のいずれかに対して、paramsパラメータを使用します。

    • Amazonリソース名(ARN)資格証明

    • Google AnalyticsまたはGoogle BigQuery資格証明

    • サポートされているボールトで使用するVaultシークレット資格証明:

      • Oracle Cloud Infrastructure Vault
      • Azure Key Vault
      • AWSシークレット・マネージャ
      • GCPシークレット・マネージャ

構文

DBMS_CLOUD.CREATE_CREDENTIAL (
      credential_name   IN VARCHAR2,
      username          IN VARCHAR2,
      password          IN VARCHAR2 DEFAULT NULL);


DBMS_CLOUD.CREATE_CREDENTIAL (
      credential_name IN VARCHAR2,
      user_ocid       IN VARCHAR2,
      tenancy_ocid    IN VARCHAR2,
      private_key     IN VARCHAR2,
      fingerprint     IN VARCHAR2);


DBMS_CLOUD.CREATE_CREDENTIAL (
      credential_name  IN VARCHAR2,
      params           IN CLOB DEFAULT);

パラメータ

パラメータ 説明

credential_name

格納する資格証明の名前。credential_nameパラメータは、スペースやハイフンを使用できないOracleオブジェクトの命名規則に準拠している必要があります。

username

username引数とpassword引数の両方で、クラウド・サービス資格証明を指定します。各クラウド・サービスのusernameおよびpasswordの指定内容については、使用上のノートを参照してください。

password

username引数とpassword引数の両方で、クラウド・サービス資格証明を指定します。

user_ocid

ユーザーのOCIDを指定します。ユーザーのOCIDの取得の詳細は、テナンシのOCIDおよびユーザーのOCIDの取得場所を参照してください。

tenancy_ocid

テナンシのOCIDを指定します。テナンシのOCIDの取得の詳細は、テナンシのOCIDおよびユーザーのOCIDの取得場所を参照してください。

private_key

生成された秘密キーを指定します。パスフレーズを設定して生成された秘密キーはサポートされていません。パスフレーズなしで秘密キーを生成する必要があります。PEMフォーマットのキー・ペアの生成の詳細は、API署名キーの生成方法を参照してください。

fingerprint

フィンガープリントを指定します。生成された公開キーがユーザーのアカウントにアップロードされると、コンソールにフィンガープリントが表示されます。表示されたフィンガープリントをこの引数に使用します。詳細は、キーのフィンガープリントの取得方法およびAPI署名キーの生成方法を参照してください。

params

次のいずれかの資格証明パラメータを指定します。

  • Amazonリソース名(ARN)資格証明

  • Google AnalyticsまたはGoogle BigQuery資格証明

  • サポートされているボールトにパスワードを格納するユーザー名/パスワード・タイプの資格証明で使用するVaultシークレット資格証明:

    • Oracle Cloud Infrastructure Vault

    • Azure Key Vault

    • AWSシークレット・マネージャ

    • GCPシークレット・マネージャ

    ボールト・シークレット資格証明を作成するには、DBMS_CLOUDパッケージに対するEXECUTE権限が必要です。

使用上のノート

  • この操作によって、資格証明が暗号化された形式でデータベースに格納されます。

  • ユーザーは、user_credentials表を問い合せることにより、自分のスキーマ内の資格証明を確認できます。

  • ADMINユーザーは、dba_credentials表を問い合せることにより、すべての資格証明を表示できます。

  • クラウド・サービス資格証明が変更されないかぎり、資格証明を作成する必要があるのは1回のみです。資格証明を一度格納したら、credential_nameパラメータを必要とするDBMS_CLOUDプロシージャに対して同じ資格証明名を使用できます。

  • このプロシージャはオーバーロードされています。キー・ベースの認証属性user_ocidtenancy_ocidprivate_keyまたはfingerprintのいずれかを指定すると、コールはOracle Cloud Infrastructure署名キー・ベースの資格証明であるとみなされます。

  • ビューALL_CREDENTIALSから資格証明をリストできます。たとえば、次のコマンドを実行して資格証明をリストします:

    SELECT credential_name, username, comments FROM all_credentials;

Oracle Cloud Infrastructure資格証明(認証トークン)

Oracle Cloud Infrastructureの場合、usernameはOracle Cloud Infrastructureのユーザー名です。passwordはOracle Cloud Infrastructureの認証トークンです。認証トークンの作業を参照してください。

たとえば:

BEGIN
  DBMS_CLOUD.CREATE_CREDENTIAL(
    credential_name => 'DEF_CRED_NAME',
    username => 'adb_user@example.com',
    password => 'password' );
END;
/

OCIオブジェクト・ストレージへのコールを認証する場合は、認証トークン・ベースの資格証明を使用します。他のタイプのOracle Cloud Infrastructureクラウド・サービスへのコールには、Oracle Cloud Infrastructure署名キー・ベースの資格証明を使用します。

OCIオブジェクト・ストレージの場合、usernameパラメータ値には、アイデンティティ・ドメインとプロファイルのユーザー名を含める必要があります。ユーザーに関連付けられているアイデンティティ・ドメインは、Oracle Cloud Infrastructure Consoleにあります。

たとえば:

oracleidentitycloudservice/adb_user@example.com

デフォルトのアイデンティティ・ドメインでは、ドメイン名Defaultを含める必要はありません。たとえば:

adb_user@example.com

Oracle Cloud Infrastructure署名キー・ベースの資格証明

Oracle Cloud Infrastructure署名キー認証では、Oracle Cloud Infrastructure署名キー関連のパラメータ(user_ocidtenancy_ocidprivate_keyfingerprintなど)を使用します。

次に例を示します。

BEGIN
   DBMS_CLOUD.CREATE_CREDENTIAL (
       credential_name => ‘OCI_KEY_CRED’,
       user_ocid       => ‘ocid1.user.oc1..aaaaaaaauq54mi7zdyfhw33ozkwuontjceel7fok5nq3bf2vwetkpqsoa’,
       tenancy_ocid    => ‘ocid1.tenancy.oc1..aabbbbbbaafcue47pqmrf4vigneebgbcmmoy5r7xvoypicjqqge32ewnrcyx2a’,
       private_key     => ‘MIIEogIBAAKCAQEAtUnxbmrekwgVac6FdWeRzoXvIpA9+0r1.....wtnNpESQQQ0QLGPD8NM//JEBg=’,
       fingerprint     => ‘f2:db:f9:18:a4:aa:fc:94:f4:f6:6c:39:96:16:aa:27’);
END;
/

パスフレーズを設定して生成された秘密キーはサポートされていません。パスフレーズなしで秘密キーを生成する必要があります。詳細は、API署名キーの生成方法を参照してください。

Oracle Cloud Infrastructure Object Storage Classicの資格証明

ソース・ファイルがOracle Cloud Infrastructure Object Storage Classicに存在する場合、usernameはOracle Cloud Infrastructure Classicのユーザー名で、passwordはOracle Cloud Infrastructure Classicのパスワードです。

Amazon Web Services (AWS)の資格証明

ソース・ファイルがAmazon S3に存在する場合、またはAWS APIをコールしている場合、usernameはAWSのアクセス・キーIDで、passwordはAWSのシークレット・アクセス・キーです。AWS Identity and Access Managementを参照してください。

Microsoft Azureの資格証明

ソース・ファイルがAzure Blob StorageまたはAzure Data Lake Storageに存在する場合、またはAzure APIをコールする場合、usernameはAzureストレージ・アカウント名で、passwordはAzureストレージ・アカウント・アクセス・キーです。Azureストレージ・アカウントについてを参照してください。

Amazon S3互換の資格証明

サービス 資格証明情報

Oracle Cloud Infrastructure (顧客秘密キー)

ソース・ファイルがOracle Cloud Infrastructureに存在する場合は、顧客秘密キーをS3互換URLとともに使用する必要があります。詳細は、顧客秘密キーの作業を参照してください。

Google Cloud Storage

ソース・ファイルがGoogle Cloud Storageに存在する場合、またはGoogle Cloud Storage APIをコールしている場合は、デフォルトのGoogleプロジェクトを設定し、HMACキーを取得して、Google Cloud Storage S3互換URLを提供する資格証明を作成する必要があります。ユーザー名としてHMACキーIDを使用し、パスワードとしてHMACシークレットを使用します。

詳細は、プロジェクトおよびHMACキーを参照してください。

Wasabi Hot Cloud Storage

ソース・ファイルがWasabi Hot Cloud Storageに存在する場合、またはWasabi Hot Cloud Storage APIをコールしている場合は、S3互換URLを提供する資格証明を作成するためにアクセス・キーが必要です。ユーザー名としてWasabi Hot Cloud Storageアクセス・キーを使用し、パスワードとしてWasabi Hot Cloud Storage秘密キーを使用します。

詳細は、Wasabi APIアクセス・キー・セットの作成を参照してください。

AWS Amazon Resource Name (ARN)の資格証明

ソース・ファイルがAmazon S3にある場合、またはAWS APIをコールしている場合、paramsを使用してAmazonリソース名(ARN)のパラメータを指定します。

パラメータ
aws_role_arn

AWSロールを識別するAmazonリソース名(ARN)を指定します。

資格証明の作成時にこのパラメータを指定しなかった場合は、ORA-20041が発生します。

external_id_type

オプションで、compartment_ociddatabase_ocidまたはtenant_ocidのいずれかを指定することで、Autonomous DatabaseのコンパートメントOCID、データベースOCIDまたはテナンシOCIDを使用するようにexternal_id_typeを設定します。

資格証明の作成時にこのパラメータを指定しない場合、デフォルト値はdatabase_ocidです。

次に例を示します。

BEGIN DBMS_CLOUD.CREATE_CREDENTIAL(
        credential_name      => 'MY_CRED',
        params               => JSON_OBJECT(
               'aws_role_arn'      value 'arn:aws:iam::123456:role/AWS_ROLE_ARN',
               'external_id_type'  value 'database_ocid'));
END;
/

GitHub個人アクセス・トークン

ソース・ファイルがGitHubリポジトリにある場合、またはGitHub APIをコールしている場合、usernameはGitHubの電子メールで、passwordはGitHubの個人アクセス・トークンです。詳細は、個人用アクセス トークンの作成を参照してください。

たとえば:

BEGIN
  DBMS_CLOUD.CREATE_CREDENTIAL(
    credential_name => 'MY_GITHUB_CRED',
    username => 'user@example.com',
    password => 'your_personal_access_token' );
END;
/

Google AnalyticsまたはGoogle BigQuery資格証明

Google AnalyticsまたはGoogle BigQueryにアクセスする場合は、paramsパラメータを使用して、Google OAuth 2.0資格証明パラメータを指定します。

パラメータ
gcp_oauth2

Google AnalyticsまたはGoogle BigQueryのOAuth 2.0アクセスを、次のパラメータとその値を含むJSONオブジェクトとともに指定します。

  • client_id: クライアントIDを取得するには、Google APIコンソールを参照してください。

  • client_secret: クライアント・シークレットを取得するには、Google APIコンソールを参照してください。

  • refresh_token: リフレッシュ・トークンを使用すると、アプリケーションは新しいアクセス・トークンを取得できます。

Google OAuth資格証明の詳細は、「OAuth 2.0を使用したGoogle APIへのアクセス」を参照してください。

たとえば:

BEGIN DBMS_CLOUD.CREATE_CREDENTIAL(
      credential_name => 'GOOGLE_BIGQUERY_CRED',
      params => JSON_OBJECT('gcp_oauth2' value 
                                  JSON_OBJECT(
                                       'client_id'     value 'client_id',
                                       'client_secret' value 'client_secret',
                                       'refresh_token' value 'refresh_token' )));
END;
/

Oracle Cloud Infrastructure Vaultを使用したVaultシークレット資格証明

Oracle Cloud Infrastructure Vaultを使用してボールト・シークレット資格証明を作成するには、paramsパラメータを使用して必要なパラメータを指定します:

  • username: OCI Swiftパスワードのユーザー名など、任意のタイプのユーザー名/パスワード資格証明のユーザー名を指定します。たとえば、ユーザー名がscott、パスワードがpasswordのSwift資格証明がある場合、usernameパラメータとしてscottを指定します。

  • secret_id: ボールト・シークレットIDです。ボールト・シークレットOCIDとしてsecret_id値を指定します。詳細は、Vaultの概要を参照してください。

  • region: oracleクラウド・リージョン識別子を指定するオプションのパラメータです。リージョンが指定されている場合、Oracle Cloud Infrastructure Vaultシークレットが配置されている場所を示します。

    デフォルトでは、CREATE_CREDENTIALは、secret_idのリージョン・キーからマップされたregionを使用します。リージョンの例は、us-ashburn-1です。

    リージョンの完全なリストは、リージョンおよび可用性ドメインを参照してください。

次に例を示します。

BEGIN DBMS_CLOUD.CREATE_CREDENTIAL(
    credential_name => 'OCI_SECRET_CRED',
    params => JSON_OBJECT( 
                'username'   value 'scott',
                'region'     value 'us-ashburn-1',
                'secret_id'  value 'ocid1.vaultsecret.co1.ap-mumbai-1.example..aaaaaaaauq5ok5nq3bf2vwetkpqsoa'));
END;
/

Oracle Cloud Infrastructure Vaultシークレットを使用してボールト・シークレットを格納するためのノート:

  • Oracle Cloud Infrastructure Vaultを使用する場合、Autonomous DatabaseインスタンスでDBMS_CLOUD_ADMIN.ENABLE_RESOURCE_PRINCIPALを使用してプリンシパル認証を有効にする必要があります。
  • Oracle Cloud Infrastructureでは、リソース・プリンシパルがシークレットにアクセスするためのポリシーを指定する必要があります。

ボールト・シークレット資格証明を作成するには、DBMS_CLOUDパッケージに対するEXECUTE権限が必要です。

Azure Key Vaultを使用したVaultシークレット資格証明

Azure Key Vault資格証明を作成するには、paramsパラメータを使用して必要なパラメータを指定します:

  • username: キーに関連付けられているユーザー名を指定します。

  • secret_id: シークレット名を指定します。

  • azure_vault_name: シークレットが存在するボールトの名前を指定します。

詳細は、キー・ボールトの作成を参照してください。

ボールト・シークレット資格証明を作成するには、DBMS_CLOUDパッケージに対するEXECUTE権限が必要です。

AWSシークレット・マネージャを使用したVaultシークレット資格証明

AWSシークレット・マネージャを使用してボールト・シークレット資格証明を作成するには、paramsパラメータを使用して必要なパラメータを指定します:

  • username: AWSシークレット・マネージャ・アクセス・キーを指定します。

  • secret_id: AWSシークレット・マネージャAWS ARNです。

  • region: (オプション)ボールトおよびシークレットがあるAWSサービス・リージョンを指定します。AWSリージョンの例は「us-east-2」です。デフォルトのregionは、secret_idパラメータのARNで指定されたリージョンです。

    詳細は、AWSリージョンの管理を参照してください。

    ボールト・シークレット資格証明を作成するには、DBMS_CLOUDパッケージに対するEXECUTE権限が必要です。

GCPシークレット・マネージャを使用したVaultシークレット資格証明

GCPシークレット・マネージャ資格証明を作成するには、paramsパラメータを使用して必要なパラメータを指定します:

  • username: シークレットに関連付けられているユーザー名を指定します。

  • secret_id: シークレット名です。

  • gcp_project_id: シークレットが配置されているプロジェクトのIDを指定します。

詳細は、「シークレット・マネージャ」を参照してください。

ボールト・シークレット資格証明を作成するには、DBMS_CLOUDパッケージに対するEXECUTE権限が必要です。

DROP_CREDENTIALプロシージャ

このプロシージャは、既存の資格証明をAutonomous Databaseから削除します。

構文

DBMS_CLOUD.DROP_CREDENTIAL (
   credential_name     IN VARCHAR2);

パラメータ

パラメータ 説明

credential_name

削除する資格証明の名前。

REFRESH_VAULT_CREDENTIALプロシージャ

このプロシージャは、ボールト・シークレット資格証明のボールト・シークレットをリフレッシュします。

このプロシージャを使用すると、ボールト・シークレット資格証明のボールト・シークレットをすぐにリフレッシュして、指定したcredential_nameのボールト・シークレットの最新バージョンを取得できます。

構文

DBMS_CLOUD.REFRESH_VAULT_CREDENTIAL (
    credential_name   IN VARCHAR2);

パラメータ

パラメータ 説明

credential_name

リフレッシュする資格証明の名前。

使用上のノート

  • ADMINユーザーは、dba_credentials表を問い合せることにより、すべての資格証明を表示できます。

  • ビューALL_CREDENTIALSから資格証明をリストできます。たとえば、次のコマンドを実行して資格証明をリストします:

    SELECT credential_name, username, comments FROM all_credentials;

BEGIN
  DBMS_CLOUD.REFRESH_VAULT_CREDENTIAL(
     credential_name => 'AZURE_SECRET_CRED'); 
END;
/

UPDATE_CREDENTIALプロシージャ

このプロシージャは、指定したcredential_nameの属性を新しい値で更新します。

データのロードやクラウド内の外部データの問合せを行う場合、またはcredential_nameパラメータでDBMS_CLOUDプロシージャを使用する場合は、格納された資格証明を使用します。

構文

DBMS_CLOUD.UPDATE_CREDENTIAL (
    credential_name   IN VARCHAR2,
    attribute         IN VARCHAR2,
    value             IN VARCHAR2);

パラメータ

パラメータ 説明

credential_name

更新する資格証明の名前。

attribute

更新する属性の名前。

ユーザー名/パスワード・タイプの資格証明の場合、有効なattribute値はUSERNAMEおよびPASSWORDです。

Amazon ARNの資格証明の場合、有効なattribute値: aws_role_arnおよびexternal_id_type

Google BigQueryまたはGoogle Analyticsの資格証明の場合、有効なattribute値はclient_idclient_secretおよびrefresh_tokenです。

使用しているボールトに応じて、Vaultシークレット資格証明の場合、有効なattribute値は次のとおりです:
  • Oracle Cloud Infrastructure Vault: secret_idregion

  • Azure Key Vault: secret_idazure_vault_name

  • AWSシークレット・マネージャ: secret_idregion

  • GCPシークレット・マネージャ: secret_idgcp_project_id

詳細は、CREATE_CREDENTIALプロシージャを参照してください。

value

指定した属性の新しい値。

使用上のノート

  • ユーザー名の値では大文字と小文字が区別されます。二重引用符や空白を含めることはできません。

  • ADMINユーザーは、dba_credentialsを問い合せると、すべての資格証明を表示できます。

  • クラウド・サービス資格証明が変更されないかぎり、資格証明を作成する必要があるのは1回のみです。資格証明を一度格納したら、credential_nameパラメータを必要とするDBMS_CLOUDプロシージャに対して同じ資格証明名を使用できます。

  • ビューALL_CREDENTIALSから資格証明をリストできます。たとえば、次のコマンドを実行して資格証明をリストします:

    SELECT credential_name, username, comments FROM all_credentials;

サンプル

BEGIN
  DBMS_CLOUD.UPDATE_CREDENTIAL(
     credential_name => 'OBJ_STORE_CRED',
     attribute => 'PASSWORD',
     value => 'password'); 
END;
/
BEGIN
  DBMS_CLOUD.UPDATE_CREDENTIAL(
     credential_name => 'ARN_CRED',
     attribute => 'aws_role_arn',
     value => 'NEW_AWS_ARN'); 
END;
/

オブジェクトおよびファイル用のDBMS_CLOUD

DBMS_CLOUDパッケージ内のオブジェクト管理およびファイル管理のサブプログラム。

サブプログラム 説明

COPY_COLLECTIONプロシージャ

このプロシージャは、クラウド・オブジェクト・ストレージまたはディレクトリ内のファイルから、既存のSODAコレクションにデータをロードします。

COPY_DATAプロシージャ

このプロシージャは、クラウド・オブジェクト・ストレージまたはディレクトリ内のファイルから、既存のAutonomous Database表にデータをロードします。

COPY_DATA Avro、ORCまたはParquetファイル用のプロシージャ

このプロシージャは、formatパラメータのtypeを値orcparquetまたはavroに設定すると、クラウドのORC、ParquetまたはAvroファイルから、またはディレクトリ内のORC、ParquetまたはAvroファイルから、既存のAutonomous Database表にデータをロードします。

テキスト・ファイルと同様に、データはソースのORC、ParquetまたはAvroファイルから既存の内部表にコピーされます。

COPY_OBJECTプロシージャ

このプロシージャは、あるクラウド・オブジェクト・ストレージ・バケットから別のクラウド・オブジェクト・ストレージ・バケットにファイルをコピーします。

CREATE_EXTERNAL_TABLEプロシージャ

このプロシージャでは、クラウド内のファイルに基づいて、またはディレクトリ内のファイルに外部表を作成します。これにより、Autonomous Databaseから外部データに対する問合せを実行できます。
CREATE_CLOUD_TABLEプロシージャ

このプロシージャは、すべての永続データがOracle管理のObject Storageに格納されるクラウド表を作成します。

Apache IcebergのCREATE_EXTERNAL_TABLEプロシージャ

このプロシージャは、サポートされている構成でApache Iceberg表の外部表を作成します。

CREATE_EXTERNAL_TABLE Avro、ORCまたはParquetファイル用のプロシージャ

このプロシージャは、formatパラメータのtypeを値parquetorcまたはavroに設定することで、クラウドまたはディレクトリ内のParquet、ORCまたはAvroフォーマット・ファイルを使用して外部表を作成します。

これにより、Autonomous Databaseから外部データに対する問合せを実行できます。

CREATE_EXTERNAL_PART_TABLEプロシージャ

このプロシージャは、クラウド内のファイルに外部パーティション表を作成します。これにより、Autonomous Databaseから外部データに対する問合せを実行できます。

CREATE_EXTERNAL_TEXT_INDEXプロシージャ

このプロシージャは、オブジェクト・ストア・ファイルにテキスト索引を作成します。

CREATE_HYBRID_PART_TABLEプロシージャ

このプロシージャは、ハイブリッド・パーティション表を作成します。これにより、Autonomous Databaseからハイブリッド・パーティション・データに対する問合せを実行できます。

DELETE_ALL_OPERATIONSプロシージャ

このプロシージャは、スキーマ内のuser_load_operations表に記録されたすべてのデータ・ロード操作をクリアするか、typeパラメータで示されている、指定されたタイプのすべてのデータ・ロード操作をクリアします。

DELETE_FILEプロシージャ

このプロシージャは、Autonomous Database上の指定されたディレクトリから指定されたファイルを削除します

DELETE_OBJECTプロシージャ

このプロシージャは、オブジェクト・ストアの指定されたオブジェクトを削除します。

DELETE_OPERATIONプロシージャ

このプロシージャは、入力としてoperation_idを受け入れ、指定したoperation_idに関連付けられているログを削除します。

DROP_EXTERNAL_TEXT_INDEXプロシージャ

このプロシージャは、オブジェクト・ストア・ファイルのテキスト索引を削除します。

EXPORT_DATAプロシージャ

このプロシージャは、問合せの結果に基づいて、Autonomous Databaseからクラウドのファイルにデータをエクスポートします。オーバーロード・フォームでは、operation_idパラメータを使用できます。指定したformatパラメータのtypeオプションに応じて、プロシージャは、CSV、JSON、ParquetまたはXMLのオプションを含むテキストとしてクラウド・オブジェクト・ストアに行をエクスポートするか、ORACLE_DATAPUMPアクセス・ドライバを使用してダンプ・ファイルにデータを書き込みます。

GET_OBJECTプロシージャおよびファンクション

このプロシージャはオーバーロードされています。このプロシージャ・フォームは、クラウド・オブジェクト・ストレージからオブジェクトを読み取り、それをAutonomous Databaseにコピーします。このファンクション・フォームは、Cloud Object Storageからオブジェクトを読み取り、Autonomous DatabaseにBLOBを返します。

LIST_FILESファンクション

このファンクションは、指定されたディレクトリ内のファイルを一覧表示します。結果には、ファイル名と、ファイルに関する追加のメタデータ(ファイル・サイズ(バイト)、作成タイムスタンプ、最終変更タイムスタンプなど)が含まれます。

LIST_OBJECTSファンクション

このファンクションは、オブジェクト・ストアの指定された場所にあるオブジェクトを一覧表示します。結果には、オブジェクト名と、オブジェクトに関する追加のメタデータ(サイズ、チェックサム、作成タイムスタンプ、最終変更タイムスタンプなど)が含まれます。

MOVE_OBJECTプロシージャ

このプロシージャは、あるクラウド・オブジェクト・ストレージ・バケットから別のバケットにオブジェクトを移動します。

PUT_OBJECTプロシージャ

このプロシージャはオーバーロードされています。このプロシージャは、1つの形式でAutonomous DatabaseからCloud Object Storageにファイルをコピーします。また、このプロシージャは、Autonomous Databaseからクラウド・オブジェクト・ストレージにBLOBをコピーします。

SYNC_EXTERNAL_PART_TABLEプロシージャ

このプロシージャは、クラウドのファイルの外部パーティション表の更新を簡素化します。このプロシージャは、新しいパーティションが追加されたとき、またはパーティションが外部パーティション表のオブジェクト・ストア・ソースから削除されたときに実行します。

VALIDATE_EXTERNAL_TABLEプロシージャ

このプロシージャは、外部表のソース・ファイルを検証し、ログ情報を生成して、外部表に指定されたフォーマット・オプションと一致しない行をAutonomous Databaseのbadfile表に格納します。

VALIDATE_EXTERNAL_PART_TABLEプロシージャ

このプロシージャは、外部パーティション表のソース・ファイルを検証し、ログ情報を生成し、外部表に指定されたフォーマット・オプションと一致しない行をAutonomous Databaseのbadfile表に格納します。

VALIDATE_HYBRID_PART_TABLEプロシージャ

このプロシージャは、ハイブリッド・パーティション表のソース・ファイルを検証し、ログ情報を生成し、ハイブリッド表に指定されたフォーマット・オプションと一致しない行をAutonomous Databaseのbadfile表に格納します。

COPY_COLLECTIONプロシージャ

このプロシージャは、クラウド・オブジェクト・ストレージまたはディレクトリからSODAコレクションにデータをロードします。指定したSODAコレクションが存在しない場合は、プロシージャによって作成されます。オーバーロード・フォームでは、operation_idパラメータを使用できます。

構文

DBMS_CLOUD.COPY_COLLECTION (
    collection_name   IN VARCHAR2,
    credential_name   IN VARCHAR2 DEFAULT NULL,
    file_uri_list     IN CLOB,
    format            IN CLOB     DEFAULT NULL
);

DBMS_CLOUD.COPY_COLLECTION (
    collection_name   IN VARCHAR2,
    credential_name   IN VARCHAR2 DEFAULT NULL,
    file_uri_list     IN CLOB,
    format            IN CLOB     DEFAULT NULL,
    operation_id      OUT NOCOPY NUMBER
);

パラメータ

パラメータ 説明

collection_name

データのロード先のSODAコレクションの名前。この名前のコレクションがすでに存在する場合は、指定したデータがロードされ、そうでない場合は新しいコレクションが作成されます。

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

file_uri_listでディレクトリを指定する場合、このパラメータは使用されません。

file_uri_list

このパラメータでは、ソース・ファイルURIのカンマ区切りリスト、または1つ以上のディレクトリとソース・ファイルを指定します。

クラウド・ソース・ファイルURI

クラウド・ソース・ファイルURIのファイル名には、ワイルドカードおよび正規表現を使用できます。

正規表現を使用できるのは、regexuri formatパラメータがTRUEに設定されている場合のみです。

regexuriパラメータがFALSEに設定されている場合、文字"*"および"?"はワイルドカード文字とみなされます。regexuriパラメータがTRUEに設定されている場合、文字"*"および"?"は指定された正規表現パターンの一部です。

正規表現パターンは、URI内のファイル名またはサブフォルダ・パスでのみサポートされ、パターン一致はREGEXP_LIKE関数によって実行されるものと同じです。

たとえば:

file_uri_list => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o(/)*year=[0-9]+(/)*month=[0-9]+(/)*[a-z]+[1-3]??.csv'

URIの形式は、使用しているCloud Object Storageサービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

REGEXP_LIKE条件の詳細は、REGEXP_LIKE条件を参照してください。

ディレクトリ

1つのディレクトリと1つ以上のファイル名を指定することも、ディレクトリとファイル名のカンマ区切りリストを使用することもできます。ディレクトリを指定する形式は:'MY_DIR:filename.ext'です。デフォルトでは、ディレクトリ名MY_DIRはデータベース・オブジェクトであり、大/小文字は区別されません。ファイル名は、大/小文字が区別されます。

ディレクトリ内のファイル名を指定する場合、正規表現はサポートされません。ワイルドカードを使用して、ディレクトリ内のファイル名のみを指定できます。文字"*"は複数文字のワイルドカードとして使用でき、文字"?"は1文字のワイルドカードとして使用できます。例:'MY_DIR:*"または'MY_DIR:test?'

複数のディレクトリを指定するには、ディレクトリのカンマ区切りリストを使用します。例:'MY_DIR1:*, MY_DIR2:test?'

大/小文字を区別するディレクトリ名を指定するには、二重引用符を使用します。例:'"my_dir1":*, "my_dir2":Test?'

引用符文字を含めるには、2つの引用符を使用します。例:'MY_DIR:''filename.ext'。これは、filenameが引用符(')で始まることを示します。

format

ソース・ファイルのフォーマットを説明するオプション。これらのオプションはJSON文字列として指定されます。

サポートされているフォーマットは、characterset, compression, encryption, ignoreblanklines, jsonpath, maxdocsize, recorddelimiter, rejectlimit, type, unpackarrayskeyassignmentおよびkeypathです。

前述したJSONデータのフォーマットとは別に、Autonomous Databaseでは他のフォーマットもサポートされています。Autonomous Databaseでサポートされているformat引数のリストは、DBMS_CLOUDパッケージ・フォーマット・オプションを参照してください。

operation_id

このパラメータを使用して、USER_LOAD_OPERATIONSビューで、ロード操作の進行状況および最終ステータスを対応するIDとして追跡します。

BEGIN
    DBMS_CLOUD.CREATE_CREDENTIAL(
            credential_name => 'OBJ_STORE_CRED',
            username        => 'user_name@oracle.com',
            password        => 'password'
            );

    DBMS_CLOUD.COPY_COLLECTION(
            collection_name => 'myCollection',
            credential_name => 'OBJ_STORE_CRED',
            file_uri_list   => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/adbexample/b/json/o/myCollection.json'  
            );
END;
/

COPY_DATAプロシージャ

このプロシージャは、クラウドのファイルまたはディレクトリ内のファイルから、Autonomous Databaseの既存の表にデータをロードします。オーバーロード・フォームでは、operation_idパラメータを使用できます。

構文

DBMS_CLOUD.COPY_DATA (
    table_name        IN VARCHAR2,
    credential_name   IN VARCHAR2 DEFAULT NULL,
    file_uri_list     IN CLOB,
    schema_name       IN VARCHAR2,
    field_list        IN CLOB,
    format            IN CLOB);

DBMS_CLOUD.COPY_DATA (
    table_name        IN VARCHAR2,
    credential_name   IN VARCHAR2 DEFAULT NULL,
    file_uri_list     IN CLOB DEFAULT NULL,
    schema_name       IN VARCHAR2 DEFAULT NULL,
    field_list        IN CLOB DEFAULT NULL,
    format            IN CLOB DEFAULT NULL
    operation_id      OUT NOCOPY NUMBER);

パラメータ

パラメータ 説明

table_name

データベースのターゲット表の名前。ターゲット表はCOPY_DATAを実行する前に作成しておく必要があります。

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

file_uri_listでディレクトリを指定する場合、このパラメータは使用されません。

file_uri_list

クラウド・ソース・ファイルURIのファイル名には、ワイルドカードおよび正規表現を使用できます。

クラウド・ソース・ファイルURI

このパラメータでは、ソース・ファイルURIのカンマ区切りリスト、または1つ以上のディレクトリとソース・ファイルを指定します。

正規表現を使用できるのは、regexuri formatパラメータがTRUEに設定されている場合のみです。

regexuriパラメータがFALSEに設定されている場合、文字"*"および"?"はワイルドカード文字とみなされます。regexuriパラメータがTRUEに設定されている場合、文字"*"および"?"は指定された正規表現パターンの一部です。

正規表現パターンは、URI内のファイル名またはサブフォルダ・パスでのみサポートされ、パターン一致はREGEXP_LIKE関数によって実行されるものと同じです。

たとえば:

file_uri_list => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o(/)*year=[0-9]+(/)*month=[0-9]+(/)*[a-z]+[1-3]??.csv'

URIの形式は、使用しているCloud Object Storageサービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

REGEXP_LIKE条件の詳細は、REGEXP_LIKE条件を参照してください。

ディレクトリ

1つのディレクトリと1つ以上のファイル名を指定することも、ディレクトリとファイル名のカンマ区切りリストを使用することもできます。ディレクトリを指定する形式は:'MY_DIR:filename.ext'です。デフォルトでは、ディレクトリ名MY_DIRはデータベース・オブジェクトであり、大/小文字は区別されません。ファイル名は、大/小文字が区別されます。

ディレクトリ内のファイル名を指定する場合、正規表現はサポートされません。ワイルドカードを使用して、ディレクトリ内のファイル名のみを指定できます。文字"*"は複数文字のワイルドカードとして使用でき、文字"?"は1文字のワイルドカードとして使用できます。例:'MY_DIR:*"または'MY_DIR:test?'

複数のディレクトリを指定するには、ディレクトリのカンマ区切りリストを使用します。例:'MY_DIR1:*, MY_DIR2:test?'

大/小文字を区別するディレクトリ名を指定するには、二重引用符を使用します。例:'"my_dir1":*, "my_dir2":Test?'

引用符文字を含めるには、2つの引用符を使用します。例:'MY_DIR:''filename.ext'。これは、filenameが引用符(')で始まることを示します。

schema_name

ターゲット表が存在するスキーマの名前。デフォルト値はNULLで、ターゲット表がプロシージャを実行しているユーザーと同じスキーマ内に存在することを意味します。

field_list

ソース・ファイル内のフィールドとそのデータ型を識別します。デフォルト値はNULLで、フィールドとそのデータ型がターゲット表の定義によって決定されることを意味します。この引数の構文は、通常のOracle外部表のfield_list句と同じです。field_listの詳細は、『Oracle® Databaseユーティリティ』を参照してください。

formatパラメータのtypeオプション値がjsonの場合、このパラメータは無視されます。

field_listの使用例については、CREATE_EXTERNAL_TABLEプロシージャを参照してください。

format

ソース・ファイル、ログ・ファイルおよび悪いファイルの形式を示すオプション。オプションのリストと値の指定方法は、DBMS_CLOUD Package Format Optionsを参照してください。

Avro、ORCまたはParquetファイル形式オプションについては、DBMS_CLOUD Avro、ORCまたはParquet用のパッケージ形式オプションを参照してください。

operation_id

このパラメータを使用して、USER_LOAD_OPERATIONSビューで、ロード操作の進行状況および最終ステータスを対応するIDとして追跡します。

使用上のノート

デフォルトのレコード・デリミタはdetected newlineです。detected newlineを指定すると、DBMS_CLOUDは、レコード・デリミタとして使用する適切な改行文字を自動的に検出しようとします。DBMS_CLOUDでは、最初にWindows改行文字\r\nが検索されます。Windowsの復帰改行文字が見つかった場合、それがプロシージャのすべてのファイルのレコード・区切り文字として使用されます。Windows改行文字が見つからない場合、DBMS_CLOUDでは、UNIX/Linux改行文字\nが検索され、見つかった場合は\nがプロシージャのすべてのファイルのレコード・区切り文字として使用されます。ソース・ファイルで異なるレコード・区切り文字の組合せが使用されている場合は、KUP-04020: found record longer than buffer size supportedなどのエラーが発生する可能性があります。この場合、ソース・ファイルを変更して同じレコード・区切り文字を使用するか、同じレコード・区切り文字を使用するソース・ファイルのみを指定する必要があります。

recorddelmiterフォーマット・オプションの詳細は、DBMS_CLOUDパッケージ・フォーマット・オプションを参照してください。

サンプル

BEGIN
    DBMS_CLOUD.CREATE_CREDENTIAL(
            credential_name => 'DEF_CRED_NAME',
            username        => 'user_name@oracle.com',
            password        => 'password'
            );
END;
/
BEGIN
 DBMS_CLOUD.COPY_DATA(
    table_name =>'CHANNELS',
    credential_name =>'DEF_CRED_NAME',
    file_uri_list =>'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/channels.txt',
    format => json_object('delimiter' value ',')
 );
END;
/
BEGIN
    DBMS_CLOUD.COPY_DATA(
            table_name      => 'ORDERS',
            schema_name     => 'TEST_SCHEMA',
            credential_name => 'DEF_CRED_NAME',
	     file_uri_list   => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/adbexample/b/json/o/orde[r]s.tbl.1'
            format          =>  json_object('ignoreblanklines' value TRUE,
                                            'rejectlimit' value '0',
                                            'dateformat' value 'yyyy-mm-dd',
                                            'regexuri' value TRUE)
            );
END;
/

COPY_DATA Avro、ORCまたはParquetファイル用のプロシージャ

このプロシージャは、formatパラメータのtypeを値avroorcまたはparquetに設定すると、クラウドのAvro、ORCまたはParquetファイルから、またはディレクトリ内のファイルから、既存のAutonomous Database表にデータをロードします。

テキスト・ファイルと同様に、データはソースのAvro、ORCまたはParquetファイルから既存の内部表にコピーされます。

構文

DBMS_CLOUD.COPY_DATA (
    table_name        IN VARCHAR2,
    credential_name   IN VARCHAR2 DEFAULT NULL,
    file_uri_list     IN CLOB,
    schema_name       IN VARCHAR2 DEFAULT,
    field_list        IN CLOB DEFAULT,
    format            IN CLOB DEFAULT);

パラメータ

パラメータ 説明

table_name

データベースのターゲット表の名前。ターゲット表はCOPY_DATAを実行する前に作成しておく必要があります。

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

file_uri_listでディレクトリを指定する場合、このパラメータは使用されません。

file_uri_list

このパラメータでは、ソース・ファイルURIのカンマ区切りリスト、または1つ以上のディレクトリとソース・ファイルを指定します。

クラウド・ソース・ファイルURI

クラウド・ソース・ファイルURIのファイル名には、ワイルドカードおよび正規表現を使用できます。

正規表現を使用できるのは、regexuri formatパラメータがTRUEに設定されている場合のみです。

regexuriパラメータがFALSEに設定されている場合、文字"*"および"?"はワイルドカード文字とみなされます。regexuriパラメータがTRUEに設定されている場合、文字"*"および"?"は指定された正規表現パターンの一部です。

正規表現パターンは、URI内のファイル名またはサブフォルダ・パスでのみサポートされ、パターン一致はREGEXP_LIKE関数によって実行されるものと同じです。

たとえば:

file_uri_list => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o(/)*year=[0-9]+(/)*month=[0-9]+(/)*[a-z]+[1-3]??.csv'

URIの形式は、使用しているCloud Object Storageサービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

REGEXP_LIKE条件の詳細は、REGEXP_LIKE条件を参照してください。

ディレクトリ

1つのディレクトリと1つ以上のファイル名を指定することも、ディレクトリとファイル名のカンマ区切りリストを使用することもできます。ディレクトリを指定する形式は:'MY_DIR:filename.ext'です。デフォルトでは、ディレクトリ名MY_DIRはデータベース・オブジェクトであり、大/小文字は区別されません。ファイル名は、大/小文字が区別されます。

ディレクトリ内のファイル名を指定する場合、正規表現はサポートされません。ワイルドカードを使用して、ディレクトリ内のファイル名のみを指定できます。文字"*"は複数文字のワイルドカードとして使用でき、文字"?"は1文字のワイルドカードとして使用できます。例:'MY_DIR:*"または'MY_DIR:test?'

複数のディレクトリを指定するには、ディレクトリのカンマ区切りリストを使用します。例:'MY_DIR1:*, MY_DIR2:test?'

大/小文字を区別するディレクトリ名を指定するには、二重引用符を使用します。例:'"my_dir1":*, "my_dir2":Test?'

引用符文字を含めるには、2つの引用符を使用します。例:'MY_DIR:''filename.ext'。これは、filenameが引用符(')で始まることを示します。

schema_name

ターゲット表が存在するスキーマの名前。デフォルト値はNULLで、ターゲット表がプロシージャを実行しているユーザーと同じスキーマ内に存在することを意味します。

field_list

Avro、ORCまたはParquetファイルでは無視されます。

ソースのフィールドは、名前によって外部表の列を照合します。ソースのデータ型は、外部表の列データ型に変換されます。

ORCファイルについては、DBMS_CLOUDパッケージのORCとOracleデータ型のマッピングを参照してください。

Parquetファイルの場合、マッピングの詳細は、DBMS_CLOUDパッケージのParquetからOracleデータ型へのマッピングを参照してください。

Avroファイルの場合、DBMS_CLOUDパッケージのAvroからOracleデータ型へのマッピングを参照してください。

format

ソース・ファイルのフォーマットを説明するオプション。Avro、ORCまたはParquetファイルでは、2つのオプションのみがサポートされています。DBMS_CLOUD Avro、ORCまたはParquet用のパッケージ形式オプションを参照してください。

使用上のノート

  • 他のデータ・ファイルと同様に、Avro、ORCおよびParquetデータをロードすると、dba_load_operationsおよびuser_load_operationsの各表で表示可能なログが生成されます。ロード操作ごとに、ログを含む表を示すdba[user]_load_operationsにレコードが追加されます。

    ログ表は、ロードに関するサマリー情報を示します。

  • Avro、ORCまたはParquetの場合、formatパラメータのtypeが値avroorcまたはparquetに設定されていると、BADFILE_TABLE表は常に空です。

    • Parquetファイルでは、PRIMARY KEY制約エラーによってORAエラーがスローされます。

    • 列のデータに変換エラーが発生すると(たとえば、ターゲット列のサイズが変換済値を保持するには不十分な場合など)、列の値はNULLに設定されます。これにより拒否レコードは生成されません。

COPY_OBJECTプロシージャ

このプロシージャは、あるクラウド・オブジェクト・ストレージ・バケットまたはフォルダから別のクラウド・オブジェクト・ストレージ・バケットにオブジェクトをコピーします。

ソース・バケットまたはターゲット・フォルダは、同じクラウド・オブジェクト・ストア・プロバイダまたは異なるクラウド・オブジェクト・ストア・プロバイダに配置できます。

ソースとターゲットが個別のオブジェクト・ストアにある場合、または同じクラウド・プロバイダを持つ異なるアカウントがある場合、ソースとターゲットの場所に個別の資格証明名を指定できます。

ターゲット資格証明名が指定されていない場合、ソース資格証明名はターゲットの場所でもデフォルトで使用されます。

構文

DBMS_CLOUD.COPY_OBJECT (
    source_credential_name  IN  VARCHAR2 DEFAULT NULL,
    source_object_uri       IN  VARCHAR2,
    target_object_uri       IN  VARCHAR2,
    target_credential_name  IN  VARCHAR2 DEFAULT NULL
);

パラメータ

パラメータ 説明

source_credential_name

ソースのCloud Object Storageにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

source_credential_name値を指定しない場合、credential_nameNULLに設定されます。

source_object_uri

ソース・オブジェクト・ストレージ・バケットまたはフォルダの場所を指すURIを指定します。

このパラメータは必須です。

URIのフォーマットは、クラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

target_object_uri

ターゲット・オブジェクト・ストアのURIを指定します。

このパラメータは必須です。

URIのフォーマットは、クラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

target_credential_name

ターゲットのクラウドのオブジェクト・ストレージの場所にアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

target_credential_name値を指定しない場合、target_object_urisource_credential_name値に設定されます。

BEGIN 
DBMS_CLOUD.COPY_OBJECT (
    source_credential_name => 'OCI_CRED',
    source_object_uri    => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname1/bgfile.csv',
    target_object_uri    => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname2/myfile.csv'
);
END;
/

CREATE_CLOUD_TABLEプロシージャ

このプロシージャは、クラウド表を作成します。すべてのクラウド表データは、Oracle管理対象オブジェクト・ストレージに格納されます(クラウド表には、そのメタデータのみがデータベースに格納されます)。

構文

DBMS_CLOUD.CREATE_CLOUD_TABLE (
    table_name       IN VARCHAR2,
    column_list      IN CLOB,
    params           IN CLOB);

パラメータ

パラメータ 説明

table_name

クラウド表の名前。

column_list

クラウド表の列名およびデータ型のカンマ区切りリスト。

使用上のノート

  • DEFAULT属性: column_listには、通常のCREATE TABLEDEFAULT句のように機能するDEFAULT句を含めることができます。DEFAULT句の動作の詳細は、CREATE TABLEを参照してください。

  • クラウド表を削除するには、DROP TABLEを使用します。クラウド表はごみ箱をサポートしていません。

    たとえば:

    DROP TABLE CLOUD_TAB1; 
  • クラウド表に対してSELECTINSERTおよびUPDATE権限を付与できます。クラウド表に他の権限を付与することはできません。

    詳細は、「権限とロール認可の構成」を参照してください。

サンプル

EXEC DBMS_CLOUD.CREATE_CLOUD_TABLE( 'CLOUD_TAB1', 'I INTEGER, J INTEGER' );
BEGIN
  DBMS_CLOUD.CREATE_CLOUD_TABLE(
   table_name  => 'CLOUD_TABLE_WITH_DEFAULT',
   column_list => 'I INTEGER,
                   A VARCHAR2(32) DEFAULT ''ABC''' );
END;
/

CREATE_EXTERNAL_PART_TABLEプロシージャ

このプロシージャでは、外部パーティション表をクラウド内のファイルに、またはディレクトリ内のファイルから作成します。これにより、Autonomous Databaseから外部データに対する問合せを実行できます。

構文

DBMS_CLOUD.CREATE_EXTERNAL_PART_TABLE (
    table_name           IN VARCHAR2,
    credential_name      IN VARCHAR2,
    partitioning_clause  IN CLOB,
    column_list          IN CLOB,
    field_list           IN CLOB DEFAULT,
    format               IN CLOB DEFAULT);


DBMS_CLOUD.CREATE_EXTERNAL_PART_TABLE (
    table_name           IN VARCHAR2,
    credential_name      IN VARCHAR2,
    file_uri_list        IN VARCHAR2,
    column_list          IN CLOB,
    field_list           IN CLOB DEFAULT,
    format               IN CLOB DEFAULT);

パラメータ

パラメータ 説明

table_name

外部表の名前。

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

partitioning_clause

個々のパーティションの場所情報を含む、完全なパーティション化句を指定します。

partitioning_clauseパラメータを使用する場合、file_uri_listパラメータは許可されません。

file_uri_list

このパラメータでは、ソース・ファイルURIのカンマ区切りリスト、または1つ以上のディレクトリとソース・ファイルを指定します。

クラウド・ソース・ファイルURI

クラウド・ソース・ファイルURIのファイル名には、ワイルドカードおよび正規表現を使用できます。

正規表現を使用できるのは、regexuri formatパラメータがTRUEに設定されている場合のみです。

regexuriパラメータがFALSEに設定されている場合、文字"*"および"?"はワイルドカード文字とみなされます。regexuriパラメータがTRUEに設定されている場合、文字"*"および"?"は指定された正規表現パターンの一部です。

正規表現パターンは、URI内のファイル名またはサブフォルダ・パスでのみサポートされ、パターン一致はREGEXP_LIKE関数によって実行されるものと同じです。

このオプションは、オブジェクト・ストレージのファイルに作成された外部表でのみサポートされます。

次に例を示します。

file_uri_list => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o(/)*year=[0-9]+(/)*month=[0-9]+(/)*[a-z]+[1-3]??.csv'

パラメータfile_uri_listを使用する場合、partitioning_clauseパラメータは許可されません。

URIのフォーマットは、クラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

REGEXP_LIKE条件の詳細は、REGEXP_LIKE条件を参照してください。

column_list

外部表の列名およびデータ型のカンマ区切りリスト。このパラメータには、file_uri_listパラメータで指定されたデータ・ファイルのタイプに応じて、次の要件があります。

  • 非構造化ファイルでは、column_listパラメータは必須です。非構造化ファイル(CSVテキスト・ファイルなど)を使用する場合、column_listパラメータでは、データ・ファイル内のすべての列名とデータ型、およびオブジェクト名から導出されたパーティション列を指定する必要があります。

  • 構造化ファイルでは、column_listパラメータはオプションです。たとえば、Avro、ORCまたはParquetデータ・ファイルでは、column_listは必要ありません。column_listを含めない場合、formatパラメータのpartition_columnsオプションには、列名(name)とデータ型(type)の両方の指定を含める必要があります。

field_list

ソース・ファイル内のフィールドとそのデータ型を識別します。デフォルト値はNULLで、フィールドおよびそのデータ型がcolumn_listパラメータによって決定されることを意味します。この引数の構文は、通常のOracle外部表のfield_list句と同じです。field_listの詳細は、『Oracle® Databaseユーティリティ』を参照してください。

format

フォーマット・オプションpartition_columnsでは、データ・ファイルのタイプ(構造化または非構造化)に応じて、パーティション列がファイル・パスから導出されるときのパーティション列のDBMS_CLOUD.CREATE_EXTERNAL_PART_TABLEの列名とデータ型を指定します:

  • DBMS_CLOUD.CREATE_EXTERNAL_PART_TABLEcolumn_listパラメータが含まれ、データ・ファイルが非構造化(CSVテキスト・ファイルなど)の場合、partition_columnsにはデータ型は含まれません。たとえば、このタイプのpartition_columnsの指定では、次のようなフォーマットを使用します:

    '"partition_columns":["state","zipcode"]'

    このデータ型は、DBMS_CLOUD.CREATE_EXTERNAL_PART_TABLEcolumn_listパラメータで指定されるため、必須ではありません。

  • DBMS_CLOUD.CREATE_EXTERNAL_PART_TABLEcolumn_listパラメータが含まれず、データ・ファイルが構造化(Avro、ORC、Parquetファイルなど)の場合、partition_columnsオプションには列名(name副句)とデータ型(type副句)の両方が含まれます。たとえば、partition_columnsの指定を次に示します:

    '"partition_columns":[
                   {"name":"country", "type":"varchar2(10)"},
                   {"name":"year", "type":"number"},
                   {"name":"month", "type":"varchar2(10)"}]'

データ・ファイルが構造化されておらず、type副句がpartition_columnsで指定されている場合、type副句は無視されます。

ハイブ形式に基づいていないオブジェクト名の場合、partition_columnsで指定された列の順序は、file_uri_listパラメータで指定されたファイル・パス内のオブジェクト名に表示される順序と一致する必要があります。

ソース・ファイルのフォーマットを説明するすべてのformatパラメータ・オプションを確認するには、DBMS_CLOUDパッケージ・フォーマット・オプションを参照してください。

使用上のノート

  • partitioning_clauseパラメータとfile_uri_listパラメータの両方を使用してこのプロシージャをコールすることはできません。

  • Avro、ParquetまたはORCデータ・ファイルを含む構造化データ・ファイルでは、column_listパラメータの指定はオプションです。column_listを指定しない場合、formatパラメータのpartition_columnsオプションには、nametypeの両方を含める必要があります。

  • CSVテキスト・ファイルなどの構造化されていないデータ・ファイルでは、column_listパラメータは必須です。

  • プロシージャDBMS_CLOUD.CREATE_EXTERNAL_PART_TABLEは、次のようなサポートされているクラウド・オブジェクト・ストレージ・サービスの外部パーティション・ファイルをサポートします:
    • Oracle Cloud Infrastructure Object Storage

    • Azure Blob StorageまたはAzure Data Lake Storage

    • Amazon S3

    • Amazon S3互換: Oracle Cloud Infrastructure Object Storage、Google Cloud Storage、Wasabi Hot Cloud Storageなど。

    • GitHubリポジトリ

    詳細は、DBMS_CLOUD URI形式を参照してください。

  • プロシージャDBMS_CLOUD.CREATE_EXTERNAL_PART_TABLEは、ローカル・ファイル・システムまたはネットワーク・ファイル・システム内のディレクトリ内の外部パーティション・ファイルをサポートします。

  • file_uri_listパラメータを指定してDBMS_CLOUD.CREATE_EXTERNAL_PART_TABLEをコールする場合、クラウド・オブジェクト・ストアのファイル名で指定される列の型は、次のいずれかの型である必要があります。

    VARCHAR2(n)
    NUMBER(n)
    NUMBER(p,s)
    NUMBER
    DATE
    TIMESTAMP(9)
  • デフォルトのレコード・デリミタはdetected newlineです。detected newlineを指定すると、DBMS_CLOUDは、レコード・デリミタとして使用する適切な改行文字を自動的に検出しようとします。DBMS_CLOUDでは、最初にWindows改行文字\r\nが検索されます。Windowsの復帰改行文字が見つかった場合、それがプロシージャのすべてのファイルのレコード・区切り文字として使用されます。Windows改行文字が見つからない場合、DBMS_CLOUDでは、UNIX/Linux改行文字\nが検索され、見つかった場合は\nがプロシージャのすべてのファイルのレコード・区切り文字として使用されます。ソース・ファイルで異なるレコード・区切り文字の組合せが使用されている場合は、KUP-04020: found record longer than buffer size supportedなどのエラーが発生する可能性があります。この場合、ソース・ファイルを変更して同じレコード・区切り文字を使用するか、同じレコード・区切り文字を使用するソース・ファイルのみを指定する必要があります。

    recorddelmiterフォーマット・オプションの詳細は、DBMS_CLOUDパッケージ・フォーマット・オプションを参照してください。

  • DBMS_CLOUD.CREATE_EXTERNAL_PART_TABLEを使用して作成する外部パーティション表には、2つの非表示列file$pathおよびfile$nameが含まれます。これらの列は、レコードの取得元ファイルの識別に役立ちます。

    • file$path: オブジェクト名の先頭までのファイル・パス・テキストを指定します。

    • file$name: バケット名に続くすべてのテキストを含め、オブジェクト名を指定します。

サンプル

partitioning_clauseパラメータを使用した例:

BEGIN  
   DBMS_CLOUD.CREATE_EXTERNAL_PART_TABLE(
      table_name =>'PET1',  
      credential_name =>'OBJ_STORE_CRED',
      format => json_object('delimiter' value ',', 'recorddelimiter' value 'newline', 'characterset' value 'us7ascii'),
      column_list => 'col1 number, col2 number, col3 number',
      partitioning_clause => 'partition by range (col1)
                                (partition p1 values less than (1000) location
                                    ( ''&base_URL//file_11.txt'')
                                 ,
                                 partition p2 values less than (2000) location
                                    ( ''&base_URL/file_21.txt'')
                                 ,
                                 partition p3 values less than (3000) location 
                                    ( ''&base_URL/file_31.txt'')
                                 )'
     );
   END;
/  


BEGIN
    DBMS_CLOUD.CREATE_EXTERNAL_PART_TABLE(
       table_name          => 'PET',
       format              => json_object('delimiter'value ','),
       column_list         => 'name varchar2(20), gender varchar2(10), salary number',
       partitioning_clause => 'partition by range (salary)
              (   -- Use test1.csv in the DEFAULT DIRECTORY DATA_PUMP_DIR 
                  partition p1 values less than (100) LOCATION (''test1.csv''),
                   -- Use test2.csv in a specified directory MY_DIR
                  partition p2 values less than (300) DEFAULT DIRECTORY MY_DIR LOCATION (''test2.csv'')        )'   );                       
END;                     
/

非構造化データ・ファイルでfile_uri_listおよびcolumn_listパラメータを使用した例:

BEGIN
  DBMS_CLOUD.CREATE_EXTERNAL_PART_TABLE(
   table_name => 'MYSALES',
   credential_name => 'DEF_CRED_NAME',
   file_uri_list     => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/*.csv', 
   column_list       => 'product varchar2(100), units number, country varchar2(100), year number, month varchar2(2)', 
   field_list        => 'product, units', --[Because country, year and month are not in the file, they are not listed in the field list]
   format            => '{"type":"csv", "partition_columns":["country","year","month"]}');
END;
/ 

構造化データ・ファイルでcolumn_listパラメータなしでfile_uri_listを使用した例:

BEGIN
  DBMS_CLOUD.CREATE_EXTERNAL_PART_TABLE(
  table_name => 'MYSALES',
  credential_name => 'DEF_CRED_NAME',
  DBMS_CLOUD.CREATE_EXTERNAL_PART_TABLE(
    table_name      => 'MYSALES',
    credential_name => 'DEF_CRED_NAME',
    file_uri_list   => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/*.parquet',
    format          => 
        json_object('type' value 'parquet', 'schema' value 'first',
                    'partition_columns' value 
                          json_array(
                                json_object('name' value 'country', 'type' value 'varchar2(100)'),
                                json_object('name' value 'year', 'type' value 'number'),
                                json_object('name' value 'month', 'type' value 'varchar2(2)')
                          )
         )
    );
END;
/

CREATE_EXTERNAL_TABLEプロシージャ

このプロシージャでは、クラウド内のファイルに基づいて、またはディレクトリ内のファイルから外部表を作成します。これにより、Autonomous Databaseから外部データに対する問合せを実行できます。

構文

DBMS_CLOUD.CREATE_EXTERNAL_TABLE (
    table_name       IN VARCHAR2,
    credential_name  IN VARCHAR2 DEFAULT NULL,
    file_uri_list    IN CLOB,
    column_list      IN CLOB,
    field_list       IN CLOB DEFAULT,
    format           IN CLOB DEFAULT);

パラメータ

パラメータ 説明

table_name

外部表の名前。

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

file_uri_listでディレクトリを指定する場合、このパラメータは使用されません。

file_uri_list

このパラメータでは、ソース・ファイルURIのカンマ区切りリスト、または1つ以上のディレクトリとソース・ファイルを指定します。

クラウド・ソース・ファイルURI

クラウド・ソース・ファイルURIのファイル名には、ワイルドカードおよび正規表現を使用できます。

正規表現を使用できるのは、regexuri formatパラメータがTRUEに設定されている場合のみです。

regexuriパラメータがFALSEに設定されている場合、文字"*"および"?"はワイルドカード文字とみなされます。regexuriパラメータがTRUEに設定されている場合、文字"*"および"?"は指定された正規表現パターンの一部です。

正規表現パターンは、URI内のファイル名またはサブフォルダ・パスでのみサポートされ、パターン一致はREGEXP_LIKE関数によって実行されるものと同じです。

このオプションは、オブジェクト・ストレージのファイルに作成された外部表でのみサポートされます。

たとえば:

file_uri_list => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o(/)*year=[0-9]+(/)*month=[0-9]+(/)*[a-z]+[1-3]??.csv'

URIの形式は、使用しているCloud Object Storageサービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

REGEXP_LIKE条件の詳細は、REGEXP_LIKE条件を参照してください。

ディレクトリ

1つのディレクトリと1つ以上のファイル名を指定することも、ディレクトリとファイル名のカンマ区切りリストを使用することもできます。ディレクトリを指定する形式は:'MY_DIR:filename.ext'です。デフォルトでは、ディレクトリ名MY_DIRはデータベース・オブジェクトであり、大/小文字は区別されません。ファイル名は、大/小文字が区別されます。

ディレクトリ内のファイル名を指定する場合、正規表現はサポートされません。ワイルドカードを使用して、ディレクトリ内のファイル名のみを指定できます。文字"*"は複数文字のワイルドカードとして使用でき、文字"?"は1文字のワイルドカードとして使用できます。例:'MY_DIR:*"または'MY_DIR:test?'

複数のディレクトリを指定するには、ディレクトリのカンマ区切りリストを使用します。例:'MY_DIR1:*, MY_DIR2:test?'

大/小文字を区別するディレクトリ名を指定するには、二重引用符を使用します。例:'"my_dir1":*, "my_dir2":Test?'

引用符文字を含めるには、2つの引用符を使用します。例:'MY_DIR:''filename.ext'。これは、filenameが引用符(')で始まることを示します。

column_list

外部表の列名およびデータ型のカンマ区切りリスト。

field_list

ソース・ファイル内のフィールドとそのデータ型を識別します。デフォルト値はNULLで、フィールドおよびそのデータ型がcolumn_listパラメータによって決定されることを意味します。この引数の構文は、通常のOracle Database外部表のfield_list句と同じです。field_listの詳細は、『Oracle Databaseユーティリティ』のfield_definitions句のORACLE_LOADERアクセス・ドライバfield_listを参照してください。

format

ソース・ファイルのフォーマットを説明するオプション。オプションのリストと値の指定方法は、DBMS_CLOUD Package Format Optionsを参照してください。

Avro、ORCまたはParquetフォーマット・ファイルについては、Avro、ORCまたはParquetファイル用のCREATE_EXTERNAL_TABLEプロシージャを参照してください。

使用上のノート

  • プロシージャDBMS_CLOUD.CREATE_EXTERNAL_TABLEは、サポートされているクラウド・オブジェクト・ストレージ・サービスで、次のような外部パーティション・ファイルをサポートします:

    • Oracle Cloud Infrastructure Object Storage

    • Azure Blob StorageまたはAzure Data Lake Storage

    • Amazon S3

    • Amazon S3互換: Oracle Cloud Infrastructure Object Storage、Google Cloud Storage、Wasabi Hot Cloud Storageなど。

    • GitHubリポジトリ

    資格証明は表レベルのプロパティであるため、外部ファイルは同じオブジェクト・ストアに存在する必要があります。

    詳細は、DBMS_CLOUD URI形式を参照してください。

  • デフォルトのレコード・デリミタはdetected newlineです。detected newlineを指定すると、DBMS_CLOUDは、レコード・デリミタとして使用する適切な改行文字を自動的に検出しようとします。DBMS_CLOUDでは、最初にWindows改行文字\r\nが検索されます。Windowsの復帰改行文字が見つかった場合、それがプロシージャのすべてのファイルのレコード・区切り文字として使用されます。Windows改行文字が見つからない場合、DBMS_CLOUDでは、UNIX/Linux改行文字\nが検索され、見つかった場合は\nがプロシージャのすべてのファイルのレコード・区切り文字として使用されます。ソース・ファイルで異なるレコード・区切り文字の組合せが使用されている場合は、KUP-04020: found record longer than buffer size supportedなどのエラーが発生する可能性があります。この場合、ソース・ファイルを変更して同じレコード・区切り文字を使用するか、同じレコード・区切り文字を使用するソース・ファイルのみを指定する必要があります。

    recorddelimiterフォーマット・オプションの詳細は、DBMS_CLOUDパッケージ・フォーマット・オプションを参照してください。

BEGIN  
   DBMS_CLOUD.CREATE_EXTERNAL_TABLE(   
      table_name =>'WEATHER_REPORT_DOUBLE_DATE',   
      credential_name =>'OBJ_STORE_CRED',   
      file_uri_list =>'&base_URL/Charlotte_NC_Weather_History_Double_Dates.csv',
      format => json_object('type' value 'csv', 'skipheaders' value '1'),   
      field_list => 'REPORT_DATE DATE''mm/dd/yy'',                   
                     REPORT_DATE_COPY DATE ''yyyy-mm-dd'',
                     ACTUAL_MEAN_TEMP,                 
                     ACTUAL_MIN_TEMP,                 
                     ACTUAL_MAX_TEMP,                 
                     AVERAGE_MIN_TEMP,                    
                     AVERAGE_MAX_TEMP,     
                     AVERAGE_PRECIPITATION',   
      column_list => 'REPORT_DATE DATE,   
                     REPORT_DATE_COPY DATE,
                     ACTUAL_MEAN_TEMP NUMBER,  
                     ACTUAL_MIN_TEMP NUMBER,  
                     ACTUAL_MAX_TEMP NUMBER,  
                     AVERAGE_MIN_TEMP NUMBER,   
                     AVERAGE_MAX_TEMP NUMBER,                  
                     AVERAGE_PRECIPITATION NUMBER');
   END;
/ 

SELECT * FROM WEATHER_REPORT_DOUBLE_DATE where         
   actual_mean_temp > 69 and actual_mean_temp < 74

Apache IcebergのCREATE_EXTERNAL_TABLEプロシージャ

このプロシージャは、サポートされている構成でApache Iceberg表の外部表を作成します。

サポートされている構成の詳細は、「Apache Iceberg表の問合せについて」を参照してください。

構文

DBMS_CLOUD.CREATE_EXTERNAL_TABLE (
    table_name       IN VARCHAR2,
    credential_name  IN VARCHAR2 DEFAULT NULL,
    file_uri_list    IN CLOB,
    column_list      IN CLOB DEFAULT NULL,
    field_list       IN CLOB DEFAULT NULL,
    format           IN CLOB DEFAULT NULL
);

パラメータ

パラメータ 説明

table_name

外部表の名前。

credential_name

データ・ファイル、メタデータ・ファイルおよびIcebergカタログ(使用する場合)へのアクセスに使用される資格証明の名前。

AWSおよびOCI構成の場合、資格証明はCREATE_CREDENTIALプロシージャの説明に従って作成する必要があります。

現在、AWS Amazon Resource Name (ARN)の資格証明はサポートされていません。

file_uri_list

Icebergカタログが指定されている場合、NULLである必要があります(次のformatパラメータを参照)。アイスバーグ・カタログを使用しない場合は、file_uri_listにアイスバーグ・メタデータ・ファイルへのURIが含まれている必要があります。

column_list

列名および型はIcebergメタデータから自動的に導出されるため、NULLである必要があります。

列名は、基礎となるデータ・ファイル(Parquet、Avro、ORC)にある名前と一致します。Oracleデータ型は、Icebergデータ型とParquetデータ型、Avroデータ型およびORCデータ型の間のParquet/Avro/ORCマッピングを使用して導出されます。したがって、ユーザーはcolumn_listを指定できません。

field_list

列名およびデータ型はIcebergメタデータから自動的に導出されるため、NULLである必要があります。

format

formatパラメータの構成は、Iceberg表のタイプ、AWSまたはOCI、および外部表の作成に使用される情報(データ・カタログや直接メタデータURIからの情報など)によって異なります。

例および詳細は、次の例、OCIデータ・フロー・サンプルのIcebergサポートDBMS_CLOUD URI形式を参照してください。

AWS Glue Catalogを使用したAWS Icebergテーブルの例

AWS Glue Catalogを使用してAWS Iceberg表に表を作成する場合のformatパラメータは、次のとおりです。

format => json_object('access_protocol' value
       json_object('protocol_type' value 'iceberg',
                   'protocol_config' value
                    json_object('iceberg_catalog_type' value 'aws_glue',
                                'iceberg_glue_region'  value 'glue region',
                                'iceberg_table_path'   value 'database_name.table_name'))); 
ここで、access_protocolパラメータには、次の2つの要素を持つJSONオブジェクトが含まれます。
  • protocol_type: 'iceberg'である必要があります
  • protocol_config: アイスバーグ・カタログの詳細を指定するネストされたJSONオブジェクト。
    • iceberg_catalog_type: 'aws_glue'である必要があります
    • iceberg_glue_region: カタログ・リージョン('us-west-1'など)
    • iceberg_table_path: glue database.glue table nameパス。

メタデータ・ファイルURIを使用したAWS Iceberg表の例

メタデータ・ファイルURIを使用してAWS Iceberg表に表を作成する場合のformatパラメータは次のとおりです。
format => json_object('access_protocol' value
       json_object('protocol_type' value 'iceberg')

HadoopCatalogカタログを使用したOCI Iceberg表の例

HadoopCatalogカタログを使用してOCIデータ・フローによって作成されたOCI Iceberg表に表を作成する場合のformatパラメータは、次のとおりです。
format => json_object('access_protocol' value
       json_object('protocol_type'   value 'iceberg',
                   'protocol_config' value
                   json_object('iceberg_catalog_type'  value 'hadoop',
                               'iceberg_warehouse'     value '<OCI folder URI>',
                               'iceberg_table_path'    value 'database_name.table_name')));
ここで、access_protocolパラメータには、次の2つの要素を持つJSONオブジェクトが含まれます。
  • protocol_type: 'iceberg'である必要があります
  • protocol_config: アイスバーグ・カタログの詳細を指定するネストされたJSONオブジェクト。
    • iceberg_catalog_type: 'hadoop'である必要があります
    • iceberg_warehouse: 表の生成時に使用されるウェアハウス・ディレクトリ・パス(ネイティブURI形式)。
    • iceberg_table_path: 表の作成時に使用されるdatabase_name.table nameパス。

メタデータ・ファイルのURIを使用したOCI Iceberg表の例

メタデータ・ファイルのURIを使用してOCI Iceberg表に表を作成する場合のformatパラメータは次のとおりです。
format => json_object('access_protocol' value
       json_object('protocol_type' value 'iceberg')
ここで、access_protocolパラメータには、次のように1つの要素を持つJSONオブジェクトが含まれます。
  • protocol_type: 'iceberg'である必要があります

CREATE_EXTERNAL_TABLE Avro、ORCまたはParquetファイル用のプロシージャ

このプロシージャは、formatパラメータのtypeを値avroorcまたはparquetに設定することで、クラウドまたはディレクトリ内のAvro、ORCまたはParquetフォーマット・ファイルを使用して外部表を作成します。

これにより、Autonomous Databaseから外部データに対する問合せを実行できます。

構文

DBMS_CLOUD.CREATE_EXTERNAL_TABLE (
    table_name       IN VARCHAR2,
    credential_name  IN VARCHAR2 DEFAULT NULL,
    file_uri_list    IN CLOB,
    column_list      IN CLOB,
    field_list       IN CLOB DEFAULT,
    format           IN CLOB DEFAULT);

パラメータ

パラメータ 説明

table_name

外部表の名前。

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

file_uri_listでディレクトリを指定する場合、このパラメータは使用されません。

file_uri_list

このパラメータでは、ソース・ファイルURIのカンマ区切りリスト、または1つ以上のディレクトリとソース・ファイルを指定します。

クラウド・ソース・ファイルURI

クラウド・ソース・ファイルURIのファイル名には、ワイルドカードおよび正規表現を使用できます。

正規表現を使用できるのは、regexuri formatパラメータがTRUEに設定されている場合のみです。

regexuriパラメータがFALSEに設定されている場合、文字"*"および"?"はワイルドカード文字とみなされます。regexuriパラメータがTRUEに設定されている場合、文字"*"および"?"は指定された正規表現パターンの一部です。

正規表現パターンは、URI内のファイル名またはサブフォルダ・パスでのみサポートされ、パターン一致はREGEXP_LIKE関数によって実行されるものと同じです。

このオプションは、オブジェクト・ストレージのファイルに作成された外部表でのみサポートされます。

たとえば:

file_uri_list => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o(/)*year=[0-9]+(/)*month=[0-9]+(/)*[a-z]+[1-3]??.parquet'

URIの形式は、使用しているCloud Object Storageサービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

REGEXP_LIKE条件の詳細は、REGEXP_LIKE条件を参照してください。

ディレクトリ

1つのディレクトリと1つ以上のファイル名を指定することも、ディレクトリとファイル名のカンマ区切りリストを使用することもできます。ディレクトリを指定する形式は:'MY_DIR:filename.ext'です。デフォルトでは、ディレクトリ名MY_DIRはデータベース・オブジェクトであり、大/小文字は区別されません。ファイル名は、大/小文字が区別されます。

ディレクトリ内のファイル名を指定する場合、正規表現はサポートされません。ワイルドカードを使用して、ディレクトリ内のファイル名のみを指定できます。文字"*"は複数文字のワイルドカードとして使用でき、文字"?"は1文字のワイルドカードとして使用できます。例:'MY_DIR:*"または'MY_DIR:test?'

複数のディレクトリを指定するには、ディレクトリのカンマ区切りリストを使用します。例:'MY_DIR1:*, MY_DIR2:test?'

大/小文字を区別するディレクトリ名を指定するには、二重引用符を使用します。例:'"my_dir1":*, "my_dir2":Test?'

引用符文字を含めるには、2つの引用符を使用します。例:'MY_DIR:''filename.ext'。これは、filenameが引用符(')で始まることを示します。

column_list

(オプション)このフィールドは、指定されると、スキーマ、列およびデータ型の自動導出を指定するformat->schemaパラメータをオーバーライドします。詳細は、formatパラメータを参照してください。

Avro、ORCまたはParquetソースに対してcolumn_listを指定する場合、列名は、ファイルにあるそれらの列と一致している必要があります。Oracleデータ型は、Avro、ORCまたはParquetデータ型に適切にマップされる必要があります。

Parquetファイルの詳細は、DBMS_CLOUDパッケージのParquetとOracleデータ型のマッピングを参照してください。

ORCファイルの場合、詳細は、DBMS_CLOUD Package ORC to Oracle Data Type Mappingを参照してください。

Avroファイルの詳細は、DBMS_CLOUD Package Avro to Oracle Data Type Mappingを参照してください。

field_list

Avro、ORCまたはParquetファイルでは無視されます。

ソースのフィールドは、名前によって外部表の列を照合します。ソースのデータ型は、外部表の列データ型に変換されます。

ORCファイルについては、DBMS_CLOUDパッケージのORCとOracleデータ型のマッピングを参照してください

Parquetファイルの詳細は、DBMS_CLOUDパッケージのParquetとOracleデータ型のマッピングを参照してください。

Avroファイルの詳細は、DBMS_CLOUD Package Avro to Oracle Data Type Mappingを参照してください。

format

Avro、ORCまたはParquet typeソース・ファイルについては、DBMS_CLOUD Avro、ORCまたはParquet用のパッケージ・フォーマット・オプションを参照してください。

ORCの例

format => '{"type":"orc", "schema": "all"}'
format => json_object('type' value 'orc', 'schema' value 'first')

Avroの例

format => '{"type":"avro", "schema": "all"}'
format => json_object('type' value 'avro', 'schema' value 'first')

Parquetの例

format => '{"type":"parquet", "schema": "all"}'
format => json_object('type' value 'parquet', 'schema' value 'first')

Oracle列名へのAvro、ORCまたはParquet列名のマッピング

Oracle SQLでの列名マッピングおよび列名変換の使用方法の詳細は、DBMS_CLOUDパッケージのAvro、ORCおよびParquetからOracle列名へのマッピングを参照してください。

CREATE_EXTERNAL_TEXT_INDEXプロシージャ

このプロシージャは、オブジェクト・ストレージ・ファイルにテキスト索引を作成します。

CREATE_EXTERNAL_TEXT_INDEXプロシージャは、location_uriの場所で指定されたオブジェクト・ストレージ・ファイルにテキスト索引を作成します。場所URI上のファイルを使用して行われた新しい追加または削除に対して、索引は定期的にリフレッシュされます。

構文

DBMS_CLOUD.CREATE_EXTERNAL_TEXT_INDEX (
      credential_name  IN  VARCHAR2 DEFAULT NULL,
      location_uri     IN  VARCHAR2,
      index_name       IN  VARCHAR2,
      format           IN  CLOB     DEFAULT NULL
);

パラメータ

パラメータ 説明

credential_name

Cloud Object Storageの場所にアクセスするための資格証明の名前。パブリック、事前認証済または事前署名済バケットURIの場合、NULLを指定できます。

詳細は、リソースにアクセスするためのポリシーとロールの構成を参照してください。

credential_name値を指定しない場合、credential_nameNULL値に設定されます。

location_uri

オブジェクト・ストア・バケットまたはフォルダURIを指定します。

このパラメータは必須です。

URIのフォーマットは、クラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

index_name location_uriの場所にあるファイル上に構築する索引の名前を指定します。

このパラメータは必須です。

format

追加の構成オプションを指定します。オプションはJSON文字列として指定されます。

サポートされている形式のオプションは次のとおりです。

refresh_rate: ローカル索引がリフレッシュされる頻度を分単位で指定します。新しいファイルのアップロードと削除により、索引がリフレッシュされます。デフォルト値は5分です。

binary_files: 索引付けするファイルの内容がバイナリかどうかを指定します。たとえば、PDF、MS-Wordの場合、デフォルト値はFALSEです。

json_index: 索引付けされるファイルの内容がJSONか行JSONかを指定します。デフォルト値はFALSEです。

json_index_doc_sep: 行JSONドキュメントの前処理に使用するセパレータを指定します。デフォルト値は'\n' (新しい行)です。

json_index_doc_len: オブジェクト内の各JSONドキュメントの長さを指定します。デフォルト値は32767、最大値は200000です。

file_compression: JSONファイルの圧縮形式を指定します。デフォルト値はgzipです。

stop_words: 索引の作成時に指定できるストップ・ワードのリストを指定します。

stop_words値は、それがストップ・ワードのリストであるか、ストップ・ワードの表であるかを示します。JSON配列にストップ・ワード・パラメータが指定されている場合、それはリストとして扱われます。それ以外の場合、ストップ・ワード・パラメータは、ストップ・ワードのリストで読み取るために列"STOP_WORDS"が使用される表名として扱われます。

次の方法でストップワードを指定できます。

  • JSON配列: 例: format := '{"stop_words":["king","queen"]}'
  • ストップ・ワード表名: たとえば: format := '{"stop_words":"STOP_WORDS_TABLE"}'

formatパラメータを指定しない場合、formatNULL値に設定されます。

BEGIN 
DBMS_CLOUD.CREATE_EXTERNAL_TEXT_INDEX (
        credential_name => 'DEFAULT_CREDENTIAL',
        location_uri    => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/ts_data/'
        index_name      => 'EMP',
        format          => JSON_OBJECT ('refresh_rate' value 10)
);
END;
/

CREATE_HYBRID_PART_TABLEプロシージャ

このプロシージャは、ハイブリッド・パーティション表を作成します。これにより、クラウドのデータベース・オブジェクトおよびファイル、またはディレクトリ内のデータベース・オブジェクトおよびファイルを使用して、Autonomous Databaseのハイブリッド・パーティション・データに対して問合せを実行できます。

構文

DBMS_CLOUD.CREATE_HYBRID_PART_TABLE (
    table_name           IN VARCHAR2,
    credential_name      IN VARCHAR2,
    partitioning_clause  IN CLOB,
    column_list          IN CLOB,
    field_list           IN CLOB DEFAULT,
    format               IN CLOB DEFAULT);

パラメータ

パラメータ 説明

table_name

外部表の名前。

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

partitioning_clause

個々のパーティションの場所情報を含む、完全なパーティション化句を指定します。

ディレクトリを使用するには、パーティション化句でLOCATIONおよびDEFAULT DIRECTORYの値がサポートされます。

クラウド・ソース・ファイルURIのファイル名には、ワイルドカードおよび正規表現を使用できます。

正規表現を使用できるのは、regexuri formatパラメータがTRUEに設定されている場合のみです。

regexuriパラメータがFALSEに設定されている場合、文字"*"および"?"はワイルドカード文字とみなされます。regexuriパラメータがTRUEに設定されている場合、文字"*"および"?"は指定された正規表現パターンの一部です。

正規表現パターンは、URI内のファイル名またはサブフォルダ・パスでのみサポートされ、パターン一致はREGEXP_LIKE関数によって実行されるものと同じです。ディレクトリ名では正規表現パターンはサポートされていません。

たとえば:

partitioning_clause => 'partition by range (col1)
                                (partition p1 values less than (1000) external location
				    ( ''https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o(/)*year=[0-9]+(/)*month=[0-9]+(/)*[a-z]+[1-3]??.txt''),….

REGEXP_LIKE条件の詳細は、REGEXP_LIKE条件を参照してください。

column_list

外部表の列名およびデータ型のカンマ区切りリスト。

field_list

ソース・ファイル内のフィールドとそのデータ型を識別します。デフォルト値はNULLで、フィールドおよびそのデータ型がcolumn_listパラメータによって決定されることを意味します。この引数の構文は、通常のOracle外部表のfield_list句と同じです。field_listの詳細は、『Oracle® Databaseユーティリティ』を参照してください。

format

ソース・ファイルのフォーマットを説明するオプション。オプションのリストと値の指定方法は、DBMS_CLOUD Package Format Optionsを参照してください。

使用上のノート

  • プロシージャDBMS_CLOUD.CREATE_HYBRID_PART_TABLEは、サポートされているクラウド・オブジェクト・ストレージ・サービスで、次のような外部パーティション・ファイルをサポートします:

    • Oracle Cloud Infrastructure Object Storage

    • Azure Blob StorageまたはAzure Data Lake Storage

    • Amazon S3

    • Amazon S3互換: Oracle Cloud Infrastructure Object Storage、Google Cloud Storage、Wasabi Hot Cloud Storageなど。

    • GitHubリポジトリ

    資格証明は表レベルのプロパティであるため、外部ファイルは同じオブジェクト・ストアに存在する必要があります。

    詳細は、DBMS_CLOUD URI形式を参照してください。

  • プロシージャDBMS_CLOUD.CREATE_HYBRID_PART_TABLEは、ローカル・ファイル・システムまたはネットワーク・ファイル・システム内のディレクトリ内のハイブリッド・パーティション・ファイルをサポートします。

  • DBMS_CLOUD.CREATE_HYBRID_PART_TABLEを使用して作成する外部パーティション表には、2つの非表示列file$pathおよびfile$nameが含まれます。これらの列は、レコードの取得元ファイルの識別に役立ちます。

    • file$path: オブジェクト名の先頭までのファイル・パス・テキストを指定します。

    • file$name: バケット名に続くすべてのテキストを含め、オブジェクト名を指定します。

サンプル

BEGIN  
   DBMS_CLOUD.CREATE_HYBRID_PART_TABLE(
      table_name =>'HPT1',  
      credential_name =>'OBJ_STORE_CRED',  
      format => json_object('delimiter' value ',', 'recorddelimiter' value 'newline', 'characterset' value 'us7ascii'),  
      column_list => 'col1 number, col2 number, col3 number',
      partitioning_clause => 'partition by range (col1)
                                (partition p1 values less than (1000) external location
                                    ( ''&base_URL/file_11.txt'')
                                 ,
                                 partition p2 values less than (2000) external location
                                    ( ''&base_URL/file_21.txt'')
                                 ,
                                 partition p3 values less than (3000)
                                 )'
     );
   END;
/ 


BEGIN
   DBMS_CLOUD.CREATE_HYBRID_PART_TABLE(
    table_name  => 'HPT1',
    format      => json_object('delimiter'value ',', 'recorddelimiter'value 'newline'),
    column_list => 'NAME VARCHAR2(30), GENDER VARCHAR2(10), BALANCE number',
    partitioning_clause => 'partition by range (B  2  ALANCE)
               (partition p1 values less than (1000) external DEFAULT DIRECTORY DATA_PUMP_DIR LOCATION (''Scott_male_1000.csv''),
                partition p2 values less than (2000) external DEFAULT DIRECTORY DATA_PUMP_DIR LOCATION (''Mary_female_3000.csv''),
                partition p3 values less than (3000))' );
END;
/

DELETE_ALL_OPERATIONSプロシージャ

このプロシージャは、スキーマ内のuser_load_operations表に記録されたすべてのデータ・ロード操作をクリアするか、typeパラメータで示されている、指定されたタイプのすべてのデータ・ロード操作をクリアします。

構文

DBMS_CLOUD.DELETE_ALL_OPERATIONS (
	type      IN VARCHAR DEFAULT NULL);

パラメータ

パラメータ 説明

type

削除する操作のタイプを指定します。タイプの値は、user_load_operations表のTYPE列にあります。

typeが指定されていない場合、すべての行が削除されます。

使用上のノート

  • DBMS_CLOUD.DELETE_ALL_OPERATIONSは、現在実行中の操作(ステータスが「実行中」の操作)は削除しません。

DELETE_FILEプロシージャ

このプロシージャは、Autonomous Database上の指定されたディレクトリから指定されたファイルを削除します。

構文

 DBMS_CLOUD.DELETE_FILE ( 
       directory_name     IN VARCHAR2,
       file_name          IN VARCHAR2,
       force              IN BOOLEAN DEFAULT FALSE); 

パラメータ

パラメータ 説明

directory_name

Autonomous Databaseインスタンスのディレクトリの名前。

file_name

削除するファイルの名前。

force

ファイルが存在しない場合、エラーを無視して報告しません。有効な値はTRUEおよびFALSEです。デフォルト値はFALSEです。

ノート

DBMS_CLOUD.DELETE_FILEをADMIN以外のユーザーで実行するには、ファイルを含むディレクトリに対する書込み権限をそのユーザーに付与する必要があります。たとえば、adb_userに書込み権限を付与するには、ADMINとして次のコマンドを実行します:
GRANT WRITE ON DIRECTORY data_pump_dir TO adb_user;

BEGIN
   DBMS_CLOUD.DELETE_FILE(
      directory_name =>  'DATA_PUMP_DIR',
      file_name => 'exp1.dmp' );
   END;
/ 

DELETE_OBJECTプロシージャ

このプロシージャは、オブジェクト・ストアの指定されたオブジェクトを削除します。

構文

DBMS_CLOUD.DELETE_OBJECT (
       credential_name      IN VARCHAR2,
       object_uri           IN VARCHAR2,
       force                IN BOOLEAN DEFAULT FALSE);

パラメータ

パラメータ 説明

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

object_uri

削除するオブジェクトのオブジェクトまたはファイルURI。URIの形式は、使用しているCloud Object Storageサービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

force

オブジェクトが存在しない場合、エラーを無視して報告しません。有効な値はTRUEおよびFALSEです。デフォルト値はFALSEです。

BEGIN
   DBMS_CLOUD.DELETE_OBJECT(
       credential_name => 'DEF_CRED_NAME',
       object_uri => 'https://objectstorage.us-ashburn-1.oraclecloud.com/n/namespace-string/b/bucketname/o/exp1.dmp' );
   END;
/ 

DELETE_OPERATIONプロシージャ

このプロシージャは、スキーマのuser_load_operationsまたはdba_load_operations表に記録された、指定された操作IDのデータ・ロード・エントリをクリアします。

構文

DBMS_CLOUD.DELETE_OPERATION (
	id      IN NUMBER);

パラメータ

パラメータ 説明

id

削除するログ・ファイル・エントリに関連付けられた操作IDを指定します。

SELECT id FROM user_load_operations WHERE type LIKE '%BAD%';
EXEC DBMS_CLOUD.DELETE_OPERATION(id);

DROP_EXTERNAL_TEXT_INDEXプロシージャ

このプロシージャは、オブジェクト・ストレージ・ファイルのテキスト索引を削除します。

DROP_EXTERNAL_TEXT_INDEXプロシージャは、CREATE_EXTERNAL_TEXT_INDEXプロシージャで作成された指定された索引を削除します。

構文

DBMS_CLOUD.DROP_EXTERNAL_TEXT_INDEX (
      index_name       IN  VARCHAR2,
);

パラメータ

パラメータ 説明
index_name

削除する索引の名前を指定します。

索引名は、索引の作成時に指定された名前と一致する必要があります。

このパラメータは必須です。

BEGIN 
DBMS_CLOUD.DROP_EXTERNAL_TEXT_INDEX (
        index_name => 'EMP',
);
END;
/

EXPORT_DATAプロシージャ

このプロシージャは、問合せの結果に基づいてAutonomous Databaseからデータをエクスポートします。この手順はオーバーロードされており、クラウドまたはディレクトリへのファイルの書込みをサポートしています。

format typeパラメータに基づいて、プロシージャは、ファイルをクラウドにエクスポートするか、CSV、JSON、ParquetまたはXML形式のテキスト・ファイルとしてディレクトリの場所にエクスポートするか、ORACLE_DATAPUMPアクセス・ドライバを使用してOracle Datapumpダンプ・ファイルにデータを書き込みます。

構文

DBMS_CLOUD.EXPORT_DATA (
      credential_name   IN VARCHAR2 DEFAULT NULL,
      file_uri_list     IN CLOB,
      format            IN CLOB,
      query             IN CLOB);

DBMS_CLOUD.EXPORT_DATA (
      credential_name   IN VARCHAR2 DEFAULT NULL,
      file_uri_list     IN CLOB DEFAULT NULL,
      format            IN CLOB DEFAULT NULL,
      query             IN CLOB DEFAULT NULL,
      operation_id      OUT NOCOPY NUMBER);

パラメータ

パラメータ 説明

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

資格証明パラメータが含まれていない場合、ディレクトリへの出力を指定します。

file_uri_list

formatパラメータの値、および資格証明パラメータを含めるかどうかに応じて、様々なフォームがあります:
  • formatパラメータのtype値がjsonの場合: オブジェクト・ストア上のJSONまたは指定されたディレクトリの場所へのJSONは、file_uri_listパラメータの値に基づいて生成されたファイル名で保存されます。詳細は、テキスト出力(CSV、JSON、ParquetまたはXML)のファイル・ネーミングを参照してください。

  • formatパラメータのtype値がdatapumpの場合、file_uri_listはダンプ・ファイルのカンマ区切りリストです。これは、オブジェクト・ストアで作成するファイルを指定します。file_uri_listでは、ワイルドカードおよび置換文字の使用はサポートされていません。

  • credential_nameパラメータを指定しない場合は、file_uri_listにディレクトリ名を指定します。

URIの形式は、使用しているクラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

format

エクスポート・フォーマット・オプションを提供するJSON文字列。

サポートされるオプションは次のとおりです。

  • type: type formatオプションは必須であり、csv | datapump | json | parquet | xmlのいずれかの値が必要です。

DBMS_CLOUD Package Format Options for EXPORT_DATAを参照してください。

query

このパラメータを使用して、必要なデータのみがエクスポートされるようにSELECT文を指定します。問合せによって、テキスト・ファイルCSV、JSON、ParquetまたはXMLとして、またはダンプ・ファイルとしてエクスポートするファイルのコンテンツが決定されます。例:

SELECT warehouse_id, quantity FROM inventories

type値がdatapumpの書式の詳細は、Oracle Data Pump Exportのデータ・フィルタおよびORACLE_DATAPUMPアクセス・ドライバを使用したデータのアンロードとロードを参照してください。

formattype値がjsonの場合、各問合せ結果がチェックされ、ファンクションJSON_OBJECT_T.parse()で決定されるとおり、それがJSONでない場合、DBMS_CLOUD.EXPORT_DATAは、行をJSONに変換するJSON_OBJECTファンクションを含むように問合せを変換します。詳細は、JSON_OBJECT_Tオブジェクト型を参照してください。

たとえば、次のとおりです。

SELECT JSON_OBJECT(* RETURNING CLOB) from(SELECT warehouse_id, quantity FROM inventories)

operation_id

このパラメータを使用して、USER_LOAD_OPERATIONSビューで、エクスポート操作の進捗および最終ステータスを対応するIDとしてトラッキングします。

使用上のノート:

  • 指定するqueryパラメータ値は、必要に応じて、結合や副問合せを含む問合せなどの拡張問合せにすることができます。

  • 指定されたformatパラメータに応じて、DBMS_CLOUD.EXPORT_DATAは、指定された問合せの結果をクラウド・オブジェクト・ストアまたは次のいずれかの形式でディレクトリの場所に出力します:

  • CSV、JSONまたはXML出力の場合、生成されたファイルに10MBのデータが含まれると、デフォルトで新しい出力ファイルが作成されます。ただし、結果データが10MB未満の場合でも、データベース・サービスおよびAutonomous DatabaseインスタンスのECPU (OCPUを使用している場合)の数によっては、複数の出力ファイルが作成される可能性があります。

    詳細は、テキスト出力(CSV、JSON、ParquetまたはXML)のファイル・ネーミングを参照してください。

    CSV、JSONまたはXMLのデフォルトの出力ファイルのチャンク・サイズは10MBです。この値は、formatパラメータのmaxfilesizeオプションを使用して変更できます。詳細は、DBMS_CLOUD EXPORT_DATAのパッケージ形式オプションを参照してください。

  • Parquet出力の場合、生成される各ファイルは128MB未満で、複数の出力ファイルが生成される可能性があります。ただし、結果データが128MB未満の場合でも、データベース・サービスおよびAutonomous DatabaseインスタンスのECPU (OCPUを使用している場合)の数によっては、複数の出力ファイルが作成される可能性があります。

    詳細は、テキスト出力(CSV、JSON、ParquetまたはXML)のファイル・ネーミングを参照してください。

ORACLE_DATAPUMP出力の使用上のノート(formatパラメータのtypeオプションがdatapumpDBMS_CLOUD.EXPORT_DATA):

  • EXPORT_DATAは、デフォルトのロギング・ディレクトリとしてDATA_PUMP_DIRを使用します。そのため、ORACLE_DATAPUMP出力を使用する場合は、DATA_PUMP_DIRに対する書込み権限が必要です。

  • formatパラメータのtypeオプションにdatapumpを持つDBMS_CLOUD.EXPORT_DATAを使用したAutonomous Databaseエクスポートでは、Oracle Cloud Infrastructure Object Storage、Oracle Cloud Infrastructure Object Storage Classicのオブジェクト・ストアまたはディレクトリ出力のみがサポートされます。

  • formatパラメータのtypeオプションdatapumpDBMS_CLOUD.EXPORT_DATAを指定する場合、credential_nameパラメータ値をOCIリソース・プリンシパルにすることはできません。

  • Oracle Data Pumpでは、各ダンプ・ファイルの部分を小さなチャンクに分割してアップロードを高速化します。Oracle Cloud Infrastructure Object Storageコンソールには、エクスポートするダンプ・ファイル・パートごとに複数のファイルが表示されます。実際のダンプファイルのサイズはゼロ(0)、関連するファイル・チャンクは10mb以下と表示されます。例:
    exp01.dmp
    exp01.dmp_aaaaaa
    exp02.dmp
    exp02.dmp_aaaaaa
    Oracle Cloud InfrastructureコンソールまたはOracle Cloud Infrastructure CLIを使用してゼロ・バイト・ダンプ・ファイルをダウンロードしても、完全なダンプ・ファイルは得られません。オブジェクト・ストアから完全なダンプ・ファイルをダウンロードするには、curlなどのSwiftをサポートするツールを使用して、ユーザー・ログインおよびSwift認証トークンを指定します。
    curl -O -v -X GET -u 'user1@example.com:auth_token' \
       https://swiftobjectstorage.us-ashburn-1.oraclecloud.com/v1/namespace-string/bucketname/exp01.dmp

    datapumpを持つformatパラメータtypeをサポートするDBMS_CLOUDプロシージャを使用してファイルをインポートする場合は、プライマリ・ファイル名のみを指定する必要があります。'datapump'形式タイプをサポートするプロシージャは、チャンクを自動的に検出およびダウンロードします。

    DBMS_CLOUD.DELETE_OBJECTを使用すると、プライマリ・ファイルが削除されたときにチャンクが自動的に検出および削除されます。

  • DBMS_CLOUD.EXPORT_DATAプロシージャは、次のように、指定したfile_uri_list値からダンプ・ファイルを作成します:

    • さらにファイルが必要な場合は、file_uri_listから追加のファイルを作成します。

    • ファイルは上書きしません。file_uri_listのダンプ・ファイルが存在する場合、DBMS_CLOUD.EXPORT_DATAはエラーを報告します。

    • DBMS_CLOUD.EXPORT_DATAはバケットを作成しません。

  • プロシージャの実行時に、DBMS_CLOUD.EXPORT_DATAによって生成されるダンプ・ファイルの数が決まります。生成されるダンプ・ファイルの数は、file_uri_listパラメータで指定するファイル名の数、およびインスタンスで使用可能なAutonomous Database OCPUの数、サービス・レベル、データのサイズによって異なります。

    たとえば、1つのOCPU Autonomous Databaseインスタンスまたはlowサービスを使用すると、複数のファイル名を指定した場合でも、単一のダンプ・ファイルが並列度なしでエクスポートされます。4 OCPUのAutonomous Databaseインスタンスをmediumまたはhighサービスで使用する場合、複数のファイル名を指定すると、ジョブをパラレルに実行でき、複数のダンプ・ファイルがエクスポートされます。

  • DBMS_CLOUD.EXPORT_DATAを使用して作成したダンプ・ファイルは、Oracle Data Pump impdpを使用してインポートすることはできません。データベースに応じて、次のようにこれらのファイルを使用できます:

    • Autonomous Databaseでは、値datapumpを持つformatパラメータtypeをサポートするDBMS_CLOUDプロシージャでダンプ・ファイルを使用できます。DBMS_CLOUD.COPY_DATAを使用してダンプ・ファイルをインポートするか、DBMS_CLOUD.CREATE_EXTERNAL_TABLEをコールして外部表を作成できます。

    • Oracle Database 19cオンプレミスなどの他のOracle Databaseでは、ORACLE_DATAPUMPアクセス・ドライバを使用して、プロシージャDBMS_CLOUD.EXPORT_DATAで作成されたダンプ・ファイルをインポートできます。詳細は、ORACLE_DATAPUMPアクセス・ドライバを使用したデータのアンロードおよびロードを参照してください。

  • 指定するqueryパラメータ値は、必要に応じて、結合や副問合せを含む問合せなどの拡張問合せにすることができます。

ディレクトリへの出力でのDBMS_CLOUD.EXPORT_DATAの使用上のノート

  • 指定されたディレクトリが存在している必要があり、ADMINユーザーとしてログインしているか、ディレクトリへのWRITEアクセス権を持っている必要があります。

  • DBMS_CLOUD.EXPORT_DATAはディレクトリを作成しません。

  • ファイルは上書きしません。たとえば、file_uri_listのダンプ・ファイルが存在する場合、DBMS_CLOUD.EXPORT_DATAは次のようなエラーを報告します。

    ORA-31641: unable to create dump file  "/u02/exports/123.dmp"
    ORA-27038: created file already exists

サンプル

次の例は、formatのtypeパラメータに値datapumpが指定されたDBMS_CLOUD.EXPORT_DATAを示しています:

BEGIN  
   DBMS_CLOUD.EXPORT_DATA(
      credential_name =>'OBJ_STORE_CRED',
      file_uri_list =>'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/exp1.dmp',
      format => json_object('type' value 'datapump', 'compression' value 'basic', 'version' value 'latest'),
      query => 'SELECT warehouse_id, quantity FROM inventories'
     );
   END;
/  

この例では、namespace-stringはOracle Cloud Infrastructureオブジェクト・ストレージ・ネームスペースで、bucketnameはバケット名です。詳細は、オブジェクト・ストレージ・ネームスペースの理解を参照してください。

次の例は、formatのtypeパラメータに値jsonが指定されたDBMS_CLOUD.EXPORT_DATAを示しています:

BEGIN  
   DBMS_CLOUD.EXPORT_DATA(
      credential_name => 'OBJ_STORE_CRED',
      file_uri_list   => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/exp1.json', 
      query           => 'SELECT * FROM DEPT',
      format          => JSON_OBJECT('type' value 'json', 'compression' value 'gzip'));
     );
   END;
/  

次の例は、formatのtypeパラメータに値xmlが指定されたDBMS_CLOUD.EXPORT_DATAを示しています:

BEGIN  
   DBMS_CLOUD.EXPORT_DATA(
      credential_name => 'OBJ_STORE_CRED',
      file_uri_list   => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/exp1.xml', 
      query           => 'SELECT * FROM DEPT',
      format          => JSON_OBJECT('type' value 'xml', 'compression' value 'gzip'));
     );
   END;
/

次の例は、formatのtypeパラメータに値csvが指定されたDBMS_CLOUD.EXPORT_DATAを示しています:

BEGIN  
   DBMS_CLOUD.EXPORT_DATA(
      credential_name => 'OBJ_STORE_CRED',
      file_uri_list   => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/exp.csv', 
      query           => 'SELECT * FROM DEPT',
      format          => JSON_OBJECT('type' value 'csv', 'delimiter' value '|', 'compression' value 'gzip', 'header' value true, 'encryption' value ('user_defined_function' value 'ADMIN.decryption_callback')));
     );
   END;
/  

次の例は、typeパラメータに値datapumpを使用して、ディレクトリの場所にデータをエクスポートするDBMS_CLOUD.EXPORT_DATAを示しています:

BEGIN
 DBMS_CLOUD.EXPORT_DATA(
    file_uri_list => 'export_dir:sales.dmp',
    format        => json_object('type' value 'datapump'),
    query         => 'SELECT * FROM sales'
 );
END;
/

GET_OBJECTプロシージャおよびファンクション

このプロシージャはオーバーロードされています。このプロシージャ・フォームは、クラウド・オブジェクト・ストレージからオブジェクトを読み取り、それをAutonomous Databaseにコピーします。このファンクション・フォームは、Cloud Object Storageからオブジェクトを読み取り、Autonomous DatabaseにBLOBを返します。

構文

DBMS_CLOUD.GET_OBJECT (
       credential_name      IN VARCHAR2,
       object_uri           IN VARCHAR2,
       directory_name       IN VARCHAR2,
       file_name            IN VARCHAR2 DEFAULT  NULL,
       startoffset          IN NUMBER DEFAULT  0,
       endoffset            IN NUMBER DEFAULT  0,
       compression          IN VARCHAR2 DEFAULT  NULL);


DBMS_CLOUD.GET_OBJECT(
       credential_name      IN VARCHAR2 DEFAULT NULL,
       object_uri           IN VARCHAR2,
       startoffset          IN NUMBER DEFAULT  0,
       endoffset            IN NUMBER DEFAULT  0,
       compression          IN VARCHAR2 DEFAULT  NULL)
RETURN BLOB;

パラメータ

パラメータ 説明

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

object_uri

オブジェクトまたはファイルURI。URIの形式は、使用しているCloud Object Storageサービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

directory_name

データベース上のディレクトリの名前。

足1

file_name

作成するファイルの名前を指定します。ファイル名を指定しない場合、ファイル名はobject_uriパラメータの最後のスラッシュの後から取得されます。たとえば、ファイル名にスラッシュが含まれるような特殊なケースでは、file_nameパラメータを使用してください。

startoffset

プロシージャが読取りを開始するオフセット(バイト)。

endoffset

プロシージャが読取りを停止するオフセット(バイト)。

compression

オブジェクトの格納に使用する圧縮を指定します。compression'AUTO'に設定されている場合、ファイルは圧縮解除されます(値'AUTO'は、object_uriで指定されたオブジェクトがGzipで圧縮されることを示します)。

脚注1

ノート

DBMS_CLOUD.GET_OBJECTをADMIN以外のユーザーで実行するには、そのユーザーにディレクトリに対するWRITE権限を付与する必要があります。たとえば、次のコマンドをADMINとして実行して、adb_userに書込み権限を付与します:

GRANT WRITE ON DIRECTORY data_pump_dir TO adb_user;

戻り値

ファンクション形式では、オブジェクト・ストアから読み取り、DBMS_CLOUD.GET_OBJECTBLOBを戻します。

サンプル

BEGIN 
   DBMS_CLOUD.GET_OBJECT(
     credential_name => 'OBJ_STORE_CRED',
     object_uri => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/file.txt',
     directory_name => 'DATA_PUMP_DIR'); 
END;
/

オブジェクト・ストア内のファイルから文字データを読み取るには:

SELECT to_clob(
     DBMS_CLOUD.GET_OBJECT(
       credential_name => 'OBJ_STORE_CRED',
       object_uri => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/file.txt'))
FROM DUAL;

データベースのBLOBのオブジェクト・ストアに格納されているイメージを追加するには:


DECLARE
   l_blob BLOB := NULL;
BEGIN
   l_blob := DBMS_CLOUD.GET_OBJECT(
     credential_name => 'OBJ_STORE_CRED',
     object_uri => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/MyImage.gif' );
END;
/

この例では、namespace-stringはOracle Cloud Infrastructureオブジェクト・ストレージ・ネームスペースで、bucketnameはバケット名です。詳細は、オブジェクト・ストレージ・ネームスペースの理解を参照してください。

LIST_FILESファンクション

このファンクションは、指定されたディレクトリ内のファイルを一覧表示します。結果には、ファイル名と、ファイルに関する追加のメタデータ(ファイル・サイズ(バイト)、作成タイムスタンプ、最終変更タイムスタンプなど)が含まれます。

構文

DBMS_CLOUD.LIST_FILES (
	directory_name      IN VARCHAR2)
       RETURN TABLE;

パラメータ

パラメータ 説明

directory_name

データベース上のディレクトリの名前。

使用上のノート

  • DBMS_CLOUD.LIST_FILESをADMIN以外のユーザーで実行するには、ディレクトリに対する読取り権限をそのユーザーに付与する必要があります。たとえば、adb_userに読取り権限を付与するには、ADMINとして次のコマンドを実行します:

    GRANT READ ON DIRECTORY data_pump_dir TO adb_user;
  • これは、戻り値のタイプがDBMS_CLOUD_TYPES.list_object_ret_tであるパイプライン・テーブル・ファンクションです。

  • DBMS_CLOUD.LIST_FILESはチェックサム値を取得せず、このフィールドに対してNULLを返します。

これはパイプライン関数で、各ファイルの行を返します。たとえば、次の問合せを使用してこのファンクションを使用します:

SELECT * FROM DBMS_CLOUD.LIST_FILES('DATA_PUMP_DIR');

OBJECT_NAME       BYTES   CHECKSUM      CREATED              LAST_MODIFIED
------------ ---------- ----------    ---------------------  ---------------------
cwallet.sso        2965               2018-12-12T18:10:47Z   2019-11-23T06:36:54Z

LIST_OBJECTSファンクション

このファンクションは、オブジェクト・ストアの指定された場所にあるオブジェクトを一覧表示します。結果には、オブジェクト名と、オブジェクトに関する追加のメタデータ(サイズ、チェックサム、作成タイムスタンプ、最終変更タイムスタンプなど)が含まれます。

構文

DBMS_CLOUD.LIST_OBJECTS (
       credential_name      IN VARCHAR2,
       location_uri         IN VARCHAR2)
   RETURN TABLE;

パラメータ

パラメータ 説明

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

location_uri

オブジェクトまたはファイルURI。URIの形式は、使用しているCloud Object Storageサービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

使用上のノート

  • オブジェクト・ストアの機能によって、DBMS_CLOUD.LIST_OBJECTSは特定の属性の値を返さず、その場合、フィールドの戻り値はNULLです。

    サポートされているすべてのオブジェクト・ストアは、OBJECT_NAMEBYTESおよびCHECKSUMフィールドの値を返します。

    次の表に、オブジェクト・ストアによるフィールドCREATEDおよびLAST_MODIFIEDのサポートを示します:

    オブジェクト・ストア CREATED LAST_MODIFIED
    Oracle Cloud Infrastructureネイティブ タイムスタンプを返します タイムスタンプを返します
    Oracle Cloud Infrastructure Swift NULLが戻されます タイムスタンプを返します
    Oracle Cloud Infrastructure Classic NULLが戻されます タイムスタンプを返します
    Amazon S3 NULLが戻されます タイムスタンプを返します
    Amazon S3互換 NULLが戻されます タイムスタンプを返します
    Azure タイムスタンプを返します タイムスタンプを返します
    GitHubリポジトリ    
  • チェックサム値は、MD5チェックサムです。これは、オブジェクトの内容に基づいて計算されます。OCI$RESOURCE_PRINCIPAL資格証明を使用する場合、チェックサム値は異なる必要があります。

  • これは、戻り値のタイプがDBMS_CLOUD_TYPES.list_object_ret_tであるパイプライン・テーブル・ファンクションです。

これは、オブジェクトごとの行を返すパイプライン関数です。たとえば、次の問合せを使用してこのファンクションを使用します:

SELECT * FROM DBMS_CLOUD.LIST_OBJECTS('OBJ_STORE_CRED', 
    'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/');


OBJECT_NAME   BYTES              CHECKSUM                       CREATED         LAST_MODIFIED
------------ ---------- -------------------------------- --------------------- --------------------
cwallet.sso   2965      2339a2731ba24a837b26d344d643dc07 2019-11-23T06:36:54Z          

この例では、namespace-stringはOracle Cloud Infrastructureオブジェクト・ストレージ・ネームスペースで、bucketnameはバケット名です。詳細は、オブジェクト・ストレージ・ネームスペースの理解を参照してください。

MOVE_OBJECTプロシージャ

このプロシージャは、あるクラウド・オブジェクト・ストレージ・バケットまたはフォルダから別のクラウド・オブジェクト・ストレージ・バケットにオブジェクトを移動します。

ソース・バケットまたはターゲット・フォルダは、同じクラウド・オブジェクト・ストア・プロバイダまたは異なるクラウド・オブジェクト・ストア・プロバイダに配置できます。

ソースとターゲットが個別のオブジェクト・ストアにある場合、または同じクラウド・プロバイダを持つ異なるアカウントがある場合、ソースとターゲットの場所に個別の資格証明名を指定できます。

ターゲット資格証明名が指定されていない場合、ソース資格証明名はターゲットの場所でもデフォルトで使用されます。

構文

DBMS_CLOUD.MOVE_OBJECT (
    source_credential_name  IN  VARCHAR2 DEFAULT NULL,
    source_object_uri       IN  VARCHAR2,
    target_object_uri       IN  VARCHAR2,
    target_credential_name  IN  VARCHAR2 DEFAULT NULL
);

パラメータ

パラメータ 説明

source_credential_name

ソースのCloud Object Storageにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

source_credential_name値を指定しない場合、credential_nameNULLに設定されます。

source_object_uri

ソース・オブジェクト・ストレージ・バケットまたはフォルダの場所を指すURIを指定します。

このパラメータは必須です。

URIのフォーマットは、クラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

target_object_uri

ファイルの移動が必要なターゲット・オブジェクト・ストレージ・バケットまたはフォルダのURIを指定します。

このパラメータは必須です。

URIのフォーマットは、クラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

target_credential_name

ターゲットのクラウドのオブジェクト・ストレージの場所にアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

target_credential_name値を指定しない場合、target_object_urisource_credential_name値に設定されます。

BEGIN 
DBMS_CLOUD.MOVE_OBJECT (
    source_credential_name => 'OCI_CRED',
    source_object_uri    => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname1/bgfile.csv',
    target_object_uri    => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname2/myfile.csv'
);
END;
/

PUT_OBJECTプロシージャ

このプロシージャはオーバーロードされています。このプロシージャは、1つの形式でAutonomous DatabaseからCloud Object Storageにファイルをコピーします。また、このプロシージャは、Autonomous Databaseからクラウド・オブジェクト・ストレージにBLOBをコピーします。

構文

DBMS_CLOUD.PUT_OBJECT (
       credential_name      IN VARCHAR2,
       object_uri           IN VARCHAR2,
       directory_name       IN VARCHAR2,
       file_name            IN VARCHAR2
       compression          IN VARCHAR2 DEFAULT  NULL);


DBMS_CLOUD.PUT_OBJECT (
       credential_name      IN VARCHAR2,
       object_uri           IN VARCHAR2,
       contents             IN BLOB
       compression          IN VARCHAR2 DEFAULT  NULL);

パラメータ

パラメータ 説明

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

object_uri

オブジェクトまたはファイルURI。URIの形式は、使用しているCloud Object Storageサービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

directory_name

Autonomous Database上のディレクトリの名前。

足2

contents

Autonomous Databaseからクラウド・オブジェクト・ストレージにコピーするBLOBを指定します。

file_name

指定されたディレクトリ内のファイルの名前。

compression

オブジェクトの格納に使用する圧縮を指定します。

デフォルト値: NULL

脚注2

ノート

DBMS_CLOUD.PUT_OBJECTをADMIN以外のユーザーで実行するには、そのユーザーにディレクトリに対する読取り権限を付与する必要があります。たとえば、次のコマンドをADMINとして実行して、adb_userに読取り権限を付与します:

GRANT READ ON DIRECTORY data_pump_dir TO adb_user;

データベース内処理後にBLOBデータを処理して、そのデータをオブジェクト・ストアのファイルに直接格納するには:

DECLARE
      my_blob_data BLOB;
BEGIN 
 /* Some processing producing BLOB data and populating my_blob_data */
DBMS_CLOUD.PUT_OBJECT(
     credential_name => 'OBJ_STORE_CRED',
     object_uri => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/my_new_file',
     contents => my_blob_data)); 
END;
/

使用上のノート

Cloud Object Storageに応じて、転送するオブジェクトのサイズは次のように制限されます:

Cloud Object Storageサービス オブジェクト転送のサイズ制限

Oracle Cloud Infrastructure Object Storage

50GB

Amazon S3

5 GB

Azure Blob StorageまたはAzure Data Lake Storage

256 MB

Amazon S3互換

オブジェクト・ストア・プロバイダによって設定されます。詳細は、プロバイダのドキュメントを参照してください。

Oracle Cloud Infrastructureオブジェクト・ストアでは、資格証明を指定せずにファイルをパブリック・バケットに書き込むことはできません(Oracle Cloud Infrastructureでは、ユーザーはパブリック・バケットからオブジェクトをダウンロードできます)。したがって、PUT_OBJECTを使用してオブジェクトをOracle Cloud Infrastructureパブリック・バケットに格納するには、有効な資格証明を含む資格証明名を指定する必要があります。

詳細は、DBMS_CLOUD URI形式を参照してください。

SYNC_EXTERNAL_PART_TABLEプロシージャ

このプロシージャは、クラウドのファイルの外部パーティション表の更新を簡素化します。このプロシージャは、新しいパーティションが追加されたとき、またはパーティションが外部パーティション表のオブジェクト・ストア・ソースから削除されたときに実行します。

構文

DBMS_CLOUD.SYNC_EXTERNAL_PART_TABLE (
	table_name        IN VARCHAR2,
	schema_name       IN VARCHAR2 DEFAULT,
	update_columns    IN BOOLEAN DEFAULT);

パラメータ

パラメータ 説明

table_name

ターゲット表の名前。DBMS_CLOUD.SYNC_EXTERNAL_PART_TABLEを実行する前にターゲット表を作成する必要があります。

schema_name

ターゲット表が存在するスキーマの名前。デフォルト値はNULLで、ターゲット表がプロシージャを実行しているユーザーと同じスキーマ内に存在することを意味します。

update_columns

新しいファイルによってスキーマに変更を取り込むことができます。サポートされる更新には、新しい列や削除された列が含まれます。データ型の変更など、既存の列に対する更新ではエラーが発生します。

デフォルト値: False

VALIDATE_EXTERNAL_PART_TABLEプロシージャ

このプロシージャは、外部パーティション表のソース・ファイルを検証し、ログ情報を生成し、外部表に指定されたフォーマット・オプションと一致しない行をAutonomous Databaseのbadfile表に格納します。オーバーロード・フォームでは、operation_idパラメータを使用できます。

構文

DBMS_CLOUD.VALIDATE_EXTERNAL_PART_TABLE (
       table_name                 IN VARCHAR2,
       partition_name             IN CLOB DEFAULT,
       subpartition_name          IN CLOB DEFAULT,
       schema_name                IN VARCHAR2 DEFAULT,
       rowcount                   IN NUMBER DEFAULT,
       partition_key_validation   IN BOOLEAN DEFAULT,
       stop_on_error              IN BOOLEAN DEFAULT);


DBMS_CLOUD.VALIDATE_EXTERNAL_PART_TABLE (
       table_name                 IN VARCHAR2,
       operation_id               OUT NUMBER,
       partition_name             IN CLOB DEFAULT,
       subpartition_name          IN CLOB DEFAULT,
       schema_name                IN VARCHAR2 DEFAULT,
       rowcount                   IN NUMBER DEFAULT,
       partition_key_validation   IN BOOLEAN DEFAULT,
       stop_on_error              IN BOOLEAN DEFAULT);

パラメータ

パラメータ 説明

table_name

外部表の名前。

operation_id

このパラメータを使用して、USER_LOAD_OPERATIONSビューで、ロード操作の進行状況および最終ステータスを対応するIDとして追跡します。

partition_name

定義すると、特定のパーティションのみが検証されます。指定しない場合は、rowcountに達するまで、すべてのパーティションを順次読み取ります。

subpartition_name

定義すると、特定のサブパーティションのみが検証されます。指定しない場合は、rowcountに達するまで、すべての外部パーティションまたはサブパーティションから順に読み取ります。

schema_name

外部表が存在するスキーマの名前。デフォルト値はNULLで、外部表がプロシージャを実行しているユーザーと同じスキーマ内に存在することを意味します。

rowcount

スキャンされる行数。デフォルト値はNULLで、ソース・ファイル内のすべての行がスキャンされることを意味します。

partition_key_validation

内部使用のみこのパラメータは使用しないでください。

stop_on_error

行が拒否されたときに検証を停止するかどうかを決定します。デフォルト値はTRUEで、最初に拒否された行で検証を停止することを意味します。値をFALSEに設定すると、最初に拒否された行で検証を停止せず、rowcountパラメータに指定された値までのすべての行を検証することを指定します。

VALIDATE_EXTERNAL_TABLEプロシージャ

このプロシージャは、外部表のソース・ファイルを検証し、ログ情報を生成して、外部表に指定されたフォーマット・オプションと一致しない行をAutonomous Databaseのbadfile表に格納します。オーバーロード・フォームでは、operation_idパラメータを使用できます。

構文

DBMS_CLOUD.VALIDATE_EXTERNAL_TABLE (
	table_name      IN VARCHAR2,
	schema_name     IN VARCHAR2 DEFAULT,		
	rowcount        IN NUMBER DEFAULT,
	stop_on_error   IN BOOLEAN DEFAULT);


DBMS_CLOUD.VALIDATE_EXTERNAL_TABLE(
	table_name      IN VARCHAR2,
	operation_id    OUT NOCOPY NUMBER,
	schema_name     IN VARCHAR2 DEFAULT NULL,		
	rowcount        IN NUMBER DEFAULT 0,
	stop_on_error   IN BOOLEAN DEFAULT TRUE);

パラメータ

パラメータ 説明

table_name

外部表の名前。

operation_id

このパラメータを使用して、USER_LOAD_OPERATIONSビューで、ロード操作の進行状況および最終ステータスを対応するIDとして追跡します。

schema_name

外部表が存在するスキーマの名前。デフォルト値はNULLで、外部表がプロシージャを実行しているユーザーと同じスキーマ内に存在することを意味します。

rowcount

スキャンされる行数。デフォルト値はNULLで、ソース・ファイル内のすべての行がスキャンされることを意味します。

stop_on_error

行が拒否されたときに検証を停止するかどうかを決定します。デフォルト値はTRUEで、最初に拒否された行で検証を停止することを意味します。値をFALSEに設定すると、最初に拒否された行で検証を停止せず、rowcountパラメータに指定された値までのすべての行を検証することを指定します。

外部表がAvro、ORCまたはParquetファイルを参照している場合、検証は最初に拒否された行を停止します。

外部表でformatパラメータのtypeが値avroorcまたはparquetに設定されている場合、stop_on_errorパラメータは事実上常に値TRUEを持ちます。そのため、Avro、ORCまたはParquetファイルを参照している外部表では、badfile表は常に空になります。

使用上のノート

  • DBMS_CLOUD.VALIDATE_EXTERNAL_TABLEは、パーティション外部表とハイブリッド・パーティション表の両方で機能します。これは、rowcountに達するか、stop_on_errorが適用されるまで、場合によってはすべての外部パーティションからデータを読み取ります。読み取られるパーティション(またはパーティションの一部)の順序は制御できません。

VALIDATE_HYBRID_PART_TABLEプロシージャ

このプロシージャは、ハイブリッド・パーティション表のソース・ファイルを検証し、ログ情報を生成し、ハイブリッド表に指定されたフォーマット・オプションと一致しない行をAutonomous Databaseのbadfile表に格納します。オーバーロード・フォームでは、operation_idパラメータを使用できます。

構文

DBMS_CLOUD.VALIDATE_HYBRID_PART_TABLE (
       table_name                 IN VARCHAR2,
       partition_name             IN CLOB DEFAULT,
       subpartition_name          IN CLOB DEFAULT,
       schema_name                IN VARCHAR2 DEFAULT,
       rowcount                   IN NUMBER DEFAULT,
       partition_key_validation   IN BOOLEAN DEFAULT,
       stop_on_error              IN BOOLEAN DEFAULT);


DBMS_CLOUD.VALIDATE_HYBRID_PART_TABLE (
       table_name                 IN VARCHAR2,
       operation_id               OUT NUMBER,
       partition_name             IN CLOB DEFAULT,
       subpartition_name          IN CLOB DEFAULT,
       schema_name                IN VARCHAR2 DEFAULT,
       rowcount                   IN NUMBER DEFAULT,
       partition_key_validation   IN BOOLEAN DEFAULT,
       stop_on_error              IN BOOLEAN DEFAULT);

パラメータ

パラメータ 説明

table_name

外部表の名前。

operation_id

このパラメータを使用して、USER_LOAD_OPERATIONSビューで、ロード操作の進行状況および最終ステータスを対応するIDとして追跡します。

partition_name

定義すると、特定のパーティションのみが検証されます。指定されていない場合は、rowcountに達するまで、すべての外部パーティションから順次読み取ります。

subpartition_name

定義すると、特定のサブパーティションのみが検証されます。指定しない場合は、rowcountに達するまで、すべての外部パーティションまたはサブパーティションから順に読み取ります。

schema_name

外部表が存在するスキーマの名前。デフォルト値はNULLで、外部表がプロシージャを実行しているユーザーと同じスキーマ内に存在することを意味します。

rowcount

スキャンされる行数。デフォルト値はNULLで、ソース・ファイル内のすべての行がスキャンされることを意味します。

partition_key_validation

内部使用のみこのパラメータは使用しないでください。

stop_on_error

行が拒否されたときに検証を停止するかどうかを決定します。デフォルト値はTRUEで、最初に拒否された行で検証を停止することを意味します。値をFALSEに設定すると、最初に拒否された行で検証を停止せず、rowcountパラメータに指定された値までのすべての行を検証することを指定します。

DBMS_CLOUD: 一括ファイル管理

DBMS_CLOUDパッケージ内のバルク・ファイル操作用のサブプログラム。

サブプログラム 説明
BULK_COPYプロシージャ

このプロシージャは、あるクラウド・オブジェクト・ストレージ・バケットから別のクラウド・オブジェクト・ストレージ・バケットにファイルをコピーします。

BULK_DELETEプロシージャ

このプロシージャは、クラウド・オブジェクト・ストレージのバケットまたはフォルダからファイルを削除します。

BULK_DOWNLOADプロシージャ

このプロシージャは、クラウド・オブジェクト・ストア・バケットからAutonomous Databaseのディレクトリにファイルをダウンロードします。

BULK_MOVEプロシージャ

このプロシージャは、あるクラウド・オブジェクト・ストレージ・バケットから別のクラウド・オブジェクト・ストレージ・バケットにファイルを移動します。

BULK_UPLOADプロシージャ

このプロシージャは、Autonomous Databaseのディレクトリからクラウド・オブジェクト・ストレージにファイルをアップロードします。

BULK_COPYプロシージャ

このプロシージャは、あるクラウド・オブジェクト・ストレージ・バケットから別のクラウド・オブジェクト・ストレージ・バケットにファイルを一括コピーします。オーバーロード・フォームでは、operation_idパラメータを使用できます。

削除するファイルのリストをフィルタするには、REGEXP_LIKE演算子と互換性のある正規表現パターンを使用します。

ソース・バケットまたはターゲット・フォルダは、同じクラウド・オブジェクト・ストア・プロバイダまたは異なるクラウド・オブジェクト・ストア・プロバイダに配置できます。

ソースとターゲットが個別のオブジェクト・ストアにある場合、または同じクラウド・プロバイダを持つ異なるアカウントがある場合、ソースとターゲットの場所に個別の資格証明名を指定できます。

デフォルトでは、ソース資格証明名はターゲットの場所でも使用されます。

構文

DBMS_CLOUD.BULK_COPY (
      source_credential_name  IN  VARCHAR2 DEFAULT NULL,
      source_location_uri     IN  VARCHAR2,
      target_location_uri     IN  VARCHAR2,
      target_credential_name  IN  VARCHAR2 DEFAULT NULL,
      regex_filter            IN  VARCHAR2 DEFAULT NULL,
      format                  IN  CLOB     DEFAULT NULL
);

DBMS_CLOUD.BULK_COPY (
      source_credential_name  IN  VARCHAR2 DEFAULT NULL,
      source_location_uri     IN  VARCHAR2,
      target_location_uri     IN  VARCHAR2,
      target_credential_name  IN  VARCHAR2 DEFAULT NULL,
      regex_filter            IN  VARCHAR2 DEFAULT NULL,
      format                  IN  CLOB     DEFAULT NULL,
      operation_id            OUT NUMBER
);

パラメータ

パラメータ 説明

source_credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

source_credential_name値を指定しない場合、credential_nameNULLに設定されます。

source_location_uri

ソース・オブジェクト・ストレージ・バケットまたはフォルダの場所を指すURIを指定します。

このパラメータは必須です。

URIのフォーマットは、クラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

target_location_uri

ファイルをコピーする必要があるターゲット・オブジェクト・ストレージ・バケットまたはフォルダのURIを指定します。

このパラメータは必須です。

URIのフォーマットは、クラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

target_credential_name

ターゲットのクラウドのオブジェクト・ストレージの場所にアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

target_credential_name値を指定しない場合、target_location_urisource_credential_name値に設定されます。

regex_filter

ファイルをフィルタするREGEX式を指定します。REGEX式パターンは、REGEXP_LIKE演算子と互換性がある必要があります。

regex_filter値を指定しない場合、regex_filterNULLに設定されます。

詳細は、REGEXP_LIKE条件を参照してください。

format

ファイル操作の追加構成オプションを指定します。これらのオプションはJSON文字列として指定されます。

サポートされている形式のオプションは次のとおりです。
  • logretention: バルク操作のためにステータス表が保持される期間(日数)を決定する整数値を受け入れます。

    デフォルト値は2日です。

  • logprefix: バルク操作ステータス表名の接頭辞文字列を決定する文字列値を受け入れます。

    操作タイプがデフォルト値です。BULK_COPYの場合、デフォルトのlogprefix値はCOPYOBJです。

  • priority: 同時に実行されるファイル操作の数を決定する文字列値を受け入れます。

    優先度が高い操作は、より多くのデータベース・リソースを消費するため、より高速に実行する必要があります。

    次のいずれかの値を受け入れます。

    • HIGH: データベースのECPU数を使用して処理されるパラレル・ファイルの数(データベースがOCPUを使用している場合はOCPU数)を決定します

    • MEDIUM: 中規模サービスの同時実行性制限を使用して、同時プロセスの数を決定します。デフォルト値は4です。

    • LOW: ファイルを順番に処理します。

    デフォルト値はMEDIUMです。

    同時ファイル操作の最大数は64に制限されています。

format値を指定しない場合、formatNULLに設定されます。

operation_id

このパラメータを使用して、USER_LOAD_OPERATIONSビューで、ロード操作の進行状況および最終ステータスを対応するIDとして追跡します。

使用上のノート

  • ソースとターゲットのURIが同じオブジェクト・ストレージ・バケットまたはフォルダを指している場合、エラーが返されます。

BEGIN 
DBMS_CLOUD.BULK_COPY (
     source_credential_name => 'OCI_CRED',
     source_location_uri    => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname1/o',
     target_location_uri    => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname2/o',
     format       => JSON_OBJECT ('logretention' value 7, 'logprefix' value 'BULKOP')
);
END;
/

BULK_DELETEプロシージャ

このプロシージャは、クラウド・オブジェクト・ストレージからファイルを一括削除します。オーバーロード・フォームでは、operation_idパラメータを使用できます。削除するファイルのリストをフィルタするには、REGEXP_LIKE演算子と互換性のある正規表現パターンを使用します。

構文

 DBMS_CLOUD.BULK_DELETE(
     credential_name  IN  VARCHAR2 DEFAULT NULL,
     location_uri     IN  VARCHAR2,
     regex_filter     IN  VARCHAR2 DEFAULT NULL,
     format           IN  CLOB     DEFAULT NULL
);

DBMS_CLOUD.BULK_DELETE (
     credential_name  IN  VARCHAR2 DEFAULT NULL,
     location_uri     IN  VARCHAR2,
     regex_filter     IN  VARCHAR2 DEFAULT NULL,
     format           IN  CLOB     DEFAULT NULL,
     operation_id     OUT NUMBER
);

パラメータ

パラメータ 説明

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

credential_name値を指定しない場合、credential_nameNULLに設定されます。

location_uri

Autonomous Database内のオブジェクト・ストレージの場所を指すURIを指定します。

このパラメータは必須です。

URIのフォーマットは、クラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

regex_filter

ファイルをフィルタするREGEX式を指定します。REGEX式パターンは、REGEXP_LIKE演算子と互換性がある必要があります。

regex_filter値を指定しない場合、regex_filterNULLに設定されます。

詳細は、REGEXP_LIKE条件を参照してください。

format

ファイル操作の追加構成オプションを指定します。これらのオプションはJSON文字列として指定されます。

サポートされている形式のオプションは次のとおりです。
  • logretention: 一括操作でステータス表が保持される期間(日数)を決定する整数値を受け入れます。

    デフォルト値は2日です。

  • logprefix: バルク操作ステータス表名の接頭辞文字列を決定する文字列値を受け入れます。

    操作タイプがデフォルト値です。BULK_DELETEの場合、デフォルトのlogprefix値はDELETEです。

  • priority: 同時に実行されるファイル操作の数を決定する文字列値を受け入れます。

    優先度が高い操作は、より多くのデータベース・リソースを消費し、より早く完了します。

    次のいずれかの値を受け入れます。

    • HIGH: データベースのECPU数を使用して処理されるパラレル・ファイルの数(データベースがOCPUを使用している場合はOCPU数)を決定します。

    • MEDIUM: 中規模サービスの同時実行性制限を使用して、同時プロセスの数を決定します。デフォルト値は4です。

    • LOW: ファイルを順番に処理します。

    デフォルト値はMEDIUMです。

    同時ファイル操作の最大数は64に制限されています。

format値を指定しない場合、formatNULLに設定されます。

operation_id

このパラメータを使用して、USER_LOAD_OPERATIONSビューで、ロード操作の進行状況および最終ステータスを対応するIDとして追跡します。

BEGIN
DBMS_CLOUD.BULK_DELETE (    
     credential_name => 'OCI_CRED',
     location_uri    => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o',
     format          => JSON_OBJECT ('logretention' value 5, 'logprefix' value 'BULKDEL')
);
END;
/

BULK_DOWNLOADプロシージャ

このプロシージャは、クラウド・オブジェクト・ストレージからAutonomous Databaseディレクトリにファイルをダウンロードします。オーバーロード・フォームでは、operation_idパラメータを使用できます。REGEXP_LIKE演算子と互換性のある正規表現パターンを使用して、ダウンロードするファイルのリストをフィルタできます。

構文

DBMS_CLOUD.BULK_DOWNLOAD (
     credential_name  IN  VARCHAR2 DEFAULT NULL,
     location_uri     IN  VARCHAR2,
     directory_name   IN  VARCHAR2,
     regex_filter     IN  VARCHAR2 DEFAULT NULL,
     format           IN  CLOB     DEFAULT NULL
);

DBMS_CLOUD.BULK_DOWNLOAD (
     credential_name  IN  VARCHAR2 DEFAULT NULL,
     location_uri     IN  VARCHAR2,
     directory_name   IN  VARCHAR2,
     regex_filter     IN  VARCHAR2 DEFAULT NULL,
     format           IN  CLOB     DEFAULT NULL,
     operation_id     OUT NUMBER
);

パラメータ

パラメータ 説明

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

credential_name値を指定しない場合、credential_nameNULLに設定されます。

location_uri

Autonomous Database内のオブジェクト・ストレージの場所を指すURIを指定します。

このパラメータは必須です。

URIのフォーマットは、クラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

directory_name

ファイルのダウンロード元となるAutonomous Database上のディレクトリの名前。

このパラメータは必須です。

regex_filter

ファイルをフィルタするREGEX式を指定します。REGEX式パターンは、REGEXP_LIKE演算子と互換性がある必要があります。

regex_filter値を指定しない場合、regex_filterNULLに設定されます。

詳細は、REGEXP_LIKE条件を参照してください。

format

ファイル操作の追加構成オプションを指定します。これらのオプションはJSON文字列として指定されます。

サポートされている形式のオプションは次のとおりです。
  • logretention: バルク操作のためにステータス表が保持される期間(日数)を決定する整数値を受け入れます。

    デフォルト値は2日です。

  • logprefix: バルク操作ステータス表名の接頭辞文字列を決定する文字列値を受け入れます。BULK_DOWNLOADの場合、デフォルトのlogprefix値はDOWNLOADです。

    操作タイプがデフォルト値です。

  • priority: 同時に実行されるファイル操作の数を決定する文字列値を受け入れます。

    優先度が高い操作は、より多くのデータベース・リソースを消費し、より早く完了します。

    次のいずれかの値を受け入れます。

    • HIGH: データベースのECPU数を使用して処理されるパラレル・ファイルの数(データベースがOCPUを使用している場合はOCPU数)を決定します。

    • MEDIUM: 中規模サービスの同時実行性制限を使用して、同時プロセスの数を決定します。デフォルト値は4です。

    • LOW: ファイルを順番に処理します。

    デフォルト値はMEDIUMです。

    同時ファイル操作の最大数は64に制限されています。

format値を指定しない場合、formatNULLに設定されます。

operation_id

このパラメータを使用して、USER_LOAD_OPERATIONSビューで、ロード操作の進行状況および最終ステータスを対応するIDとして追跡します。

BEGIN
DBMS_CLOUD.BULK_DOWNLOAD (    
     credential_name => 'OCI_CRED',
     location_uri    => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o',
     directory_name  => 'BULK_TEST',
     format          => JSON_OBJECT ('logretention' value 7, 'logprefix' value 'BULKOP')
 );
END;
/

BULK_MOVEプロシージャ

このプロシージャは、クラウド・オブジェクト・ストレージのバケットまたはフォルダ間でファイルを一括移動します。オーバーロード・フォームでは、operation_idパラメータを使用できます。

削除するファイルのリストをフィルタするには、REGEXP_LIKE演算子と互換性のある正規表現パターンを使用します。

ソース・バケットまたはターゲット・フォルダは、同じクラウド・オブジェクト・ストア・プロバイダまたは異なるクラウド・オブジェクト・ストア・プロバイダに配置できます。

ソースとターゲットが個別のオブジェクト・ストアにある場合、または同じクラウド・プロバイダを持つ異なるアカウントがある場合、ソースとターゲットの場所に個別の資格証明名を指定できます。

ターゲット資格証明名が指定されていない場合、ソース資格証明名はターゲットの場所でもデフォルトで使用されます。

ファイルを移動する最初のステップは、ファイルをターゲットの場所にコピーしてから、正常にコピーされたソース・ファイルを削除することです。

オブジェクト・ストアでソースとターゲットの場所間の名前変更操作が許可されている場合、オブジェクトの名前は移動されずに変更されます。

構文

DBMS_CLOUD.BULK_MOVE (
      source_credential_name  IN  VARCHAR2 DEFAULT NULL,
      source_location_uri     IN  VARCHAR2,
      target_location_uri     IN  VARCHAR2,
      target_credential_name  IN  VARCHAR2 DEFAULT NULL,
      regex_filter            IN  VARCHAR2 DEFAULT NULL,
      format                  IN  CLOB     DEFAULT NULL
);

DBMS_CLOUD.BULK_MOVE (
      source_credential_name  IN  VARCHAR2 DEFAULT NULL,
      source_location_uri     IN  VARCHAR2,
      target_location_uri     IN  VARCHAR2,
      target_credential_name  IN  VARCHAR2 DEFAULT NULL,
      regex_filter            IN  VARCHAR2 DEFAULT NULL,
      format                  IN  CLOB     DEFAULT NULL,
      operation_id            OUT NUMBER
);

パラメータ

パラメータ 説明

source_credential_name

ソースのCloud Object Storageにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

source_credential_name値を指定しない場合、credential_nameNULLに設定されます。

source_location_uri

ソース・オブジェクト・ストレージ・バケットまたはフォルダの場所を指すURIを指定します。

このパラメータは必須です。

URIのフォーマットは、クラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

target_location_uri

ファイルの移動が必要なターゲット・オブジェクト・ストレージ・バケットまたはフォルダのURIを指定します。

このパラメータは必須です。

URIのフォーマットは、クラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

target_credential_name

ターゲットのクラウドのオブジェクト・ストレージの場所にアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

target_credential_name値を指定しない場合、target_location_urisource_credential_name値に設定されます。

regex_filter

ファイルをフィルタするREGEX式を指定します。REGEX式パターンは、REGEXP_LIKE演算子と互換性がある必要があります。

regex_filter値を指定しない場合、regex_filterNULLに設定されます。

詳細は、REGEXP_LIKE条件を参照してください。

format

ファイル操作の追加構成オプションを指定します。これらのオプションはJSON文字列として指定されます。

サポートされている形式のオプションは次のとおりです。
  • logretention: バルク操作のためにステータス表が保持される期間(日数)を決定する整数値を受け入れます。

    デフォルト値は2日です。

  • logprefix: バルク操作ステータス表名の接頭辞文字列を決定する文字列値を受け入れます。

    操作タイプがデフォルト値です。BULK_MOVEの場合、デフォルトのlogprefix値はMOVEです。

  • priority: 同時に実行されるファイル操作の数を決定する文字列値を受け入れます。

    優先度が高い操作は、より多くのデータベース・リソースを消費し、より早く完了します。

    次のいずれかの値を受け入れます。

    • HIGH: データベースのECPU数を使用して処理されるパラレル・ファイルの数(データベースがOCPUを使用している場合はOCPU数)を決定します。

    • MEDIUM: 中規模サービスの同時実行性制限を使用して、同時プロセスの数を決定します。デフォルト値は4です。

    • LOW: ファイルを順番に処理します。

    デフォルト値はMEDIUMです。

    同時ファイル操作の最大数は64に制限されています。

format値を指定しない場合、formatNULLに設定されます。

operation_id

このパラメータを使用して、USER_LOAD_OPERATIONSビューで、ロード操作の進行状況および最終ステータスを対応するIDとして追跡します。

BEGIN 
DBMS_CLOUD.BULK_MOVE (    
     source_credential_name => 'OCI_CRED',
     source_location_uri    => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname1/o',
     target_location_uri    => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname2/o',
     format                 => JSON_OBJECT ('logretention' value 7, 'logprefix' value 'BULKMOVE')
);
END;
/
ノート

ソースおよびターゲットのURIが同じオブジェクト・ストレージ・バケットまたはフォルダを指している場合、エラーが返されます。

BULK_UPLOADプロシージャ

このプロシージャは、Autonomous Databaseディレクトリからクラウド・オブジェクト・ストレージにファイルをコピーします。オーバーロード・フォームでは、operation_idパラメータを使用できます。

構文

DBMS_CLOUD.BULK_UPLOAD (
     credential_name  IN  VARCHAR2 DEFAULT NULL,
     location_uri     IN  VARCHAR2,
     directory_name   IN  VARCHAR2,
     regex_filter     IN  VARCHAR2 DEFAULT NULL,
     format           IN  CLOB     DEFAULT NULL
);

DBMS_CLOUD.BULK_UPLOAD (
     credential_name  IN  VARCHAR2 DEFAULT NULL,
     location_uri     IN  VARCHAR2,
     directory_name   IN  VARCHAR2,
     regex_filter     IN  VARCHAR2 DEFAULT NULL,
     format           IN  CLOB     DEFAULT NULL,
     operation_id     OUT NUMBER
);

パラメータ

パラメータ 説明

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

credential_name値を指定しない場合、credential_nameNULLに設定されます。

location_uri

ファイルをアップロードするオブジェクト・ストレージの場所を指すURIを指定します。

このパラメータは必須です。

URIのフォーマットは、クラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

directory_name

ファイルをアップロードするAutonomous Database上のディレクトリの名前。

このパラメータは必須です。

regex_filter

ファイルをフィルタするREGEX式を指定します。REGEX式パターンは、REGEXP_LIKE演算子と互換性がある必要があります。

regex_filter値を指定しない場合、regex_filterNULLに設定されます。

詳細は、REGEXP_LIKE条件を参照してください。

format

ファイル操作の追加構成オプションを指定します。これらのオプションはJSON文字列として指定されます。

サポートされている形式のオプションは次のとおりです。
  • logretention: バルク操作のためにステータス表が保持される期間(日数)を決定する整数値を受け入れます。

    デフォルト値は2日です。

  • logprefix: バルク操作ステータス表名の接頭辞文字列を決定する文字列値を受け入れます。

    操作タイプがデフォルト値です。BULK_UPLOADの場合、デフォルトのlogprefix値はUPLOADです。

  • priority: 同時に実行されるファイル操作の数を決定する文字列値を受け入れます。

    優先度が高い操作は、より多くのデータベース・リソースを消費し、より早く完了します。

    次のいずれかの値を受け入れます。

    • HIGH: データベースのECPU数を使用して処理されるパラレル・ファイルの数(データベースがOCPUを使用している場合はOCPU数)を決定します。

    • MEDIUM: 中規模サービスの同時実行性制限を使用して、同時プロセスの数を決定します。デフォルト値は4です。

    • LOW: ファイルを順番に処理します。

    デフォルト値はMEDIUMです。

    同時ファイル操作の最大数は64に制限されています。

format値を指定しない場合、formatNULLに設定されます。

operation_id

このパラメータを使用して、USER_LOAD_OPERATIONSビューで、ロード操作の進行状況および最終ステータスを対応するIDとして追跡します。

BEGIN
DBMS_CLOUD.BULK_UPLOAD ( 
     credential_name => 'OCI_CRED',
     location_uri    => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o',
     directory_name  => 'BULK_TEST',
     format          => JSON_OBJECT ('logretention' value 5, 'logprefix' value 'BULKUPLOAD')
 );
END;
/

DBMS_CLOUD REST API

この項では、Autonomous Databaseで提供されるDBMS_CLOUD REST APIについて説明します。

REST API 説明

GET_RESPONSE_HEADERSファンクション

このファンクションは、Autonomous DatabaseでHTTPレスポンス・ヘッダーをJSONオブジェクト内のJSONデータとして返します。

GET_RESPONSE_RAWファンクション

このファンクションは、Autonomous DatabaseでHTTPレスポンスをRAW形式で返します。これは、HTTPレスポンスがバイナリ形式である必要がある場合に便利です。

GET_RESPONSE_STATUS_CODEファンクション

このファンクションは、Autonomous DatabaseでHTTPレスポンス・ステータス・コードを整数として戻します。ステータス・コードは、リクエストが成功したかどうかを識別するのに役立ちます。

GET_RESPONSE_TEXTファンクション

このファンクションは、Autonomous DatabaseでHTTPレスポンスをTEXT形式(VARCHAR2またはCLOB)で返します。通常、ほとんどのクラウドREST APIは、JSONレスポンスをテキスト形式で戻します。この関数は、HTTPレスポンスがテキスト形式であることが予想される場合に役立ちます。

GET_API_RESULT_CACHE_SIZEファンクション

このファンクションは、構成された結果キャッシュ・サイズを返します。

SEND_REQUESTファンクションおよびプロシージャ

このファンクションは、Autonomous DatabaseでHTTPリクエストを開始してレスポンスを取得し、レスポンスを終了します。このファンクションは、引数、戻りレスポンス・コードおよびペイロードを使用してクラウドREST APIリクエストを送信するためのワークフローを提供します。

SET_API_RESULT_CACHE_SIZEプロシージャ

このプロシージャは、現在のセッションの最大キャッシュ・サイズを設定します。

DBMS_CLOUD REST APIの概要

アプリケーションでPL/SQLを使用しているときに、クラウドREST APIをコールする必要があります。DBMS_CLOUD.SEND_REQUESTを使用してREST APIリクエストを送信できます。

DBMS_CLOUD REST APIファンクションを使用すると、DBMS_CLOUD.SEND_REQUESTを使用してHTTPリクエストを行い、結果を取得して保存できます。これらのファンクションは、サポートされている次のクラウド・サービスを使用して任意のREST APIをコールできる汎用APIを提供します:

DBMS_CLOUD REST APIの定数

DBMS_CLOUD.SEND_REQUESTを使用してHTTPリクエストを行うためのDBMS_CLOUD定数について説明します。

DBMS_CLOUDは、GETPUTPOSTHEADおよびDELETE HTTPメソッドをサポートしています。HTTPリクエストに使用されるREST APIメソッドは通常、クラウドREST APIドキュメントに記載されています。

名前 タイプ
METHOD_DELETE VARCHAR2(6) 'DELETE'
METHOD_GET VARCHAR2(3) 'GET'
METHOD_HEAD VARCHAR2(4) 'HEAD'
METHOD_POST VARCHAR2(4) 'POST'
METHOD_PUT VARCHAR2(3) 'PUT'

DBMS_CLOUD REST APIの結果キャッシュ

DBMS_CLOUD.SEND_REQUESTcacheパラメータをtrueに設定すると、DBMS_CLOUD REST APIの結果を保存できます。SESSION_CLOUD_API_RESULTSビューは、REST APIの結果の保存時に使用できる列を示します。

デフォルトでは、DBMS_CLOUD REST APIコールはセッションの結果を保存しません。この場合、DBMS_CLOUD.SEND_REQUESTファンクションを使用して結果を返します。

DBMS_CLOUD.SEND_REQUESTを使用してcacheパラメータをTRUEに設定すると、結果が保存され、SESSION_CLOUD_API_RESULTSビューで過去の結果を表示できます。DBMS_CLOUD REST APIリクエストの履歴結果の保存および問合せは、アプリケーションで以前の結果を操作する必要がある場合に役立ちます。

たとえば、最近のDBMS_CLOUD REST APIの結果を問い合せるには、SESSION_CLOUD_API_RESULTSビューを使用します:

SELECT timestamp FROM SESSION_CLOUD_API_RESULTS;

DBMS_CLOUD REST APIをDBMS_CLOUD.SEND_REQUESTで保存すると、保存されたデータは同じセッション(接続)でのみ使用可能です。セッションが終了すると、保存されたデータは使用できなくなります。

DBMS_CLOUD.GET_API_RESULT_CACHE_SIZEおよびDBMS_CLOUD.SET_API_RESULT_CACHE_SIZEを使用して、DBMS_CLOUD REST APIキャッシュ・サイズを表示および設定し、キャッシュを無効にします。

DBMS_CLOUD REST APIの結果のcache_scopeパラメータ

DBMS_CLOUD.SEND_REQUESTを使用してDBMS_CLOUD REST APIの結果を保存すると、cache_scopeの値に基づいてSESSION_CLOUD_API_RESULTSの結果へのアクセスが提供されます。

デフォルトでは、cache_scope'PRIVATE'であり、セッションの現在のユーザーのみが結果にアクセスできます。cache_scope'PUBLIC'に設定すると、すべてのセッション・ユーザーが結果にアクセスできます。cache_scopeのデフォルト値の指定では、各ユーザーは、実行者権限で起動するプロシージャによって生成されたDBMS_CLOUD.SEND_REQUEST REST APIの結果のみを表示できます。セッションでDBMS_CLOUD.SEND_REQUESTを起動する場合、cache_scopeの値に基づいて、現在のユーザーがキャッシュ内の結果を表示できるかどうかを決定する3つの可能性があります:

  • DBMS_CLOUD.SEND_REQUESTを最上位レベルの文として直接実行し、DBMS_CLOUD.SEND_REQUESTをコールすると、REST APIの結果は同じユーザー名で保存されます。この場合、cache_scopeに設定されたデフォルト値PRIVATE'を持つすべての結果にアクセスできます。

  • あなたはラッパー実行者権限プロシージャを記述し、現在のユーザーとしてDBMS_CLOUD.SEND_REQUESTによるコールでプロシージャをコールすると、REST APIの結果は同じユーザー名で保存されます。この場合、デフォルト値のPRIVATE'cache_scopeに設定されているすべての結果にアクセスできます。

  • ユーザーがラッパー定義者権限プロシージャを記述し、そのプロシージャを別のユーザーが所有します。プロシージャ内でDBMS_CLOUD.SEND_REQUESTをコールすると、結果はプロシージャ所有者のユーザー名で保存されます。

    この場合、別の定義者権限ユーザーがDBMS_CLOUD.SEND_REQUESTを起動すると、REST APIの結果はその定義者プロシージャの所有者を使用して保存されます。この場合、デフォルトでcache_scopePRIVATE'の場合、実行者のセッションでは結果を表示できません。

    定義者プロシージャの所有者が、起動しているセッション・ユーザーに結果を使用できるようにする場合は、DBMS_CLOUD.SEND_REQUESTcache_scope'PUBLIC'に設定する必要があります。

DBMS_CLOUD REST API SESSION_CLOUD_API_RESULTSビュー

DBMS_CLOUD.SEND_REQUESTcacheパラメータをtrueに設定すると、DBMS_CLOUD REST APIの結果を保存できます。SESSION_CLOUD_API_RESULTSビューは、REST APIの結果の保存時に使用できる列を示します。

SESSION_CLOUD_API_RESULTSビューは、DBMS_CLOUD.SEND_REQUESTを使用して結果をキャッシュする場合に作成されるビューです。ユーザー・セッションに属する履歴結果を問い合せることができます。セッションが終了すると、SESSION_CLOUD_API_RESULTSのデータはパージされます。

説明
URI DBMS_CLOUD REST APIリクエストURL
TIMESTAMP DBMS_CLOUD REST APIレスポンス・タイムスタンプ
CLOUD_TYPE Oracle Cloud Infrastructure、AMAZON_S3、AZURE_BLOBなどのDBMS_CLOUD REST APIクラウド・タイプ
REQUEST_METHOD DBMS_CLOUD REST APIリクエスト・メソッド(GETPUTHEADなど)
REQUEST_HEADERS DBMS_CLOUD REST APIリクエスト・ヘッダー
REQUEST_BODY_TEXT DBMS_CLOUD REST APIリクエスト本文(CLOB)
RESPONSE_STATUS_CODE DBMS_CLOUD REST APIレスポンス・ステータス・コード(200(OK)404(Not Found)など)
RESPONSE_HEADERS DBMS_CLOUD REST APIレスポンス・ヘッダー
RESPONSE_BODY_TEXT CLOBDBMS_CLOUD REST APIレスポンス本文
SCOPE

DBMS_CLOUD.SEND_REQUESTによって設定されたcache_scope。有効な値は PUBLICまたは PRIVATEです。

GET_RESPONSE_HEADERSファンクション

このファンクションは、HTTPレスポンス・ヘッダーをJSONオブジェクト内のJSONデータとして返します。

構文

DBMS_CLOUD.GET_RESPONSE_HEADERS(
       resp          IN DBMS_CLOUD_TYPES.resp)
   RETURN JSON_OBJECT_T;

パラメータ

パラメータ 説明
resp

DBMS_CLOUD.SEND_REQUESTから戻されるHTTPレスポンス・タイプ。

例外

例外 エラー 説明
invalid_response ORA-20025

無効なレスポンス・タイプ・オブジェクトがDBMS_CLOUD.GET_RESPONSE_HEADERSに渡されました。

GET_RESPONSE_RAWファンクション

このファンクションは、HTTPレスポンスをRAW形式で返します。これは、HTTPレスポンスがバイナリ形式である必要がある場合に便利です。

構文

DBMS_CLOUD.GET_RESPONSE_RAW(
       resp          IN DBMS_CLOUD_TYPES.resp)
   RETURN BLOB;

パラメータ

パラメータ 説明
resp

DBMS_CLOUD.SEND_REQUESTから戻されるHTTPレスポンス・タイプ。

例外

例外 エラー 説明
invalid_response ORA-20025

無効なレスポンス・タイプ・オブジェクトがDBMS_CLOUD.GET_RESPONSE_RAWに渡されました。

GET_RESPONSE_STATUS_CODEファンクション

このファンクションは、HTTPレスポンス・ステータス・コードを整数として戻します。ステータス・コードは、リクエストが成功したかどうかを識別するのに役立ちます。

構文

DBMS_CLOUD.GET_RESPONSE_STATUS_CODE(
       resp          IN DBMS_CLOUD_TYPES.resp)
   RETURN PLS_INTEGER;

パラメータ

パラメータ 説明
resp

DBMS_CLOUD.SEND_REQUESTから戻されるHTTPレスポンス・タイプ。

例外

例外 エラー 説明
invalid_response ORA-20025

無効なレスポンス・タイプ・オブジェクトがDBMS_CLOUD.GET_RESPONSE_STATUS_CODEに渡されました。

GET_RESPONSE_TEXTファンクション

このファンクションは、HTTPレスポンスをTEXT形式(VARCHAR2またはCLOB)で戻します。通常、ほとんどのクラウドREST APIは、JSONレスポンスをテキスト形式で戻します。この関数は、HTTPレスポンスがテキスト形式であることが予想される場合に役立ちます。

構文

DBMS_CLOUD.GET_RESPONSE_TEXT(
       resp          IN DBMS_CLOUD_TYPES.resp)
   RETURN CLOB;

パラメータ

パラメータ 説明
resp

DBMS_CLOUD.SEND_REQUESTから戻されるHTTPレスポンス・タイプ。

例外

例外 エラー 説明
invalid_response ORA-20025

無効なレスポンス・タイプ・オブジェクトがDBMS_CLOUD.GET_RESPONSE_TEXTに渡されました。

GET_API_RESULT_CACHE_SIZEファンクション

このファンクションは、構成された結果キャッシュ・サイズを返します。キャッシュ・サイズの値は、現在のセッションにのみ適用されます。

構文

DBMS_CLOUD.GET_API_RESULT_CACHE_SIZE()
   RETURN NUMBER;

SEND_REQUESTファンクションおよびプロシージャ

このファンクションおよびプロシージャは、HTTPリクエストの開始、レスポンスの取得およびレスポンスの終了を行います。このファンクションは、引数を使用してクラウドREST APIリクエストを送信するワークフローを提供します。ファンクションは、レスポンス・コードおよびペイロードを返します。このプロシージャを使用する場合は、SESSION_CLOUD_API_RESULTSビューに保存された結果から結果およびレスポンスの詳細を表示できます。

構文

DBMS_CLOUD.SEND_REQUEST(
       credential_name    IN VARCHAR2,
       uri                IN VARCHAR2,
       method             IN VARCHAR2,
       headers            IN CLOB DEFAULT NULL,
       async_request_url  IN VARCHAR2 DEFAULT NULL,
       wait_for_states    IN DBMS_CLOUD_TYPES.wait_for_states_t DEFAULT NULL,
       timeout            IN NUMBER DEFAULT 0,
       cache              IN PL/SQL BOOLEAN DEFAULT FALSE,
       cache_scope        IN VARCHAR2 DEFAULT 'PRIVATE',
       body               IN BLOB DEFAULT NULL)
   RETURN DBMS_CLOUD_TYPES.resp;

DBMS_CLOUD.SEND_REQUEST(
       credential_name    IN VARCHAR2,
       uri                IN VARCHAR2,
       method             IN VARCHAR2,
       headers            IN CLOB DEFAULT NULL,
       async_request_url  IN VARCHAR2 DEFAULT NULL,
       wait_for_states    IN DBMS_CLOUD_TYPES.wait_for_states_t DEFAULT NULL,
       timeout            IN NUMBER DEFAULT 0,
       cache              IN PL/SQL BOOLEAN DEFAULT FALSE,
       cache_scope        IN VARCHAR2 DEFAULT 'PRIVATE',
       body               IN BLOB DEFAULT NULL);

パラメータ

パラメータ 説明

credential_name

対応するクラウド・ネイティブAPIで認証するための資格証明の名前。

リソース・プリンシパルが有効な場合は、'OCI$RESOURCE_PRINCIPAL'credential_nameとして使用できます。詳細は、ENABLE_RESOURCE_PRINCIPALを参照してください。

uri

リクエストを作成するためのHTTP URI。

method

HTTPリクエスト・メソッド: GETPUTPOSTHEADおよびDELETEDBMS_CLOUDパッケージ定数を使用して、メソッドを指定します。

詳細は、DBMS_CLOUD REST APIの定数を参照してください。

headers

JSON形式の対応するクラウド・ネイティブAPIのHTTPリクエスト・ヘッダー。認証ヘッダーは自動的に設定され、カスタム・ヘッダーのみを渡します。

async_request_url

非同期リクエストURL。

URLを取得するには、APIのリストからリクエストAPIを選択します(https://docs.cloud.oracle.com/en-us/iaas/api/を参照)。次に、左ペインでリクエストのAPIにナビゲートします。たとえば、「データベース・サービスAPI」→「Autonomous Database」→「StopAutonomousDatabase」です。このページには、APIホームが表示されます(ベース・エンドポイントも表示されます)。次に、作業リクエストのWorkRequestリンク用に取得した相対パスを使用してベース・エンドポイントを追加します。

wait_for_states

待機状態は次のタイプのステータスです: DBMS_CLOUD_TYPES.wait_for_states_t。予想される状態の有効な値は次のとおりです: 'ACTIVE'、'CANCELED'、'COMPLETED'、'DELETED'、'FAILED'、'SUCCEEDED'。

wait_for_statesには、複数の状態を指定できます。wait_for_statesのデフォルト値は、予想される状態のいずれかを待機することです: 'ACTIVE'、'CANCELED'、'COMPLETED'、'DELETED'、'FAILED'、'SUCCEEDED'。

timeout

パラメータasync_request_urlおよびwait_for_statesを使用した非同期リクエストのタイムアウトを秒単位で指定します。

デフォルト値は0です。これは、タイムアウトなしでリクエストの完了を待つことを示します。

cache

TRUEの場合、リクエストはREST結果のAPIキャッシュにキャッシュされます。

デフォルト値はFALSEであり、REST APIリクエストはキャッシュされないことを意味します。

cache_scope

すべてのユーザーがこのリクエスト結果のキャッシュにアクセスできるかどうかを指定します。有効な値: "PRIVATE"および"PUBLIC"。デフォルト値は"PRIVATE"です。

body

PUTおよびPOSTリクエストのHTTPリクエスト本文。

例外

例外 エラー 説明
invalid_req_method ORA-20023

DBMS_CLOUD.SEND_REQUESTに渡されたリクエスト・メソッドが無効です。

invalid_req_header ORA-20024

Request headers passed to DBMS_CLOUD.SEND_REQUEST are not in valid JSON format.

使用上のノート

  • Oracle Cloud Infrastructureを使用している場合は、credential_nameに署名キー・ベースの資格証明値を使用する必要があります。詳細は、CREATE_CREDENTIALプロシージャを参照してください。

  • オプションのパラメータasync_request_urlwait_for_statesおよびtimeoutを使用すると、長時間実行リクエストを処理できます。この非同期形式のsend_requestを使用すると、ファンクションはwait_for_statesで指定された完了ステータスを待機してから返されます。送信リクエストでこれらのパラメータを使用して、予期される戻り状態をwait_for_statesパラメータで渡し、async_request_urlパラメータを使用して関連する作業リクエストを指定すると、リクエストはすぐに戻りません。かわりに、リクエストは、戻り状態が予想される状態のいずれかになるか、timeoutを超える(timeoutはオプション)まで、async_request_urlを調査します。timeoutが指定されていない場合、リクエストは、wait_for_statesで検出された状態が発生するまで待機します。

SET_API_RESULT_CACHE_SIZEプロシージャ

このプロシージャは、現在のセッションの最大キャッシュ・サイズを設定します。キャッシュ・サイズの値は、現在のセッションにのみ適用されます。

構文

DBMS_CLOUD.SET_API_RESULT_CACHE_SIZE(
       cache_size          IN NUMBER);

パラメータ

パラメータ 説明
cache_size

指定した値cache_sizeに最大キャッシュ・サイズを設定します。新しい最大キャッシュ・サイズが現在のキャッシュ・サイズより小さい場合、行数が指定の最大キャッシュ・サイズと等しくなるまで古いレコードが削除されます。最大値は10000です。

キャッシュ・サイズが0に設定されている場合、キャッシュはセッションで無効になります。

デフォルトのキャッシュ・サイズは10です。

例外

例外 エラー 説明
invalid API result cache size ORA-20032

最小値は0、最大値は10000です。この例外は、入力パラメータが0より小さいか10000より大きい場合に表示されます。

EXEC DBMS_CLOUD.SET_API_RESULT_CACHE_SIZE(101);

DBMS_CLOUD REST APIの例

DBMS_CLOUD.SEND_REQUESTを使用してOracle Cloud Infrastructure Object Storageバケットを作成および削除する例と、テナンシ内のすべてのコンパートメントをリストする例を示します。

ノート

次の例では、Oracle Cloud InfrastructureリクエストAPIを示しており、credential_nameに対して署名キー・ベースの資格証明を使用する必要があります。Oracle Cloud Infrastructureの署名キー・ベースの資格証明には、private_keyおよびfingerprint引数が含まれます。

たとえば:

BEGIN
   DBMS_CLOUD.CREATE_CREDENTIAL (
       credential_name => ‘OCI_KEY_CRED’,
       user_ocid       => ‘ocid1.user.oc1..aaaaaaaauq54mi7zdyfhw33ozkwuontjceel7fok5nq3bf2vwetkpqsoa’,
       tenancy_ocid    => ‘ocid1.tenancy.oc1..aabbbbbbaafcue47pqmrf4vigneebgbcmmoy5r7xvoypicjqqge32ewnrcyx2a’,
       private_key     => ‘MIIEogIBAAKCAQEAtUnxbmrekwgVac6FdWeRzoXvIpA9+0r1.....wtnNpESQQQ0QLGPD8NM//JEBg=’,
       fingerprint     => ‘f2:db:f9:18:a4:aa:fc:94:f4:f6:6c:39:96:16:aa:27’);
END;
/
DBMS_CLOUD.CREATE_CREDENTIALの詳細は、CREATE_CREDENTIALプロシージャを参照してください。

バケットの作成の例

DBMS_CLOUD.SEND_REQUESTとHTTP POSTメソッドを使用して、bucketnameという名前のオブジェクト・ストア・バケットを作成する例を示します。

この例のOracle Cloud Infrastructure Object Storage Service APIの詳細は、CreateBucketを参照してください。

SET SERVEROUTPUT ON
DECLARE
  resp DBMS_CLOUD_TYPES.resp;
BEGIN
  -- Send request
  resp := DBMS_CLOUD.send_request(
            credential_name => 'OCI_KEY_CRED',
            uri => 'https://objectstorage.region.oraclecloud.com/n/namespace-string/b/',
            method => DBMS_CLOUD.METHOD_POST,
            body => UTL_RAW.cast_to_raw(
                        JSON_OBJECT('name' value 'bucketname',
                                    'compartmentId' value 'compartment_OCID'))
          );
 
  -- Response Body in TEXT format
  dbms_output.put_line('Body: ' || '------------' || CHR(10) ||
  DBMS_CLOUD.get_response_text(resp) || CHR(10));
  
  -- Response Headers in JSON format
  dbms_output.put_line('Headers: ' || CHR(10) || '------------' || CHR(10) ||
  DBMS_CLOUD.get_response_headers(resp).to_clob || CHR(10));
 
  -- Response Status Code
  dbms_output.put_line('Status Code: ' || CHR(10) || '------------' || CHR(10) ||
  DBMS_CLOUD.get_response_status_code(resp));
 
END;
/

ノート:

バケットの削除の例

bucketnameという名前のオブジェクト・ストア・バケットを削除するために、HTTP DELETEメソッドでDBMS_CLOUD.SEND_REQUESTを使用する例を示します。

この例のOracle Cloud Infrastructure Object Storage Service APIの詳細は、DeleteBucketを参照してください。

SET SERVEROUTPUT ON
DECLARE
  resp DBMS_CLOUD_TYPES.resp;
BEGIN
  -- Send request
  resp := DBMS_CLOUD.send_request(
            credential_name => 'OCI_KEY_CRED',
            uri => 'https://objectstorage.region.oraclecloud.com/n/namespace-string/b/bucketname',
            method => DBMS_CLOUD.METHOD_DELETE
          );
 
  -- Response Body in TEXT format
  dbms_output.put_line('Body: ' || '------------' || CHR(10) ||
  DBMS_CLOUD.get_response_text(resp) || CHR(10));
  
  -- Response Headers in JSON format
  dbms_output.put_line('Headers: ' || CHR(10) || '------------' || CHR(10) ||
  DBMS_CLOUD.get_response_headers(resp).to_clob || CHR(10));
 
  -- Response Status Code
  dbms_output.put_line('Status Code: ' || CHR(10) || '------------' || CHR(10) ||
  DBMS_CLOUD.get_response_status_code(resp));
 
END;
/

ノート:

コンパートメントのリストの例

HTTP GETメソッドでDBMS_CLOUD.SEND_REQUESTを使用して、テナント(ルート・コンパートメント)内のすべてのコンパートメントをリストする例を示します。この例では、DBMS_CLOUD.SEND_REQUESTでリクエスト・ヘッダーを渡す方法を示します。

この例のOracle Cloud Infrastructure Identity and Access Management Service APIの詳細は、ListCompartmentsを参照してください。

--
-- List compartments
--
DECLARE
  resp DBMS_CLOUD_TYPES.resp;
  root_compartment_ocid VARCHAR2(512) := '&1';
BEGIN
  -- Send request
  dbms_output.put_line('Send Request');
  resp := DBMS_CLOUD.send_request(
            credential_name => 'OCI_KEY_CRED',
            uri => 'https://identity.region.oraclecloud.com/20160918/compartments?compartmentId=' || root_compartment_ocid,
            method => DBMS_CLOUD.METHOD_GET,
            headers => JSON_OBJECT('opc-request-id' value 'list-compartments')
          );
  dbms_output.put_line('Body: ' || '------------' || CHR(10) || DBMS_CLOUD.get_response_text(resp) || CHR(10));
  dbms_output.put_line('Headers: ' || CHR(10) || '------------' || CHR(10) || DBMS_CLOUD.get_response_headers(resp).to_clob || CHR(10));
  dbms_output.put_line('Status Code: ' || CHR(10) || '------------' || CHR(10) || DBMS_CLOUD.get_response_status_code(resp));
  dbms_output.put_line(CHR(10));
END;
/

ここでは、regionはエンドポイント・リージョンです。詳細は、APIリファレンスおよびエンドポイントのIdentity and Access Management (IAM) APIリファレンスを参照してください。たとえば、regionuk-london-1です。

非同期リクエストの例

HTTP POSTメソッドでDBMS_CLOUD.SEND_REQUESTを使用してAutonomous Databaseの停止操作を実行し、ステータスを待機する例を示します。この例では、DBMS_CLOUD.SEND_REQUESTasync_request_urlwait_for_statesおよびtimeoutパラメータとともに使用する方法を示します。

--
-- Sent Work Request Autonomous Database Stop Request with Wait for Status
DECLARE
    l_resp DBMS_CLOUD_TYPES.resp;
    l_resp_json JSON_OBJECT_T;
    l_key_shape JSON_OBJECT_T;
    l_body JSON_OBJECT_T;
    status_array DBMS_CLOUD_TYPES.wait_for_states_t;
BEGIN
  status_array := DBMS_CLOUD_TYPES.wait_for_states_t('SUCCEEDED');
  l_body := JSON_OBJECT_T('{}');
  l_body.put('autonomousDatabaseId', 'ocid');
-- Send request
  dbms_output.put_line(l_body.to_clob);
  dbms_output.put_line('Send Request');
  l_resp := DBMS_CLOUD.send_request(
                       credential_name    => 'NATIVE_CRED_OCI',
                       uri                => 'https://database.region.oraclecloud.com/20160918/autonomousDatabases/ocid/actions/stop',
                       method             => DBMS_CLOUD.METHOD_POST,
                       body               => UTL_RAW.cast_to_raw(l_body.to_clob),
                       async_request_url  => 'https://iaas.region.oraclecloud.com/20160918/workRequests',
                       wait_for_states    => status_array,
                       timeout            => 600
                  );
   dbms_output.put_line('resp body: '||DBMS_CLOUD.get_response_text(l_resp));
   dbms_output.put_line('resp headers: '||DBMS_CLOUD.get_response_headers(l_resp).to_clob);
END;
/

ここでは、regionはエンドポイント・リージョンです。詳細は、APIリファレンスおよびエンドポイントのIdentity and Access Management (IAM) APIリファレンスを参照してください。たとえば、regionuk-london-1です。

ocidは、Oracle Cloud Infrastructureリソース識別子です。詳細は、リソース識別子を参照してください。



脚注の説明

脚注3: Azure Cloud REST APIコールのサポートは、ドメインblob.windows.netに制限されます。