pg

package module

Go to main page

Versions in this module

v1

v1.0.12

Mar 11, 2026

Changes in this version

+ func IsErrNoRows(err error) bool

v1.0.11

Aug 24, 2025

Changes in this version

+ func QuoteIdentifier(identifier string) string

v1.0.10

Apr 16, 2025

Changes in this version

+ type ConcurrentTx struct

+ func NewConcurrentTx(ctx context.Context, p *pgxpool.Pool) (*ConcurrentTx, error)

+ func (ct *ConcurrentTx) Begin(ctx context.Context) (pgx.Tx, error)

+ func (ct *ConcurrentTx) Commit(ctx context.Context) error

+ func (ct *ConcurrentTx) Exec(ctx context.Context, sql string, args ...any) (commandTag pgconn.CommandTag, err error)

+ func (ct *ConcurrentTx) Prepare(ctx context.Context, name, sql string) (*pgconn.StatementDescription, error)

+ func (ct *ConcurrentTx) Query(ctx context.Context, sql string, args ...any) (Rows, error)

+ func (ct *ConcurrentTx) QueryRow(ctx context.Context, sql string, args ...interface{}) pgx.Row

+ func (ct *ConcurrentTx) Rollback(ctx context.Context) error

+ func (ct *ConcurrentTx) SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults

type DB

+ func (db *DB) BeginConcurrent(ctx context.Context) (*DB, error)

+ func (db *DB) Mutate(ctx context.Context, query string, args ...any) (int64, error)

+ func (db *DB) MutateSingle(ctx context.Context, query string, args ...any) (bool, error)

type Repository

+ func (repo *Repository[T]) Mutate(ctx context.Context, query string, args ...any) (int64, error)

+ func (repo *Repository[T]) MutateSingle(ctx context.Context, query string, args ...any) (bool, error)

+ func (repo *Repository[T]) UpdateOnlyColumnsReportNoRows(ctx context.Context, columnsToUpdate []string, values ...T) (bool, error)

v1.0.9

Jan 13, 2024

v1.0.8

Dec 5, 2023

Changes in this version

type DB

+ func (db *DB) UpdateJSONB(ctx context.Context, tableName, columnName, rowID string, ...) (int64, error)

v1.0.7

Nov 5, 2023

Changes in this version

+ type Closer interface

+ Close func(ctx context.Context) error

type DB

+ func (db *DB) GetSize(ctx context.Context) (t SizeInfo, err error)

+ func (db *DB) ListTableSizes(ctx context.Context) ([]TableSizeInfo, error)

+ func (db *DB) ListenTable(ctx context.Context, opts *ListenTableOptions, ...) (Closer, error)

+ func (db *DB) PrepareListenTable(ctx context.Context, opts *ListenTableOptions) error

+ type ListenTableOptions struct

+ Channel string

+ Function string

+ Tables map[string][]TableChangeType

type Repository

+ func (repo *Repository[T]) ListenTable(ctx context.Context, callback func(TableNotification[T], error) error) (Closer, error)

+ type SizeInfo struct

+ Size float64

+ SizePretty string

+ SizeTotal float64

+ SizeTotalPretty string

+ type TableChangeType string

+ const TableChangeTypeDelete

+ const TableChangeTypeInsert

+ const TableChangeTypeUpdate

+ type TableNotification struct

+ Change TableChangeType

+ New T

+ Old T

+ Table string

+ func (tn TableNotification[T]) GetPayload() string

+ type TableNotificationJSON = TableNotification[json.RawMessage]

+ type TableSizeInfo struct

+ TableName string

v1.0.6

Sep 19, 2023

Changes in this version

+ const DoNothing

+ func QueryTwoSlices(ctx context.Context, db *DB, query string, args ...any) ([]T, []V, error)

type DB

+ func (db *DB) Duplicate(ctx context.Context, value any, idPtr any) error

+ func (db *DB) ListUniqueIndexes(ctx context.Context, tableNames ...string) ([]*desc.UniqueIndex, error)

+ func (db *DB) PoolStat() PoolStat

+ func (db *DB) QueryBoolean(ctx context.Context, query string, args ...any) (ok bool, err error)

+ type PoolStat struct

+ AcquireCount int64

+ AcquireDuration time.Duration

+ AcquiredConns int32

+ CanceledAcquireCount int64

+ ConstructingConns int32

+ EmptyAcquireCount int64

+ IdleConns int32

+ MaxConns int32

+ TotalConns int32

type Repository

+ func (repo *Repository[T]) Duplicate(ctx context.Context, id any, newIDPtr any) error

+ func (repo *Repository[T]) QueryBoolean(ctx context.Context, query string, args ...any) (bool, error)

type Schema

+ Strict bool

