package stmtcache

Import Path
	github.com/jackc/pgx/v5/internal/stmtcache (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	    lru_cache.go
	  d stmtcache.go
		Package stmtcache is a cache for statement descriptions.
Package-Level Type Names (total 3, in which 2 are exported)

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

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

			( Cache) Get(sql string) *pgconn.StatementDescription
				Get returns the statement description for sql. Returns nil if not found.

			( Cache) GetInvalidated() []*pgconn.StatementDescription
				GetInvalidated returns a slice of all statement descriptions invalidated since the last call to RemoveInvalidated.

			( Cache) Invalidate(sql string)
				Invalidate invalidates statement description identified by sql. Does nothing if not found.

			( Cache) InvalidateAll()
				InvalidateAll invalidates all statement descriptions.

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

			( Cache) Put(sd *pgconn.StatementDescription)
				Put stores sd in the cache. Put panics if sd.SQL is "". Put does nothing if sd.SQL already exists in the cache.

			( Cache) RemoveInvalidated()
				RemoveInvalidated removes all invalidated statement descriptions. No other calls to Cache must be made between a
				call to GetInvalidated and RemoveInvalidated or RemoveInvalidated may remove statement descriptions that were
				never seen by the call to GetInvalidated.

		Implemented By (at least one exported)
			*LRUCache
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/jackc/pgx/v5.(*Conn).sendBatchExtendedWithDescription(ctx context.Context, b *pgx.Batch, distinctNewQueries []*pgconn.StatementDescription, sdCache Cache) (pbr *pgx.pipelineBatchResults)

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

		Fields (total 8, none are exported)
			/* 8 unexporteds ... *//* 8 unexporteds: */
			cap int
			freelist *lruNode
			head *lruNode
			invalidSet map[string]struct{}
			invalidStmts []*pgconn.StatementDescription
			len int
			m map[string]*lruNode
			tail *lruNode
		Methods (total 14, in which 8 are exported)
			(*LRUCache) Cap() int
				Cap returns the maximum number of cached prepared statement descriptions.

			(*LRUCache) Get(key string) *pgconn.StatementDescription
				Get returns the statement description for sql. Returns nil if not found.

			(*LRUCache) GetInvalidated() []*pgconn.StatementDescription
				GetInvalidated returns a slice of all statement descriptions invalidated since the last call to RemoveInvalidated.

			(*LRUCache) Invalidate(sql string)
				Invalidate invalidates statement description identified by sql. Does nothing if not found.

			(*LRUCache) InvalidateAll()
				InvalidateAll invalidates all statement descriptions.

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

			(*LRUCache) Put(sd *pgconn.StatementDescription)
				Put stores sd in the cache. Put panics if sd.SQL is "". Put does nothing if sd.SQL already exists in the cache or
				sd.SQL has been invalidated and HandleInvalidated has not been called yet.

			(*LRUCache) RemoveInvalidated()
				RemoveInvalidated removes all invalidated statement descriptions. No other calls to Cache must be made between a
				call to GetInvalidated and RemoveInvalidated or RemoveInvalidated may remove statement descriptions that were
				never seen by the call to GetInvalidated.

			/* 6 unexporteds ... *//* 6 unexporteds: */
			(*LRUCache) allocNode() *lruNode
			(*LRUCache) freeNode(node *lruNode)
			(*LRUCache) insertAfter(at, node *lruNode)
			(*LRUCache) invalidateOldest()
			(*LRUCache) moveToFront(node *lruNode)
			(*LRUCache) unlink(node *lruNode)
		Implements (at least one exported)
			*LRUCache : Cache
		As Outputs Of (at least one exported)
			func NewLRUCache(cap int) *LRUCache

	/* one unexported ... *//* one unexported: */
	 type lruNode (struct)
		lruNode is a typed doubly-linked list node with freelist support.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			next *lruNode
			prev *lruNode
			sd *pgconn.StatementDescription
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func (*LRUCache).allocNode() *lruNode
		As Inputs Of (at least 4, none are exported)
			/* 4+ unexporteds ... *//* 4+ unexporteds: */
			func (*LRUCache).freeNode(node *lruNode)
			func (*LRUCache).insertAfter(at, node *lruNode)
			func (*LRUCache).moveToFront(node *lruNode)
			func (*LRUCache).unlink(node *lruNode)


Package-Level Functions (total 2, both are exported)

	 func NewLRUCache(cap int) *LRUCache
		NewLRUCache creates a new LRUCache. cap is the maximum size of the cache.

	 func StatementName(sql string) string
		StatementName returns a statement name that will be stable for sql across multiple connections and program
		executions.

The pages are generated with Golds v0.7.6. (GOOS=linux GOARCH=amd64)