Documentation
¶
Overview ¶
Package awspostgres provides connections to AWS RDS PostgreSQL instances.
URLs ¶
For postgres.Open, awspostgres registers for the scheme "awspostgres". The default URL opener will create a connection using the default credentials from the environment, as described in https://docs.aws.amazon.com/sdk-for-go/api/aws/session/. To customize the URL opener, or for more details on the URL format, see URLOpener.
See https://gocloud.dev/concepts/urls/ for background information.
Example ¶
package main
import (
"context"
"log"
"github.com/hy9be/gocloud/postgres"
_ "github.com/hy9be/gocloud/postgres/awspostgres"
)
func main() {
// PRAGMA: This example is used on gocloud.dev; PRAGMA comments adjust how it is shown and can be ignored.
// PRAGMA: On gocloud.dev, add a blank import: _ "github.com/hy9be/gocloud/postgres/awspostgres"
// PRAGMA: On gocloud.dev, hide lines until the next blank line.
ctx := context.Background()
// Replace these with your actual settings.
db, err := postgres.Open(ctx,
"awspostgres://myrole:swordfish@example01.xyzzy.us-west-1.rds.amazonaws.com/testdb")
if err != nil {
log.Fatal(err)
}
defer db.Close()
// Use database in your program.
db.ExecContext(ctx, "CREATE TABLE foo (bar INT);")
}
Index ¶
Examples ¶
Constants ¶
View Source
const Scheme = "awspostgres"
Scheme is the URL scheme awspostgres registers its URLOpener under on postgres.DefaultMux.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type URLOpener ¶
type URLOpener struct {
// CertSource specifies how the opener will obtain the RDS Certificate
// Authority. If nil, it will use the default *rds.CertFetcher.
CertSource rds.CertPoolProvider
// TraceOpts contains options for OpenCensus.
TraceOpts []ocsql.TraceOption
}
URLOpener opens RDS PostgreSQL URLs like "awspostgres://user:password@myinstance.borkxyzzy.us-west-1.rds.amazonaws.com:5432/mydb".
Source Files
Click to show internal directories.
Click to hide internal directories.