JDBC

Apps Script は、標準の Java Database Connectivity テクノロジのラッパーである JDBC サービスを介して外部データベースに接続できます。JDBC サービスは、Google Cloud SQL for MySQL、MySQL、Microsoft SQL Server、Oracle データベースをサポートしています。

JDBC を使用して外部データベースを更新するには、スクリプトでデータベースへの接続を開き、SQL ステートメントを送信して変更を加える必要があります。

Google Cloud SQL データベース

Google Cloud SQL を使用すると、Google のクラウドに存在するリレーショナル データベースを作成できます。Cloud SQL では、使用量に基づいて料金が発生する場合があります。

Google Cloud SQL インスタンスを作成するには、Cloud SQL クイックスタートの手順に沿って操作します。

Google Cloud SQL 接続を作成する

Apps Script の JDBC サービスを使用して Google Cloud SQL データベースに接続する方法は 2 つあります。

これらの方法について以下で説明します。どちらの方法でも有効ですが、2 番目の方法では、データベースへのアクセス用に IP 範囲のセットを承認する必要があります。

このメソッドは、Jdbc.getCloudSqlConnection(url) メソッドを使用して、Google Cloud SQL MySQL インスタンスへの接続を作成します。データベース URL の形式は jdbc:google:mysql://subname です。ここで、subname は Google Cloud コンソールの Cloud SQL インスタンスの [概要] ページに表示される MySQL のインスタンス接続名です。

Cloud SQL SQL Server に接続するには、Jdbc.getConnection(url) をご覧ください。

Jdbc.getConnection(url) を使用する

この方法を使用するには、Apps Script のサーバーがデータベースに接続できるように、特定の クラスレス ドメイン間ルーティング（CIDR） IP アドレス範囲を承認する必要があります。スクリプトを実行する前に、次の手順を完了します。

  1. Google Cloud SQL インスタンスで、このデータソースから 1 つずつIP 範囲を承認します。

  2. データベースに割り当てられた URL をコピーします。この URL は jdbc:mysql:subname の形式になります。

これらの IP 範囲を承認したら、Jdbc.getConnection(url) メソッドのいずれかを使用して、上記でコピーした URL を使用して Google Cloud SQL インスタンスへの接続を作成できます。

その他のデータベース

独自の MySQL、Microsoft SQL Server、Oracle データベースがすでにある場合は、Apps Script の JDBC サービスを使用してそのデータベースに接続できます。

他のデータベース接続を作成する

Apps Script の JDBC サービスを使用してデータベース接続を作成するには、データベース設定でこのデータソースの IP 範囲を承認する必要があります。

これらの許可リストが設定されたら、Jdbc.getConnection(url) メソッドのいずれかを使用して、データベースへの接続を作成できます。

サンプルコード

次のサンプルコードは、Google Cloud SQL データベースに接続することを前提としており、Jdbc.getCloudSqlConnection(url) メソッドを使用してデータベース接続を作成します。他のデータベースの場合は、Jdbc.getConnection(url) メソッドを使用してデータベース接続を作成する必要があります。

JDBC メソッドの詳細については、JDBC の Java ドキュメントをご覧ください。

データベース、ユーザー、テーブルを作成する

ほとんどのデベロッパーは、MySQL コマンドライン ツールを使用してデータベース、ユーザー、テーブルを作成します。ただし、次に示すように、Apps Script でも同じことができます。スクリプトで常に root としてデータベースに接続しなくても済むように、少なくとも 1 人のユーザーを作成することをおすすめします。

service/jdbc.gs
/**
 * Create a new database within a Cloud SQL instance.
 */
function createDatabase() {
  try {
    const conn = Jdbc.getCloudSqlConnection(instanceUrl, root, rootPwd);
    conn.createStatement().execute('CREATE DATABASE ' + db);
  } catch (err) {
    // TODO(developer) - Handle exception from the API
    console.log('Failed with an error %s', err.message);
  }
}

/**
 * Create a new user for your database with full privileges.
 */
function createUser() {
  try {
    const conn = Jdbc.getCloudSqlConnection(dbUrl, root, rootPwd);

    const stmt = conn.prepareStatement('CREATE USER ? IDENTIFIED BY ?');
    stmt.setString(1, user);
    stmt.setString(2, userPwd);
    stmt.execute();

    conn.createStatement().execute('GRANT ALL ON `%`.* TO ' + user);
  } catch (err) {
    // TODO(developer) - Handle exception from the API
    console.log('Failed with an error %s', err.message);
  }
}

