Cloud SQL Proxy を使用して MySQL クライアントを接続する

ここでは、IP ではなく Cloud SQL Proxy を使用して MySQL クライアントを Cloud SQL インスタンスに接続する方法を説明します。

IP を使用して MySQL クライアントを Cloud SQL インスタンスに接続する方法については、IP アドレスを使用して MySQL クライアントを接続するをご覧ください。

プロキシの仕組みの詳細については、Cloud SQL Proxy についてをご覧ください。

注: Cloud SQL Proxy は、Cloud SQL の第 2 世代インスタンスに対してのみ使用できます。

始める前に

MySQL を Cloud SQL インスタンスに接続するには、以下を実行しておく必要があります。

MySQL クライアントに接続する

プロキシで MySQL を Cloud SQL インスタンスに接続する手順には、次の作業が含まれます。

  1. Cloud SQL Admin API を有効にする
  2. プロキシをインストールする
  3. サービス アカウントを作成する
  4. プロキシを開始する
  5. MySQL セッションを開始する

1. API を有効化する

Cloud SQL Admin API を有効にします。

API を有効にする

2. プロキシをインストールする

Linux 64 ビット

  1. プロキシをダウンロードします。 
        wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.amd64 -O cloud_sql_proxy
  2. プロキシを実行可能にします。 
        chmod +x cloud_sql_proxy

Linux 32 ビット

  1. プロキシをダウンロードします。 
        wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.386 -O cloud_sql_proxy
  2. プロキシを実行可能にします。 
        chmod +x cloud_sql_proxy

macOS 64 ビット

  1. プロキシをダウンロードします。 
        curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.amd64
  2. プロキシを実行可能にします。 
        chmod +x cloud_sql_proxy

macOS 32 ビット

  1. プロキシをダウンロードします。 
        curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.386
  2. プロキシを実行可能にします。 
        chmod +x cloud_sql_proxy

Windows 64 ビット

https://dl.google.com/cloudsql/cloud_sql_proxy_x64.exe を右クリックして [名前を付けてリンク先を保存] を選択し、プロキシをダウンロードします。ファイル名を cloud_sql_proxy.exe に変更します。

Windows 32 ビット

https://dl.google.com/cloudsql/cloud_sql_proxy_x86.exe を右クリックして [名前を付けてリンク先を保存] を選択し、プロキシをダウンロードします。ファイル名を cloud_sql_proxy.exe に変更します。
お使いのオペレーティング システムがここに記載されていない場合は、ソースからプロキシをコンパイルすることもできます。

3. サービス アカウントを作成する

プロキシを使用して接続する場合、プロキシは Google Cloud Platform で認証する必要があります。Cloud SDK 認証情報を使用するか、サービス アカウントを作成してそのアカウントのローカル鍵ファイルへのパスをプロキシに提供できます（本番環境インスタンスで推奨）。Cloud SDK 認証情報を使用する場合は、この手順をスキップできます。

サービス アカウントの詳細については、Google Cloud Platform 認証ガイドをご覧ください。

サービス アカウントを使用してプロキシの認証情報を提示する場合は、十分な権限が付与されたサービス アカウントを作成する必要があります。よりきめ細かい Identity Access and Management（IAM）のロールを使用して Cloud SQL 権限を管理する場合は、サービス アカウントに cloudsql.instances.connect 権限を含むロールを付与する必要があります。この権限を含む事前定義された Cloud SQL のロールは次のとおりです。

  • Cloud SQL クライアント
  • Cloud SQL 編集者
  • Cloud SQL 管理者

以前のプロジェクトのロール（閲覧者、編集者、オーナー）を使用する場合、サービス アカウントには少なくとも編集者のロールが付与されている必要があります。

  1. Google Cloud Console の [サービス アカウント] ページに移動します。

    [サービス アカウント] ページに移動

  2. Cloud SQL インスタンスを含むプロジェクトを選択します。
  3. [サービス アカウントを作成] をクリックします。
  4. [サービス アカウントの作成] ダイアログで、わかりやすいサービス アカウント名を指定します。
  5. [役割] で、次のいずれかのロールを選択します。
    • [Cloud SQL] > [Cloud SQL クライアント]
    • [Cloud SQL] > [Cloud SQL 編集者]
    • [Cloud SQL] > [Cloud SQL 管理者]

    あるいは、[プロジェクト] > [編集者] の順に選択して、編集者の基本的なロールを使用できますが、編集者のロールには Google Cloud 全体に対する権限が含まれています。

    これらのロールが表示されない場合、Google Cloud ユーザーに resourcemanager.projects.setIamPolicy 権限がない可能性があります。 権限を確認するには、Google Cloud Console の IAM ページにアクセスし、自分のユーザー ID を検索します。

  6. [サービス アカウント ID] を一意のわかりやすい値に変更します。
  7. [新しい秘密鍵の提供] をクリックし、キーのタイプが JSON であることを確認します。
  8. [作成] をクリックします。

    秘密鍵ファイルがマシンにダウンロードされます。秘密鍵ファイルは、別の場所に移動できます。安全な場所に鍵ファイルを保管してください。

