fathom/pkg/datastore/datastore.go

package datastore

import (
	"time"

	"github.com/usefathom/fathom/pkg/datastore/sqlstore"
	"github.com/usefathom/fathom/pkg/models"
)

// ErrNoResults is returned whenever a single-item query returns 0 results
var ErrNoResults = sqlstore.ErrNoResults // ???

// Datastore represents a database implementations
type Datastore interface {
	// users
	GetUser(int64) (*models.User, error)
	GetUserByEmail(string) (*models.User, error)
	SaveUser(*models.User) error
	CountUsers() (int64, error)

	// site stats
	GetSiteStats(time.Time) (*models.SiteStats, error)
	GetSiteStatsPerDay(time.Time, time.Time) ([]*models.SiteStats, error)
	InsertSiteStats(*models.SiteStats) error
	UpdateSiteStats(*models.SiteStats) error
	GetAggregatedSiteStats(time.Time, time.Time) (*models.SiteStats, error)
	GetTotalSiteViews(time.Time, time.Time) (int, error)
	GetTotalSiteVisitors(time.Time, time.Time) (int, error)
	GetTotalSiteSessions(time.Time, time.Time) (int, error)
	GetAverageSiteDuration(time.Time, time.Time) (float64, error)
	GetAverageSiteBounceRate(time.Time, time.Time) (float64, error)
	GetRealtimeVisitorCount() (int, error)

	// pageviews
	InsertPageviews([]*models.Pageview) error
	UpdatePageviews([]*models.Pageview) error
	GetPageview(string) (*models.Pageview, error)
	GetProcessablePageviews() ([]*models.Pageview, error)
	DeletePageviews([]*models.Pageview) error

	// page stats
	GetPageStats(time.Time, string, string) (*models.PageStats, error)
	InsertPageStats(*models.PageStats) error
	UpdatePageStats(*models.PageStats) error
	GetAggregatedPageStats(time.Time, time.Time, int) ([]*models.PageStats, error)
	GetAggregatedPageStatsPageviews(time.Time, time.Time) (int, error)

	// referrer stats
	GetReferrerStats(time.Time, string, string) (*models.ReferrerStats, error)
	InsertReferrerStats(*models.ReferrerStats) error
	UpdateReferrerStats(*models.ReferrerStats) error
	GetAggregatedReferrerStats(time.Time, time.Time, int) ([]*models.ReferrerStats, error)
	GetAggregatedReferrerStatsPageviews(time.Time, time.Time) (int, error)

	// misc
	Close() error
}

// New instantiates a new datastore from the given configuration struct
func New(c *sqlstore.Config) Datastore {
	return sqlstore.New(c)
}