postgres

package
v0.20.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 7, 2026 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Overview

Package postgres provides the PostgreSQL data layer for the CMS core.

Index

Constants

View Source 
const OldestMajor = 15

OldestMajor is the oldest PostgreSQL major version this release supports.

Variables

View Source 
var Migrations embed.FS

Migrations holds the core schema migration files applied by goose.

Functions

func CheckMajor added in v0.20.0 

func CheckMajor(ctx context.Context, db *sql.DB) error

CheckMajor returns an error naming the server's version when it runs a PostgreSQL major older than OldestMajor.

func Migrate 

func Migrate(ctx context.Context, db *sql.DB) error

Migrate applies the core schema migrations on db under goose's advisory lock, opening nothing itself.

func RaiseMinimumVersion added in v0.20.0 

func RaiseMinimumVersion(ctx context.Context, db *sql.DB, minimum string) error

RaiseMinimumVersion stores minimum on db when the stored one comes before it, reading again after a lost race.

func ServerMajor added in v0.20.0 

func ServerMajor(ctx context.Context, db *sql.DB) (int, error)

ServerMajor returns the PostgreSQL major the server db connects to runs.

func StoredMinimumVersion added in v0.20.0 

func StoredMinimumVersion(ctx context.Context, db *sql.DB) (string, error)

StoredMinimumVersion returns the minimum version stored on db, empty before the core tables exist or while none is.

Types

type ContentStore added in v0.4.0 

type ContentStore struct {
	*contentstore.Store
}

ContentStore persists content items in the core schema.

func NewContentStore added in v0.4.0 

func NewContentStore(pool *pgxpool.Pool) *ContentStore

NewContentStore returns a ContentStore backed by pool.

type CronStore added in v0.19.0 

type CronStore struct {
	// contains filtered or unexported fields
}

CronStore keeps the site's cron jobs and their leases in the core schema.

func NewCronStore added in v0.19.0 

func NewCronStore(pool *pgxpool.Pool) *CronStore

NewCronStore returns a CronStore backed by pool.

func (*CronStore) Settle added in v0.19.0 

func (s *CronStore) Settle(ctx context.Context, lease cron.Lease, outcome cron.Outcome) error

Settle frees the job and records how its run ended, refusing a lease another run took over.

func (*CronStore) Slots added in v0.19.0 

func (s *CronStore) Slots(ctx context.Context) ([]cron.Slot, error)

Slots returns where every stored job stands.

func (*CronStore) Take added in v0.19.0 

func (s *CronStore) Take(ctx context.Context, lease cron.Lease) (cron.Lease, bool, error)

Take claims the job for the lease when it is due and free, reporting whether it did.

type MediaStore added in v0.3.0 

type MediaStore struct {
	// contains filtered or unexported fields
}

MediaStore persists the media library in the core schema.

func NewMediaStore added in v0.3.0 

func NewMediaStore(pool *pgxpool.Pool) *MediaStore

NewMediaStore returns a MediaStore backed by pool.

func (*MediaStore) ByID added in v0.3.0 

func (s *MediaStore) ByID(ctx context.Context, id int64) (media.Media, error)

ByID returns the media item with the given id, or media.ErrNotFound.

func (*MediaStore) ByIDs added in v0.11.0 

func (s *MediaStore) ByIDs(ctx context.Context, ids []int64) ([]media.Media, error)

ByIDs returns the media items stored under the identities, leaving out any that are gone.

func (*MediaStore) Create added in v0.3.0 

func (s *MediaStore) Create(ctx context.Context, m media.Media) (media.Media, error)

Create stores a new media item and returns it with its assigned identifier.

func (*MediaStore) Delete added in v0.3.0 

func (s *MediaStore) Delete(ctx context.Context, id int64) (media.Media, error)

Delete removes the media item and returns it, or reports media.ErrNotFound.

func (*MediaStore) List added in v0.3.0 

func (s *MediaStore) List(ctx context.Context, f media.Filter) ([]media.Listed, int, error)

List returns the media items the filter matches, sorted as it names, beside their authors' names, with their total.

func (*MediaStore) Saved added in v0.18.0 

func (s *MediaStore) Saved(ctx context.Context, files []string) (map[string]bool, error)

Saved reports which of the files a stored item holds as its own file.

func (*MediaStore) Update added in v0.3.0 

func (s *MediaStore) Update(ctx context.Context, m media.Media, expectedUpdatedAt time.Time) (media.Media, error)

Update stores the media item's descriptions, or reports a missing item or a stale edit.

type SettingStore added in v0.2.0 

type SettingStore struct {
	// contains filtered or unexported fields
}

SettingStore persists named values in the core schema.

func NewSettingStore added in v0.2.0 

func NewSettingStore(pool *pgxpool.Pool) *SettingStore

NewSettingStore returns a SettingStore backed by pool.

func (*SettingStore) Lookup added in v0.2.0 

func (s *SettingStore) Lookup(ctx context.Context, key string) (string, bool, error)

Lookup returns the value stored under key and whether the key is set at all.

func (*SettingStore) Save added in v0.2.0 

func (s *SettingStore) Save(ctx context.Context, values map[string]string) error

Save stores every given value, or stores none of them.

func (*SettingStore) Update added in v0.20.0 

func (s *SettingStore) Update(
	ctx context.Context, keys []string, change func(held map[string]string) (map[string]string, error),
) error

Update stores what change makes of the values stored under keys, as one write no other Update overlaps.

type TypeStore added in v0.4.0 

type TypeStore struct {
	*typestore.Store
}

TypeStore persists the content type registry in the core schema.

func NewTypeStore added in v0.4.0 

func NewTypeStore(pool *pgxpool.Pool) *TypeStore

NewTypeStore returns a TypeStore backed by pool.

type UserSettingStore added in v0.6.0 

type UserSettingStore struct {
	// contains filtered or unexported fields
}

UserSettingStore persists one reader's own preferences in the core schema.

func NewUserSettingStore added in v0.6.0 

func NewUserSettingStore(pool *pgxpool.Pool) *UserSettingStore

NewUserSettingStore returns a UserSettingStore backed by pool.

func (*UserSettingStore) Lookup added in v0.6.0 

func (s *UserSettingStore) Lookup(
	ctx context.Context, userID uuid.UUID, key string,
) (string, bool, error)

Lookup returns the value the reader stored under key, and whether it is set at all.

func (*UserSettingStore) Save added in v0.6.0 

func (s *UserSettingStore) Save(ctx context.Context, userID uuid.UUID, key, value string) error

Save stores the value under the reader's key.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.