postgres

Documentation

Overview

Package postgres is a baur-storage implementation storing data in postgresql.

Index

• type Client
  • func New(ctx context.Context, url string, logger Logger) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) CreateRelease(ctx context.Context, releaseName string, createdAt time.Time, taskRunIDs []int, ...) error
  • func (c *Client) Init(ctx context.Context) error
  • func (c *Client) Inputs(ctx context.Context, taskRunID int) (*storage.Inputs, error)
  • func (c *Client) IsCompatible(ctx context.Context) error
  • func (c *Client) LatestTaskRunByDigest(ctx context.Context, appName, taskName, totalInputDigest string) (*storage.TaskRunWithID, error)
  • func (c *Client) MaxSchemaVersion() int32
  • func (c *Client) Outputs(ctx context.Context, taskRunID int) ([]*storage.Output, error)
  • func (c *Client) ReleaseExists(ctx context.Context, name string) (bool, error)
  • func (c *Client) ReleaseMetadata(ctx context.Context, releaseName string) ([]byte, error)
  • func (c *Client) ReleaseTaskRuns(ctx context.Context, releaseName string) ([]*storage.ReleaseTaskRunsResult, error)
  • func (c *Client) ReleasesDelete(ctx context.Context, before time.Time, pretend bool) (*storage.ReleasesDeleteResult, error)
  • func (c *Client) SaveTaskRun(ctx context.Context, taskRun *storage.TaskRunFull) (int, error)
  • func (c *Client) SchemaVersion(ctx context.Context) (int32, error)
  • func (c *Client) TaskRun(ctx context.Context, id int) (*storage.TaskRunWithID, error)
  • func (c *Client) TaskRuns(ctx context.Context, filters []*storage.Filter, sorters []*storage.Sorter, ...) error
  • func (c *Client) TaskRunsDelete(ctx context.Context, before time.Time, pretend bool) (*storage.TaskRunsDeleteResult, error)
  • func (c *Client) Upgrade(ctx context.Context) error
• type Logger

Types

type Client

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

Client is a postgres storage client

func New

func New(ctx context.Context, url string, logger Logger) (*Client, error)

New returns a new postgres client. If logger is nil, logging is disabled.

func (*Client) Close

func (c *Client) Close() error

Close closes the connections of the client. It always returns a nil error.

func (*Client) CreateRelease

func (c *Client) CreateRelease(ctx context.Context, releaseName string, createdAt time.Time, taskRunIDs []int, metadata io.Reader) error

func (*Client) Init

func (c *Client) Init(ctx context.Context) error

Init creates the baur tables in the postgresql database. If the database already exist, storage.ErrExist is returned.

func (*Client) Inputs

func (c *Client) Inputs(ctx context.Context, taskRunID int) (*storage.Inputs, error)

func (*Client) IsCompatible

func (c *Client) IsCompatible(ctx context.Context) error

IsCompatible checks if the database schema exist and has the required migration version.

func (*Client) LatestTaskRunByDigest

func (c *Client) LatestTaskRunByDigest(ctx context.Context, appName, taskName, totalInputDigest string) (*storage.TaskRunWithID, error)

func (*Client) MaxSchemaVersion

func (c *Client) MaxSchemaVersion() int32

func (*Client) Outputs

func (c *Client) Outputs(ctx context.Context, taskRunID int) ([]*storage.Output, error)

func (*Client) ReleaseExists

func (c *Client) ReleaseExists(ctx context.Context, name string) (bool, error)

func (*Client) ReleaseMetadata

func (c *Client) ReleaseMetadata(ctx context.Context, releaseName string) ([]byte, error)

func (*Client) ReleaseTaskRuns

func (c *Client) ReleaseTaskRuns(ctx context.Context, releaseName string) ([]*storage.ReleaseTaskRunsResult, error)

func (*Client) ReleasesDelete

func (c *Client) ReleasesDelete(ctx context.Context, before time.Time, pretend bool) (*storage.ReleasesDeleteResult, error)

func (*Client) SaveTaskRun

func (c *Client) SaveTaskRun(ctx context.Context, taskRun *storage.TaskRunFull) (int, error)

func (*Client) SchemaVersion

func (c *Client) SchemaVersion(ctx context.Context) (int32, error)

func (*Client) TaskRun

func (c *Client) TaskRun(ctx context.Context, id int) (*storage.TaskRunWithID, error)

func (*Client) TaskRuns

func (c *Client) TaskRuns(
	ctx context.Context,
	filters []*storage.Filter,
	sorters []*storage.Sorter,
	limit uint,
	cb func(*storage.TaskRunWithID) error,
) error

func (*Client) TaskRunsDelete

func (c *Client) TaskRunsDelete(ctx context.Context, before time.Time, pretend bool) (*storage.TaskRunsDeleteResult, error)

func (*Client) Upgrade

func (c *Client) Upgrade(ctx context.Context) error

Upgrade transitions the database schema to the current version by running all migrations sql script that have a newer version then current schema version that the database uses. If the database does not exist, storage.ErrNotExist is returned.

type Logger

type Logger interface {
	Debugln(v ...any)
}

Logger is an interface for logging debug informations