package instance

import "cloud.google.com/go/cloudsqlconn/instance"

Index ¶

• type ConnName
• func ParseConnName(cn string) (ConnName, error)
• func ParseConnNameWithDomainName(cn string, dn string) (ConnName, error)
• func (c *ConnName) DomainName() string
• func (c *ConnName) HasDomainName() bool
• func (c *ConnName) Name() string
• func (c *ConnName) Project() string
• func (c *ConnName) Region() string
• func (c *ConnName) String() string
• type ConnectionNameResolver

Types ¶

type ConnName ¶

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

ConnName represents the "instance connection name", in the format "project:region:name".

func ParseConnName ¶

func ParseConnName(cn string) (ConnName, error)

ParseConnName initializes a new ConnName struct.

func ParseConnNameWithDomainName ¶

func ParseConnNameWithDomainName(cn string, dn string) (ConnName, error)

ParseConnNameWithDomainName initializes a new ConnName struct, also setting the domain name.

func (*ConnName) DomainName ¶

func (c *ConnName) DomainName() string

DomainName returns the domain name for this instance

func (*ConnName) HasDomainName ¶

func (c *ConnName) HasDomainName() bool

HasDomainName returns the Cloud SQL domain name

func (*ConnName) Name ¶

func (c *ConnName) Name() string

Name returns the Cloud SQL instance name

func (*ConnName) Project ¶

func (c *ConnName) Project() string

Project returns the project within which the Cloud SQL instance runs.

func (*ConnName) Region ¶

func (c *ConnName) Region() string

Region returns the region where the Cloud SQL instance runs.

func (*ConnName) String ¶

func (c *ConnName) String() string

type ConnectionNameResolver ¶

type ConnectionNameResolver interface {
	// Resolve accepts a name, and returns a ConnName with the instance
	// connection string for the name. If the name cannot be resolved, returns
	// an error.
	Resolve(ctx context.Context, name string) (ConnName, error)
}

ConnectionNameResolver resolves the connection name string into a valid instance name. This allows an application to replace the default resolver with a custom implementation.

Source Files ¶

conn_name.go