postgres

package
v0.24.1 Latest Latest
Warning

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

Go to latest
Published: Jan 27, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package postgres provides functions to open PostgreSQL databases with OpenCensus instrumentation.

Index

Examples

Constants

View Source
const Scheme = "postgres"

Scheme is the URL scheme this package registers its URLOpener under on DefaultMux.

Variables

This section is empty.

Functions

func Open

func Open(ctx context.Context, urlstr string) (*sql.DB, error)

Open opens the bucket identified by the URL given. URL openers must be registered in the DefaultURLMux, which is typically done in driver packages' initialization.

See the URLOpener documentation in driver subpackages for more details on supported scheme(s) and URL parameter(s).

Example
package main

import (
	"context"
	"log"

	"github.com/hy9be/gocloud/postgres"
)

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, hide lines until the next blank line.
	ctx := context.Background()

	// Replace this with your actual settings.
	db, err := postgres.Open(ctx, "postgres://user:password@localhost/testdb")
	if err != nil {
		log.Fatal(err)
	}
	defer db.Close()

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

Types

type PostgresURLOpener

type PostgresURLOpener interface {
	// OpenPostgresURL opens a Postgres connection based on the URL.
	OpenPostgresURL(ctx context.Context, u *url.URL) (*sql.DB, error)
}

PostgresURLOpener can open Postgres connections based on a URL. The opener must not modify the URL argument. OpenPostgresURL must be safe to call from multiple goroutines.

This interface is generally implemented by types in driver packages.

type URLMux

type URLMux struct {
	// contains filtered or unexported fields
}

URLMux is a URL opener multiplexer. It matches the scheme of the URLs against a set of registered schemes and calls the opener that matches the URL's scheme.

The zero value is a multiplexer with no registered schemes.

func DefaultURLMux

func DefaultURLMux() *URLMux

DefaultURLMux returns the URLMux used by OpenPostgres.

Driver packages can use this to register their PostgresURLOpener on the mux.

func (*URLMux) OpenPostgres

func (mux *URLMux) OpenPostgres(ctx context.Context, urlstr string) (*sql.DB, error)

OpenPostgres calls OpenPostgresURL with the URL parsed from urlstr. OpenPostgres is safe to call from multiple goroutines.

func (*URLMux) OpenPostgresURL

func (mux *URLMux) OpenPostgresURL(ctx context.Context, u *url.URL) (*sql.DB, error)

OpenPostgresURL dispatches the URL to the opener that is registered with the URL's scheme. OpenPostgresURL is safe to call from multiple goroutines.

func (*URLMux) RegisterPostgres

func (mux *URLMux) RegisterPostgres(scheme string, opener PostgresURLOpener)

RegisterPostgres registers the opener with the given scheme. If an opener already exists for the scheme, RegisterPostgres panics.

type URLOpener

type URLOpener struct{}

URLOpener opens URLs like "postgres://" by using the underlying PostgreSQL driver. See https://godoc.org/github.com/lib/pq#hdr-Connection_String_Parameters for details.

func (*URLOpener) OpenPostgresURL

func (*URLOpener) OpenPostgresURL(ctx context.Context, u *url.URL) (*sql.DB, error)

OpenPostgresURL opens a new database connection wrapped with OpenCensus instrumentation.

Directories

Path Synopsis
Package awspostgres provides connections to AWS RDS PostgreSQL instances.
Package awspostgres provides connections to AWS RDS PostgreSQL instances.
Package gcppostgres provides connections to managed PostgreSQL Cloud SQL instances.
Package gcppostgres provides connections to managed PostgreSQL Cloud SQL instances.

Jump to

Keyboard shortcuts

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