cloudsql

Documentation

Overview

Package cloudsql supports Cloud SQL Admin API operations.

Index

• Constants
• type Instance
  • func NewInstance(instance string, client *sqladmin.Service, key *rsa.PrivateKey, ...) (*Instance, error)
  • func (i *Instance) Close()
  • func (i *Instance) ConnectInfo(ctx context.Context, ipType string) (string, *tls.Config, error)
  • func (i *Instance) ForceRefresh()
  • func (i *Instance) InstanceEngineVersion(ctx context.Context) (string, error)
  • func (i *Instance) String() string

Constants

const (
	PublicIP  = "PUBLIC"
	PrivateIP = "PRIVATE"
)

Types

type Instance

type Instance struct {

	// OpenConns is the number of open connections to the instance.
	OpenConns uint64
	// contains filtered or unexported fields
}

Instance manages the information used to connect to the Cloud SQL instance by periodically calling the Cloud SQL Admin API. It automatically refreshes the required information approximately 5 minutes before the previous certificate expires (every 55 minutes).

func NewInstance

func NewInstance(
	instance string,
	client *sqladmin.Service,
	key *rsa.PrivateKey,
	refreshTimeout time.Duration,
	ts oauth2.TokenSource,
	dialerID string,
) (*Instance, error)

NewInstance initializes a new Instance given an instance connection name

func (*Instance) Close

func (i *Instance) Close()

Close closes the instance; it stops the refresh cycle and prevents it from making additional calls to the Cloud SQL Admin API.

func (*Instance) ConnectInfo

func (i *Instance) ConnectInfo(ctx context.Context, ipType string) (string, *tls.Config, error)

ConnectInfo returns an IP address specified by ipType (i.e., public or private) and a TLS config that can be used to connect to a Cloud SQL instance.

func (*Instance) ForceRefresh

func (i *Instance) ForceRefresh()

ForceRefresh triggers an immediate refresh operation to be scheduled and used for future connection attempts.

func (*Instance) InstanceEngineVersion

func (i *Instance) InstanceEngineVersion(ctx context.Context) (string, error)

InstanceEngineVersion returns the engine type and version for the instance. The value coresponds to one of the following types for the instance: https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1beta4/SqlDatabaseVersion

func (*Instance) String

func (i *Instance) String() string

String returns the instance's connection name.