+ func (s *Schema) Last() *desc.Table

v1.0.5

Aug 21, 2023

Changes in this version

type DB

+ func (db *DB) Schema() *Schema

type Repository

+ func (repo *Repository[T]) Table() *desc.Table

v1.0.4

Aug 20, 2023

Changes in this version

type Repository

+ func (repo *Repository[T]) DeleteByID(ctx context.Context, id any) (bool, error)

v1.0.3

Aug 17, 2023

Changes in this version

+ var JSONColumnNameMapper = func(field reflect.StructField) string

+ var NoColumnNameMapper = func(field reflect.StructField) string

+ func SetDefaultColumnNameMapper(fn func(field reflect.StructField) string)

type DB

+ func (db *DB) UpdateExceptColumns(ctx context.Context, columnsToExcept []string, values ...any) (int64, error)

type Repository

+ func (repo *Repository[T]) UpdateExceptColumns(ctx context.Context, columnsToExcept []string, values ...T) (int64, error)

type Schema

+ SetTimestampTriggerName string

+ UpdatedAtColumnName string

v1.0.1

Jul 6, 2023

v1.0.0

Jun 28, 2023

v0

v0.0.1

Jun 28, 2023

Changes in this version

+ var ErrEmptyPayload = fmt.Errorf("empty payload")

+ var ErrIntentionalRollback = errors.New("skip error: intentional rollback")

+ var ErrIsReadOnly = errors.New("repository is read-only")

+ var ErrNoRows = pgx.ErrNoRows

+ var Presenter = func(td *desc.Table) bool

+ var View = func(td *desc.Table) bool

+ var WithLogger = func(logger tracelog.Logger) ConnectionOption

+ func IsErrColumnNotExists(err error, col string) bool

+ func IsErrDuplicate(err error) (string, bool)

+ func IsErrForeignKey(err error) (string, bool)

+ func IsErrInputSyntax(err error) (string, bool)

+ func QuerySingle(ctx context.Context, db *DB, query string, args ...any) (entry T, err error)

+ func QuerySlice(ctx context.Context, db *DB, query string, args ...any) ([]T, error)

+ func SetDefaultSearchPath(searchPath string)

+ func SetDefaultTag(tag string)

+ func UnmarshalNotification(n *Notification) (T, error)

+ type Column = desc.Column

+ type ColumnFilter = desc.ColumnFilter

+ type ConnectionOption func(*pgxpool.Config) error

+ type DB struct

+ ConnectionOptions *pgx.ConnConfig

+ Pool *pgxpool.Pool

+ func Open(ctx context.Context, schema *Schema, connString string, ...) (*DB, error)

+ func OpenPool(schema *Schema, pool *pgxpool.Pool) *DB

+ func (db *DB) Begin(ctx context.Context) (*DB, error)

+ func (db *DB) CheckSchema(ctx context.Context) error

+ func (db *DB) Close()

+ func (db *DB) Commit(ctx context.Context) error

+ func (db *DB) CreateSchema(ctx context.Context) error

+ func (db *DB) CreateSchemaDumpSQL(ctx context.Context) (string, error)

+ func (db *DB) Delete(ctx context.Context, values ...any) (int64, error)

+ func (db *DB) DeleteSchema(ctx context.Context) error

+ func (db *DB) DisableAutoVacuum(ctx context.Context) error

+ func (db *DB) DisableTableAutoVacuum(ctx context.Context, tableName string) error

+ func (db *DB) Exec(ctx context.Context, query string, args ...any) (pgconn.CommandTag, error)

+ func (db *DB) ExecFiles(ctx context.Context, fileReader interface{ ... }, filenames ...string) error

+ func (db *DB) Exists(ctx context.Context, value any) (bool, error)

+ func (db *DB) GetVersion(ctx context.Context) (string, error)

+ func (db *DB) InTransaction(ctx context.Context, fn func(*DB) error) error

+ func (db *DB) Insert(ctx context.Context, values ...any) error

+ func (db *DB) InsertSingle(ctx context.Context, value any, idPtr any) error

+ func (db *DB) IsAutoVacuumEnabled(ctx context.Context) (enabled bool, err error)

+ func (db *DB) IsTransaction() bool

+ func (db *DB) ListColumns(ctx context.Context, tableNames ...string) ([]*desc.Column, error)

+ func (db *DB) ListColumnsInformationSchema(ctx context.Context, tableNames ...string) ([]*desc.ColumnBasicInfo, error)

+ func (db *DB) ListConstraints(ctx context.Context, tableNames ...string) ([]*desc.Constraint, error)

+ func (db *DB) ListTables(ctx context.Context, opts ListTablesOptions) ([]*desc.Table, error)

+ func (db *DB) ListTriggers(ctx context.Context) ([]*desc.Trigger, error)

