changes

Documentation

Index

• type ChangeReportComponent
• type ChangeReportDeltaComponent
• type ChangeReportResponse
• type EmptyObject
• type Service
  • func New(loader dsref.Loader, stats *stats.Service) Service
• type StatsChangeComponent
• type StatsChangeSummaryFields

Types

type ChangeReportComponent

type ChangeReportComponent struct {
	Left  interface{}            `json:"left"`
	Right interface{}            `json:"right"`
	About map[string]interface{} `json:"about,omitempty"`
}

ChangeReportComponent is a generic component used to populate the change report

type ChangeReportDeltaComponent

type ChangeReportDeltaComponent struct {
	ChangeReportComponent
	Title string      `json:"title,omitempty"`
	Delta interface{} `json:"delta"`
}

ChangeReportDeltaComponent is a subcomponent that can hold delta information between left and right

type ChangeReportResponse

type ChangeReportResponse struct {
	VersionInfo *ChangeReportComponent `json:"version_info,omitempty"`
	Commit      *ChangeReportComponent `json:"commit,omitempty"`
	Meta        *ChangeReportComponent `json:"meta,omitempty"`
	Readme      *ChangeReportComponent `json:"readme,omitempty"`
	Structure   *ChangeReportComponent `json:"structure,omitempty"`
	Transform   *ChangeReportComponent `json:"transform,omitempty"`
	Stats       *StatsChangeComponent  `json:"stats,omitempty"`
}

ChangeReportResponse is the result of a call to changereport

type EmptyObject

type EmptyObject map[string]interface{}

EmptyObject is used mostly as a placeholder in palces where it is required that a key is present in the response even if empty and not be nil

type Service

type Service interface {
	Report(ctx context.Context, leftRef, rightRef string) (*ChangeReportResponse, error)
}

Service generates a change report between two datasets

func New

func New(loader dsref.Loader, stats *stats.Service) Service

New allocates a Change service

type StatsChangeComponent

type StatsChangeComponent struct {
	Summary *ChangeReportDeltaComponent   `json:"summary"`
	Columns []*ChangeReportDeltaComponent `json:"columns"`
}

StatsChangeComponent represents the stats change report

type StatsChangeSummaryFields

type StatsChangeSummaryFields struct {
	Entries int `json:"entries"`
	Columns int `json:"columns"`
	// NullValues int `json:"nullValues"`
	TotalSize int `json:"totalSize"`
}

StatsChangeSummaryFields represents the stats summary