model

package

v1.6.0 Latest Latest Go to latest Published: Jun 20, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/micro/services

Links

Open Source Insights

Documentation ¶

Overview ¶

package model helps with data modelling on top of the store

Index ¶

Variables
func Create(ctx context.Context, e Entity) error
func Delete(ctx context.Context, e Entity) error
func List(ctx context.Context, e Entity, rsp interface{}, q Query) error
func Read(ctx context.Context, e Entity) error
func ReadIndex(ctx context.Context, e Entity) error
func Update(ctx context.Context, e Entity) error
type Entity
type Query

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNotFound      = errors.New("not found")
	ErrAlreadyExists = errors.New("already exists")
)

Functions ¶

func Create ¶

func Create(ctx context.Context, e Entity) error

func Delete ¶

func Delete(ctx context.Context, e Entity) error

func List ¶

func List(ctx context.Context, e Entity, rsp interface{}, q Query) error

func Read ¶

func Read(ctx context.Context, e Entity) error

func ReadIndex ¶

func ReadIndex(ctx context.Context, e Entity) error

func Update ¶

func Update(ctx context.Context, e Entity) error

Types ¶

type Entity ¶

type Entity interface {
	// The primary key
	Key(ctx context.Context) string
	// The index for the entity
	Index(ctx context.Context) string
	// The raw value of the entity
	Value() interface{}
}

type Query ¶

type Query struct {
	Limit  uint
	Offset uint
	Order  string
}

Source Files ¶

View all Source files

model.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL