cmd

Documentation

Index

• func Execute()
• type Command
  • func NewCommand(opts ...Option) *Command
• type Option
  • func WithAutoIP() Option
  • func WithConnRefuseNotify(n func()) Option
  • func WithDebugLogging() Option
  • func WithDialer(d cloudsql.Dialer) Option
  • func WithFuseDir(dir string) Option
  • func WithFuseTempDir(dir string) Option
  • func WithLazyRefresh() Option
  • func WithLogger(l cloudsql.Logger) Option
  • func WithMaxConnections(mc uint64) Option
  • func WithQuietLogging() Option
  • func WithUserAgent(agent string) Option

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

Types

type Command

type Command struct {
	*cobra.Command
	// contains filtered or unexported fields
}

Command represents an invocation of the Cloud SQL Auth Proxy.

func NewCommand

func NewCommand(opts ...Option) *Command

NewCommand returns a Command object representing an invocation of the proxy.

type Option

type Option func(*Command)

Option is a function that configures a Command.

func WithAutoIP

func WithAutoIP() Option

WithAutoIP enables legacy behavior of v1 and will try to connect to first IP address returned by the SQL Admin API. In most cases, this flag should not be used. Prefer default of public IP or use --private-ip instead.`

func WithConnRefuseNotify

func WithConnRefuseNotify(n func()) Option

WithConnRefuseNotify configures the Proxy to call the provided function when a connection is refused. The notification function is run in a goroutine.

func WithDebugLogging

func WithDebugLogging() Option

WithDebugLogging configures the Proxy to log debug level messages.

func WithDialer

func WithDialer(d cloudsql.Dialer) Option

WithDialer configures the Command to use the provided dialer to connect to Cloud SQL instances.

func WithFuseDir

func WithFuseDir(dir string) Option

WithFuseDir mounts a directory at the path using FUSE to access Cloud SQL instances.

func WithFuseTempDir

func WithFuseTempDir(dir string) Option

WithFuseTempDir sets the temp directory where Unix sockets are created with FUSE

func WithLazyRefresh

func WithLazyRefresh() Option

WithLazyRefresh configures the Proxy to refresh connection info on an as-needed basis when the cached copy has expired.

func WithLogger

func WithLogger(l cloudsql.Logger) Option

WithLogger overrides the default logger.

func WithMaxConnections

func WithMaxConnections(mc uint64) Option

WithMaxConnections sets the maximum allowed number of connections. Default is no limit.

func WithQuietLogging

func WithQuietLogging() Option

WithQuietLogging configures the Proxy to log error messages only.

func WithUserAgent

func WithUserAgent(agent string) Option

WithUserAgent sets additional user agents for Admin API tracking and should be a space separated list of additional user agents, e.g. cloud-sql-proxy-operator/0.0.1,other-agent/1.0.0