Package alloydbconn provides functions for authorizing and encrypting connections. These functions can be used with a database driver to connect to an AlloyDB cluster.
Creating a Dialer
To start working with this package, create a Dialer. There are two ways of creating a Dialer, which one you use depends on your database driver.
Users have the option of using the database/sql interface or using pgx directly.
To use a dialer with pgx , we recommend using connection pooling with pgxpool . To create the dialer use the NewDialer func.
import ( "context" "net" "cloud.google.com/go/alloydbconn" "github.com/jackc/pgx/v4/pgxpool" ) func connect () { // Configure the driver to connect to the database dsn := fmt . Sprintf ( "user=%s password=%s dbname=%s sslmode=disable" , pgUser , pgPass , pgDB ) config , err := pgxpool . ParseConfig ( dsn ) if err != nil { log . Fatalf ( "failed to parse pgx config: %v" , err ) } // Create a new dialer with any options d , err := alloydbconn . NewDialer ( ctx ) if err != nil { log . Fatalf ( "failed to initialize dialer: %v" , err ) } defer d . Close () // Tell the driver to use the AlloyDB Go Connector to create connections config . ConnConfig . DialFunc = func ( ctx context . Context , _ string , instance string ) ( net . Conn , error ) { return d . Dial ( ctx , "projects/<PROJECT>/locations/<REGION>/clusters/<CLUSTER>/instances/<INSTANCE>" ) } // Interact with the driver directly as you normally would conn , err := pgxpool . ConnectConfig ( context . Background (), config ) if err != nil { log . Fatalf ( "failed to connect: %v" , connErr ) } defer conn . Close () }
To use database/sql , call pgxv4.RegisterDriver with any necessary Dialer configuration.
import ( "database/sql" "cloud.google.com/go/alloydbconn" "cloud.google.com/go/alloydbconn/driver/pgxv4" ) func connect () { // adjust options as needed cleanup , err := pgxv4 . RegisterDriver ( "alloydb" ) if err != nil { // ... handle error } defer cleanup () db , err := sql . Open ( "alloydb" , "host=projects/<PROJECT>/locations/<REGION>/clusters/<CLUSTER>/instances/<INSTANCE> user=myuser password=mypass dbname=mydb sslmode=disable" , ) //... etc }
Constants
CloudPlatformScope
const
CloudPlatformScope
=
"https://www.googleapis.com/auth/cloud-platform"
CloudPlatformScope is the default OAuth2 scope set on the API client.
DialOption
type
DialOption
func
(
d
*
dialCfg
)
A DialOption is an option for configuring how a Dialer's Dial call is executed.
func DialOptions
func
DialOptions
(
opts
...
DialOption
)
DialOption
DialOptions turns a list of DialOption instances into an DialOption.
func WithTCPKeepAlive
func
WithTCPKeepAlive
(
d
time
.
Duration
)
DialOption
WithTCPKeepAlive returns a DialOption that specifies the tcp keep alive period for the connection returned by Dial.
Dialer
type
Dialer
struct
{
// contains filtered or unexported fields
}
A Dialer is used to create connections to AlloyDB instance.
Use NewDialer to initialize a Dialer.
func NewDialer
NewDialer creates a new Dialer.
Initial calls to NewDialer make take longer than normal because generation of an RSA keypair is performed. Calls with a WithRSAKeyPair DialOption or after a default RSA keypair is generated will be faster.
func (*Dialer) Close
Close closes the Dialer; it prevents the Dialer from refreshing the information needed to connect. Additional dial operations may succeed until the information expires.
func (*Dialer) Dial
func
(
d
*
Dialer
)
Dial
(
ctx
context
.
Context
,
instance
string
,
opts
...
DialOption
)
(
conn
net
.
Conn
,
err
error
)
Dial returns a net.Conn connected to the specified AlloyDB instance. The instance argument must be the instance's URI, which is in the format projects/
Option
type
Option
func
(
d
*
dialerConfig
)
An Option is an option for configuring a Dialer.
func WithAdminAPIEndpoint
WithAdminAPIEndpoint configures the underlying AlloyDB Admin API client to use the provided URL.
func WithCredentialsFile
WithCredentialsFile returns an Option that specifies a service account or refresh token JSON credentials file to be used as the basis for authentication.
func WithCredentialsJSON
WithCredentialsJSON returns an Option that specifies a service account or refresh token JSON credentials to be used as the basis for authentication.
func WithDefaultDialOptions
func
WithDefaultDialOptions
(
opts
...
DialOption
)
Option
WithDefaultDialOptions returns an Option that specifies the default DialOptions used.
func WithDialFunc
func
WithDialFunc
(
dial
func
(
ctx
context
.
Context
,
network
,
addr
string
)
(
net
.
Conn
,
error
))
Option
WithDialFunc configures the function used to connect to the address on the named network. This option is generally unnecessary except for advanced use-cases.
func WithHTTPClient
WithHTTPClient configures the underlying AlloyDB Admin API client with the provided HTTP client. This option is generally unnecessary except for advanced use-cases.
func WithOptions
WithOptions turns a list of Option's into a single Option.
func WithRSAKey
func
WithRSAKey
(
k
*
rsa
.
PrivateKey
)
Option
WithRSAKey returns an Option that specifies a rsa.PrivateKey used to represent the client.
func WithRefreshTimeout
WithRefreshTimeout returns an Option that sets a timeout on refresh operations. Defaults to 60s.
func WithTokenSource
func
WithTokenSource
(
s
oauth2
.
TokenSource
)
Option
WithTokenSource returns an Option that specifies an OAuth2 token source to be used as the basis for authentication.
func WithUserAgent
WithUserAgent returns an Option that sets the User-Agent.
