README
¶
dotpgx
A Go library for parsing, mapping and executing .sql files or blobs. Inspired by projects such as dotsql, yesql and anosql.
Documentation
¶
Overview ¶
Package dotpgx creates a connection pool, parses and executes queries.
Index ¶
- Variables
- type Batch
- func (b *Batch) Close() error
- func (b *Batch) ExecResults() (pgx.CommandTag, error)
- func (b *Batch) QueryResults() (*pgx.Rows, error)
- func (b *Batch) QueryRowResults() *pgx.Row
- func (b *Batch) Queue(name string, arguments []interface{}, parameterOIDs []pgtype.OID, ...) (err error)
- func (b *Batch) QueueAll()
- func (b *Batch) Send() error
- type Config
- type DB
- func (db *DB) Begin() (tx *Tx, err error)
- func (db *DB) BeginBatch() *Batch
- func (db *DB) ClearMap() (err error)
- func (db *DB) Close()
- func (db *DB) DropQuery(name string) (err error)
- func (db *DB) Exec(name string, args ...interface{}) (pgx.CommandTag, error)
- func (db *DB) HasQueries() bool
- func (db *DB) List() (index []string)
- func (db *DB) ParseFileGlob(glob string) error
- func (db *DB) ParseFiles(files ...string) error
- func (db *DB) ParsePath(path string) error
- func (db *DB) ParseSQL(r io.Reader) error
- func (db *DB) Prepare(name string) (*pgx.PreparedStatement, error)
- func (db *DB) PrepareAll() (ps []*pgx.PreparedStatement, err error)
- func (db *DB) Query(name string, args ...interface{}) (*pgx.Rows, error)
- func (db *DB) QueryRow(name string, args ...interface{}) (*pgx.Row, error)
- type Tx
- func (tx *Tx) BeginBatch() *Batch
- func (tx *Tx) Commit() error
- func (tx *Tx) Exec(name string, args ...interface{}) (pgx.CommandTag, error)
- func (tx *Tx) Prepare(name string) (*pgx.PreparedStatement, error)
- func (tx *Tx) Query(name string, args ...interface{}) (*pgx.Rows, error)
- func (tx *Tx) QueryRow(name string, args ...interface{}) (*pgx.Row, error)
- func (tx *Tx) Rollback() error
Constants ¶
This section is empty.
Variables ¶
var Default = Config{
Name: "dotpgx_test",
Host: "/run/postgresql",
Port: 5432,
User: "postgres",
MaxConnections: 5,
RunTime: dbRuntime{
AppName: "dotpgx connection lib",
},
}
Default config for database
Functions ¶
This section is empty.
Types ¶
type Batch ¶
type Batch struct {
// Pgx provides direct access to the pgx batch object
Pgx *pgx.Batch
// contains filtered or unexported fields
}
Batch represents a pgx btach and the loaded query map. Support is still primitive and limited for our own use in migrations.
func (*Batch) ExecResults ¶
func (b *Batch) ExecResults() (pgx.CommandTag, error)
ExecResults reads the results from the next query in the batch as if the query has been sent with Exec.
func (*Batch) QueryResults ¶
QueryResults reads the results from the next query in the batch as if the query has been sent with Query.
func (*Batch) QueryRowResults ¶
QueryRowResults reads the results from the next query in the batch as if the query has been sent with QueryRow.
func (*Batch) Queue ¶
func (b *Batch) Queue(name string, arguments []interface{}, parameterOIDs []pgtype.OID, resultFormatCodes []int16) (err error)
Queue a query by name
type Config ¶
type Config struct {
Name string `usage:"PostgreSQL database name"`
Host string `usage:"PostgreSQL host"`
Port uint `usage:"Postgresql port number"`
TLS bool `usage:"Enable TLS communication with database server"`
User string `usage:"PostgreSQL username"`
Password string `usage:"PostgreSQL password"`
MaxConnections int `usage:"Maximum DB connection pool size"`
RunTime dbRuntime
}
Config for database
func (Config) ConnPoolConfig ¶
func (c Config) ConnPoolConfig() pgx.ConnPoolConfig
ConnPoolConfig parses the Config into a pgx.ConnPoolConfig
type DB ¶
type DB struct {
// Pool allows direct access to the underlying *pgx.ConnPool
Pool *pgx.ConnPool
// contains filtered or unexported fields
}
DB represents the database connection pool and parsed queries.
func InitDB ¶
InitDB is a wrapper for New() and ParsePath(). Config is the dotpgx config, which will be parsed into a pgx.ConnPoolConfig. Path is where sql queries will be parsed from.
func New ¶
func New(conf pgx.ConnPoolConfig) (db *DB, err error)
New configures and creates a database connection pool It returns a pointer to the Database object. It returns an error only when the connection pool cannot be set-up.
An example config object would look like:
conf := pgx.ConnPoolConfig{
ConnConfig: pgx.ConnConfig{
Host: pgHost,
User: pgUser,
Database: pgDatabase,
Logger: logger,
},
MaxConnections: 50,
AfterConnect: sqlPrepare,
}
Most arguments are optional. If no logger is specified, one will get apointed automatically.
func (*DB) ClearMap ¶
ClearMap clears the query map and sets the internal incremental counter to 0. Use this before you want to load a fresh set of queries, keeping the connection pool open. An error is only returned if one or more prepared statements failed to deallocate. It does not abbort on error and continues to (attempt) the clear the remaining queries.
func (*DB) Close ¶
func (db *DB) Close()
Close cleans up the mapped queries and closes the pgx connection pool. It is safe to call close multiple times.
func (*DB) DropQuery ¶
DropQuery removes a query form the Map. It calls Pgx Deallocate if the query was a prepared statement. An error is returned only when deallocating fails. Regardless of an error, the query will be dropped from the map.
func (*DB) Exec ¶
func (db *DB) Exec(name string, args ...interface{}) (pgx.CommandTag, error)
Exec runs the sql identified by name. Returns the result of the exec or an error.
func (*DB) HasQueries ¶
HasQueries returns true if the are queries in the map. False in case of nil map or 0 queries.
func (*DB) ParseFileGlob ¶
ParseFileGlob passes all files that match glob to ParseFiles. Subsequently those files get fed into DB.ParseSql. See filepath.glob for behavior.
func (*DB) ParseFiles ¶
ParseFiles opens one or more files and feeds them to ParseSql
func (*DB) ParsePath ¶
ParsePath is a convenience wrapper. It uses ParseFileGlob to load all files in path, with a .sql suffix.
func (*DB) ParseSQL ¶
ParseSQL parses and stores SQL queries from a io.Reader. Queries should end with a semi-colon. It stores queries by their "--name: <name>" tag. If no name tag is specified, an incremental number will be appointed. This might come in handy for sequential execution (like migrations).ParseSql Parsed queries get appended to the current map. If a name tag was already present, it will get overwritten by the new one parsed. The serial value is stored inside the DB object, so it is safe to call this function multiple times.
If the input conains a double dollar sign "$$", the parser will ignore semi-colon untill another occurance of "$$". This makes parsing of functions possible.
func (*DB) Prepare ¶
func (db *DB) Prepare(name string) (*pgx.PreparedStatement, error)
Prepare a sql statement identified by name.
func (*DB) PrepareAll ¶
func (db *DB) PrepareAll() (ps []*pgx.PreparedStatement, err error)
PrepareAll prepares all registered queries. It returns an error when one of the queries failed to prepare. However, it will not abort in such case and attempts to prepare the remaining statements.
type Tx ¶
Tx is transaction
func (*Tx) BeginBatch ¶
BeginBatch starts a new pgx batch inside the current transaction
func (*Tx) Exec ¶
func (tx *Tx) Exec(name string, args ...interface{}) (pgx.CommandTag, error)
Exec runs the sql identified by name. Returns the result of the exec or an error.
func (*Tx) Prepare ¶
func (tx *Tx) Prepare(name string) (*pgx.PreparedStatement, error)
Prepare a sql statement identified by name.
Source Files