package stmtcache

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

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	    lru_cache.go
	  d stmtcache.go
		Package stmtcache is a cache for statement descriptions.

	    unlimited_cache.go
Package-Level Type Names (total 3)

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

		Methods (total 7)
			( 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) HandleInvalidated() []*pgconn.StatementDescription
				HandleInvalidated returns a slice of all statement descriptions invalidated since the last call to HandleInvalidated.

			( 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.

		Implemented By (at least 2)
			*LRUCache
			*UnlimitedCache

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

		Methods (total 7)
			(*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) HandleInvalidated() []*pgconn.StatementDescription
			(*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.

		Implements (at least one exported)
			*LRUCache : Cache
		As Outputs Of (at least one exported)
			func NewLRUCache(cap int) *LRUCache

	 type UnlimitedCache (struct)
		UnlimitedCache implements Cache with no capacity limit.

		Methods (total 7)
			(*UnlimitedCache) Cap() int
				Cap returns the maximum number of cached prepared statement descriptions.

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

			(*UnlimitedCache) HandleInvalidated() []*pgconn.StatementDescription
			(*UnlimitedCache) Invalidate(sql string)
				Invalidate invalidates statement description identified by sql. Does nothing if not found.

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

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

			(*UnlimitedCache) 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.

		Implements (at least one exported)
			*UnlimitedCache : Cache
		As Outputs Of (at least one exported)
			func NewUnlimitedCache() *UnlimitedCache


Package-Level Functions (total 4)

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

	 func NewUnlimitedCache() *UnlimitedCache
		NewUnlimitedCache creates a new UnlimitedCache.

	 func NextStatementName() string
		NextStatementName returns a statement name that will be unique for the lifetime of the program.

The pages are generated with Golds v0.6.7. (GOOS=linux 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.