db

Documentation

Overview

Package db handles interactions with the MongoDB instance and works as an abstraction layer

Index

• func PGTimestamp(t time.Time) pgtype.Timestamp
• func PGUint64(x uint64) pgtype.Numeric
• type Assignment
  • func (a *Assignment) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error
• type Campaign
  • func (c *Campaign) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error
• type Client
  • func New(cfg *config.Config, logger *log.Logger) (*Client, error)
  • func (c *Client) Connect(ctx context.Context) error
  • func (c *Client) Disconnect() error
  • func (c *Client) Merge(ctx context.Context, mergers ...[]EntityMerger) error
  • func (c *Client) MigrateUp(migrationsFolder string) error
• type Dispatch
  • func (d *Dispatch) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error
• type EntityMerger
• type Event
  • func (e *Event) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error
• type Planet
  • func (p *Planet) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error
• type PlanetSnapshot
• type Snapshot
  • func (s *Snapshot) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error
• type War
  • func (w *War) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error

Functions

func PGTimestamp

func PGTimestamp(t time.Time) pgtype.Timestamp

PGTimestamp converts a `time.Time` to a `pgx`-compatible `pgtype.Timestamp`.

func PGUint64

func PGUint64(x uint64) pgtype.Numeric

PGUint64 converts a `uint64` to a `pgx`-compatible `pgtype.Numeric`.

Types

type Assignment

type Assignment struct {
	gen.Assignment
	Tasks []gen.AssignmentTask
}

Assignment implements EntityMerger

func (*Assignment) Merge

func (a *Assignment) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error

Merge implements EntityMerger.

type Campaign

type Campaign gen.Campaign

Campaign implements EntityMerger

func (*Campaign) Merge

func (c *Campaign) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error

Merge implements EntityMerger. It is assumed that the currently known planets are already present in the database.

type Client

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

Client is the abstraction layer for the MongoDB connector

func New

func New(cfg *config.Config, logger *log.Logger) (*Client, error)

New creates a new client and connects it to the DB

func (*Client) Connect

func (c *Client) Connect(ctx context.Context) error

Connect implements main.ConnectWaiter.

func (*Client) Disconnect

func (c *Client) Disconnect() error

Disconnect disconnects from the MongoDB instance

func (*Client) Merge

func (c *Client) Merge(ctx context.Context, mergers ...[]EntityMerger) error

Merge attempts to merge each `EntityMerger` to the database.

It will print statistics once finished.

func (*Client) MigrateUp

func (c *Client) MigrateUp(migrationsFolder string) error

MigrateUp runs required migrations to get to the latest version.

This should be run before any other operations.

type Dispatch

type Dispatch gen.Dispatch

Dispatch implements EntityMerger

func (*Dispatch) Merge

func (d *Dispatch) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error

Merge implements EntityMerger.

type EntityMerger

type EntityMerger interface {
	// Merge merges the implementing entity to the database. It should call `onMerge` when finished.
	Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error
}

EntityMerger provide a means of merging an entity to the database.

type Event

type Event gen.Event

Event implements EntityMerger

func (*Event) Merge

func (e *Event) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error

Merge implements EntityMerger.

type Planet

type Planet struct {
	gen.Planet
	Biome   gen.Biome
	Hazards []gen.Hazard
}

Planet implements EntityMerger

func (*Planet) Merge

func (p *Planet) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error

Merge implements EntityMerger.

type PlanetSnapshot

type PlanetSnapshot struct {
	gen.PlanetSnapshot
	Event      *gen.EventSnapshot
	Statistics gen.SnapshotStatistic
}

PlanetSnapshot wraps all snapshots relevant for a planet.

type Snapshot

type Snapshot struct {
	gen.Snapshot
	WarSnapshot         gen.WarSnapshot
	AssignmentSnapshots []gen.AssignmentSnapshot
	PlanetSnapshots     []PlanetSnapshot
	Statistics          gen.SnapshotStatistic
}

Snapshot implements EntityMerger

func (*Snapshot) Merge

func (s *Snapshot) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error

Merge implements EntityMerger.

type War

type War gen.War

War implements EntityMerger

func (*War) Merge

func (w *War) Merge(ctx context.Context, tx *gen.Queries, onMerge onMergeFunc) error

Merge implements EntityMerger.