alloydb

Documentation

Index

• Constants
• type ConnectionInfo
• type InstanceURI
  • func ParseInstURI(cn string) (InstanceURI, error)
  • func (i *InstanceURI) String() string
  • func (i *InstanceURI) URI() string
• type LazyRefreshCache
  • func NewLazyRefreshCache(uri InstanceURI, l debug.ContextLogger, ...) *LazyRefreshCache
  • func (c *LazyRefreshCache) Close() error
  • func (c *LazyRefreshCache) ConnectionInfo(ctx context.Context) (ConnectionInfo, error)
  • func (c *LazyRefreshCache) ForceRefresh()
• type RefreshAheadCache
  • func NewRefreshAheadCache(instance InstanceURI, l debug.ContextLogger, ...) *RefreshAheadCache
  • func (i *RefreshAheadCache) Close() error
  • func (i *RefreshAheadCache) ConnectionInfo(ctx context.Context) (ConnectionInfo, error)
  • func (i *RefreshAheadCache) ForceRefresh()
• type StaticConnectionInfoCache
  • func NewStaticConnectionInfoCache(inst InstanceURI, l debug.ContextLogger, r io.Reader) (*StaticConnectionInfoCache, error)
  • func (*StaticConnectionInfoCache) Close() error
  • func (c *StaticConnectionInfoCache) ConnectionInfo(_ context.Context) (ConnectionInfo, error)
  • func (*StaticConnectionInfoCache) ForceRefresh()

Constants

const (
	// PublicIP is the value for public IP connections.
	PublicIP = "PUBLIC"
	// PrivateIP is the value for private IP connections.
	PrivateIP = "PRIVATE"
	// PSC designates PSC-based connections.
	PSC = "PSC"
)

const (

	// RefreshTimeout is the maximum amount of time to wait for a refresh
	// cycle to complete. This value should be greater than the
	// refreshInterval.
	RefreshTimeout = 60 * time.Second
)

Types

type ConnectionInfo

type ConnectionInfo struct {
	Instance   InstanceURI
	IPAddrs    map[string]string
	ClientCert tls.Certificate
	RootCAs    *x509.CertPool
	Expiration time.Time
}

ConnectionInfo holds all the data necessary to connect to an instance.

type InstanceURI

type InstanceURI struct {
	// contains filtered or unexported fields
}

InstanceURI represents an AlloyDB instance.

func ParseInstURI

func ParseInstURI(cn string) (InstanceURI, error)

ParseInstURI initializes a new InstanceURI struct.

func (*InstanceURI) String

func (i *InstanceURI) String() string

String returns a short-hand representation of an instance URI.

func (*InstanceURI) URI

func (i *InstanceURI) URI() string

URI returns the full URI specifying an instance.

type LazyRefreshCache

type LazyRefreshCache struct {
	// contains filtered or unexported fields
}

LazyRefreshCache is caches connection info and refreshes the cache only when a caller requests connection info and the current certificate is expired.

func NewLazyRefreshCache

func NewLazyRefreshCache(
	uri InstanceURI,
	l debug.ContextLogger,
	client *alloydbadmin.AlloyDBAdminClient,
	key *rsa.PrivateKey,
	_ time.Duration,
	dialerID string,
) *LazyRefreshCache

NewLazyRefreshCache initializes a new LazyRefreshCache.

func (*LazyRefreshCache) Close

func (c *LazyRefreshCache) Close() error

Close is a no-op and provided purely for a consistent interface with other caching types.

func (*LazyRefreshCache) ConnectionInfo

func (c *LazyRefreshCache) ConnectionInfo(
	ctx context.Context,
) (ConnectionInfo, error)

ConnectionInfo returns connection info for the associated instance. New connection info is retrieved under two conditions: - the current connection info's certificate has expired, or - a caller has separately called ForceRefresh

func (*LazyRefreshCache) ForceRefresh

func (c *LazyRefreshCache) ForceRefresh()

ForceRefresh invalidates the caches and configures the next call to ConnectionInfo to retrieve a fresh connection info.

type RefreshAheadCache

type RefreshAheadCache struct {
	// contains filtered or unexported fields
}

RefreshAheadCache manages the information used to connect to the AlloyDB instance by periodically calling the AlloyDB Admin API. It automatically refreshes the required information approximately 4 minutes before the previous certificate expires (every ~56 minutes).

func NewRefreshAheadCache

func NewRefreshAheadCache(
	instance InstanceURI,
	l debug.ContextLogger,
	client *alloydbadmin.AlloyDBAdminClient,
	key *rsa.PrivateKey,
	refreshTimeout time.Duration,
	dialerID string,
) *RefreshAheadCache

NewRefreshAheadCache initializes a new cache that proactively refreshes the caches connection info.

func (*RefreshAheadCache) Close

func (i *RefreshAheadCache) Close() error

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

func (*RefreshAheadCache) ConnectionInfo

func (i *RefreshAheadCache) ConnectionInfo(ctx context.Context) (ConnectionInfo, error)

ConnectionInfo returns an IP address specified by ipType (i.e., public or private) of the AlloyDB instance.

func (*RefreshAheadCache) ForceRefresh

func (i *RefreshAheadCache) ForceRefresh()

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

type StaticConnectionInfoCache

type StaticConnectionInfoCache struct {
	// contains filtered or unexported fields
}

StaticConnectionInfoCache provides connection info that is never refreshed.

func NewStaticConnectionInfoCache

func NewStaticConnectionInfoCache(
	inst InstanceURI,
	l debug.ContextLogger,
	r io.Reader,
) (*StaticConnectionInfoCache, error)

NewStaticConnectionInfoCache creates a connection info cache that will always return the predefined connection info within the provided io.Reader

func (*StaticConnectionInfoCache) Close

func (*StaticConnectionInfoCache) Close() error

Close is a no-op.

func (*StaticConnectionInfoCache) ConnectionInfo

func (c *StaticConnectionInfoCache) ConnectionInfo(
	_ context.Context,
) (ConnectionInfo, error)

ConnectionInfo returns the connection info for the specified instance URI as loaded from the provided io.Reader.

func (*StaticConnectionInfoCache) ForceRefresh

func (*StaticConnectionInfoCache) ForceRefresh()

ForceRefresh is a no-op as the cache holds only static connection information and does no refresh.