postgres

README

postgres

A PostgreSQL Driver for GOE ORM

Documentation

Index

• func NewConfig(c Config) config
• type Config
• type Connection
  • func (c Connection) ExecContext(ctx context.Context, query *model.Query) error
  • func (c Connection) QueryContext(ctx context.Context, query *model.Query) (model.Rows, error)
  • func (c Connection) QueryRowContext(ctx context.Context, query *model.Query) model.Row
• type Driver
  • func Open(dns string, c config) (driver *Driver)
  • func (dr *Driver) Close() error
  • func (db *Driver) DropColumn(schema, table, column string) error
  • func (db *Driver) DropTable(schema, table string) error
  • func (dr *Driver) ErrorTranslator() func(err error) error
  • func (d *Driver) GetDatabaseConfig() *model.DatabaseConfig
  • func (dr *Driver) Init() error
  • func (dr *Driver) KeywordHandler(s string) string
  • func (db *Driver) MigrateContext(ctx context.Context, migrator *model.Migrator) error
  • func (dr *Driver) Name() string
  • func (dr *Driver) NewConnection() model.Connection
  • func (dr *Driver) NewTransaction(ctx context.Context, opts *sql.TxOptions) (model.Transaction, error)
  • func (db *Driver) RenameColumn(schema, table, oldColumn, newColumn string) error
  • func (db *Driver) RenameTable(schema, table, newTable string) error
  • func (dr *Driver) Stats() sql.DBStats
• type Row
  • func (r Row) Scan(dest ...any) error
• type Rows
  • func (rs Rows) Close() error
  • func (rs Rows) Next() bool
  • func (rs Rows) Scan(dest ...any) error
• type SavePoint
  • func (s SavePoint) Commit() error
  • func (s SavePoint) Rollback() error
• type Transaction
  • func (t Transaction) Commit() error
  • func (t Transaction) ExecContext(ctx context.Context, query *model.Query) error
  • func (t Transaction) QueryContext(ctx context.Context, query *model.Query) (model.Rows, error)
  • func (t Transaction) QueryRowContext(ctx context.Context, query *model.Query) model.Row
  • func (t Transaction) Rollback() error
  • func (t Transaction) SavePoint() (model.SavePoint, error)

Functions

func NewConfig

func NewConfig(c Config) config

Types

type Config

type Config struct {
	Logger           model.Logger
	IncludeArguments bool          // include all arguments used on query
	QueryThreshold   time.Duration // query threshold to warning on slow queries

	MigratePath string // output sql file, if defined the driver will not auto apply the migration.
}

type Connection

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

func (Connection) ExecContext

func (c Connection) ExecContext(ctx context.Context, query *model.Query) error

func (Connection) QueryContext

func (c Connection) QueryContext(ctx context.Context, query *model.Query) (model.Rows, error)

func (Connection) QueryRowContext

func (c Connection) QueryRowContext(ctx context.Context, query *model.Query) model.Row

type Driver

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

func Open

func Open(dns string, c config) (driver *Driver)

func (*Driver) Close

func (dr *Driver) Close() error

func (*Driver) DropColumn

func (db *Driver) DropColumn(schema, table, column string) error

func (*Driver) DropTable

func (db *Driver) DropTable(schema, table string) error

func (*Driver) ErrorTranslator

func (dr *Driver) ErrorTranslator() func(err error) error

func (*Driver) GetDatabaseConfig

func (d *Driver) GetDatabaseConfig() *model.DatabaseConfig

func (*Driver) Init

func (dr *Driver) Init() error

func (*Driver) KeywordHandler

func (dr *Driver) KeywordHandler(s string) string

func (*Driver) MigrateContext

func (db *Driver) MigrateContext(ctx context.Context, migrator *model.Migrator) error

func (*Driver) Name

func (dr *Driver) Name() string

func (*Driver) NewConnection

func (dr *Driver) NewConnection() model.Connection

func (*Driver) NewTransaction

func (dr *Driver) NewTransaction(ctx context.Context, opts *sql.TxOptions) (model.Transaction, error)

func (*Driver) RenameColumn

func (db *Driver) RenameColumn(schema, table, oldColumn, newColumn string) error

func (*Driver) RenameTable

func (db *Driver) RenameTable(schema, table, newTable string) error

func (*Driver) Stats

func (dr *Driver) Stats() sql.DBStats

type Row

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

func (Row) Scan

func (r Row) Scan(dest ...any) error

type Rows

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

func (Rows) Close

func (rs Rows) Close() error

func (Rows) Next

func (rs Rows) Next() bool

func (Rows) Scan

func (rs Rows) Scan(dest ...any) error

type SavePoint

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

func (SavePoint) Commit

func (s SavePoint) Commit() error

func (SavePoint) Rollback

func (s SavePoint) Rollback() error

type Transaction

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

func (Transaction) Commit

func (t Transaction) Commit() error

func (Transaction) ExecContext

func (t Transaction) ExecContext(ctx context.Context, query *model.Query) error

func (Transaction) QueryContext

func (t Transaction) QueryContext(ctx context.Context, query *model.Query) (model.Rows, error)

func (Transaction) QueryRowContext

func (t Transaction) QueryRowContext(ctx context.Context, query *model.Query) model.Row

func (Transaction) Rollback

func (t Transaction) Rollback() error

func (Transaction) SavePoint

func (t Transaction) SavePoint() (model.SavePoint, error)