2f7465c294
this will allow us to inspect the type of `db.Driver()` on *sql.DB connections to correctly differentiate between pg and crdb conns. as a bonus, this moves all concerns about when to replace "cockroach://" with "postgres://" out of view, letting the thin shim "driver" take care of that. Change-Id: Ib24103ab7c508231e681f89a7321b623e4e125e9
70 lines
1.8 KiB
Go
70 lines
1.8 KiB
Go
// Copyright (C) 2019 Storj Labs, Inc.
|
|
// See LICENSE for copying information.
|
|
|
|
package cockroachutil
|
|
|
|
import (
|
|
"database/sql"
|
|
"database/sql/driver"
|
|
"strings"
|
|
|
|
"github.com/lib/pq"
|
|
)
|
|
|
|
// Driver is the type for the "cockroach" sql/database driver.
|
|
// It uses github.com/lib/pq under the covers because of Cockroach's
|
|
// PostgreSQL compatibility, but allows differentiation between pg and
|
|
// crdb connections.
|
|
type Driver struct {
|
|
pq.Driver
|
|
}
|
|
|
|
// Open opens a new cockroachDB connection.
|
|
func (cd *Driver) Open(name string) (driver.Conn, error) {
|
|
return Open(name)
|
|
}
|
|
|
|
// Open opens a new cockroachDB connection.
|
|
func Open(name string) (driver.Conn, error) {
|
|
name = TranslateName(name)
|
|
return pq.Open(name)
|
|
}
|
|
|
|
// OpenConnector obtains a new db Connector, which sql.DB can use to
|
|
// obtain each needed connection at the appropriate time.
|
|
func (cd *Driver) OpenConnector(name string) (driver.Connector, error) {
|
|
name = TranslateName(name)
|
|
pgConnector, err := pq.NewConnector(name)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &Connector{pgConnector}, nil
|
|
}
|
|
|
|
// TranslateName changes the scheme name in a `cockroach://` URL to
|
|
// `postgres://`, as that is what lib/pq will expect.
|
|
func TranslateName(name string) string {
|
|
if strings.HasPrefix(name, "cockroach://") {
|
|
name = "postgres://" + name[12:]
|
|
}
|
|
return name
|
|
}
|
|
|
|
// Connector is a thin wrapper around a pq-based connector. This allows
|
|
// Driver to satisfy driver.DriverContext, and avoids weird breakage if
|
|
// and when we upgrade from pq 1.0 to pq 1.2 or higher.
|
|
type Connector struct {
|
|
driver.Connector
|
|
}
|
|
|
|
// Driver returns the driver being used for this connector.
|
|
func (conn *Connector) Driver() driver.Driver {
|
|
return &Driver{}
|
|
}
|
|
|
|
var _ driver.DriverContext = &Driver{}
|
|
|
|
func init() {
|
|
sql.Register("cockroach", &Driver{})
|
|
}
|