Overview ▹

Overview ▾

Package cloudsqlconn provides functions for authorizing and encrypting connections. These functions can be used with a database driver to connect to a Cloud SQL instance.

The instance connection name for a Cloud SQL instance is always in the format "project:region:instance".

Creating a Dialer

To start working with this package, create a Dialer. There are two ways of creating a Dialer, which one you use depends on your database driver.

Postgres

Postgres users have the option of using the database/sql interface or using pgx directly.

To use a dialer with pgx, we recommend using connection pooling with pgxpool. To create the dialer use the NewDialer func.

import (
    "context"
    "net"

    "cloud.google.com/go/cloudsqlconn"
    "github.com/jackc/pgx/v4/pgxpool"
)

func connect() {
    // Configure the driver to connect to the database
    dsn := "user=myuser password=mypass dbname=mydb sslmode=disable"
    config, err := pgxpool.ParseConfig(dsn)
    if err != nil {
	    // handle error
    }

    // Create a new dialer with any options
    d, err := cloudsqlconn.NewDialer(context.Background())
    if err != nil {
	    // handle error
    }

    // Tell the driver to use the Cloud SQL Go Connector to create connections
    config.ConnConfig.DialFunc = func(ctx context.Context, _ string, instance string) (net.Conn, error) {
	    return d.Dial(ctx, "project:region:instance")
    }

    // Interact with the driver directly as you normally would
    conn, err := pgxpool.ConnectConfig(context.Background(), config)
    if err != nil {
	    // handle error
    }

    // call cleanup when you're done with the database connection
    cleanup := func() error { return d.Close() }
    // ... etc
}

To use database/sql, call pgxv4.RegisterDriver with any necessary Dialer configuration.

Note: the connection string must use the keyword/value format with host set to the instance connection name. The returned cleanup func will stop the dialer's background refresh goroutine and so should only be called when you're done with the Dialer.

import (
    "database/sql"

    "cloud.google.com/go/cloudsqlconn"
    "cloud.google.com/go/cloudsqlconn/postgres/pgxv4"
)

func connect() {
    // adjust options as needed
    cleanup, err := pgxv4.RegisterDriver("cloudsql-postgres", cloudsqlconn.WithIAMAuthN())
    if err != nil {
    	// ... handle error
    }
    // call cleanup when you're done with the database connection
    defer cleanup()

    db, err := sql.Open(
        "cloudsql-postgres",
        "host=project:region:instance user=myuser password=mypass dbname=mydb sslmode=disable",
    )
    // ... etc
}

MySQL

MySQL users should use database/sql. Use mysql.RegisterDriver with any necessary Dialer configuration.

Note: The returned cleanup func will stop the dialer's background refresh goroutine and should only be called when you're done with the Dialer.

import (
    "database/sql"

    "cloud.google.com/go/cloudsqlconn"
    "cloud.google.com/go/cloudsqlconn/mysql/mysql"
)

func connect() {
    // adjust options as needed
    cleanup, err := mysql.RegisterDriver("cloudsql-mysql", cloudsqlconn.WithIAMAuthN())
    if err != nil {
        // ... handle error
    }
    // call cleanup when you're done with the database connection
    defer cleanup()

    db, err := sql.Open(
        "cloudsql-mysql",
        "myuser:mypass@cloudsql-mysql(project:region:instance)/mydb",
    )
    // ... etc
}

SQL Server

SQL Server users should use database/sql. Use mssql.RegisterDriver with any necessary Dialer configuration.

Note: The returned cleanup func will stop the dialer's background refresh goroutine and should only be called when you're done with the Dialer.

import (
    "database/sql"

    "cloud.google.com/go/cloudsqlconn"
    "cloud.google.com/go/cloudsqlconn/sqlserver/mssql"
)

func connect() {
    cleanup, err := mssql.RegisterDriver("cloudsql-sqlserver")
    if err != nil {
        // ... handle error
    }
    // call cleanup when you're done with the database connection
    defer cleanup()

    db, err := sql.Open(
        "cloudsql-sqlserver",
        "sqlserver://user:password@localhost?database=mydb&cloudsql=project:region:instance",
    )
    // ... etc
}

Name	Synopsis
..
debug
errtype	Package errtype provides a number of concrete types which are used by the cloudsqlconn package.
instance
mysql
mysql	Package mysql provides a Cloud SQL MySQL driver that uses go-sql-driver/mysql and works with database/sql
postgres
pgxv4	Package pgxv4 provides a Cloud SQL Postgres driver that uses pgx v4 and works with the database/sql package.
pgxv5	Package pgxv5 provides a Cloud SQL Postgres driver that uses pgx v5 and works with the database/sql package.
sqlserver
mssql	Package mssql provides a Cloud SQL SQL Server driver that works with the database/sql package.

Package cloudsqlconn

Overview ▹

Overview ▾

Creating a Dialer

Postgres

MySQL

SQL Server

Index ▹

Index ▾

Package files

Variables

type DialOption ¶

func DialOptions ¶

func WithAutoIP ¶

func WithDialIAMAuthN ¶

func WithOneOffDialFunc ¶

func WithPSC ¶

func WithPrivateIP ¶

func WithPublicIP ¶

func WithTCPKeepAlive ¶

type Dialer ¶

func NewDialer ¶

func (*Dialer) Close ¶

func (*Dialer) Dial ¶

func (*Dialer) EngineVersion ¶

func (*Dialer) Warmup ¶

type Option ¶

func WithAdminAPIEndpoint ¶

func WithContextDebugLogger ¶

func WithCredentialsFile ¶

func WithCredentialsJSON ¶

func WithDebugLogger ¶

func WithDefaultDialOptions ¶

func WithDialFunc ¶

func WithHTTPClient ¶

func WithIAMAuthN ¶

func WithIAMAuthNTokenSources ¶

func WithLazyRefresh ¶

func WithOptions ¶

func WithQuotaProject ¶

func WithRSAKey ¶

func WithRefreshTimeout ¶

func WithTokenSource ¶

func WithUniverseDomain ¶

func WithUserAgent ¶

Subdirectories