pgx

package

v2.1.1+incompatible Latest Latest Go to latest Published: Jan 27, 2020 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/acls/migrate

Links

Open Source Insights

Documentation ¶

Overview ¶

Package pgx implements the Driver interface.

Index ¶

func Conn(c *pgx.Conn) driver.CopyConn
func New(tableName string) driver.DumpDriver
func WithTransaction(tx driver.Tx, fn func() error) (err error)
type MigratableDatabase
type Row
- func (r Row) Columns() ([]string, error)
- func (r Row) Scan(dest ...interface{}) (err error)
type Rows
- func (r Rows) Columns() ([]string, error)
type SchemaMigrator

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Conn ¶

func Conn(c *pgx.Conn) driver.CopyConn

Conn wraps a postgresql connection and returns a driver.Conn

func New ¶

func New(tableName string) driver.DumpDriver

New creates a new postgresql driver

func WithTransaction ¶

func WithTransaction(tx driver.Tx, fn func() error) (err error)

WithTransaction wraps a transaction and handles rollback and commit and recovers if there are any panics

Types ¶

type MigratableDatabase ¶

type MigratableDatabase interface {
	Pool() *pgx.ConnPool
	Schema() string
	Path() string
	Migrate() (string, error)
	Dump(file.DumpWriter) error
	Restore(file.DumpReader) error
	Revert() error
}

MigratableDatabase interface

type Row ¶

type Row struct {
	*pgx.Row
}

Row wraps *pgx.Row which is a convenience wrapper over *pgx.Rows

func (Row) Columns ¶

func (r Row) Columns() ([]string, error)

Columns returns the column names for the row.

func (Row) Scan ¶

func (r Row) Scan(dest ...interface{}) (err error)

Scan scans the data in the row into the provided input parameters.

type Rows ¶

type Rows struct {
	*pgx.Rows
}

Rows defines Columns so that sqlstruct.Scan can be used

func (Rows) Columns ¶

func (r Rows) Columns() ([]string, error)

Columns returns the column names for the rows.

type SchemaMigrator ¶

type SchemaMigrator struct {
	*pgx.ConnPool
	BaseMigrator migrate.Migrator
}

SchemaMigrator struct

func (*SchemaMigrator) Drop ¶

func (m *SchemaMigrator) Drop() error

Drop rotates the schema to _bak and creates a new schema

func (*SchemaMigrator) Dump ¶

func (m *SchemaMigrator) Dump(dw file.DumpWriter) (err error)

Dump write the database to the DumpWriter

func (*SchemaMigrator) FinishRestore ¶

func (m *SchemaMigrator) FinishRestore(migrator migrate.Migrator, schemas []string) error

FinishRestore finishes the restore by rotating the schemas

func (*SchemaMigrator) InitCopy ¶

func (m *SchemaMigrator) InitCopy(schemaSuffix string, d driver.DumpDriver, newPool func(string) *pgx.ConnPool, ensureSchema bool) SchemaMigrator

InitCopy makes a copy and initializes it

func (*SchemaMigrator) Migrate ¶

func (m *SchemaMigrator) Migrate() (schema string, fromVersion, toVersion file.Version, err error)

Migrate migrate between schema versions

func (*SchemaMigrator) Path ¶

func (m *SchemaMigrator) Path() string

Path returns the base path

func (*SchemaMigrator) Pool ¶

func (m *SchemaMigrator) Pool() *pgx.ConnPool

Pool returns connection pool

func (*SchemaMigrator) Restore ¶

func (m *SchemaMigrator) Restore(dr file.DumpReader) error

Restore restores the database from the passed in DumpReader

func (*SchemaMigrator) Revert ¶

func (m *SchemaMigrator) Revert() error

Revert reverts the database to the previous version

func (*SchemaMigrator) Schema ¶

func (m *SchemaMigrator) Schema() string

Schema returns the base schema

func (*SchemaMigrator) StartRestore ¶

func (m *SchemaMigrator) StartRestore() (migrator migrate.Migrator, schemas []string)

StartRestore creates a migrator and schemas used during restore

func (*SchemaMigrator) StartRevert ¶

func (m *SchemaMigrator) StartRevert() (migrator migrate.Migrator, schemas []string)

StartRevert creates a migrator and schemas used during revert

Source Files ¶

View all Source files

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