外部プロシージャをSQL関数として起動

外部プロシージャは、第3世代言語で記述されたファンクションであり、PL/SQLルーチンまたはファンクションと同様に、PL/SQLまたはSQL内からコールできます。

ユーザー定義関数を使用して、Autonomous Databaseで外部プロシージャを起動および使用できます。

これらのプロトタイプのいずれかを使用してCプロシージャを定義します。

共有オブジェクト(.soファイル)ライブラリを作成します。共有オブジェクト・ライブラリには、前のステップで定義したCプロシージャ(外部プロシージャ)が含まれています。

gcc -I/u01/app/oracle/extproc_libs/ -shared -fPIC -o extproc.so UpdateSalary.c

OCI Marketplace EXTPROCスタック・アプリケーションを取得するステップを示します。

1. OCIコンソール(http://cloud.oracle.com)にサインインします。詳細は、Oracle Cloud Infrastructure Consoleへのサインインを参照してください。
2. Oracle Cloud Infrastructureの左側のナビゲーション・メニューから「マーケットプレイス」をクリックし、「マーケットプレイス」で「すべてのアプリケーション」をクリックします。これにより、「Marketplace All Applications」ダッシュボードに移動します。
3. 検索フィールドにEXTPROCと入力し、「検索」をクリックします。
4. 「タイプ: スタック」のEXTPROCウィジェットをクリックします。
   
   

   
   図adbs_extproc_application.pngの説明

   
   

EXTPROCアプリケーションの詳細ページから、EXTPROCスタック・アプリケーションを起動します。

1. Oracle Autonomous DatabaseのEXTPROCエージェント・ページの「タイプ・スタック」で、次を実行します:

   • 「バージョン」ドロップダウン・リストから、スタックのパッケージのバージョンを選択します。デフォルトでは、メニューには最新バージョンが表示されます。

   • 「コンパートメント」ドロップダウン・リストから、インスタンスを起動するコンパートメントの名前を選択します。

     ノート
     
     選択したコンパートメントでインスタンスを起動する権限がない場合、インスタンスはルート・コンパートメントで起動されます。

   • 「Oracle標準条件および制約事項を確認してこれに同意します」チェック・ボックスを選択します。

2. 「スタックの起動」をクリックします。
   
   

   
   図adb_launch_stack.pngの説明

   
   

EXTPROCインスタンスのスタックを作成するステップを示します。

1. 「スタック情報」ページで、必要に応じて次の情報を確認および編集します:

   • スタック情報

   • カスタム・プロバイダ

   • 名前(オプション): デフォルトのスタック名を編集できます。機密情報を入力しないでください。

   • 説明(オプション): デフォルトのスタックの説明を編集できます。機密情報を入力しないでください。

   • コンパートメントに作成

   • Terraformのバージョン

   • タグ: スタックにタグを割り当てるには、次を指定します。

     • タグ・ネームスペース: 定義済タグを追加するには、既存のネームスペースを選択します。フリーフォーム・タグを追加するには、値を空白のままにします。

     • タグ・キー: 定義済タグを追加するには、既存のタグ・キーを選択します。フリーフォームタグを追加するには、目的のキー名を入力します。

     • タグ値: 必要なタグ値を入力します。

     タグの追加: 別のタグを追加する場合にクリックします。

     タグ付けの詳細は、リソース・タグを参照してください。

   
   

   
   図adbs_extproc_createstack_updated.pngの説明

   
   
2. 「次へ」をクリックします。
   これにより、「変数の構成」ページに移動し、この実行計画の適用ジョブの実行時にスタックが作成するインフラストラクチャ・リソースの変数を構成できます。
3. 「変数の構成」ページで、「EXTPROCエージェントの構成」、「ネットワーク構成」および「コンピュート構成」の領域の情報を入力します。
   1. 「EXTPROCエージェントの構成」領域に情報を指定します。

      • 外部ライブラリ: Autonomous Databaseから起動できるようにするライブラリのリストをカンマ(、)で区切って指定します。たとえば、extproc.so、extproc1.soです。

        スタックを作成した後、ライブラリをEXTPROCエージェントVMの/u01/app/oracle/extproc_libsディレクトリにコピーする必要があります。

      • Wallet Password:ウォレット・パスワードを指定します。

        ウォレットと自己署名証明書は、Autonomous DatabaseとEXTPROCエージェントVMの間の相互TLS認証用に生成されます。ウォレットは/u01/app/oracle/extproc_walletディレクトリに作成されます。

        ノート
        
        ウォレットの作成後は、ウォレット・パスワードを変更できません。

      
      

      
      図adbs_configure_var_extproc_agent.pngの説明

      
      
   2. 「ネットワーク構成」領域に情報を指定します。

      • コンパートメント: ドロップダウン・リストから、構成を配置するコンパートメントを選択します。

      • ネットワーク戦略: ドロップダウン・リストから、「新規VCNおよびサブネットの作成」または「既存のVCNおよびサブネットの使用」のいずれかのオプションを選択します。

        • 新規VCNおよびサブネットの作成: Autonomous Databaseにプライベート・エンドポイントが構成されていない場合は、このオプションを選択します。これにより、セキュリティ・ルールで事前構成されたパブリックおよびプライベート・サブネットを持つ新しいVCNが作成されます。

          このオプションを選択すると、「構成戦略」ドロップダウン・リストもページに表示されます。

          「構成戦略」ドロップダウン・リストから「推奨構成の使用」を選択します。

          
          

          
          図adb_extproc_network_config.pngの説明

          
          

        • 既存のVCNおよびサブネットの使用: 既存のVCNを使用してEXTPROCエージェントを作成するには、このオプションを選択します。これにより、指定されたサブネットにEXTPROCエージェント・インスタンスが作成されます。

          このオプションを選択する場合は、既存のVCNおよびサブネットに次の情報を指定します:

          • 「Virtual Cloud Network」で、次の手順を実行します。

            「既存のVCN」ドロップダウン・リストから、既存のVCNを選択します。指定されたVCNが存在しない場合は、新しいVCNが作成されます。

          • 「EXTPROCサブネット」で、次の手順を実行します。

            「既存のサブネット」ドロップダウン・リストから、既存のサブネットを選択します。

            既存のVCNおよびサブネットを使用する場合は、EXTPROCエージェント・インスタンスのポート16000のイングレス・ルールを追加します。また、パブリック・サブネットにエグレス・ルールを追加します。

            詳細は、プライベート・エンドポイントを使用したネットワーク・アクセスの構成を参照してください。

          
          

          
          図adbs_extproc_network_configuration_existing_vcn.pngの説明

          
          

      • EXTPROCエージェント・アクセス・タイプ: ドロップダウン・リストから次のいずれかのオプションを選択します。

        • VCN内の特定のADB-Sプライベート・エンドポイント・データベースからのセキュアなアクセス: Virtual Cloud Network (VCN)内の指定されたプライベート・エンドポイントIPのみがEXTPROCエージェントに接続できるようにするには、このオプションを選択します。

          このオプションを選択した場合、次のステップで許可されるプライベート・エンドポイントIPアドレスのリストを指定します。

        • VCN内のすべてのADB-Sプライベート・エンドポイント・データベースからのセキュアなアクセス: Virtual Cloud Network (VCN)内のプライベート・エンドポイントがEXTPROCエージェントに接続できるようにするには、このオプションを選択します。

      • プライベート・ エンドポイントIPアドレス

        プライベート・エンドポイントIPアドレス変数のプライベート・エンドポイントIPアドレスのリストをカンマ(、)で区切って指定します。たとえば、10.0.0.0、10.0.0.1です。

        ノート
        
        このフィールドは、「EXTPROCエージェント・アクセス・タイプ」に「VCN内の特定のADB-Sプライベート・エンドポイント・データベースからのセキュア・アクセス」を選択した場合にのみ表示されます。
   3. コンピュート構成情報を指定します。

      • コンパートメント: スタックを作成するコンパートメントを選択します。

      • シェイプ: EXTPROCエージェント・インスタンスのワークロード要件に基づいてシェイプを選択します。シェイプによって、EXTPROCエージェント・インスタンスに割り当てられるリソースが決まります。

      • OCPUの数: EXTPROCエージェント・インスタンスに割り当てるOCPU数を選択します。

      • メモリー・サイズ(GB): EXTPROCエージェント・インスタンスに割り当てるメモリー量(ギガバイト(GB)を選択します。

      • SSHキーの追加: SSH公開キーをアップロードするか、公開キーを貼り付けます。次のいずれかのオプションを選択します:

        • SSHキー・ファイルの場所の選択: キー・ペアの公開キー部分をアップロードします。アップロードするキー・ファイルを参照して選択するか、ボックスにファイルをドラッグ・アンド・ドロップします。

        • SSHキーの貼付け: ボックスにキー・ペアの秘密キー部分を貼り付けます。

      
      

      
      図adbs_extproc_compute_config.pngの説明

      
      
4. 「次へ」をクリックします。

   これにより、「確認」ページに移動します。

5. 「確認」ページで、次のステップを実行します:
   1. 構成変数の検証。
   2. Select the Run apply checkbox under Run apply on the created stack?
   3. 「作成」をクリックします。
   ノート
   
   この領域には、変更していないデフォルト値または変数を持つ変数は表示されません。

   
   

   
   図adbs_extproc_review.pngの説明

   
   

   リソース・マネージャは、適用ジョブを実行して、それに応じてスタック・リソースを作成します。これにより、「ジョブ詳細」ページに移動し、ジョブの状態は「受入済」になります。適用ジョブが開始されると、ステータスは「進行中」に更新されます。

   
   

   
   図adbs_extproc_job_details.pngの説明

   
   

   ノート
   
   スタックの一部として作成されたインスタンスに接続するために必要な情報は、「アプリケーション情報」タブにあります。

自己署名ウォレットは、EXTPROCエージェント・アプリケーションの作成の一部として作成されます。このウォレットを使用すると、Extrpocエージェント・インスタンスにアクセスできます。

1. Autonomous Databaseのオブジェクト・ストレージから、EXTPROCエージェント・インスタンスの証明書を含むウォレットcwallet.ssoをインポートします。ウォレット・ファイルについて次の点に注意してください。

   • ウォレット・ファイルは、データベース・ユーザーIDとパスワードとともに、EXTPROCエージェント・インスタンスへのアクセスを提供します。ウォレット・ファイルを安全な場所に格納し、認可されたユーザーのみと共有します。

   • ウォレット・ファイルの名前を変更しないでください。オブジェクト・ストレージのウォレット・ファイルには、cwallet.ssoという名前を付ける必要があります。

2. 資格証明を作成して、ウォレット・ファイルcwallet.ssoを格納するオブジェクト・ストレージにアクセスします。様々なオブジェクト・ストレージ・サービスのusernameおよびpasswordパラメータの詳細は、「CREATE_CREDENTIALプロシージャ」を参照してください。
   リソース・プリンシパル資格証明を有効にする場合、Oracle Cloud Infrastructureオブジェクト・ストアにアクセスするための資格証明の作成は必要ありません。詳細は、リソース・プリンシパルを使用したOracle Cloud Infrastructureリソースへのアクセスについてを参照してください。
3. ウォレット・ファイルcwallet.ssoのディレクトリをAutonomous Databaseに作成します。

   CREATE DIRECTORY wallet_dir AS 'directory_location';

   ディレクトリの作成の詳細は、Autonomous Databaseでのディレクトリの作成を参照してください。

4. DBMS_CLOUD.GET_OBJECTを使用して、ウォレットのアップロードを行います。たとえば:

   BEGIN
     DBMS_CLOUD.GET_OBJECT (
       credential_name     => 'DEF_CRED_NAME',
       object_uri          => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname/o/cwallet.sso',
       directory_name      => 'WALLET_DIR'
   );
   END;
   /

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

   ウォレットは、前のステップWALLET_DIRで作成したディレクトリにコピーされます。EXTPROCエージェント・インスタンスに接続できるウォレットが、Autonomous Databaseインスタンスで使用できるようになりました。

SQLファンクションとして外部プロシージャを起動するステップを示します。

1. ライブラリを作成します。

   外部プロシージャは、ライブラリに格納されているC言語ルーチンです。Autonomous Databaseで外部プロシージャを起動するには、ライブラリを作成します。

   DBMS_CLOUD_FUNCTION.CREATE_CATALOGを実行してライブラリを作成します。たとえば:

   BEGIN
       DBMS_CLOUD_FUNCTION.CREATE_CATALOG (
           library_name               => 'demolib',
           library_listener_url       => 'remote_extproc_hostname:16000',
           library_wallet_dir_name    => 'wallet_dir',
           library_ssl_server_cert_dn => 'CN=VM Hostname',
           library_remote_path        => '/u01/app/oracle/extproc_libs/library name'
   );
   END;
   /
   

   これにより、Autonomous Databaseにdemolibライブラリが作成され、データベースに動的リンク・ライブラリが登録されます。EXTPROCエージェント・インスタンスは、ポート16000で外部プロシージャをホストするように事前構成されています。

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

   DBA_CLOUD_FUNCTION_CATALOGビューおよびUSER_CLOUD_FUNCTION_CATALOGビュー・ビューを問い合せて、データベース内のすべてのカタログおよびライブラリのリストを取得します。

   USER_CLOUD_FUNCTION_ERRORSビュー・ビューを問い合せて、リモート・ライブラリの場所への接続検証中に生成されたエラーをリストします。

2. 関数を作成します。

   たとえば:

   CREATE OR REPLACE FUNCTION ftest(
         x VARCHAR2, 
         y VARCHAR2) 
   RETURN VARCHAR2 AS LANGUAGE C
         LIBRARY test
         NAME "demolib"
         PARAMETERS(
             x STRING, 
             y STRING)
         AGENT IN (x);
   /

3. 既存のライブラリは、DROP_CATALOGプロシージャを使用して削除できます。たとえば:

   BEGIN
       DBMS_CLOUD_FUNCTION.DROP_CATALOG (
         LIBRARY_NAME  => 'demolib'
     );
   END;
   /
   

   これにより、DEMOLIBライブラリが削除されます。

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