middleware

Documentation

Index

• func ConvertArgsToNamedValues(args ...interface{}) []driver.NamedValue
• type Pool
• type PoolConn
• type Result
• type Statement
• type Transaction

Functions

func ConvertArgsToNamedValues

func ConvertArgsToNamedValues(args ...interface{}) []driver.NamedValue

ConvertArgsToNamedValues converts args to named values

Types

type Pool

type Pool interface {
	// Close releases each connection in the pool
	Close() error
	// IsClosed returns if pool had been closed
	IsClosed() bool
	// Get gets a connection from the pool
	Get() (PoolConn, error)
	// Transaction returns a connection that could run multiple statements in the same transaction
	Transaction() (Transaction, error)
	// Supply creates given number of connections and add them to the pool
	Supply(num int) error
	// Release releases given number of connections, each connection will disconnect with the middleware
	Release(num int) error
}

type PoolConn

type PoolConn interface {
	// Close returns connection back to the pool
	Close() error
	// Disconnect disconnects from the middleware, normally when using connection pool
	Disconnect() error
	// IsValid validates if connection is valid
	IsValid() bool
	// Prepare prepares a statement and returns a Statement
	Prepare(command string) (Statement, error)
	// PrepareContext prepares a statement with context and returns a Statement
	PrepareContext(ctx context.Context, command string) (Statement, error)
	// Execute executes given command and placeholders on the middleware
	Execute(command string, args ...interface{}) (Result, error)
	// ExecuteContext executes given command and placeholders with context on the middleware
	ExecuteContext(ctx context.Context, command string, args ...interface{}) (Result, error)
}

type Result

type Result interface {
	result.Metadata
	result.Value
	result.Number
	result.String
	result.Slice
	result.Map
	result.Unmarshaler
}

type Statement

type Statement interface {
	// Execute executes given command and placeholders on the middleware
	Execute(args ...interface{}) (Result, error)
	// ExecuteContext executes given command and placeholders with context on the middleware
	ExecuteContext(ctx context.Context, args ...interface{}) (Result, error)
}

type Transaction

type Transaction interface {
	PoolConn
	// Begin begins a transaction
	Begin() error
	// Commit commits current transaction
	Commit() error
	// Rollback rollbacks current transaction
	Rollback() error
}