App Engine から Cloud SQL への接続

MySQL   |  PostgreSQL   |  SQL Server

このページには、App Engine で実行されているサービスから Cloud SQL インスタンスに接続するための情報と例が含まれています。

Cloud SQL は、クラウド上の PostgreSQL と MySQL のリレーショナル データベースを簡単に設定、維持、運用、管理できるようにするフルマネージド データベース サービスです。

App Engine は、大規模なウェブ アプリケーションを開発およびホスティングするための、フルマネージド型のサーバーレス プラットフォームです。アプリの開発では複数の一般的な言語、ライブラリ、フレームワークからの選択が可能で、開発したアプリのインスタンスのサーバー プロビジョニングとスケーリングは App Engine によってオンデマンドで行われます。

Cloud SQL インスタンスの設定

1. Cloud SQL for MySQL インスタンスを作成します。

   注意: これらの手順では、Cloud SQL インスタンスにパブリック IP アドレスを設定する必要があります。プライベート IP アドレスを使用する場合は、サーバーレス VPC アクセスの設定を参照し、プライベート IP を使用して直接接続してください。

2. [インスタンスの詳細] ページで、インスタンスの INSTANCE_CONNECTION_NAME を見つけます。これは、PROJECT_ID:REGION:INSTANCE_ID の形式で、接続先の Cloud SQL インスタンスを識別するために使用されます。

3. まだ Cloud SQL Admin API を有効にしていない場合は有効にします。

   APIを有効にする

App Engine の設定

スタンダード

App Engine では、使用するサービス アカウントに正しいアクセス許可が設定されていること以外に、特別な構成は必要ありません。

注: App Engine のスタンダード環境では、TCP を使用した Cloud SQL インスタンスへの接続はサポートされていません。サーバーレス VPC アクセスを設定していない限り、コードは IP アドレス（127.0.0.1 または 172.17.0.1）を使用してインスタンスにアクセスしないでください。

フレキシブル

最適に機能するオプションを使用して、プロジェクトの app.yaml ファイルを更新します。インスタンスのカンマ区切りのリストを使用すると、複数のオプションを一度に指定できます。

Unix ドメイン ソケットの有効化

Unix ドメイン ソケットを有効にするには、プロジェクトの app.yaml ファイルに次の行を追加します。

beta_settings:
  cloud_sql_instances: <INSTANCE_CONNECTION_NAME>

TCP ポートの有効化

ローカル TCP ポートを有効にするには、プロジェクトの app.yaml ファイルに次の行を追加します。

beta_settings:
  cloud_sql_instances: <INSTANCE_CONNECTION_NAME>=tcp:<PORT>

App Engine はサービス アカウントを使用して Cloud SQL への接続を承認します。正常に接続するためには、このサービス アカウントに適切な IAM 権限が必要です。特に指定しない限り、デフォルトのサービス アカウントの形式は [e-mail] になります。

リソースを 2 つの異なるプロジェクトに接続する場合は、どちらのプロジェクトでも、適切な IAM 役割が有効であり、サービス アカウントに適切な権限が付与されていることを確認します。

サービスのサービス アカウントが次のいずれかの IAM 役割を持つことを確認します。

• Cloud SQL Client（推奨）
• Cloud SQL Editor
• Cloud SQL Admin

または、次の IAM 権限を手動で割り当てることもできます。

• cloudsql.instances.connect
• cloudsql.instances.get

サービス アカウントに IAM 役割を追加する方法の詳細については、サービス アカウントへの役割の付与をご覧ください。

Cloud SQL への接続

正しく構成されたら、/cloudsql/INSTANCE_CONNECTION_NAME にある Unix ドメイン ソケットを使用して、サービスを Cloud SQL インスタンスに接続できます。これらの接続は、追加構成なしで自動的に暗号化されます。

警告: Linux ベースのオペレーティング システムの最大ソケットパス長は 107 文字です。パスの全長がこの長さを超えると、App Engine からソケットに接続できなくなります。

App Engine フレキシブル環境は、TCP 経由の接続もサポートしています。TCP ポートを使用してインスタンスを構成した場合、代わりに 172.17.0.1:PORT に接続するようにアプリケーションを構成します。

Python

cloud-sql/mysql/sqlalchemy/main.py

GitHub で表示

