store

Documentation

Index

• Constants
• Variables
• type CreateOptions
• type DeleteOptions
• type Event
• type EventType
• type GetOptions
• type ListOptions
• type Store
• type UpdateOptions
• type WatchOptions
• type WatchStartTimeStamp

Constants

const (
	// EventAdd add event
	EventAdd = "add"
	// EventUpdate update event
	EventUpdate = "update"
	// EventDelete delete event
	EventDelete = "delete"
	// EventClose close event
	EventClose = "close"
	// EventError err event
	EventError = "error"
)

Variables

var (
	// ErrObjectNotFound error for object not found
	ErrObjectNotFound = errors.New("object not found")
	// ErrObjectExists error for object exists
	ErrObjectExists = errors.New("object already exists")
)

Types

type CreateOptions

type CreateOptions struct {
	// UpdateExists if do update when exists
	UpdateExists bool
	Env          string
}

CreateOptions options for create operation

type DeleteOptions

type DeleteOptions struct {
	// IgnoreNotFound if return err when data not found
	IgnoreNotFound bool
	Env            string
}

DeleteOptions options for delete operation

type Event

type Event struct {
	Type EventType
	Obj  *types.RawObject
}

Event event for store watch

type EventType

type EventType string

EventType event type for store

type GetOptions

type GetOptions struct {
	Env string
}

GetOptions options for get operation

type ListOptions

type ListOptions struct {
	Selector  *types.ValueSelector
	Cluster   string
	Namespace string
	Offset    int64
	Limit     int64
	Env       string
}

ListOptions options for list operation

type Store

type Store interface {
	Get(ctx context.Context, t types.ObjectType, key types.ObjectKey, opt *GetOptions) (*types.RawObject, error)
	Create(ctx context.Context, obj *types.RawObject, opt *CreateOptions) error
	Update(ctx context.Context, obj *types.RawObject, opt *UpdateOptions) error
	Delete(ctx context.Context, obj *types.RawObject, opt *DeleteOptions) error
	List(ctx context.Context, objectType types.ObjectType, opts *ListOptions) ([]*types.RawObject, error)
	Watch(ctx context.Context, resourceType types.ObjectType, opts *WatchOptions) (chan *Event, error)
}

Store interface for store object

type UpdateOptions

type UpdateOptions struct {
	// CreateNotExists if do creation when not exists
	CreateNotExists bool
	Env             string
}

UpdateOptions options for update operation

type WatchOptions

type WatchOptions struct {
	Selector     *types.ValueSelector
	BatchSize    int32
	MaxAwaitTime time.Duration
	StartTime    *WatchStartTimeStamp
	Env          string
}

WatchOptions options for watch operation

type WatchStartTimeStamp

type WatchStartTimeStamp struct {
	T uint32
	I uint32
}

WatchStartTimeStamp start time stamp for watch