Jack Christensen
53 lines
1.5 KiB
Go
53 lines
1.5 KiB
Go
// Package pscache is a cache that can be used to implement lazy, automatic prepared statements.
|
|
package pscache
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/jackc/pgconn"
|
|
)
|
|
|
|
const (
|
|
PrepareMode = iota // Cache should prepare named statements.
|
|
DescribeMode // Cache should prepare the anonymous prepared statement to only fetch the description of the statement.
|
|
)
|
|
|
|
// Cache prepares and caches prepared statement descriptions.
|
|
type Cache interface {
|
|
// Get returns the prepared statement description for sql preparing or describing the sql on the server as needed.
|
|
Get(ctx context.Context, sql string) (*pgconn.PreparedStatementDescription, error)
|
|
|
|
// Clear removes all entries in the cache. Any prepared statements will be deallocated from the PostgreSQL session.
|
|
Clear(ctx context.Context) error
|
|
|
|
// Len returns the number of cached prepared statement descriptions.
|
|
Len() int
|
|
|
|
// Cap returns the maximum number of cached prepared statement descriptions.
|
|
Cap() int
|
|
|
|
// Mode returns the mode of the cache (PrepareMode or DescribeMode)
|
|
Mode() int
|
|
}
|
|
|
|
// New returns the preferred cache implementation for mode and cap. mode is either PrepareMode or DescribeMode. cap is
|
|
// the maximum size of the cache.
|
|
func New(conn *pgconn.PgConn, mode int, cap int) Cache {
|
|
mustBeValidMode(mode)
|
|
mustBeValidCap(cap)
|
|
|
|
return NewLRUCache(conn, mode, cap)
|
|
}
|
|
|
|
func mustBeValidMode(mode int) {
|
|
if mode != PrepareMode && mode != DescribeMode {
|
|
panic("mode must be PrepareMode or DescribeMode")
|
|
}
|
|
}
|
|
|
|
func mustBeValidCap(cap int) {
|
|
if cap < 1 {
|
|
panic("cache must have cap of >= 1")
|
|
}
|
|
}
|