/**
 * Create a new table in the database.
 */
function createTable() {
  try {
    const conn = Jdbc.getCloudSqlConnection(dbUrl, user, userPwd);
    conn.createStatement().execute('CREATE TABLE entries ' +
      '(guestName VARCHAR(255), content VARCHAR(255), ' +
      'entryID INT NOT NULL AUTO_INCREMENT, PRIMARY KEY(entryID));');
  } catch (err) {
    // TODO(developer) - Handle exception from the API
    console.log('Failed with an error %s', err.message);
  }
}

データベースに書き込む

次の例は、単一のレコードと 500 件のレコードのバッチをデータベースに書き込む方法を示しています。バッチ処理は、一括オペレーションに不可欠です。

また、変数が ? で表されるパラメータ化されたステートメントを使用していることにも注意してください。SQL インジェクション攻撃を防ぐには、パラメータ化されたステートメントを使用して、ユーザー提供のすべてのデータをエスケープする必要があります。

service/jdbc.gs
/**
 * Write one row of data to a table.
 */
function writeOneRecord() {
  try {
    const conn = Jdbc.getCloudSqlConnection(dbUrl, user, userPwd);

    const stmt = conn.prepareStatement('INSERT INTO entries ' +
      '(guestName, content) values (?, ?)');
    stmt.setString(1, 'First Guest');
    stmt.setString(2, 'Hello, world');
    stmt.execute();
  } catch (err) {
    // TODO(developer) - Handle exception from the API
    console.log('Failed with an error %s', err.message);
  }
}

/**
 * Write 500 rows of data to a table in a single batch.
 */
function writeManyRecords() {
  try {
    const conn = Jdbc.getCloudSqlConnection(dbUrl, user, userPwd);
    conn.setAutoCommit(false);

    const start = new Date();
    const stmt = conn.prepareStatement('INSERT INTO entries ' +
      '(guestName, content) values (?, ?)');
    for (let i = 0; i < 500; i++) {
      stmt.setString(1, 'Name ' + i);
      stmt.setString(2, 'Hello, world ' + i);
      stmt.addBatch();
    }

    const batch = stmt.executeBatch();
    conn.commit();
    conn.close();

    const end = new Date();
    console.log('Time elapsed: %sms for %s rows.', end - start, batch.length);
  } catch (err) {
    // TODO(developer) - Handle exception from the API
    console.log('Failed with an error %s', err.message);
  }
}

データベースから読み取る

この例は、必要に応じて結果セットをループして、データベースから大量のレコードを読み取る方法を示しています。

service/jdbc.gs
/**
 * Read up to 1000 rows of data from the table and log them.
 */
function readFromTable() {
  try {
    const conn = Jdbc.getCloudSqlConnection(dbUrl, user, userPwd);
    const start = new Date();
    const stmt = conn.createStatement();
    stmt.setMaxRows(1000);
    const results = stmt.executeQuery('SELECT * FROM entries');
    const numCols = results.getMetaData().getColumnCount();

    while (results.next()) {
      let rowString = '';
      for (let col = 0; col < numCols; col++) {
        rowString += results.getString(col + 1) + '\t';
      }
      console.log(rowString);
    }

    results.close();
    stmt.close();

    const end = new Date();
    console.log('Time elapsed: %sms', end - start);
  } catch (err) {
    // TODO(developer) - Handle exception from the API
    console.log('Failed with an error %s', err.message);
  }
}

接続を閉じる

スクリプトの実行が完了すると、JDBC 接続は自動的に閉じられます。（呼び出しを行った HTML サービスページが開いたままでも、1 回の google.script.run 呼び出しは完全な実行としてカウントされます）。

ただし、スクリプトの終了前に接続、ステートメント、結果セットの使用が完了していることがわかっている場合は、JdbcConnection.close()、JdbcStatement.close()、JdbcResultSet.close() を呼び出して手動で閉じることをおすすめします。

アラートまたはプロンプト ダイアログを表示すると、開いている JDBC 接続も終了します。ただし、カスタム メニューやダイアログ、カスタム コンテンツを含むサイドバーなど、他の表示 UI 要素はカウントされません。

Google、Google Workspace、および関連するマークとロゴは、Google LLC の商標です。その他すべての企業名および商品名は関連各社の商標です。