README
¶
Cloud SQL proxy dialer for Go
Note
This package is deprecated. Instead use the Cloud SQL Go Connector which has support for MySQL, Postgres, and SQL Server, in addition to better configurability, support for metrics and tracing, and a number of additional features. See the migration guide for how to switch.
Overview
You can also use the Cloud SQL proxy directly from a Go program.
These packages are primarily used as implementation for the Cloud SQL proxy command, and may be changed in backwards incompatible ways in the future.
Usage
If your program is written in Go you can use the Cloud SQL Proxy as a library, avoiding the need to start the Proxy as a companion process.
Alternatively, there are Cloud SQL Connectors for Java and Python.
MySQL
If you're using the MySQL go-sql-driver you can use helper
functions found in the proxy/dialers/mysql
See example usage.
Postgres
If you're using the Postgres lib/pq, you can
use the cloudsqlpostgres driver from here.
See example usage.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package certs implements a CertSource which speaks to the public Cloud SQL API endpoint.
|
Package certs implements a CertSource which speaks to the public Cloud SQL API endpoint. |
|
dialers
|
|
|
mysql
Package mysql adds a 'cloudsql' network to use when you want to access a Cloud SQL Database via the mysql driver found at github.com/go-sql-driver/mysql.
|
Package mysql adds a 'cloudsql' network to use when you want to access a Cloud SQL Database via the mysql driver found at github.com/go-sql-driver/mysql. |
|
postgres
Package postgres adds a 'cloudsqlpostgres' driver to use when you want to access a Cloud SQL Database via the go database/sql library.
|
Package postgres adds a 'cloudsqlpostgres' driver to use when you want to access a Cloud SQL Database via the go database/sql library. |
|
Package fuse provides a connection source wherein the user does not need to specify which instance they are connecting to before they start the executable.
|
Package fuse provides a connection source wherein the user does not need to specify which instance they are connecting to before they start the executable. |
|
Package limits provides routines to check and enforce certain resource limits on the Cloud SQL client proxy process.
|
Package limits provides routines to check and enforce certain resource limits on the Cloud SQL client proxy process. |
|
Package proxy implements client and server code for proxying an unsecure connection over SSL.
|
Package proxy implements client and server code for proxying an unsecure connection over SSL. |
|
Package util contains utility functions for use throughout the Cloud SQL Auth proxy.
|
Package util contains utility functions for use throughout the Cloud SQL Auth proxy. |