storage

Documentation

Overview

Package storage contains types and functions for managing data storage in identity-api.

Index

• Variables
• func Diff[T any, V comparable](current, incoming []T, val func(T) V) (add, rm []T)
• func InMemoryCRDB() (testserver.TestServer, error)
• func RunMigrations(config crdbx.Config) error
• func SeedDatabase(config crdbx.Config, path string) error
• type Engine
  • func NewEngine(config crdbx.Config, opts ...EngineOption) (Engine, error)
• type EngineOption
  • func WithMigrations() EngineOption
  • func WithSeedData(data SeedData) EngineOption
• type SeedData
• type SeedIssuer
• type TransactionManager

Variables

var (
	// ErrorMissingContextTx represents an error where no context transaction was provided.
	ErrorMissingContextTx = fmt.Errorf("no transaction provided in context")
	// ErrorInvalidContextTx represents an error where the given context transaction is of the wrong type.
	ErrorInvalidContextTx = fmt.Errorf("invalid type for transaction context")
)

Functions

func Diff

func Diff[T any, V comparable](current, incoming []T, val func(T) V) (add, rm []T)

Diff compares the current and incoming values and returns the difference.

func InMemoryCRDB

func InMemoryCRDB() (testserver.TestServer, error)

InMemoryCRDB creates an in-memory CRDB test server.

func RunMigrations

func RunMigrations(config crdbx.Config) error

RunMigrations runs all migrations using the given storage config.

func SeedDatabase

func SeedDatabase(config crdbx.Config, path string) error

SeedDatabase seeds the database using the data at the given path

Types

type Engine

type Engine interface {
	types.IssuerService
	types.UserInfoService
	types.OAuthClientManager
	types.GroupService
	TransactionManager
}

Engine represents a storage engine.

func NewEngine

func NewEngine(config crdbx.Config, opts ...EngineOption) (Engine, error)

NewEngine creates a new storage engine based on the given config.

type EngineOption

type EngineOption func(*engine) error

EngineOption defines an initialization option for a storage engine.

func WithMigrations

func WithMigrations() EngineOption

WithMigrations runs migrations on the storage engine.

func WithSeedData

func WithSeedData(data SeedData) EngineOption

WithSeedData adds seed data to the storage engine.

type SeedData

type SeedData struct {
	Issuers []SeedIssuer
}

SeedData represents the seed data for an identity-api instance on startup.

type SeedIssuer

type SeedIssuer struct {
	OwnerID       gidx.PrefixedID   `yaml:"ownerID"`
	ID            gidx.PrefixedID   `yaml:"id"`
	Name          string            `yaml:"name"`
	URI           string            `yaml:"uri"`
	JWKSURI       string            `yaml:"jwksURI"`
	ClaimMappings map[string]string `yaml:"claimMappings"`
}

SeedIssuer represents the seed data for a single issuer.

type TransactionManager

type TransactionManager interface {
	BeginContext(context.Context) (context.Context, error)
	CommitContext(context.Context) error
	RollbackContext(context.Context) error
}

TransactionManager manages the state of sql transactions within a context