models

Documentation

Index

• type Key
• type Snapshot
• type Store
• type Value

Types

type Key

type Key struct {
	ID          string          `bson:"_id" json:"id"`
	StoreID     string          `bson:"store_id" json:"store_id"`
	Name        string          `json:"name"`
	Description string          `json:"description"`
	Type        string          `json:"type"`
	Encoding    string          `json:"encoding"`
	Expression  string          `json:"expression"`
	Notes       string          `json:"notes"`
	Tags        []modelcore.Tag `json:"tags"`
	modelcore.Auditable
}

Key model. This model represents a key in a store of key-value information.

type Snapshot

type Snapshot struct {
	ID      string          `bson:"_id" json:"id" jsonapi:"primary,snapshot"`
	StoreID string          `bson:"store_id" json:"store_id" jsonapi:"relation,store"`
	Name    string          `json:"name" jsonapi:"attr,name"`
	Notes   string          `json:"notes" jsonapi:"attr,notes"`
	Tags    []modelcore.Tag `json:"tags" jsonapi:"attr,tags"`
	modelcore.Auditable
}

Snapshot model. This model represents a snapshot of keys and values in a store.

type Store

type Store struct {
	ID                string          `bson:"_id" json:"id" jsonapi:"primary,store"`
	Name              string          `json:"name" jsonapi:"attr,name"`
	Description       string          `json:"description" jsonapi:"attr,description"`
	CurrentSnapshotID string          `bson:"current_snapshot_id" json:"current_snapshot_id" jsonapi:"relation,snapshot"`
	Notes             string          `json:"notes" jsonapi:"attr,notes"`
	Tags              []modelcore.Tag `json:"tags" jsonapi:"attr,tags"`
	modelcore.Auditable
}

Store model. This model represents a store of key-value information.

type Value

type Value struct {
	ID         string          `bson:"_id" json:"id" jsonapi:"primary,value"`
	StoreID    string          `bson:"store_id" json:"store_id" jsonapi:"relation,store"`
	KeyID      string          `bson:"key_id" json:"key_id" jsonapi:"relation,key"`
	SnapshotID string          `bson:"snapshot_id" json:"snapshot_id" jsonapi:"relation,snapshot"`
	Value      string          `json:"value" jsonapi:"attr,value"`
	Notes      string          `json:"notes" jsonapi:"attr,notes"`
	Tags       []modelcore.Tag `json:"tags" jsonapi:"attr,tags"`
	modelcore.Auditable
}

Value model. This model represents a store of key-value information.