メインコンテンツへスキップ

TDVから外部データソースへの書き込みについて（Webサービス形式）

  • 更新

    概要

    TDVに追加したデータソースに対してINSERT / UPDATE / DELETE文を実行するプロシージャをWebサービス形式のデータサービスとして公開（パブリッシュ）し、そのデータサービスをREST APIとしてAPIクライアントツールから実行することで、データソースに変更を加えることができます。

     

     

    検証環境

    PostgreSQL（外部データソース）

    外部データソース用のPostgreSQLインスタンス（5432ポート）です。
    TDV ServerにバンドルされているリポジトリDB（9408ポート）やデフォルトキャッシュデータベース（9404ポート）とは異なります。
    TDVに追加するデータソースとして、PostgreSQLインスタンス内に作成済みの「契約管理データベース」を使用します。
    「契約管理データベース」は「契約管理スキーマ」を持ち、そのスキーマ内に「契約テーブル」が存在します。
    「契約テーブル」には10件のレコードが存在しています。（以下はDBeaverで接続しプレビューしたものです。）

    0_dbeaver_postgres.png

    CREATE TABLEでは、「契約管理スキーマ」内に新しいテーブルを作成しますので、TDV ServerからPostgreSQLデータソースへの接続に利用するユーザー（tdv）には各種クエリ（INSERT, UPDATE, …）を実行するために必要な権限がPostgreSQL側で事前に付与されています。

     

    TDV Server

    TDV Serverは、PostgreSQL（外部データソース）と同一サーバー上で実行されています。

     

    データソース

    PostgreSQL（外部データソース）の「契約管理データベース」がデータソースとして追加されており、

    0_tdvstudio_ds.png

    「契約管理スキーマ」とその配下の「契約テーブル」がイントロスペクトされ、メタデータが追加されています。

    0_tdvstudio_ds_table.png

     

    公開データサービス

    コンポジットデータサービス「契約管理データベース」>「契約管理スキーマ」>「契約テーブル」がデータサービス（データベース方式）として公開されています。

    0_tdvstudio_published_table.png

    コンポジットデータサービス「契約管理データベース」には、コンテナのマッピング設定を事前に行います。
    ここでは、コンポジットデータサービス「契約管理データベース」直下の「契約管理スキーマ」とデータソース「契約管理データベース」直下の「契約管理スキーマ」の対応付けを行います。
    これにより、公開テーブル「契約管理データベース」>「契約管理スキーマ」>「契約テーブル」に対して外部のクライアントアプリなどからDDLクエリが実行された場合には、対応するスキーマ、すなわちデータソース「契約管理データベース」>「契約管理スキーマ」に対してそのDDLがわたされ、結果として、データソース「契約管理データベース」の先にある物理データソース（PostgreSQL）に対してそのDDLが実行されることになります。

    0_tdvstudio_published_database.png

     

     

    プロシージャ作成・公開

    契約管理テーブルに対して、INSERT / UPDATE / DELETEを実行するプロシージャを作成し、Webサービスとして公開します。

    すべてのプロシージャを公開し、https://<TDV Serverのホスト>:9402/rest/api-docs/webservice.htmlで確認すると、以下のように公開済みREST APIが表示されます。

    tdv880_published_restapi.png

    以下に、作成するプロシージャとWebサービスの設定を示します。

     

    INSERT

    tdv880_published_restapi_insertproc0.png

    PROCEDURE 契約追加プロシージャ(
    IN cid INTEGER, 
    IN name VARCHAR(100), 
    IN ammount INTEGER, 
    IN client VARCHAR(100), 
    IN sdate DATE, 
    IN edate DATE, 
    OUT result VARCHAR(100))
    BEGIN INDEPENDENT TRANSACTION
        INSERT INTO /shared/検証用データベース/契約管理データベース/契約管理スキーマ/契約テーブル(
            契約ＩＤ, 
            契約名, 
            金額, 
            取引先名, 
            契約開始日, 
            契約終了日) 
        VALUES (
            cid, 
            name, 
            ammount, 
            client, 
            sdate, 
            edate);
        SET result = 'Insert succeeded.';
    EXCEPTION
        ELSE
            SET result = 'Insert failed.';
    END

    tdv880_published_restapi_insertproc1_1.png

    tdv880_published_restapi_insertproc1_2.png

     

    UPDATE

    tdv880_published_restapi_updateproc0.png

    PROCEDURE 契約更新プロシージャ(
	IN cid INTEGER, 
	IN name VARCHAR(100), 
	IN ammount INTEGER, 
	IN client VARCHAR(100), 
	IN sdate DATE, 
	IN edate DATE, 
	OUT result VARCHAR(100))
    BEGIN INDEPENDENT TRANSACTION
        UPDATE /shared/検証用データベース/契約管理データベース/契約管理スキーマ/契約テーブル
            SET
				"契約名" = name,
				"金額" = ammount,
				"取引先名" = client,
				"契約開始日" = sdate,
				"契約終了日" = edate
            WHERE
				"契約ＩＤ" = cid;
		SET result = 'Update succeeded.';
    EXCEPTION
        ELSE
            SET result = 'Update failed.';
    END

    tdv880_published_restapi_updateproc1_1.png

    tdv880_published_restapi_updateproc1_2.png

     

    DELETE

    tdv880_published_restapi_deleteproc0.png

    PROCEDURE 契約削除プロシージャ(
	IN cid INTEGER, 
	OUT result VARCHAR(100))
    BEGIN INDEPENDENT TRANSACTION
        DELETE FROM /shared/検証用データベース/契約管理データベース/契約管理スキーマ/契約テーブル
            WHERE "契約ＩＤ" = cid;
		SET result = 'Delete succeeded.';
    EXCEPTION
        ELSE
            SET result = 'Delete failed.';
    END

    tdv880_published_restapi_deleteproc1_1.png

    tdv880_published_restapi_deleteproc1_2.png

     

     

    REST API実行

    本記事では、Talend API Tester（Google Chromeの拡張機能）からTDVの公開Webサービスにリクエストを実行し、INSERT / UPDATE / DELETEがそれぞれ正常に実行されることを確認します。

     

    INSERT

    tdv880_published_restapi_insertproc2.png

    リクエストボディは以下のとおりです。

    {
 "insert_contract": {
   "cid": 11,
   "name": "サーバー構築",
   "ammount": 80000,
   "client": "BCDシステムズ",
   "sdate": "2024-01-01",
   "edate": "2024-03-31"
 }
}

    続いて、TDV公開テーブルに対して、以下のSELECTクエリを実行し、 レコードが1件追加されたことを確認します。

    SELECT * FROM 契約管理スキーマ.契約テーブル

    1_insert_dbeaver_tdv_published_table_selectresult.png

    TDV Studio上でも同様に確認します。

    1_insert_tdvstudio_published_table_selectresult.png

    1_insert_tdvstudio_ds_table_selectresult.png

    最後に、物理データソース（PostgreSQL）のテーブルも直接参照して確認します。

    1_insert_dbeaver_postgres_table_selectresult.png

    このように、INSERT実行用プロシージャ由来のTDV公開REST APIを実行することで、その先の物理データソースに対してINSERTを実行することができます。

     

    UPDATE

    tdv880_published_restapi_updateproc2.png

    リクエストボディは以下のとおりです。

    {
 "update_contract": {
   "cid": 8,
   "name": "アプリケーション開発",
   "ammount": 70000,
   "client": "STUソリューションズ",
   "sdate": "2023-08-01",
   "edate": null
 }
}

    続いて、TDV公開テーブルに対して、以下のSELECTクエリを実行し、 契約ＩＤ = 8のレコードが更新されたことを確認します。

    SELECT * FROM 契約管理スキーマ.契約テーブル

    2_update_dbeaver_tdv_published_table_selectresult.png

    TDV Studio上でも同様に確認します。

    2_update_tdvstudio_published_table_selectresult.png

    2_update_tdvstudio_ds_table_selectresult.png

    最後に、物理データソース（PostgreSQL）のテーブルも直接参照して確認します。

    2_update_dbeaver_postgres_table_selectresult.png

    このように、UPDATE用プロシージャ由来のTDV公開REST APIを実行することで、その先の物理データソースに対してUPDATEを実行することができます。

     

    DELETE

    tdv880_published_restapi_deleteproc2.png

    delete_contract/{cid}という形式でパスに契約ＩＤを指定してリクエストします。

    続いて、TDV公開テーブルに対して、以下のSELECTクエリを実行し、 契約ＩＤ = 3のレコードが削除されたことを確認します。

    SELECT * FROM 契約管理スキーマ.契約テーブル

    3_delete_dbeaver_tdv_published_table_selectresult.png

    TDV Studio上でも同様に確認します。

    3_delete_tdvstudio_published_table_selectresult.png

    3_delete_tdvstudio_ds_table_selectresult.png

    最後に、物理データソース（PostgreSQL）のテーブルも直接参照して確認します。

    3_delete_dbeaver_postgres_table_selectresult.png

    このように、DELETE用プロシージャ由来のTDV公開REST APIを実行することで、その先の物理データソースに対してDELETEを実行することができます。