system

Documentation

Overview

Package system provides resources related to the DB state itself.

Index

• Constants
• type DBVersion
  • func NewDBVersion(ns, id string) *DBVersion
• type DBVersionExtension
  • func (DBVersionExtension) ResourceDefinition() meta.ResourceDefinitionSpec
• type DBVersionSpec
• type SysVersion
  • func NewSysVersion(ns, id string) *SysVersion
• type SysVersionExtension
  • func (SysVersionExtension) ResourceDefinition() meta.ResourceDefinitionSpec
• type SysVersionSpec

Constants

const (
	// DBVersionType is the type of DBVersion resource.
	DBVersionType = resource.Type("DBVersions.system.sidero.dev")
	// DBVersionID is the single resource id.
	DBVersionID = resource.ID("current")
)

const (
	// SysVersionType is the type of SysVersion resource.
	//
	// tsgen:SysVersionType
	SysVersionType = resource.Type("SysVersions.system.sidero.dev")
	// SysVersionID is the single resource id.
	//
	// tsgen:SysVersionID
	SysVersionID = resource.ID("current")
)

Types

type DBVersion

type DBVersion = typed.Resource[DBVersionSpec, DBVersionExtension]

DBVersion resource describes current DB version (migrations state).

func NewDBVersion

func NewDBVersion(ns, id string) *DBVersion

NewDBVersion creates new DBVersion state.

type DBVersionExtension

type DBVersionExtension struct{}

DBVersionExtension providers auxiliary methods for DBVersion resource.

func (DBVersionExtension) ResourceDefinition

func (DBVersionExtension) ResourceDefinition() meta.ResourceDefinitionSpec

ResourceDefinition implements typed.Extension interface.

type DBVersionSpec

type DBVersionSpec = protobuf.ResourceSpec[specs.DBVersionSpec, *specs.DBVersionSpec]

DBVersionSpec wraps specs.DBVersionSpec.

type SysVersion

type SysVersion = typed.Resource[SysVersionSpec, SysVersionExtension]

SysVersion resource describes current DB SysVersion (migrations state).

func NewSysVersion

func NewSysVersion(ns, id string) *SysVersion

NewSysVersion creates new SysVersion state.

type SysVersionExtension

type SysVersionExtension struct{}

SysVersionExtension providers auxiliary methods for SysVersion resource.

func (SysVersionExtension) ResourceDefinition

func (SysVersionExtension) ResourceDefinition() meta.ResourceDefinitionSpec

ResourceDefinition implements typed.Extension interface.

type SysVersionSpec

type SysVersionSpec = protobuf.ResourceSpec[specs.SysVersionSpec, *specs.SysVersionSpec]

SysVersionSpec wraps specs.SysVersionSpec.