The highest tagged major version is v2.

pg

package

v0.0.5 Latest Latest Go to latest Published: Jan 4, 2022 License: Apache-2.0 Imports: 11 Imported by: 0

Details

This section is empty.

View Source

var (
	ErrNotExist     = fmt.Errorf("schema or table does not exist")
	ErrAlreadyExist = fmt.Errorf("schema or table already exist")
)

This section is empty.

type Placeholder int

func (p *Placeholder) Next() string

type Pool struct {
	*pgxpool.Pool
}

Pool data struct for *pgxpool.Pool.

func NewPool(connString string, logger *zap.Logger, lazy bool) (*Pool, error)

NewPool returns a pgxpool, a concurrency-safe connection pool for pgx.

func (pgPool *Pool) CreateSchema(ctx context.Context, db string) error

CreateSchema creates a new FerretDB database / PostgreSQL schema.

It returns ErrAlreadyExist if schema already exist.

func (pgPool *Pool) CreateTable(ctx context.Context, db, collection string) error

CreateTable creates a new FerretDB collection / PostgreSQL jsonb table.

It returns ErrAlreadyExist if table already exist.

func (pgPool *Pool) DropSchema(ctx context.Context, db string) error

DropSchema drops FerretDB database / PostgreSQL schema.

It returns ErrNotExist if schema does not exist.

func (pgPool *Pool) DropTable(ctx context.Context, db, collection string) error

DropTable drops FerretDB collection / PostgreSQL table.

It returns ErrNotExist is table does not exist.

func (pgPool *Pool) Schemas(ctx context.Context) ([]string, error)

Schemas returns a sorted list of FerretDB database / PostgreSQL schema names.

func (pgPool *Pool) TableStats(ctx context.Context, db, table string) (*TableStats, error)

TableStats returns a set of statistics for a table.

func (pgPool *Pool) Tables(ctx context.Context, db string) ([]string, error)

Tables returns a sorted list of FerretDB collection / PostgreSQL table names.

type TableStats struct {
	Table       string
	TableType   string
	SizeTotal   int64
	SizeIndexes int64
	SizeTable   int64
	Rows        int64
}

TableStats describes some statistics for a table.