+ func (db *DB) Listen(ctx context.Context, channel string) (*Listener, error)

+ func (db *DB) Notify(ctx context.Context, channel string, payload any) error

+ func (db *DB) Query(ctx context.Context, query string, args ...any) (Rows, error)

+ func (db *DB) QueryRow(ctx context.Context, query string, args ...any) Row

+ func (db *DB) Rollback(ctx context.Context) error

+ func (db *DB) SearchPath() string

+ func (db *DB) Select(ctx context.Context, scannerFunc func(Rows) error, query string, args ...any) error

+ func (db *DB) SelectByID(ctx context.Context, destPtr any, id any) error

+ func (db *DB) SelectByUsernameAndPassword(ctx context.Context, destPtr any, username, plainPassword string) error

+ func (db *DB) Unlisten(ctx context.Context, channel string) error

+ func (db *DB) Update(ctx context.Context, values ...any) (int64, error)

+ func (db *DB) UpdateOnlyColumns(ctx context.Context, columnsToUpdate []string, values ...any) (int64, error)

+ func (db *DB) Upsert(ctx context.Context, forceOnConflictExpr string, values ...any) error

+ func (db *DB) UpsertSingle(ctx context.Context, value any, idPtr any, forceOnConflictExpr string) error

+ type DataType = desc.DataType

+ type ListTablesOptions struct

+ Filter desc.TableFilter

+ TableNames []string

+ type Listener struct

+ func (l *Listener) Accept(ctx context.Context) (*Notification, error)

+ func (l *Listener) Close(ctx context.Context) error

+ type MapTypeFilter map[string]any

+ func (m MapTypeFilter) FilterTable(t *Table) bool

+ type Notification = pgconn.Notification

+ type Repository struct

+ func NewRepository(db *DB) *Repository[T]

+ func (repo *Repository[T]) DB() *DB

+ func (repo *Repository[T]) Delete(ctx context.Context, values ...T) (int64, error)

+ func (repo *Repository[T]) Exec(ctx context.Context, query string, args ...any) (pgconn.CommandTag, error)

+ func (repo *Repository[T]) Exists(ctx context.Context, value T) (bool, error)

+ func (repo *Repository[T]) InTransaction(ctx context.Context, fn func(*Repository[T]) error) error

+ func (repo *Repository[T]) Insert(ctx context.Context, values ...T) error

+ func (repo *Repository[T]) InsertSingle(ctx context.Context, value T, idPtr any) error

+ func (repo *Repository[T]) IsReadOnly() bool

+ func (repo *Repository[T]) IsTransaction() bool

+ func (repo *Repository[T]) Query(ctx context.Context, query string, args ...any) (Rows, error)

+ func (repo *Repository[T]) QueryRow(ctx context.Context, query string, args ...any) Row

+ func (repo *Repository[T]) Select(ctx context.Context, query string, args ...any) ([]T, error)

+ func (repo *Repository[T]) SelectByID(ctx context.Context, id any) (T, error)

+ func (repo *Repository[T]) SelectByUsernameAndPassword(ctx context.Context, username, plainPassword string) (T, error)

+ func (repo *Repository[T]) SelectSingle(ctx context.Context, query string, args ...any) (T, error)

+ func (repo *Repository[T]) Update(ctx context.Context, values ...T) (int64, error)

+ func (repo *Repository[T]) UpdateOnlyColumns(ctx context.Context, columnsToUpdate []string, values ...T) (int64, error)

+ func (repo *Repository[T]) Upsert(ctx context.Context, forceOnConflictExpr string, values ...T) error

+ func (repo *Repository[T]) UpsertSingle(ctx context.Context, forceOnConflictExpr string, value T, idPtr any) error

+ type Row = pgx.Row

+ type Rows = pgx.Rows

+ type Schema struct

+ func NewSchema() *Schema

+ func (s *Schema) Get(typ reflect.Type) (*desc.Table, error)

+ func (s *Schema) GetByTableName(tableName string) (*desc.Table, error)

+ func (s *Schema) HandlePassword(handler desc.PasswordHandler) *Schema

+ func (s *Schema) HasColumnType(dataTypes ...desc.DataType) bool

+ func (s *Schema) HasPassword() bool

+ func (s *Schema) MustRegister(tableName string, emptyStructValue any, opts ...TableFilterFunc) *Schema

+ func (s *Schema) Register(tableName string, emptyStructValue any, opts ...TableFilterFunc) (*desc.Table, error)

+ func (s *Schema) TableNames(types ...desc.TableType) []string

+ func (s *Schema) Tables(types ...desc.TableType) []*desc.Table

+ type Table = desc.Table

+ type TableFilterFunc = desc.TableFilterFunc

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