var DefaultTimezone = "Canada/Newfoundland"

funcDumpOnFailure¶added inv2.2.0

func DumpOnFailure(ttesting.TB, connectionURLstring)

DumpOnFailure exports the database referenced by connectionURL to a filecorresponding to the current test, with a suffix indicating the time thetest was run.To import this into a new database (assuming you have already run make test-postgres-docker):

• Create a new test database:go run ./scripts/migrate-ci/main.go and note the database name it outputs
• Import the file into the above database:psql 'postgres://postgres:postgres@127.0.0.1:5432/<dbname>?sslmode=disable' -f <path to file.test.sql>
• Run a dev server against that database:./scripts/coder-dev.sh server --postgres-url='postgres://postgres:postgres@127.0.0.1:5432/<dbname>?sslmode=disable'

funcNewDB¶

func NewDB(ttesting.TB, opts ...Option) (database.Store,pubsub.Pubsub)

funcNewDBWithSQLDB¶added inv2.3.1

func NewDBWithSQLDB(ttesting.TB, opts ...Option) (database.Store,pubsub.Pubsub, *sql.DB)

funcNowInDefaultTimezone¶added inv2.19.0

func NowInDefaultTimezone()time.Time

NowInDefaultTimezone returns the current time rounded to the nearest microsecond in the default timezoneused by postgres in tests. Useful for object equality checks.

funcOpen¶added inv2.10.0

func Open(tTBSubset, opts ...OpenOption) (string,error)

Open creates a new PostgreSQL database instance.If there's a database running at localhost:5432, it will use that.Otherwise, it will start a new postgres container.

funcOpenContainerized¶added inv2.10.0

func OpenContainerized(tTBSubset, optsDBContainerOptions) (string, func(),error)

OpenContainerized creates a new PostgreSQL server using a Docker container. If port is nonzero, forward host trafficto that port to the database. If port is zero, allocate a free port from the OS.The user is responsible for calling the returned cleanup function.

funcPGDump¶added inv2.11.0

func PGDump(dbURLstring) ([]byte,error)

PGDump runs pg_dump against dbURL and returns the output.It is used by DumpOnFailure().

funcPGDumpSchemaOnly¶added inv2.11.0

func PGDumpSchemaOnly(dbURLstring) ([]byte,error)

PGDumpSchemaOnly is for use by gen/dump only.It runs pg_dump against dbURL and sets a consistent timezone and encoding.

funcWillUsePostgres¶

func WillUsePostgres()bool

WillUsePostgres returns true if a call to NewDB() will return a real, postgres-backed Store and Pubsub.

typeConnectionParams¶added inv2.18.0

type ConnectionParams struct {UsernamestringPasswordstringHoststringPortstringDBNamestring}

func (pConnectionParams) DSN()string

typeConnector¶added inv2.15.0

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

func (c *Connector) Connect(_context.Context) (driver.Conn,error)

func (c *Connector) Dialer(dialerpq.Dialer)

func (c *Connector) Driver()driver.Driver

typeDBContainerOptions¶added inv2.18.0

type DBContainerOptions struct {PortintNamestring}

typeDBTx¶added inv2.17.0

type DBTx struct {database.Store// contains filtered or unexported fields}

func StartTx(t *testing.T, dbdatabase.Store, opts *database.TxOptions) *DBTx

a := StartTx(t, db, opts)b := StartTx(t, db, opts)a.GetUsers(...)b.GetUsers(...)require.NoError(t, a.Done()

func (tx *DBTx) Done()error

typeDriver¶added inv2.15.0

type Driver struct {Connections chandriver.Conn}

func NewDriver() *Driver

func (d *Driver) Close()

func (d *Driver) Connector(namestring) (driver.Connector,error)

func (d *Driver) Open(namestring) (driver.Conn,error)

typeOpenOption¶added inv2.18.0

type OpenOption func(*OpenOptions)

func WithDBFrom(dbFromstring)OpenOption

typeOpenOptions¶added inv2.18.0

type OpenOptions struct {DBFrom *string}

typeOption¶added inv2.2.0

type Option func(*options)

func WithDumpOnFailure()Option

func WithLogger(loggerslog.Logger)Option

func WithTimezone(tzstring)Option

func WithURL(ustring)Option

typeTBSubset¶added inv2.18.0

type TBSubset interface {Cleanup(func())Helper()Logf(formatstring, args ...any)}

TBSubset is a subset of the testing.TB interface.It allows to use dbtestutil.Open outside of tests.