Connection to Cloud SQL - SQL Server

Before you begin

This code sample requires the pdo_sqlsrv extension to be installed and enabled. For more information, including getting started guides, refer to the source repository.
Before you use this code sample, you need to have Composer installed or downloaded into this folder. Download instructions can be found here. Once you've installed composer, use it to install required dependencies by running composer install.
Create a SQL Server Cloud SQL Instance by following these instructions. Note the connection string, database user, and database password that you create.
Create a database for your application by following these instructions. Note the database name.
Create a service account with the 'Cloud SQL Client' permissions by following these instructions. Download a JSON key to use to authenticate your connection.

Running Locally

To run this application locally, download and install the cloud_sql_proxy by following the instructions here.

To authenticate with Cloud SQL, set the $GOOGLE_APPLICATION_CREDENTIALS environment variable:

export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json

To run the Cloud SQL proxy, you need to set the instance connection name. See the instructions here for finding the instance connection name.

export INSTANCE_CONNECTION_NAME='<PROJECT-ID>:<INSTANCE-REGION>:<INSTANCE-NAME>'

Once the proxy is ready, use one of the following commands to start the proxy in the background.

You may connect to your instance via TCP. To connect via TCP, you must provide a port as part of the instance name, as demonstrated below.

$ ./cloud_sql_proxy \
    --instances=$INSTANCE_CONNECTION_NAME=tcp:1433 \
    --credential_file=$GOOGLE_APPLICATION_CREDENTIALS

Set Configuration Values

Set the required environment variables for your connection to Cloud SQL.

export DB_USER='<DB_USER_NAME>'
export DB_PASS='<DB_PASSWORD>'
export DB_NAME='<DB_NAME>'
export DB_HOST='127.0.0.1'

Note: Saving credentials in environment variables is convenient, but not secure - consider a more secure solution such as Secret Manager to help keep secrets safe.

Execute the following:

$ php -S localhost:8080

Navigate towards http://localhost:8080 to verify your application is running correctly.

Google App Engine Flex

To run on App Engine Flex, create an App Engine project by following the setup for these instructions.

First, update app.yaml with the correct values to pass the environment variables into the runtime.

In order to use the sqlsrv extension, you will need to build a custom runtime. The Dockerfile in this sample contains a simple example of a custom PHP 7.2 runtime based off of the default App Engine Flex image with the pdo_sqlsrv extension installed.

Then, make sure that the App Engine default service account <PROJECT-ID>@appspot.gserviceaccount.com has the IAM role Cloud SQL Client.

Also, make sure that the Cloud Build service account cloudbuild@<PROJECT-ID>.iam.gserviceaccount.com has the IAM role Cloud SQL Client.

Next, the following command will deploy the application to your Google Cloud project:

$ gcloud beta app deploy

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!