# The SQLAlchemy engine will help manage interactions, including automatically
# managing a pool of connections to your database
db = sqlalchemy.create_engine(
    # Equivalent URL:
    # mysql+pymysql://<db_user>:<db_pass>@/<db_name>?unix_socket=/cloudsql/<cloud_sql_instance_name>
    sqlalchemy.engine.url.URL(
        drivername='mysql+pymysql',
        username=db_user,
        password=db_pass,
        database=db_name,
        query={
            'unix_socket': '/cloudsql/{}'.format(cloud_sql_connection_name)
        }
    ),
    # ... Specify additional properties here.
    # ...
)

このスニペットをウェブ アプリケーションのコンテキストで表示するには、GitHub にあるソースコードを表示してください。

Java

cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java

GitHub で表示

// The configuration object specifies behaviors for the connection pool.
HikariConfig config = new HikariConfig();

// Configure which instance and what database user to connect with.
config.setJdbcUrl(String.format("jdbc:mysql:///%s", DB_NAME));
config.setUsername(DB_USER); // e.g. "root", "postgres"
config.setPassword(DB_PASS); // e.g. "my-password"

// For Java users, the Cloud SQL JDBC Socket Factory can provide authenticated connections.
// See https://github.com/GoogleCloudPlatform/cloud-sql-jdbc-socket-factory for details.
config.addDataSourceProperty("socketFactory", "com.google.cloud.sql.mysql.SocketFactory");
config.addDataSourceProperty("cloudSqlInstance", CLOUD_SQL_CONNECTION_NAME);
config.addDataSourceProperty("useSSL", "false");

// ... Specify additional connection properties here.
// ...

// Initialize the connection pool using the configuration object.
DataSource pool = new HikariDataSource(config);

このスニペットをウェブ アプリケーションのコンテキストで表示するには、GitHub にあるソースコードを表示してください。

Node.js

cloud-sql/mysql/mysql/server.js

GitHub で表示

let pool;
const createPool = async () => {
  pool = await mysql.createPool({
    user: process.env.DB_USER, // e.g. 'my-db-user'
    password: process.env.DB_PASS, // e.g. 'my-db-password'
    database: process.env.DB_NAME, // e.g. 'my-database'
    // If connecting via unix domain socket, specify the path
    socketPath: `/cloudsql/${process.env.CLOUD_SQL_CONNECTION_NAME}`,
    // If connecting via TCP, enter the IP and port instead
    // host: 'localhost',
    // port: 3306,

    //...
  });
};
createPool();

このスニペットをウェブ アプリケーションのコンテキストで表示するには、GitHub にあるソースコードを表示してください。

C#

cloud-sql/mysql/Startup.cs

GitHub で表示

var connectionString = new MySqlConnectionStringBuilder(
    Configuration["CloudSql:ConnectionString"])
// ConnectionString set in appsetings.json formatted as:
// "Uid=aspnetuser;Pwd=;Host=cloudsql;Database=votes"
{
    // Connecting to a local proxy that does not support ssl.
    SslMode = MySqlSslMode.None,
};
connectionString.Pooling = true;
// ...
DbConnection connection =
    new MySqlConnection(connectionString.ConnectionString);

このスニペットをウェブ アプリケーションのコンテキストで表示するには、GitHub にあるソースコードを表示してください。

ベスト プラクティスとその他の情報

アプリケーションをローカルでテストする場合は、Cloud SQL プロキシを使用できます。詳細については、ローカルテストにプロキシを使用する場合のクイックスタートをご覧ください。

接続プール

データベース サーバー自体、または基盤となるインフラストラクチャによって、基盤となるデータベースへの接続が切断される可能性があります。これを軽減するには、接続プールと自動再接続をサポートするクライアント ライブラリを使用することをおすすめします。

接続プールの使用方法の詳しい例については、データベース接続を管理するをご覧ください。

接続制限

Cloud SQL では、同時接続の上限が設定されています。これらの上限は、選択したデータベース エンジンによって異なります。詳しくは、Cloud SQL の割り当てと上限をご覧ください。

App Engine には負荷の増加に応じて自動的にインスタンスを作成する機能があるため、これらの上限を超える可能性があります。この問題を回避するには、App Engine インスタンスの上限を設定します。詳しくは、要素のスケーリングをご覧ください。

インスタンスごとの最大接続数は、接続プールを使用して制限できます。接続の数を制限する使用例の詳細については、データベース接続を管理するのページをご覧ください。