Package cloudsqlconn contains methods for creating secure, authorized connections to a Cloud SQL instance.
DialOption
type DialOption func(d *dialCfg)A DialOption is an option for configuring how a Dialer's Dial call is executed.
func DialOptions
func DialOptions(opts ...DialOption) DialOptionDialOptions turns a list of DialOption instances into an DialOption.
func WithPrivateIP
func WithPrivateIP() DialOptionWithPrivateIP returns a DialOption that specifies a private IP (VPC) will be used to connect.
func WithPublicIP
func WithPublicIP() DialOptionWithPublicIP returns a DialOption that specifies a public IP will be used to connect.
func WithTCPKeepAlive
func WithTCPKeepAlive(d time.Duration) DialOptionWithTCPKeepAlive returns a DialOption that specifies the tcp keep alive period for the connection returned by Dial.
Dialer
type Dialer struct {
// contains filtered or unexported fields
}A Dialer is used to create connections to Cloud SQL instances.
Use NewDialer to initialize a Dialer.
func NewDialer
NewDialer creates a new Dialer.
Initial calls to NewDialer make take longer than normal because generation of an RSA keypair is performed. Calls with a WithRSAKeyPair DialOption or after a default RSA keypair is generated will be faster.
func (*Dialer) Close
Close closes the Dialer; it prevents the Dialer from refreshing the information needed to connect. Additional dial operations may succeed until the information expires.
func (*Dialer) Dial
func (d *Dialer) Dial(ctx context.Context, instance string, opts ...DialOption) (conn net.Conn, err error)Dial returns a net.Conn connected to the specified Cloud SQL instance. The instance argument must be the instance's connection name, which is in the format "project-name:region:instance-name".
func (*Dialer) EngineVersion
EngineVersion returns the engine type and version for the instance. The value will corespond to one of the following types for the instance: https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1beta4/SqlDatabaseVersion
Option
type Option func(d *dialerConfig)An Option is an option for configuring a Dialer.
func WithCredentialsFile
WithCredentialsFile returns an Option that specifies a service account or refresh token JSON credentials file to be used as the basis for authentication.
func WithCredentialsJSON
WithCredentialsJSON returns an Option that specifies a service account or refresh token JSON credentials to be used as the basis for authentication.
func WithDefaultDialOptions
func WithDefaultDialOptions(opts ...DialOption) OptionWithDefaultDialOptions returns an Option that specifies the default DialOptions used.
func WithDialFunc
WithDialFunc configures the function used to connect to the address on the named network. This option is generally unnecessary except for advanced use-cases.
func WithHTTPClient
WithHTTPClient configures the underlying SQL Admin API client with the provided HTTP client. This option is generally unnecessary except for advanced use-cases.
func WithIAMAuthN
func WithIAMAuthN() OptionWithIAMAuthN enables automatic IAM Authentication. If no token source has been configured (such as with WithTokenSource, WithCredentialsFile, etc), the dialer will use the default token source as defined by https://pkg.go.dev/golang.org/x/oauth2/google#FindDefaultCredentialsWithParams.
For documentation on automatic IAM Authentication, see https://cloud.google.com/sql/docs/postgres/authentication.
func WithOptions
WithOptions turns a list of Option's into a single Option.
func WithRSAKey
func WithRSAKey(k *rsa.PrivateKey) OptionWithRSAKey returns an Option that specifies a rsa.PrivateKey used to represent the client.
func WithRefreshTimeout
WithRefreshTimeout returns an Option that sets a timeout on refresh operations. Defaults to 30s.
func WithTokenSource
func WithTokenSource(s oauth2.TokenSource) OptionWithTokenSource returns an Option that specifies an OAuth2 token source to be used as the basis for authentication.