metadata

Documentation

Index

• type CacheStore
• type CreateEntityOpt
• type CreateFeatureOpt
• type CreateGroupOpt
• type CreateRevisionOpt
• type DBStore
• type ListCachedFeatureOpt
• type ListFeatureOpt
• type ListGroupOpt
• type SqlxContext
• type Store
• type UpdateEntityOpt
• type UpdateFeatureOpt
• type UpdateGroupOpt
• type UpdateRevisionOpt

Types

type CacheStore

type CacheStore interface {
	ListCachedFeature(ctx context.Context, opt ListCachedFeatureOpt) types.FeatureList
	GetCachedGroup(ctx context.Context, id int) (*types.Group, error)

	// Refresh pulls data from database and update cache.
	Refresh() error
}

CacheStore defines methods that a memory backend store must implement.

type CreateEntityOpt

type CreateEntityOpt struct {
	types.CreateEntityOpt
}

Create

type CreateFeatureOpt

type CreateFeatureOpt struct {
	FeatureName string
	GroupID     int
	Description string
	ValueType   types.ValueType
}

type CreateGroupOpt

type CreateGroupOpt struct {
	GroupName   string
	EntityID    int
	Description string
	Category    types.Category

	SnapshotInterval int
}

type CreateRevisionOpt

type CreateRevisionOpt struct {
	Revision      int64
	GroupID       int
	SnapshotTable *string
	CdcTable      *string
	Anchored      bool
	Description   string
}

type DBStore

type DBStore interface {
	// entity
	CreateEntity(ctx context.Context, opt CreateEntityOpt) (int, error)
	UpdateEntity(ctx context.Context, opt UpdateEntityOpt) error
	GetEntity(ctx context.Context, id int) (*types.Entity, error)
	GetEntityByName(ctx context.Context, name string) (*types.Entity, error)
	ListEntity(ctx context.Context, entityIDs *[]int) (types.EntityList, error)

	// feature
	CreateFeature(ctx context.Context, opt CreateFeatureOpt) (int, error)
	UpdateFeature(ctx context.Context, opt UpdateFeatureOpt) error
	GetFeature(ctx context.Context, id int) (*types.Feature, error)
	GetFeatureByName(ctx context.Context, groupName string, featureName string) (*types.Feature, error)
	ListFeature(ctx context.Context, opt ListFeatureOpt) (types.FeatureList, error)

	// feature group
	CreateGroup(ctx context.Context, opt CreateGroupOpt) (int, error)
	UpdateGroup(ctx context.Context, opt UpdateGroupOpt) error
	GetGroup(ctx context.Context, id int) (*types.Group, error)
	GetGroupByName(ctx context.Context, name string) (*types.Group, error)
	ListGroup(ctx context.Context, opt ListGroupOpt) (types.GroupList, error)

	// revision
	CreateRevision(ctx context.Context, opt CreateRevisionOpt) (int, error)
	UpdateRevision(ctx context.Context, opt UpdateRevisionOpt) error
	GetRevision(ctx context.Context, id int) (*types.Revision, error)
	GetRevisionBy(ctx context.Context, groupID int, revision int64) (*types.Revision, error)
	ListRevision(ctx context.Context, groupID *int) (types.RevisionList, error)

	// transaction
	WithTransaction(ctx context.Context, fn func(context.Context, DBStore) error) error
}

DBStore defines the methods that a database backend store must implement.

type ListCachedFeatureOpt

type ListCachedFeatureOpt struct {
	FullNames *[]string
	GroupName *string
	GroupID   *int
}

type ListFeatureOpt

type ListFeatureOpt struct {
	EntityIDs  *[]int
	GroupIDs   *[]int
	FeatureIDs *[]int
}

type ListGroupOpt

type ListGroupOpt struct {
	EntityIDs *[]int
	GroupIDs  *[]int
}

type SqlxContext

type SqlxContext interface {
	GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
	SelectContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
	ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)

	DriverName() string
	Rebind(string) string
}

type Store

type Store interface {
	DBStore
	CacheStore

	Ping(ctx context.Context) error
	io.Closer
}

type UpdateEntityOpt

type UpdateEntityOpt struct {
	EntityID       int
	NewDescription *string
}

Update

type UpdateFeatureOpt

type UpdateFeatureOpt struct {
	FeatureID      int
	NewDescription *string
}

type UpdateGroupOpt

type UpdateGroupOpt struct {
	GroupID             int
	NewSnapshotInterval *int
	NewDescription      *string
	NewOnlineRevisionID *int
}

type UpdateRevisionOpt

type UpdateRevisionOpt struct {
	RevisionID       int
	NewRevision      *int64
	NewAnchored      *bool
	NewSnapshotTable *string
	NewCdcTable      *string
}