1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
// Copyright 2015 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// 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.
package mysql
import (
"database/sql"
"errors"
"github.com/GoogleCloudPlatform/cloudsql-proxy/proxy/proxy"
"github.com/go-sql-driver/mysql"
)
func init() {
mysql.RegisterDialContext("cloudsql", proxy.DialContext)
}
// 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).
//
// Deprecated: Dial has been replaced by the Cloud SQL Go connector which has
// better support for configuring the dialer's behavior.
// See cloud.google.com/go/cloudsqlconn/mysql/mysql.RegisterDriver instead.
func Dial(instance, user string) (*sql.DB, error) {
cfg := mysql.NewConfig()
cfg.User = user
cfg.Addr = instance
return DialCfg(cfg)
}
// 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 in the mysql.user table is 'cloudsqlproxy~'. For more
// information, see:
//
// https://cloud.google.com/sql/docs/sql-proxy#user
//
// Deprecated: DialPassword has been replaced by the Cloud SQL Go connector
// which has better support for configuring the dialer's behavior. See
// cloud.google.com/go/cloudsqlconn/mysql/mysql.RegisterDriver instead.
func DialPassword(instance, user, password string) (*sql.DB, error) {
cfg := mysql.NewConfig()
cfg.User = user
cfg.Passwd = password
cfg.Addr = instance
return DialCfg(cfg)
}
// 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.
//
// Deprecated: Cfg has been replaced by the Cloud SQL Go connector which has
// better support for configuring the dialer's behavior.
// See cloud.google.com/go/cloudsqlconn/mysql/mysql.RegisterDriver instead.
func Cfg(instance, user, password string) *mysql.Config {
cfg := mysql.NewConfig()
cfg.User = user
cfg.Passwd = password
cfg.Addr = instance
cfg.Net = "cloudsql"
return cfg
}
// 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.
//
// Deprecated: DialCfg has been replaced by the Cloud SQL Go connector which has
// better support for configuring the dialer's behavior. See
// cloud.google.com/go/cloudsqlconn/mysql/mysql.RegisterDriver instead.
func DialCfg(cfg *mysql.Config) (*sql.DB, error) {
if cfg.TLSConfig != "" {
return nil, errors.New("do not specify TLS when using the Proxy")
}
// Copy the config so that we can modify it without feeling bad.
c := *cfg
c.Net = "cloudsql"
dsn := c.FormatDSN()
db, err := sql.Open("mysql", dsn)
if err == nil {
err = db.Ping()
}
return db, err
}
|