4. プロキシを開始する

言語や環境に応じて、TCP ソケットまたは UNIX ソケットのどちらかを使用してプロキシを開始できます。

TCP ソケット

  1. [インスタンスの詳細] ページからインスタンス接続名をコピーします。

    例: myproject:myregion:myinstance。

  2. サービス アカウントを使用してプロキシを認証する場合は、サービス アカウントを作成したときに作成された秘密鍵ファイルのクライアント マシン上での場所を記録しておきます。
  3. プロキシを開始します。

    考えられるプロキシ呼び出し文字列を以下にいくつか示します。

    • Cloud SDK 認証を使用する場合 
          ./cloud_sql_proxy -instances=<INSTANCE_CONNECTION_NAME>=tcp:3306
      指定されたポートは、ローカル データベース サーバーなどがまだ使用していないものにする必要があります。
    • サービス アカウントと明示的なインスタンス指定を使用する場合（本番環境で推奨） 
          ./cloud_sql_proxy -instances=<INSTANCE_CONNECTION_NAME>=tcp:3306 \
                      -credential_file=<PATH_TO_KEY_FILE> &

    プロキシ オプションの詳細については、プロキシを認証するためのオプションとインスタンスを指定するためのオプションをご覧ください。

Unix ソケット

  1. 明示的なインスタンス指定を使用する場合は、[インスタンスの詳細] ページからインスタンス接続名をコピーします。
  2. プロキシ ソケットを格納するディレクトリを作成します。 
    sudo mkdir /cloudsql; sudo chmod 777 /cloudsql
  3. サービス アカウントを使用してプロキシを認証する場合は、サービス アカウントを作成したときに作成された秘密鍵ファイルのクライアント マシン上での場所を記録しておきます。
  4. 新しいターミナル ウィンドウを開き、プロキシを開始します。

    考えられるプロキシ呼び出し文字列を以下にいくつか示します。

    • サービス アカウントと明示的なインスタンス指定を使用する場合（本番環境で推奨） 
          ./cloud_sql_proxy -dir=/cloudsql -instances=<INSTANCE_CONNECTION_NAME> \
                      -credential_file=<PATH_TO_KEY_FILE> &
    • Cloud SDK 認証と自動インスタンス検出を使用する場合 
      ./cloud_sql_proxy -dir=/cloudsql &

    専用のターミナルでプロキシを開始することをおすすめします。こうすることで他のプログラムからの出力と混ざることなく出力をモニタリングできます。

    プロキシ オプションの詳細については、プロキシを認証するためのオプションとインスタンスを指定するためのオプションをご覧ください。

  5. Unix ソケットを使用して Cloud SQL Proxy を使用する Cloud SQL に接続する場合、ソケットのファイル名の長さがシステムの上限を超えていないことを確認してください。システムによって異なりますが、通常は 91～108 文字です。Linux では、この長さが通常 108 文字と定義され、次のコマンドで確認できます。
    cat /usr/include/linux/un.h | grep "define UNIX_PATH_MAX"

5. クライアント セッションを開始する

プロキシをインストールして開始したので、このプロキシを使用して MySQL セッションを開始できます。MySQL クライアントで Cloud SQL インスタンスに接続するときは常に、このコマンドを使用できます。

使用する接続文字列は、プロキシの開始時に TCP ソケットを使用したか UNIX ソケットを使用したかによって異なります。

TCP ソケット

  1. MySQL クライアントを起動します。 
        mysql -u <USERNAME> -p --host 127.0.0.1

    TCP ソケットを使用して接続する場合、プロキシには 127.0.0.1 経由でアクセスします。

  2. プロンプトが表示されたら、パスワードを入力します。
  3. MySQL のプロンプトが表示されます。

Unix ソケット

  1. MySQL クライアントを起動します。 
        mysql -u <USERNAME> -p -S /cloudsql/<INSTANCE_CONNECTION_NAME>
  2. パスワードを入力します。
  3. MySQL のプロンプトが表示されます。

お困りの場合、プロキシのトラブルシューティングについては、Cloud SQL Proxy 接続のトラブルシューティングをご覧ください。または、Cloud SQL のサポートページをご覧ください。

次のステップ