grafana/pkg/storage/secret/metadata/query.go

package metadata

import (
	"embed"
	"fmt"
	"text/template"

	"github.com/grafana/grafana/pkg/storage/unified/sql/sqltemplate"
)

var (
	//go:embed data/*.sql
	sqlTemplatesFS embed.FS

	sqlTemplates = template.Must(template.New("sql").ParseFS(sqlTemplatesFS, `data/*.sql`))

	// The SQL Commands
	sqlKeeperCreate      = mustTemplate("keeper_create.sql")
	sqlKeeperRead        = mustTemplate("keeper_read.sql")
	sqlKeeperReadActive  = mustTemplate("keeper_read_active.sql")
	sqlKeeperUpdate      = mustTemplate("keeper_update.sql")
	sqlKeeperList        = mustTemplate("keeper_list.sql")
	sqlKeeperDelete      = mustTemplate("keeper_delete.sql")
	sqlKeeperSetAsActive = mustTemplate("keeper_set_as_active.sql")

	sqlKeeperListByName      = mustTemplate("keeper_listByName.sql")
	sqlSecureValueListByName = mustTemplate("secure_value_listByName.sql")

	sqlSecureValueRead             = mustTemplate("secure_value_read.sql")
	sqlSecureValueList             = mustTemplate("secure_value_list.sql")
	sqlSecureValueCreate           = mustTemplate("secure_value_create.sql")
	sqlSecureValueUpdateExternalId = mustTemplate("secure_value_updateExternalId.sql")
	sqlSecureValueDelete           = mustTemplate("secure_value_delete.sql")
	sqlSecureValueLeaseInactive    = mustTemplate("secure_value_lease_inactive.sql")
	sqlSecureValueListByLeaseToken = mustTemplate("secure_value_list_by_lease_token.sql")

	sqlGetLatestSecureValueVersionAndCreatedAt = mustTemplate("secure_value_get_latest_version_and_created_at.sql")
	sqlSecureValueSetVersionToActive           = mustTemplate("secure_value_set_version_to_active.sql")
	sqlSecureValueSetVersionToInactive         = mustTemplate("secure_value_set_version_to_inactive.sql")
)

func mustTemplate(filename string) *template.Template {
	if t := sqlTemplates.Lookup(filename); t != nil {
		return t
	}
	panic(fmt.Sprintf("template file not found: %s", filename))
}

/************************/
/**-- Keeper Queries --**/
/************************/

// Set as active
type setKeeperAsActive struct {
	sqltemplate.SQLTemplate
	Namespace string
	Name      string
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r setKeeperAsActive) Validate() error {
	return nil // TODO
}

// Create
type createKeeper struct {
	sqltemplate.SQLTemplate
	Row *keeperDB
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r createKeeper) Validate() error {
	return nil // TODO
}

// Read
type readKeeper struct {
	sqltemplate.SQLTemplate
	Namespace   string
	Name        string
	IsForUpdate bool
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r readKeeper) Validate() error {
	return nil // TODO
}

// Read active keeper
type readActiveKeeper struct {
	sqltemplate.SQLTemplate
	Namespace string
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r readActiveKeeper) Validate() error {
	return nil // TODO
}

// Update
type updateKeeper struct {
	sqltemplate.SQLTemplate
	Row *keeperDB
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r updateKeeper) Validate() error {
	return nil // TODO
}

// List
type listKeeper struct {
	sqltemplate.SQLTemplate
	Namespace string
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r listKeeper) Validate() error {
	return nil // TODO
}

// Delete
type deleteKeeper struct {
	sqltemplate.SQLTemplate
	Namespace string
	Name      string
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r deleteKeeper) Validate() error {
	return nil // TODO
}

// This is used at keeper store to validate create & update operations
type listByNameSecureValue struct {
	sqltemplate.SQLTemplate
	Namespace        string
	UsedSecureValues []string
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r listByNameSecureValue) Validate() error {
	return nil // TODO
}

// This is used at keeper store to validate create & update operations
type listByNameKeeper struct {
	sqltemplate.SQLTemplate
	Namespace   string
	KeeperNames []string
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r listByNameKeeper) Validate() error {
	return nil // TODO
}

/******************************/
/**-- Secure Value Queries --**/
/******************************/

type readSecureValue struct {
	sqltemplate.SQLTemplate
	Namespace   string
	Name        string
	IsForUpdate bool
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r readSecureValue) Validate() error {
	return nil // TODO
}

type getLatestSecureValueVersionAndCreatedAt struct {
	sqltemplate.SQLTemplate
	Namespace string
	Name      string
}

func (r getLatestSecureValueVersionAndCreatedAt) Validate() error {
	return nil
}

type secureValueSetVersionToActive struct {
	sqltemplate.SQLTemplate
	Namespace string
	Name      string
	Version   int64
}

func (r secureValueSetVersionToActive) Validate() error {
	return nil
}

type secureValueSetVersionToInactive struct {
	sqltemplate.SQLTemplate
	Namespace string
	Name      string
	Version   int64
}

func (r secureValueSetVersionToInactive) Validate() error {
	return nil
}

type listSecureValue struct {
	sqltemplate.SQLTemplate
	Namespace string
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r listSecureValue) Validate() error {
	return nil // TODO
}

type createSecureValue struct {
	sqltemplate.SQLTemplate
	Row *secureValueDB
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r createSecureValue) Validate() error {
	return nil // TODO
}

// Update externalId
type updateExternalIdSecureValue struct {
	sqltemplate.SQLTemplate
	Namespace  string
	Name       string
	Version    int64
	ExternalID string
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r updateExternalIdSecureValue) Validate() error {
	return nil // TODO
}

type deleteSecureValue struct {
	sqltemplate.SQLTemplate
	Namespace string
	Name      string
	Version   int64
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r deleteSecureValue) Validate() error {
	return nil // TODO
}

type leaseInactiveSecureValues struct {
	sqltemplate.SQLTemplate
	LeaseToken   string
	MaxBatchSize uint16
	MinAge       int64
	LeaseTTL     int64
	Now          int64
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r leaseInactiveSecureValues) Validate() error {
	return nil // TODO
}

type listSecureValuesByLeaseToken struct {
	sqltemplate.SQLTemplate
	LeaseToken string
}

// Validate is only used if we use `dbutil` from `unifiedstorage`
func (r listSecureValuesByLeaseToken) Validate() error {
	return nil // TODO
}