dbconn

Documentation

Index

• func GetDataType(ctx context.Context, inConn Conn, oid oid.Oid) (*pgtype.Type, error)
• func RegisterTelemetry(conns OrderedConns) error
• type Config
• type Conn
  • func Connect(ctx context.Context, preferredID ID, connStr string) (Conn, error)
  • func TestOnlyCleanDatabase(ctx context.Context, id ID, url string, dbName string) (Conn, error)
• type FakeConn
  • func MakeFakeConn(id ID) FakeConn
  • func (f FakeConn) Clone(ctx context.Context) (Conn, error)
  • func (f FakeConn) Close(ctx context.Context) error
  • func (f FakeConn) ConnStr() string
  • func (f FakeConn) Database() tree.Name
  • func (f FakeConn) Dialect() string
  • func (f FakeConn) ID() ID
  • func (f FakeConn) IsCockroach() bool
  • func (f FakeConn) TypeMap() *pgtype.Map
• type ID
• type MySQLConn
  • func ConnectMySQL(ctx context.Context, id ID, connStr string) (*MySQLConn, error)
  • func (c *MySQLConn) Clone(ctx context.Context) (Conn, error)
  • func (c *MySQLConn) Close(ctx context.Context) error
  • func (c *MySQLConn) ConnStr() string
  • func (c *MySQLConn) Database() tree.Name
  • func (c *MySQLConn) Dialect() string
  • func (c *MySQLConn) ID() ID
  • func (c *MySQLConn) IsCockroach() bool
  • func (c *MySQLConn) TLSMap() map[string]string
  • func (c *MySQLConn) TypeMap() *pgtype.Map
• type OracleConn
  • func ConnectOracle(ctx context.Context, id ID, connStr string) (*OracleConn, error)
  • func (c *OracleConn) Clone(ctx context.Context) (Conn, error)
  • func (c *OracleConn) Close(ctx context.Context) error
  • func (c *OracleConn) ConnStr() string
  • func (c *OracleConn) Database() tree.Name
  • func (c *OracleConn) Dialect() string
  • func (c *OracleConn) ID() ID
  • func (c *OracleConn) IsCockroach() bool
  • func (c *OracleConn) TypeMap() *pgtype.Map
• type OrderedConns
• type PGConn
  • func ConnectPG(ctx context.Context, id ID, connStr string) (*PGConn, error)
  • func ConnectPGConfig(ctx context.Context, id ID, cfg *pgx.ConnConfig, testOnly bool) (*PGConn, error)
  • func (c *PGConn) CheckIfAfterVersion(ctx context.Context, version string) (bool, error)
  • func (c *PGConn) Clone(ctx context.Context) (Conn, error)
  • func (c *PGConn) ConnStr() string
  • func (c *PGConn) Database() tree.Name
  • func (c *PGConn) Dialect() string
  • func (c *PGConn) ID() ID
  • func (c *PGConn) IsCockroach() bool

Functions

func GetDataType

func GetDataType(ctx context.Context, inConn Conn, oid oid.Oid) (*pgtype.Type, error)

func RegisterTelemetry

func RegisterTelemetry(conns OrderedConns) error

Types

type Config

type Config struct {
	Source string
	Target string
}

type Conn

type Conn interface {
	ID() ID
	// Close closes the connection.
	Close(ctx context.Context) error
	// Clone creates a new Conn with the same underlying connections arguments.
	Clone(ctx context.Context) (Conn, error)
	// TypeMap returns a pgx typemap.
	TypeMap() *pgtype.Map

	IsCockroach() bool
	ConnStr() string
	Dialect() string
	Database() tree.Name
}

func Connect

func Connect(ctx context.Context, preferredID ID, connStr string) (Conn, error)

func TestOnlyCleanDatabase

func TestOnlyCleanDatabase(ctx context.Context, id ID, url string, dbName string) (Conn, error)

