manifest

Documentation

Overview

Package manifest implements support for managing JSON-based manifests in repository.

Index

• Constants
• Variables
• type EntryMetadata
• type ID
• type Manager
  • func NewManager(ctx context.Context, b contentManager, options ManagerOptions) (*Manager, error)
  • func (m *Manager) Compact(ctx context.Context) error
  • func (m *Manager) Delete(ctx context.Context, id ID) error
  • func (m *Manager) Find(ctx context.Context, labels map[string]string) ([]*EntryMetadata, error)
  • func (m *Manager) Flush(ctx context.Context) error
  • func (m *Manager) Get(ctx context.Context, id ID, data interface{}) (*EntryMetadata, error)
  • func (m *Manager) GetMetadata(ctx context.Context, id ID) (*EntryMetadata, error)
  • func (m *Manager) Put(ctx context.Context, labels map[string]string, payload interface{}) (ID, error)
  • func (m *Manager) Refresh(ctx context.Context) error
• type ManagerOptions

Constants

const (
	ContentPrefix = "m"
)

ContentPrefix is the prefix of the content id for manifests.

const TypeLabelKey = "type"

TypeLabelKey is the label key for manifest type.

Variables

var ErrNotFound = errors.New("not found")

ErrNotFound is returned when the metadata item is not found.

Types

type EntryMetadata

type EntryMetadata struct {
	ID      ID                `json:"id"`
	Length  int               `json:"length"`
	Labels  map[string]string `json:"labels"`
	ModTime time.Time         `json:"mtime"`
}

EntryMetadata contains metadata about manifest item. Each manifest item has one or more labels Including required "type" label.

type ID

type ID string

ID is a unique identifier of a single manifest.

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

Manager organizes JSON manifests of various kinds, including snapshot manifests.

func NewManager

func NewManager(ctx context.Context, b contentManager, options ManagerOptions) (*Manager, error)

NewManager returns new manifest manager for the provided content manager.

func (*Manager) Compact

func (m *Manager) Compact(ctx context.Context) error

Compact performs compaction of manifest contents.

func (*Manager) Delete

func (m *Manager) Delete(ctx context.Context, id ID) error

Delete marks the specified manifest ID for deletion.

func (*Manager) Find

func (m *Manager) Find(ctx context.Context, labels map[string]string) ([]*EntryMetadata, error)

Find returns the list of EntryMetadata for manifest entries matching all provided labels.

func (*Manager) Flush

func (m *Manager) Flush(ctx context.Context) error

Flush persists changes to manifest manager.

func (*Manager) Get

func (m *Manager) Get(ctx context.Context, id ID, data interface{}) (*EntryMetadata, error)

Get retrieves the contents of the provided manifest item by deserializing it as JSON to provided object. If the manifest is not found, returns ErrNotFound.

func (*Manager) GetMetadata

func (m *Manager) GetMetadata(ctx context.Context, id ID) (*EntryMetadata, error)

GetMetadata returns metadata about provided manifest item or ErrNotFound if the item can't be found.

func (*Manager) Put

func (m *Manager) Put(ctx context.Context, labels map[string]string, payload interface{}) (ID, error)

Put serializes the provided payload to JSON and persists it. Returns unique identifier that represents the manifest.

func (*Manager) Refresh

func (m *Manager) Refresh(ctx context.Context) error

Refresh updates the committed contents from the underlying storage.

type ManagerOptions

type ManagerOptions struct {
	TimeNow func() time.Time // Time provider
}

ManagerOptions are optional parameters for Manager creation.