rev

Documentation

Overview

Package rev defines structure and syntax for specifying revisions of a dataset history. Much of this is inspired by git revisions: https://git-scm.com/docs/gitrevisions

Unlike git, Qri is aware of the underlying data model it's selecting against, so revisions can have conventional names for specifying fields of a dataset

Index

• Constants
• type Rev
  • func NewAllRevisions() Rev
  • func ParseRev(rev string) (*Rev, error)
  • func ParseRevs(str string) (revs []*Rev, err error)

Constants

const AllGenerations = -1

AllGenerations represents all the generations of a dataset's history

Types

type Rev

type Rev struct {
	// field scopt, currently can only be a component name, or the entire dataset
	Field string
	// the nth-generational ancestor of a history
	Gen int
}

Rev names a field of a dataset at a snapshot

func NewAllRevisions

func NewAllRevisions() Rev

NewAllRevisions returns a Rev struct that represents all revisions.

func ParseRev

func ParseRev(rev string) (*Rev, error)

ParseRev turns a string into a revision

func ParseRevs

func ParseRevs(str string) (revs []*Rev, err error)

ParseRevs turns a comma-separated list of revisions into a slice of revisions