クイックスタート: Cloud SQL Auth プロキシを使用して Cloud SQL for PostgreSQL に接続する

Cloud SQL Auth プロキシを使用して Cloud SQL for PostgreSQL に接続する

このページでは、Cloud SQL Auth Proxy を使用して、ローカルテスト環境から Cloud SQL に接続する方法を示します。Cloud SQL Auth Proxy を使用すると、承認済みネットワークや SSL の構成を必要とせずに、安全に Cloud SQL インスタンスへアクセスできます。Cloud SQL Auth プロキシを使用すると、Cloud SQL インスタンスに安全に接続できます。

本番環境の Cloud SQL Auth プロキシの設定には、以下の手順を使用しないでください。また、プロキシの認証と使用に関するその他の接続オプションについては、Cloud SQL Auth プロキシを使用した接続をご覧ください。

始める前に

  1. Google Cloud アカウントにログインします。Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。
  2. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

    プロジェクト セレクタに移動

  3. Cloud プロジェクトに対して課金が有効になっていることを確認します。詳しくは、プロジェクトで課金が有効になっているかどうかを確認する方法をご覧ください。

  4. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

    プロジェクト セレクタに移動

  5. Cloud プロジェクトに対して課金が有効になっていることを確認します。詳しくは、プロジェクトで課金が有効になっているかどうかを確認する方法をご覧ください。

  6. 必要な Google Cloud APIs を有効にします。

    Console

    Google Cloud Console の [API] ページに移動します。

    [API] に移動

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

    gcloud

    次のボタンをクリックして Cloud Shell を開きます。これにより、ブラウザから Google Cloud リソースにコマンドラインで直接アクセスできます。Cloud Shell を使用して、このクイックスタートで紹介する gcloud コマンドを実行できます。

    Cloud Shell を開く

    Cloud Shell を使用して、次のように gcloud services enable コマンドを実行し、このクイックスタートに必要な API を有効にします。

    gcloud services enable sqladmin.googleapis.com

    このコマンドにより、次の API が有効になります。

    • Cloud SQL Admin API

Cloud SQL インスタンスを作成する

このクイックスタートでは、Google Cloud Console を使用します。Google Cloud CLI、cURL、PowerShell を使用するには、インスタンスの作成をご覧ください。

  1. Google Cloud コンソールで Cloud SQL の [インスタンス] ページに移動します。

    Cloud SQL の [インスタンス] に移動

  2. [インスタンスを作成] をクリックします。
  3. [PostgreSQL を選択] をクリックします。
  4. [インスタンス ID] に「myinstance」と入力します。
  5. postgres ユーザーのパスワードを入力します。
  6. [作成] をクリックします。

    インスタンスのリストに戻ります。新しいインスタンスをすぐにクリックして詳細を表示できますが、初期化と起動が完了するまで他のオペレーションには使用できません。

Debian、Ubuntu

PSQL クライアントをパッケージ マネージャーから次のようにインストールします。

sudo apt-get update
sudo apt-get install postgresql-client

CentOS / RHEL

PSQL クライアントをパッケージ マネージャーから次のようにインストールします。

sudo yum install postgresql

openSUSE

PSQL クライアントをパッケージ マネージャーから次のようにインストールします。

sudo zypper install postgresql

他のプラットフォーム

  1. ご使用のプラットフォームに対応する PostgreSQL Core Distribution を、PostgreSQL のダウンロード ページからダウンロードします。
    Core Distribution には、PSQL クライアントが含まれています。
  2. ダウンロード ページの指示に沿って、PostgreSQL データベースをインストールします。

Cloud SQL Auth Proxy クライアントをインストールする

ダウンロードする Cloud SQL Auth Proxy バイナリは、使用しているオペレーティング システムと、オペレーティング システムが 32 ビットと 64 ビットのいずれのカーネルを使用しているかによって異なります。新しいハードウェアのほとんどは 64 ビットのカーネルを使用しています。お使いのマシンが 32 ビットと 64 ビットのどちらのカーネルを実行しているかわからない場合は、Linux または macOS で uname -a コマンドを使用します。Windows の場合は、Windows のドキュメントをご覧ください。

Linux 64 ビット

  1. Cloud SQL Auth Proxy をダウンロードします。
    wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.amd64 -O cloud_sql_proxy
    
  2. Cloud SQL Auth Proxy を動作可能にします。
    chmod +x cloud_sql_proxy
    

