perf/go/alerts/store.go

package alerts

import (
	"context"

	"github.com/jackc/pgx/v4"
)

type SubKey struct {
	SubName     string
	SubRevision string
}

type SaveRequest struct {
	Cfg    *Alert
	SubKey *SubKey
}

// Store is the interface used to persist Alerts.
type Store interface {
	// Save can write a new, or update an existing, Config. New Configs will
	// have an ID of -1. On insert the ID of the Alert will be updated.
	Save(ctx context.Context, req *SaveRequest) error

	// ReplaceAll will remove all existing Alerts, then it'll insert the
	// new input alerts and mark them as active.
	ReplaceAll(ctx context.Context, reqs []*SaveRequest, tx pgx.Tx) error

	// Delete removes the Alert with the given id.
	Delete(ctx context.Context, id int) error

	// List retrieves all the Alerts.
	//
	// If includeDeleted is true then deleted Alerts are also included in the
	// response.
	List(ctx context.Context, includeDeleted bool) ([]*Alert, error)

	// List all alerts under a given subscription.
	ListForSubscription(ctx context.Context, subName string) ([]*Alert, error)
}