GASのJDBCサービスでCloud SQLデータベースに接続をする方法

photo credit: #PACOM Sailors assigned to Military Sealift Command hospital ship USNS Mercy (T-AH 19) for Pacific Partnership 2018 (PP18), refuel an MH-60S Sea Hawk helicopter via photopin (license)

みなさん、こんにちは！
タカハシ(@ntakahashi0505)です。

GASからJDBCサービスを使ってCloud SQLのデータベースにアクセスする方法をシリーズでお伝えしています。

前回の記事はこちら。

GCPのCloud SQLデータベースのテーブルにSQLでレコードを追加する方法

GASからJDBCサービスを使ってCloud SQLのデータベースにアクセスする方法をシリーズでお伝えしています。今回は、GCPのCloud SQLデータベースのテーブルにSQLでレコードを追加する方法です。

Cloud SQLのデータベースにSQLでレコードを追加する方法をお伝えしました。

これで、GCPでのCloud SQLの準備と、SQLに馴染むのは十分かなと思いますので、いよいよGASからCloud SQLを操作していきたいと思います。

今回は、GASのJDBCサービスでCloud SQLデータベースに接続をする方法です。

では、行ってみましょう！

前回のおさらい
JDBCサービスとは
GASからCloud SQLへの接続
1. データベースURLの作り方
2. ユーザー名、パスワード
GASからCloud SQLのデータベースに接続する
1. 接続のカタログ名を取得する
2. データベース接続を閉じる
まとめ
連載目次：GASのJDBCサービスでCloud SQLのDBを操作する

前回のおさらい

これまで、以下のような手順で、データベースの準備を進めてきました。

GCPのプロジェクト配下にCloud SQLインスタンスを作成する
└Cloud SQL配下のインスタンスにデータベースを作成する
　└データベースにテーブルを作成する
　　└テーブルにレコードを追加する

ここで、データベース名は「guestbook」、テーブル名は「entries」でした。

このデータベースにGASからアクセスしていきたいと思います。

JDBCサービスとは

外部のデータベースに接続する機能を提供するサービスとして、GASにはJDBCサービスが用意されています。

JDBCサービスはScript Servicesに含まれていますので、デフォルトで使用可能です。

「JDBC」…何のことやら、さっぱり予想がつきませんね、

これは「Java DataBase Connectivity」の略で、業界標準として「Javaによるプログラミング言語」と様々な種類のデータベースとの「接続」を提供するAPIです。

GASで提供されているJDBCサービスは、このAPIを利用して外部のデータベース接続を実現するものです。

詳しく知りたい方は、英語ですが、以下のドキュメントをそれぞれご覧ください。

Java SE Technologies - Database

This page contains information about Java Database Connectivity (JDBC) related to Java SE

JDBC | Apps Script | Google for Developers

GASからCloud SQLへの接続

このJDBCサービスですが、Cloud SQLのデータベースの接続については、専用のメソッドが用意されています。

その名もgetCloudSqlConnectionメソッドです。

Jdbc.getCloudSqlConnection(データベースURL, ユーザー名, パスワード)

このメソッドにより、データベースURLが示すデータベースに接続して、その接続を表すJdbcConnectionという種類のオブジェクトを返します。

データベースを操作する場合、この「接続」からスタートすることが多いので、覚えておくと良いかも知れません。

データベースURLの作り方

データベースURLですが、Cloud SQLでは以下のような作りになります。

jdbc:google:mysql://{インスタンス接続名}/{データベース名}

データベース名は今回の場合は「guestbook」という名前でしたね。

インスタンス接続名ですが、これはGCPのナビゲーションメニュー > 「SQL」の画面で、すぐに確認できます。

何やら文字列と、リージョンと、インスタンス名がコロン記号「:」で結合された文字列です。

ユーザー名、パスワード

ユーザー名、パスワードは、Cloud SQLのインスタンス作成時に定めた「root」のものでも良いですし、GCPで新たなユーザーアカウントを追加することもできます。

GASからCloud SQLのデータベースに接続する

これで材料は揃いましたので、GASでCloud SQLのデータベースへの接続を試してみましょう。

コードはこちらです。

var connectionName = '*****データベース接続名*****'; //Instance_connection_name
var userName = '*****ユーザー名*****'; //user_name
var password = '*****パスワード*****'; //'user_password'
var databaseName = 'guestbook'; //database_name

var url = 'jdbc:google:mysql://' + connectionName + '/' + databaseName;

function readFromTable() {
  var connection = Jdbc.getCloudSqlConnection(url, userName, password);
  Logger.log(connection.getCatalog());

  connection.close();
}

（スクリプトとして、データベース接続名、ユーザー名、パスワードなどをベタ打ちするのはあまり望ましくないので、実際にはプロパティストアなどを用いてくださいね。）

実行すると、ログで以下のようにデータベース名の表示を確認できます。