Linux 32 ビット

  1. Cloud SQL Auth Proxy をダウンロードします。
    wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.386 -O cloud_sql_proxy
    
  2. wget コマンドが見つからない場合は、sudo apt-get install wget を実行してダウンロード コマンドを繰り返します。
  3. Cloud SQL Auth Proxy を動作可能にします。
    chmod +x cloud_sql_proxy
    

macOS 64 ビット

  1. Cloud SQL Auth Proxy をダウンロードします。
    curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.amd64
    
  2. Cloud SQL Auth Proxy を動作可能にします。
    chmod +x cloud_sql_proxy
    

macOS 32 ビット

  1. Cloud SQL Auth Proxy をダウンロードします。
    curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.386
    
  2. Cloud SQL Auth Proxy を動作可能にします。
    chmod +x cloud_sql_proxy
    

Mac M1

  1. Cloud SQL Auth Proxy をダウンロードします。
      curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.arm64
      
  2. Cloud SQL Auth Proxy を動作可能にします。
      chmod +x cloud_sql_proxy
      

Windows 64 ビット

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

Windows 32 ビット

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

Cloud SQL Auth Proxy Docker イメージ

便宜上、Cloud SQL Auth プロキシを含む複数のコンテナ イメージは、GitHub で Cloud SQL Auth プロキシ リポジトリから入手できます。次のコマンドを使用して、最新のイメージをローカルマシンに Docker で pull できます。
docker pull gcr.io/cloudsql-docker/gce-proxy:1.31.2

その他の OS

ここに記載されていないその他のオペレーティング システムの場合は、ソースから Cloud SQL Auth Proxy をコンパイルできます。

インスタンス接続名の取得

  1. Google Cloud コンソールで Cloud SQL の [インスタンス] ページに移動します。

    Cloud SQL の [インスタンス] に移動

  2. インスタンス名をクリックして [概要] ページを開きます。
  3. [このインスタンスと接続] セクションで接続名をコピーします。接続名の形式は projectID:region:instanceID です。

Cloud SQL Auth Proxy の起動

専用のターミナルで Cloud SQL Auth Proxy を起動して、その出力をモニタリングできるようにします。INSTANCE_CONNECTION_NAME を、前のステップでコピーしたインスタンス接続名に置き換えます。

Linux 環境の場合は、次のコマンドを使用して Cloud SQL Auth Proxy を起動します。

./cloud_sql_proxy -instances=INSTANCE_CONNECTION_NAME=tcp:5432

Windows の PowerShell では、次のコマンドを使用して Cloud SQL Auth Proxy を起動します。

.\cloud_sql_proxy.exe -instances=INSTANCE_CONNECTION_NAME=tcp:5432

次のようなメッセージが表示されます。

Listening on 127.0.0.1:5432 for INSTANCE_CONNECTION_NAME
Ready for new connections

次のコマンドを実行します。DB_NAME は、Cloud SQL データベースの名前に置き換えます。

psql "host=127.0.0.1 port=5432 sslmode=disable dbname=DB_NAME user=postgres"

パスワード入力のプロンプトで、PostgreSQL アカウントのパスワードを入力します。

PostgreSQL のプロンプトが表示されることを確認します。psql クライアントを使用してデータベースに接続しています。

Cloud SQL Auth Proxy を起動したターミナル ウィンドウに戻ります。次のようなメッセージが表示されます。

New connection for myInstance

クリーンアップ

このページで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、次の手順を行います。

  1. Google Cloud コンソールで Cloud SQL の [インスタンス] ページに移動します。

    Cloud SQL の [インスタンス] に移動

  2. myinstance インスタンスを選択して [インスタンスの詳細] ページを開きます。
  3. ページ上部にあるアイコンバーで、[削除] をクリックします。
  4. インスタンスの削除ウィンドウでインスタンスの名前を入力し、[削除] をクリックします。

省略可能なクリーンアップ手順

このクイックスタートで有効にした API を使用しない場合は、無効にすることができます。

  • このクイックスタートで有効にした API:
    • Cloud SQL Admin API
  1. Google Cloud Console の [API] ページに移動します。

    [API] に移動

  2. Cloud SQL Admin API を選択し、[API を無効にする] ボタンをクリックします。

次のステップ