online

Documentation

Index

• type CreateTableOpt
• type GetByGroupOpt
  • func (g *GetByGroupOpt) Validate() error
• type GetOpt
  • func (g *GetOpt) Validate() error
• type ImportOpt
• type MultiGetOpt
  • func (m *MultiGetOpt) Validate() error
• type PushOpt
• type Store

Types

type CreateTableOpt

type CreateTableOpt struct {
	EntityName string
	TableName  string
	Features   types.FeatureList
}

type GetByGroupOpt

type GetByGroupOpt struct {
	EntityKey  string
	Group      types.Group
	GetFeature func(featureID int) (*types.Feature, error)

	// Only works when get batch features, it should be nil when get stream features
	RevisionID *int
}

func (*GetByGroupOpt) Validate

func (g *GetByGroupOpt) Validate() error

type GetOpt

type GetOpt struct {
	EntityKey string
	Group     types.Group
	Features  types.FeatureList

	// Only works when get batch features, it should be nil when get stream features
	RevisionID *int
}

func (*GetOpt) Validate

func (g *GetOpt) Validate() error

type ImportOpt

type ImportOpt struct {
	Group        types.Group
	Features     types.FeatureList
	ExportStream <-chan types.ExportRecord
	RevisionID   *int
}

type MultiGetOpt

type MultiGetOpt struct {
	EntityKeys []string
	Group      types.Group
	Features   types.FeatureList

	// Only works when get batch features, it should be nil when get stream features
	RevisionID *int
}

func (*MultiGetOpt) Validate

func (m *MultiGetOpt) Validate() error

type PushOpt

type PushOpt struct {
	EntityName    string
	EntityKey     string
	GroupID       int
	Features      types.FeatureList
	FeatureValues []interface{}
}

type Store

type Store interface {
	Get(ctx context.Context, opt GetOpt) (dbutil.RowMap, error)
	GetByGroup(ctx context.Context, opt GetByGroupOpt) (dbutil.RowMap, error)
	MultiGet(ctx context.Context, opt MultiGetOpt) (map[string]dbutil.RowMap, error)
	Purge(ctx context.Context, revisionID int) error
	CreateTable(ctx context.Context, opt CreateTableOpt) error

	// Import batch / streaming features to online store
	Import(ctx context.Context, opt ImportOpt) error

	// Push streaming feature to online store
	// Note: Make sure that the table corresponding to the stream feature already exists before executing this method
	Push(ctx context.Context, opt PushOpt) error

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