package stmtcache

Import Path
	github.com/jackc/pgconn/stmtcache (on go.dev)

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	      lru.go
	   d➜ stmtcache.go
		Package stmtcache is a cache that can be used to implement lazy prepared statements.
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Cache (interface)
		Cache prepares and caches prepared statement descriptions.

		Methods (total 6, all are exported)
			( T) Cap() int
				Cap returns the maximum number of cached prepared statement descriptions.

			( T) Clear(ctx context.Context) error
				Clear removes all entries in the cache. Any prepared statements will be deallocated from the PostgreSQL session.

			( T) Get(ctx context.Context, sql string) (*pgconn.StatementDescription, error)
				Get returns the prepared statement description for sql preparing or describing the sql on the server as needed.

			( T) Len() int
				Len returns the number of cached prepared statement descriptions.

			( T) Mode() int
				Mode returns the mode of the cache (ModePrepare or ModeDescribe)

			( T) StatementErrored(sql string, err error)
				StatementErrored informs the cache that the given statement resulted in an error when it
				was last used against the database. In some cases, this will cause the cache to maer that
				statement as bad. The bad statement will instead be flushed during the next call to Get
				that occurs outside of a failed transaction.

		Implemented By (at least one exported)
			*LRU
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			 T : github.com/aws/aws-sdk-go/aws/corehandlers.lener
		As Outputs Of (at least 2, both are exported)
			func New(conn *pgconn.PgConn, mode int, cap int) Cache
			func github.com/jackc/pgx/v4.(*Conn).StatementCache() Cache

	 type LRU (struct)
		LRU implements Cache with a Least Recently Used (LRU) cache.

		Fields (total 8, none are exported)
			/* 8 unexporteds ... *//* 8 unexporteds: */
			cap int
			conn *pgconn.PgConn
			l *list.List
			m map[string]*list.Element
			mode int
			prepareCount int
			psNamePrefix string
			stmtsToClear []string
		Methods (total 9, in which 6 are exported)
			(*T) Cap() int
				Cap returns the maximum number of cached prepared statement descriptions.

			(*T) Clear(ctx context.Context) error
				Clear removes all entries in the cache. Any prepared statements will be deallocated from the PostgreSQL session.

			(*T) Get(ctx context.Context, sql string) (*pgconn.StatementDescription, error)
				Get returns the prepared statement description for sql preparing or describing the sql on the server as needed.

			(*T) Len() int
				Len returns the number of cached prepared statement descriptions.

			(*T) Mode() int
				Mode returns the mode of the cache (ModePrepare or ModeDescribe)

			(*T) StatementErrored(sql string, err error)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			(*T) clearStmt(ctx context.Context, sql string) error
			(*T) prepare(ctx context.Context, sql string) (*pgconn.StatementDescription, error)
			(*T) removeOldest(ctx context.Context) error
		Implements (at least 2, in which 1 are exported)
			*T : Cache
			/* at least one unexported ... *//* at least one unexported: */
			*T : github.com/aws/aws-sdk-go/aws/corehandlers.lener
		As Outputs Of (at least one exported)
			func NewLRU(conn *pgconn.PgConn, mode int, cap int) *LRU


Package-Level Functions (total 4, in which 2 are exported)

	 func New(conn *pgconn.PgConn, mode int, cap int) Cache
		New returns the preferred cache implementation for mode and cap. mode is either ModePrepare or ModeDescribe. cap is
		the maximum size of the cache.

	 func NewLRU(conn *pgconn.PgConn, mode int, cap int) *LRU
		NewLRU creates a new LRU. mode is either ModePrepare or ModeDescribe. cap is the maximum size of the cache.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func mustBeValidCap(cap int)
	 func mustBeValidMode(mode int)
Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var lruCount uint64
Package-Level Constants (total 2, both are exported)

	const ModeDescribe = 1 // Cache should prepare the anonymous prepared statement to only fetch the description of the statement.
	const ModePrepare = 0 // Cache should prepare named statements.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.