Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DBConn ¶
type DBConn interface {
Close() error
Ping() error
PingContext(ctx context.Context) error
SetMaxIdleConns(n int)
SetMaxOpenConns(n int)
SetConnMaxIdleTime(d time.Duration)
SetConnMaxLifetime(d time.Duration)
Stats() sql.DBStats
}
DBConn is the list of connection related actions such as Connecting, Disconnecting Ping and so on
type Database ¶
type Database interface {
DBConn
ReadQuerier
WriteQuerier
GetReader() ReadQuerier
GetWriter() WriteQuerier
}
Database is the interface for an object with Separate reader and writer objects inside of it
type DatabaseX ¶
type DatabaseX interface {
DBConn
ReadQuerierX
WriteQuerierX
GetReaderX() ReadQuerierX
GetWriterX() WriteQuerierX
}
type ReadQuerier ¶
type ReadQuerier interface {
Prepare(query string) (*sql.Stmt, error)
PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)
Query(query string, args ...any) (*sql.Rows, error)
QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error)
QueryRow(query string, args ...any) *sql.Row
QueryRowContext(ctx context.Context, query string, args ...any) *sql.Row
}
ReadQuerier is a container for the SQL queries that are meant to be executed against Secondary database list Queries and operations such as Get, QueryRow, GetContext, Statement and so on
some Functionalities are meant to be executed on both read and write for example Prepare(query string) (*sql.Stmt, error) PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)
type ReadQuerierX ¶
type ReadQuerierX interface {
ReadQuerier
Get(dest interface{}, query string, args ...interface{}) error
GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
NamedQuery(query string, arg interface{}) (*sqlx.Rows, error)
NamedQueryContext(ctx context.Context, query string, arg interface{}) (*sqlx.Rows, error)
PrepareNamed(query string) (*sqlx.NamedStmt, error)
PrepareNamedContext(ctx context.Context, query string) (*sqlx.NamedStmt, error)
Preparex(query string) (*sqlx.Stmt, error)
PreparexContext(ctx context.Context, query string) (*sqlx.Stmt, error)
QueryRowx(query string, args ...interface{}) *sqlx.Row
QueryRowxContext(ctx context.Context, query string, args ...interface{}) *sqlx.Row
Queryx(query string, args ...interface{}) (*sqlx.Rows, error)
QueryxContext(ctx context.Context, query string, args ...interface{}) (*sqlx.Rows, error)
Select(dest interface{}, query string, args ...interface{}) error
SelectContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
}
ReadQuerierX is a container for the SQL queries that are meant to be executed against Secondary database list Queries and operations such as Get, QueryRow, GetContext, Statement and so on
some Functionalities are meant to be executed on both read and write for example Prepare(query string) (*sql.Stmt, error) PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)
type WriteQuerier ¶
type WriteQuerier interface {
Begin() (*sql.Tx, error)
BeginTx(ctx context.Context, opts *sql.TxOptions) (*sql.Tx, error)
Exec(query string, args ...any) (sql.Result, error)
ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error)
Prepare(query string) (*sql.Stmt, error)
PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)
}
WriteQuerier is a container for the SQL queries that are meant to be executed against Primary databases list Queries and operations such as transactions, Execute Update, Statement and so on
some Functionalities are meant to be executed on both read and write for example Prepare(query string) (*sql.Stmt, error) PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)
type WriteQuerierX ¶
type WriteQuerierX interface {
WriteQuerier
BeginTxx(ctx context.Context, opts *sql.TxOptions) (*sqlx.Tx, error)
Beginx() (*sqlx.Tx, error)
MustBegin() *sqlx.Tx
MustBeginTx(ctx context.Context, opts *sql.TxOptions) *sqlx.Tx
MustExec(query string, args ...interface{}) sql.Result
MustExecContext(ctx context.Context, query string, args ...interface{}) sql.Result
NamedExec(query string, arg interface{}) (sql.Result, error)
NamedExecContext(ctx context.Context, query string, arg interface{}) (sql.Result, error)
}
WriteQuerierx is a container for the SQL queries that are meant to be executed against Primary databases list Queries and operations such as transactions, Execute Update, Statement and so on
some Functionalities are meant to be executed on both read and write for example Prepare(query string) (*sql.Stmt, error) PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)