cloudmysql

Documentation

Overview

Package cloudmysql provides connections to managed MySQL Cloud SQL instances.

Example

package main

import (
	"context"

	"github.com/Lioric/go-cloud/gcp"
	"github.com/Lioric/go-cloud/mysql/cloudmysql"
	"golang.org/x/oauth2"
	"golang.org/x/oauth2/google"
)

func main() {
	ctx := context.Background()
	creds, err := google.FindDefaultCredentials(ctx, "https://www.googleapis.com/auth/cloud-platform")
	if err != nil {
		panic(err)
	}
	authClient := gcp.HTTPClient{Client: *oauth2.NewClient(ctx, creds.TokenSource)}
	db, err := cloudmysql.Open(ctx, cloudmysql.NewCertSource(&authClient), &cloudmysql.Params{
		// Replace these with your actual settings.
		ProjectID: "example-project",
		Region:    "us-central1",
		Instance:  "my-instance01",
		User:      "myrole",
		Database:  "test",
	})
	if err != nil {
		panic(err)
	}

	// Use database in your program.
	db.Exec("CREATE TABLE foo (bar INT);")
}

Index

• Variables
• func NewCertSource(c *gcp.HTTPClient) *certs.RemoteCertSource
• func Open(ctx context.Context, certSource proxy.CertSource, params *Params) (*sql.DB, error)
• type Params

Examples

• Package

Variables

var CertSourceSet = wire.NewSet(
	NewCertSource,
	wire.Bind((*proxy.CertSource)(nil), (*certs.RemoteCertSource)(nil)))

CertSourceSet is a Wire provider set that binds a Cloud SQL proxy certificate source from an GCP-authenticated HTTP client.

Functions

func NewCertSource

func NewCertSource(c *gcp.HTTPClient) *certs.RemoteCertSource

NewCertSource creates a local certificate source that uses the given HTTP client. The client is assumed to make authenticated requests.

func Open

func Open(ctx context.Context, certSource proxy.CertSource, params *Params) (*sql.DB, error)

Open opens a Cloud SQL database.

Types

type Params

type Params struct {
	ProjectID string
	Region    string
	Instance  string
	User      string
	Password  string // may be empty, see https://cloud.google.com/sql/docs/sql-proxy#user
	Database  string
}

Params specifies how to connect to a Cloud SQL database.