TestOnlyCleanDatabase returns a connection to a clean database. This is recommended for test use only

type FakeConn

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

func MakeFakeConn

func MakeFakeConn(id ID) FakeConn

func (FakeConn) Clone

func (f FakeConn) Clone(ctx context.Context) (Conn, error)

func (FakeConn) Close

func (f FakeConn) Close(ctx context.Context) error

func (FakeConn) ConnStr

func (f FakeConn) ConnStr() string

func (FakeConn) Database

func (f FakeConn) Database() tree.Name

func (FakeConn) Dialect

func (f FakeConn) Dialect() string

func (FakeConn) ID

func (f FakeConn) ID() ID

func (FakeConn) IsCockroach

func (f FakeConn) IsCockroach() bool

func (FakeConn) TypeMap

func (f FakeConn) TypeMap() *pgtype.Map

type ID

type ID string

type MySQLConn

type MySQLConn struct {
	*sql.DB
	// contains filtered or unexported fields
}

func ConnectMySQL

func ConnectMySQL(ctx context.Context, id ID, connStr string) (*MySQLConn, error)

func (*MySQLConn) Clone

func (c *MySQLConn) Clone(ctx context.Context) (Conn, error)

func (*MySQLConn) Close

func (c *MySQLConn) Close(ctx context.Context) error

func (*MySQLConn) ConnStr

func (c *MySQLConn) ConnStr() string

func (*MySQLConn) Database

func (c *MySQLConn) Database() tree.Name

func (*MySQLConn) Dialect

func (c *MySQLConn) Dialect() string

func (*MySQLConn) ID

func (c *MySQLConn) ID() ID

func (*MySQLConn) IsCockroach

func (c *MySQLConn) IsCockroach() bool

func (*MySQLConn) TLSMap

func (c *MySQLConn) TLSMap() map[string]string

func (*MySQLConn) TypeMap

func (c *MySQLConn) TypeMap() *pgtype.Map

type OracleConn

type OracleConn struct {
	*sql.DB
	// contains filtered or unexported fields
}

func ConnectOracle

func ConnectOracle(ctx context.Context, id ID, connStr string) (*OracleConn, error)

func (*OracleConn) Clone

func (c *OracleConn) Clone(ctx context.Context) (Conn, error)

func (*OracleConn) Close

func (c *OracleConn) Close(ctx context.Context) error

func (*OracleConn) ConnStr

func (c *OracleConn) ConnStr() string

func (*OracleConn) Database

func (c *OracleConn) Database() tree.Name

func (*OracleConn) Dialect

func (c *OracleConn) Dialect() string

func (*OracleConn) ID

func (c *OracleConn) ID() ID

func (*OracleConn) IsCockroach

func (c *OracleConn) IsCockroach() bool

func (*OracleConn) TypeMap

func (c *OracleConn) TypeMap() *pgtype.Map

type OrderedConns

type OrderedConns [2]Conn

type PGConn

type PGConn struct {
	*pgx.Conn
	// contains filtered or unexported fields
}

func ConnectPG

func ConnectPG(ctx context.Context, id ID, connStr string) (*PGConn, error)

func ConnectPGConfig

func ConnectPGConfig(
	ctx context.Context, id ID, cfg *pgx.ConnConfig, testOnly bool,
) (*PGConn, error)

func (*PGConn) CheckIfAfterVersion

func (c *PGConn) CheckIfAfterVersion(ctx context.Context, version string) (bool, error)

func (*PGConn) Clone

func (c *PGConn) Clone(ctx context.Context) (Conn, error)

func (*PGConn) ConnStr

func (c *PGConn) ConnStr() string

func (*PGConn) Database

func (c *PGConn) Database() tree.Name

func (*PGConn) Dialect

func (c *PGConn) Dialect() string

func (*PGConn) ID

func (c *PGConn) ID() ID

func (*PGConn) IsCockroach

func (c *PGConn) IsCockroach() bool