pgruntime

Documentation

Index

• Constants
• func CurrentRuntimeDir() string
• func DefaultRuntimeSource() (string, bool)
• func ExtractTarZstdFile(archivePath, dest string) error
• func MissingRuntimeHint() string
• func RuntimeAssetName(version, goos, goarch, source string) string
• func RuntimeAssetURL(repo, version, goos, goarch, source string) string
• func RuntimeChecksumURL(repo, version, goos, goarch, source string) string
• func RuntimeRoot(stellaHome, source string) string
• type InstalledRuntime
  • func InstalledRuntimes(stellaHome string) ([]InstalledRuntime, error)

Constants

const (
	// The -r2 suffix is a rebuild of the same upstream versions: the bundled
	// libraries had no rpath of their own, so a host without a matching system
	// libicu could not start the runtime. The suffix also renames the local
	// cache directory, so an existing install stops using the broken extraction
	// rather than silently keeping it — `stellad upgrade` fetches the
	// replacement, and any other install path needs `postgres download`.
	RuntimeVersion     = "pg18.4-pgvector0.8.2-pgsearch0.24.1-r2"
	DefaultRuntimeRepo = "CherryHQ/stella-pg-runtime"
)

Functions

func CurrentRuntimeDir

func CurrentRuntimeDir() string

CurrentRuntimeDir names the directory holding the runtime this binary uses. Every installed version gets its own sibling, so the name doubles as the identity an operator sees when deciding what is safe to remove.

func DefaultRuntimeSource

func DefaultRuntimeSource() (string, bool)

func ExtractTarZstdFile

func ExtractTarZstdFile(archivePath, dest string) error

func MissingRuntimeHint

func MissingRuntimeHint() string

MissingRuntimeHint explains why automatic PostgreSQL runtime selection failed.

func RuntimeAssetName

func RuntimeAssetName(version, goos, goarch, source string) string

func RuntimeAssetURL

func RuntimeAssetURL(repo, version, goos, goarch, source string) string

func RuntimeChecksumURL

func RuntimeChecksumURL(repo, version, goos, goarch, source string) string

func RuntimeRoot

func RuntimeRoot(stellaHome, source string) string

Types

type InstalledRuntime

type InstalledRuntime struct {
	// Name is the directory name, which encodes version, OS, and architecture.
	Name string
	Path string
	// Bytes is the extracted size, best effort: entries that cannot be read are
	// skipped rather than failing a report whose only purpose is disk space.
	Bytes int64
	// Current marks the runtime this binary would use. Removing it is not
	// pruning, it is uninstalling, so callers keep the two apart.
	Current bool
}

InstalledRuntime is one extracted runtime version found on disk.

func InstalledRuntimes

func InstalledRuntimes(stellaHome string) ([]InstalledRuntime, error)

InstalledRuntimes lists the runtime versions extracted under $STELLA_HOME, sorted by name. A missing pg-runtime directory is not an error: it just means nothing has been downloaded yet.