ent

Documentation

Index

• type After
• type Before
• type Builder
• type DB
  • func New(config orm.Config) (*DB, error)
  • func (db *DB) After(ctx context.Context, fns ...After) error
  • func (db *DB) Before(ctx context.Context, fns ...Before) error
  • func (db *DB) Close() error
  • func (db *DB) Connector(builder Builder) orm.Connector
  • func (db *DB) Driver() *sql.Driver

Types

type After

type After func(ctx context.Context, drv *sql.Driver) (err error)

After is a hook that is executed after closing a database connection.

type Before

type Before func(ctx context.Context, drv *sql.Driver) (err error)

Before is a hook that is executed before opening a database connection.

type Builder

type Builder func(drv *sql.Driver, config orm.Config) (any, error)

Builder is a builder function that returns a driver.

type DB

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

DB is the database client.

func New

func New(config orm.Config) (*DB, error)

New creates a new database instance.

func (*DB) After

func (db *DB) After(ctx context.Context, fns ...After) error

After executes the hooks after the database connection.

func (*DB) Before

func (db *DB) Before(ctx context.Context, fns ...Before) error

Before executes the hooks before the database connection.

func (*DB) Close

func (db *DB) Close() error

Close closes the database connection.

func (*DB) Connector

func (db *DB) Connector(builder Builder) orm.Connector

Connector returns a new database connector.

func (*DB) Driver

func (db *DB) Driver() *sql.Driver

Driver returns the underlying database driver.