actions

Documentation

Overview

Package actions provides canonical business logic that operates on Repos to get higher-order functionality. Actions use only Repo methods to do their work, allowing them to be used across any repo.Repo implementation

Index

• Constants
• func CanResolveEvents(left repo.Event, right repo.Event) bool
• type Dataset
  • func (act Dataset) AddDataset(ref *repo.DatasetRef) (err error)
  • func (act Dataset) CreateDataset(name string, ds *dataset.Dataset, data cafs.File, secrets map[string]string, ...) (ref repo.DatasetRef, err error)
  • func (act Dataset) DeleteDataset(ref repo.DatasetRef) error
  • func (act Dataset) ExecTransform(ds *dataset.Dataset, infile cafs.File, secrets map[string]string) (file cafs.File, err error)
  • func (act Dataset) PinDataset(ref repo.DatasetRef) error
  • func (act Dataset) PrepareViz(ds *dataset.Dataset) (err error)
  • func (act Dataset) ReadDataset(ref *repo.DatasetRef) (err error)
  • func (act Dataset) RenameDataset(a, b repo.DatasetRef) (err error)
  • func (act Dataset) Select(ref repo.DatasetRef, path string) (interface{}, error)
  • func (act Dataset) UnpinDataset(ref repo.DatasetRef) error
• type MergeResultEntry
  • func (e MergeResultEntry) NumConflicts() int
  • func (e MergeResultEntry) NumUpdates() int
• type MergeResultSet
  • func MergeRepoEvents(one repo.Repo, two repo.Repo) (MergeResultSet, error)
  • func (s MergeResultSet) Peer(i int) MergeResultEntry
• type Registry
  • func (act Registry) Pin(ref repo.DatasetRef, addrs []string) (err error)
  • func (act Registry) Publish(ref repo.DatasetRef) (err error)
  • func (act Registry) Status(ref repo.DatasetRef) (err error)
  • func (act Registry) Unpin(ref repo.DatasetRef, addrs []string) (err error)
  • func (act Registry) Unpublish(ref repo.DatasetRef) (err error)

Constants

const MaxDatasetSize = 1000000 * 250

MaxDatasetSize is the maximum size a dataset body can be before it cannot be uploaded to a registry TODO - this should be dictated by registries

Functions

func CanResolveEvents

func CanResolveEvents(left repo.Event, right repo.Event) bool

CanResolveEvents determines whether two Events can be resolved, or if they conflict.

Types

type Dataset

type Dataset struct {
	repo.Repo
}

Dataset wraps a repo.Repo, adding actions related to working with datasets

func (Dataset) AddDataset

func (act Dataset) AddDataset(ref *repo.DatasetRef) (err error)

AddDataset fetches & pins a dataset to the store, adding it to the list of stored refs

func (Dataset) CreateDataset

func (act Dataset) CreateDataset(name string, ds *dataset.Dataset, data cafs.File, secrets map[string]string, pin bool) (ref repo.DatasetRef, err error)

CreateDataset initializes a dataset from a dataset pointer and data file

func (Dataset) DeleteDataset

func (act Dataset) DeleteDataset(ref repo.DatasetRef) error

DeleteDataset removes a dataset from the store

func (Dataset) ExecTransform

func (act Dataset) ExecTransform(ds *dataset.Dataset, infile cafs.File, secrets map[string]string) (file cafs.File, err error)

ExecTransform executes a designated transformation

func (Dataset) PinDataset

func (act Dataset) PinDataset(ref repo.DatasetRef) error

PinDataset marks a dataset for retention in a store

func (Dataset) PrepareViz

func (act Dataset) PrepareViz(ds *dataset.Dataset) (err error)

PrepareViz loads vizualization bytes from a local filepath

func (Dataset) ReadDataset

func (act Dataset) ReadDataset(ref *repo.DatasetRef) (err error)

ReadDataset grabs a dataset from the store

func (Dataset) RenameDataset

func (act Dataset) RenameDataset(a, b repo.DatasetRef) (err error)

RenameDataset alters a dataset name

func (Dataset) Select

func (act Dataset) Select(ref repo.DatasetRef, path string) (interface{}, error)

Select loads a dataset value specified by case.Sensitve.dot.separated.paths

func (Dataset) UnpinDataset

func (act Dataset) UnpinDataset(ref repo.DatasetRef) error

UnpinDataset unmarks a dataset for retention in a store

type MergeResultEntry

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

MergeResultEntry contains information about how a single peer should update its EventLog.

func (MergeResultEntry) NumConflicts

func (e MergeResultEntry) NumConflicts() int

NumConflicts gets the number of conflicts.

func (MergeResultEntry) NumUpdates

func (e MergeResultEntry) NumUpdates() int

NumUpdates gets the number of updates.

type MergeResultSet

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

MergeResultSet contains information about how to merge a collection of EventLogs.

func MergeRepoEvents

func MergeRepoEvents(one repo.Repo, two repo.Repo) (MergeResultSet, error)

MergeRepoEvents tries to merge multiple EventLogs.

func (MergeResultSet) Peer

func (s MergeResultSet) Peer(i int) MergeResultEntry

Peer gets a MegeResultEntry for a single peer.

type Registry

type Registry struct {
	repo.Repo
}

Registry wraps a repo.Repo, adding actions related to working with registries

func (Registry) Pin

func (act Registry) Pin(ref repo.DatasetRef, addrs []string) (err error)

Pin requests a dataset be pinned to the designated registry

func (Registry) Publish

func (act Registry) Publish(ref repo.DatasetRef) (err error)

Publish a dataset to a repo's specified registry

func (Registry) Status

func (act Registry) Status(ref repo.DatasetRef) (err error)

Status checks to see if a dataset is published to a repo's specific registry

func (Registry) Unpin

func (act Registry) Unpin(ref repo.DatasetRef, addrs []string) (err error)

Unpin removes a pin from the remote registry

func (Registry) Unpublish

func (act Registry) Unpublish(ref repo.DatasetRef) (err error)

Unpublish a dataset from a repo's specified registry