state

Documentation

Index

• type State
  • func NewState(modelFactory database.TxnRunnerFactory) *State
  • func (s *State) GetModelConfigKeyValues(ctx context.Context, keys ...string) (map[string]string, error)
  • func (s *State) ModelID(ctx context.Context) (model.UUID, error)

Types

type State

type State struct {
	*domain.StateBase
}

State is responsible for accessing the controller/model DB to retrieve the controller/model config keys required for the container config.

func NewState

func NewState(modelFactory database.TxnRunnerFactory) *State

NewState creates a new State object.

func (*State) GetModelConfigKeyValues

func (s *State) GetModelConfigKeyValues(
	ctx context.Context,
	keys ...string,
) (map[string]string, error)

GetModelConfigKeyValues returns the values of the specified model config keys from the model database. If a key cannot be found in model config, it will be omitted from the result. If no keys are specified, then this method returns an empty map.

func (*State) ModelID

func (s *State) ModelID(ctx context.Context) (model.UUID, error)

ModelID returns the UUID of the current model. If the model cannot be found, an error is returned satisfying modelerrors.NotFound.