Client libraries and sample code for Cloud SQL

The Cloud SQL Admin API is built on HTTP and JSON, so any standard HTTP client can send requests to it and parse the responses. However, instead of creating HTTP requests and parsing responses manually, you may want to use the Google APIs client libraries. The client libraries provide better language integration, improved security, and support for making calls that require user authorization.

客户端库可以使用应用默认凭据轻松进行 Google API 身份验证,并向这些 API 发送请求。借助应用默认凭据,您可以在本地测试应用并部署它,无需更改底层代码。如需了解详情(包括代码示例),请参阅 Google Cloud Platform 身份验证指南

Application Default Credentials are part of the client libraries you can use to access Cloud SQL. Default credentials identify your application with either a user credential or a default service account. When working with a library, it's typical to choose credentials based on the type of environment where you run code. For example, in a development environment, you can authenticate with the gcloud auth command and the client libraries will use those credentials. For more information about environments, see Authentication overview in the Google Cloud Platform Auth Guide.

Accessing the service

Depending on the Cloud SQL Admin API client library you use, you may need to configure how the library discovers the default service path. For client libraries that use the Google APIs Discovery Service, use the API name sqladmin to build a client. This includes libraries for Python and JavaScript.

The following code snippets show how to create a client and list Cloud SQL instances in a project.

Go

For the Client Library for Go, import the sqladmin package.


func ListInstances(projectId string) ([]*sqladmin.DatabaseInstance, error) {
	ctx := context.Background()

	// Create an http.Client that uses Application Default Credentials.
	hc, err := google.DefaultClient(ctx, sqladmin.SqlserviceAdminScope)
	if err != nil {
		return nil, err
	}

	// Create the Google Cloud SQL service.
	service, err := sqladmin.New(hc)
	if err != nil {
		return nil, err
	}

	// List instances for the project ID.
	instances, err := service.Instances.List(projectId).Do()
	if err != nil {
		return nil, err
	}
	return instances.Items, nil
}

Java

For the Client Library for Java, you can optionally specify the service path directly.

// Set up global SQLAdmin instance.
client = new SQLAdmin.Builder(httpTransport, JSON_FACTORY, credential)
    .setServicePath("sql/v1beta4/")
    .setApplicationName(APPLICATION_NAME).build();
InstancesListResponse resp = client.instances().list("PROJECT_ID").execute();
List<DatabaseInstance> list = resp.getItems();
for (DatabaseInstance d : list) {
    System.out.println(d.getName());
}

JavaScript

For the Client Library for JavaScript, specify sqladmin to build a client.

gapi.client.load('sqladmin', 'v1beta4', function() { console.log('loaded');});
gapi.client.sql.instances.list({'project': PROJECT_ID}).execute(showResult);
function showResult(result) {
  // Process the result.
};

Python

For the Client Library for Python, specify sqladmin to build a client.

# Construct the service object for the interacting with the Cloud SQL Admin API.
service = discovery.build('sqladmin', 'v1beta4', http=http)

req = service.instances().list(project="PROJECT_ID")
resp = req.execute()
print json.dumps(resp, indent=2)

The service object queries the discovery document and use the correct service path, in this case, "sql/v1beta4/projects/".

If you are looking for code samples that show how applications can connect to Cloud SQL, see the Connecting overview page.

Libraries and sample code

Language Documentation
Dart Google API Client Library
Go Google API Client Library
Sample code: Cloud SQL Auth proxy
Java Google API Client Library
Google Client Developer's Guide
Sample code: Cloud SQL Java connector
JavaScript Google API Client Library
.NET Google API Client Library
Google Client Developer's Guide
Node.js Google API Client Library
Objective-C Google API Client Library
PHP Google API Client Library
Python Google API Client Library
Google Client Developer's Guide
Cloud SQL Python connector
Sample code: MySQL, PostgreSQL, SQL Server
Ruby Google API Client Library