mysql

package
v0.0.0-...-9dd433b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 27, 2016 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package mysql adds a 'cloudsql' network to use when you want to access a Cloud SQL Database via the mysql driver found at github.com/go-sql-driver/mysql. It also exposes helper functions for dialing.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Cfg

func Cfg(instance, user, password string) *mysql.Config

Cfg returns the effective *mysql.Config to represent connectivity to the provided instance via the given user and password. The config can be modified and passed to DialCfg to connect. If you don't modify the returned config before dialing, consider using Dial or DialPassword.

func Dial

func Dial(instance, user string) (*sql.DB, error)

Dial logs into the specified Cloud SQL Instance using the given user and no password. To set more options, consider calling DialCfg instead.

The provided instance should be in the form project-name:region:instance-name.

The returned *sql.DB may be valid even if there's also an error returned (e.g. if there was a transient connection error).

func DialCfg

func DialCfg(cfg *mysql.Config) (*sql.DB, error)

DialCfg opens up a SQL connection to a Cloud SQL Instance specified by the provided configuration. It is otherwise the same as Dial.

The cfg.Addr should be the instance's connection string, in the format of:

project-name:region:instance-name.

func DialPassword

func DialPassword(instance, user, password string) (*sql.DB, error)

DialPassword is similar to Dial, but allows you to specify a password.

Note that using a password with the proxy is not necessary as long as the user's hostname is 'cloudsqlproxy~'. For more information, see:

https://cloud.google.com/sql/docs/sql-proxy#user

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL