datastore

Documentation

Index

• Variables
• type Datastore
  • func NewDatastore(db qrm.DB) *Datastore
  • func (d *Datastore) CreateAuditEvent(ctx context.Context, event *entities.AuditEvent) error
  • func (d *Datastore) CreateResource(ctx context.Context, resource *entities.Resource) error
  • func (d *Datastore) DeleteResource(ctx context.Context, id uuid.UUID) error
  • func (d *Datastore) GetResource(ctx context.Context, id uuid.UUID) (*entities.Resource, error)
  • func (d *Datastore) ListAuditEvents(ctx context.Context) ([]*entities.AuditEvent, error)
  • func (d *Datastore) ListResources(ctx context.Context) ([]*entities.Resource, error)
  • func (d *Datastore) UpdateResource(ctx context.Context, resource *entities.Resource) (*entities.Resource, error)
  • func (d *Datastore) WatchAuditEvents(ctx context.Context, ch chan<- *entities.AuditEvent) error
• type Provider
  • func NewProvider(db *sql.DB) *Provider
  • func (p *Provider) BeginTx(ctx context.Context) (txn.Datastore, txn.CommitFn, txn.RollbackFn, error)
  • func (p *Provider) Datastore() txn.Datastore

Variables

var MigrationFS embed.FS

MigrationFS is an embedded filesystem containing all SQL migrations necessary for provisioning the database.

Migration filenames must be in the format <version>_<name>.sql, where version is a 4 digit number. The first version is 0001, the second 0002, and so on. The leading 0s are stripped from the version during migration, so exist only to support numerical ordering when listing files.

Types

type Datastore

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

Datastore provides various operations for manipulating a database.

func NewDatastore

func NewDatastore(db qrm.DB) *Datastore

NewDatastore creates a new Datastore.

func (*Datastore) CreateAuditEvent

func (d *Datastore) CreateAuditEvent(ctx context.Context, event *entities.AuditEvent) error

...

func (*Datastore) CreateResource

func (d *Datastore) CreateResource(ctx context.Context, resource *entities.Resource) error

...

func (*Datastore) DeleteResource

func (d *Datastore) DeleteResource(ctx context.Context, id uuid.UUID) error

...

func (*Datastore) GetResource

func (d *Datastore) GetResource(ctx context.Context, id uuid.UUID) (*entities.Resource, error)

...

func (*Datastore) ListAuditEvents

func (d *Datastore) ListAuditEvents(ctx context.Context) ([]*entities.AuditEvent, error)

...

func (*Datastore) ListResources

func (d *Datastore) ListResources(ctx context.Context) ([]*entities.Resource, error)

...

func (*Datastore) UpdateResource

func (d *Datastore) UpdateResource(
	ctx context.Context,
	resource *entities.Resource,
) (*entities.Resource, error)

...

func (*Datastore) WatchAuditEvents

func (d *Datastore) WatchAuditEvents(ctx context.Context, ch chan<- *entities.AuditEvent) error

...

TODO: decide how to implement this, use poller or notify?

type Provider

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

Provider is used to create a Datastore with an optional transaction.

When using transactions, it is recommended to use TxFunc, TxValue or TxValues in the common adapter. This reduces boilerplate by abstracting away the commit and rollback of the transaction.

func NewProvider

func NewProvider(db *sql.DB) *Provider

NewProvider creates a new Provider.

func (*Provider) BeginTx

func (p *Provider) BeginTx(
	ctx context.Context,
) (txn.Datastore, txn.CommitFn, txn.RollbackFn, error)

BeginTx creates a Datastore within a transaction.

func (*Provider) Datastore

func (p *Provider) Datastore() txn.Datastore

Datastore creates a Datastore without a transaction.