attribution

Documentation

Overview

Package attribution implements value attribution from docs/design/value-attribution.md

Index

• Variables
• type CSVRow
• type DB
• type Info

Variables

var ErrBucketNotAttributed = errs.Class("bucket not attributed")

ErrBucketNotAttributed is returned if a requested bucket not attributed(entry not found).

Types

type CSVRow

type CSVRow struct {
	PartnerID         []byte
	ProjectID         []byte
	BucketName        []byte
	TotalBytesPerHour float64
	EgressData        int64
}

CSVRow represents data from QueryAttribution without exposing dbx.

type DB

type DB interface {
	// Get retrieves attribution info using project id and bucket name.
	Get(ctx context.Context, projectID uuid.UUID, bucketName []byte) (*Info, error)
	// Insert creates and stores new Info
	Insert(ctx context.Context, info *Info) (*Info, error)
	// QueryAttribution queries partner bucket attribution data
	QueryAttribution(ctx context.Context, partnerID uuid.UUID, start time.Time, end time.Time) ([]*CSVRow, error)
}

DB implements the database for value attribution table.

architecture: Database

type Info

type Info struct {
	ProjectID  uuid.UUID
	BucketName []byte
	PartnerID  uuid.UUID
	CreatedAt  time.Time
}

Info describing value attribution from partner to bucket.