メインコンテンツまでスキップ

データベースの操作

前処理と後処理操作は、いくつかのデータベースの操作をサポートしているので、データベースにしたしてCRUD操作を行うことができます。例えば、データの読み書き、APIで結果、アサーション状態、カスタムスクリプトの照会がサポートされています。

データベース操作によって返された結果は、直接にコンソールで確認することもできますし、変数として抽出することもできますので、後ほど、APIのリクエストパラメータ、アサーション、カスタムScriptなど様々な場面で利用することができます。

現在、対応のSQLデータベースは以下：

  • MySQL
  • SQL Server（2014 及びそれ以上のバージョン）
  • Oracle
  • PostgreSQL
  • ClickHouse

非SQLデータベースは以下：

  • MongoDB

データベースの追加と選択​

「前・後処理」で、「データベース操作」を選択し、「データベース接続」で既存のデータベース接続を選択することもできますし、新しいデータベースに接続することもできます。

違う環境では、同じデータベース接続の設定をデフォルトで使用しますが、違う環境に違うデータベースを設定することもサポートされています。セキュリティ向上のため、データベースのアドレス、ポート、ユーザーメオ。パスワード、データベース名などの情報は、すべてローカル環境に保存されていて、クラウドに同期することがありませんし、チームメンバーの間で同期することもありません。全てのチームメンバーも手動でデータベース設定を行う必要があります。

データベースに接続

SQLコマンドの入力​

SQLデータベースに対して、SQLコマンドを入力して操作することができます。

例えば、usersというテーブルで2つのデータをクエリするためのコマンドラインは以下：

データのクエリ：ELECT * FROM user LIMIT 2

apidog

非SQLのデータベースに対して、SQLコマンドを使用しません。詳細の使い方について、相応のヘルプドキュメントをご参照ください。

コンソールに結果を表示​

「コンソールに結果を表示する」機能を有効にすると、Apidogのコンソールでデータベースから返されたデータを直接に確認することができます。

データベースのコマンドを入力

結果を変数として抽出​

データベースが返した結果が、JSONPath式によってApidogの変数に抽出されることが可能です。上記画像のように、$[0].name は、Array中の1番目のエレメントの nameフィールドの値になります。それをローカル変数として抽出されると、 userNameという変数が作成されます。

SQLクエリ結果が次のような場合、クエリを3つの変数に抽出：allUser,user,userName。

[
  {
    id: 1,
    name: "jack",
  },
  {
    id: 2,
    name: "peter",
  },
];

変数の抽出値は次のようになります：

1.allUser(一時的な配列変数)の値：

[
  {
    id: 1,
    name: "jack",
  },
  {
    id: 2,
    name: "peter",
  },
];

2.user(オブジェクト変数)の値：

{
  "id": 1,
  "name": "jack",
}

3.userName(文字型変数)の値：

jack;

より詳しくは：環境変数/グローバル変数/ローカル変数