Google Cloud Platform
Python

Using Google Cloud SQL

Python |Java |PHP |Go

Google Cloud SQL provides a relational database that you can use with your App Engine application. Cloud SQL is a MySQL database that lives in Google's cloud. To learn more about Google Cloud SQL, see the Google Cloud SQL documentation.

You can connect to Cloud SQL First Generation or Second Generation instances.

For information on pricing and restrictions imposed by both Cloud SQL and App Engine, see Pricing and Access Limits.

  1. Before you begin
  2. Setting up
  3. Code sample overview
  4. Testing and deploying

Before you begin

  • Select or create a Cloud Platform Console project.

    Go to the Projects page

  • To test in your development environment, you need to connect to a local MySQL server. Install the MySQL Community Server.

    If you use Linux on a distribution with apt-get, you can run:

    sudo apt-get install mysql-server
    

  • While the App Engine Python runtime includes the MySQLdb library, you need to install MySQLdb locally to test in your development environment.

    If you use Linux on a distribution with apt-get, you can install MySQLdb by running:

    sudo apt-get install python-mysqldb

    For instructions for other operating systems, see MySQLdb installation instructions at SourceForge.

Setting up

  1. In the same project as your App Engine application, create a Cloud SQL instance and configure the root user.

    You can use a Cloud SQL First Generation or a Second Generation instance. For more information on the differences, see Announcing Cloud SQL Second Generation. Note that Cloud SQL Second Generation is in beta.

  2. For the Cloud SQL instance, create a database.
  3. The default user for App Engine applications is root@localhost. If you don't want to use the default user, create a user.
  4. If you are using a Cloud SQL First Generation instance, in the Cloud Platform Console, grant your App Engine application access to the Google Cloud SQL instance.

    If you are using a Cloud SQL Second Generation instance and your application is in the same project as the SQL instance, then your application should already have access.

  5. Get the Cloud SQL instance connection name to use as a connection string in your application code. To find the instance connection name, go to the Cloud SQL Instances page in the Cloud Platform Console.
    Go to the Cloud SQL Instances page
    1. Click on the Instance ID for the Cloud SQL instance you are using.
    2. Under Properties, find the Instance connection name.
  6. Add the Cloud SQL instance connection name, database name, user, and password to the environment variables in app.yaml.
  7. The App Engine Python runtime includes the MySQLdb library. To request the library so that it is added to the runtime environment when your application is deployed, add the MySQLdb client library to your application's app.yaml:

Code sample overview

The following code sample connects to Google Cloud SQL using App Engine's native UNIX socket, then uses the SHOW VARIABLES command to display values of MySQL flags:

Testing and deploying

The development server in the Google App Engine SDK can use a locally installed MySQL server instance to closely mirror the Google Cloud SQL environment during development. To test in your development environment:
  1. Update the connection string in your application code to connect to a local instance of MySQL server.
  2. Start the MySQL server in your development environment.
  3. Start the development server, including a path to the application directory. For example, if your application's main.py file is in a directory named cloudsql:

    dev_appserver.py cloudsql/

  4. The web server is now running and listening for requests on port 8080. To view, visit the following URL:

    http://localhost:8080/

  5. When you are ready, deploy your project to App Engine:

    appcfg.py update cloudsql/