database

README

database

Shared database library for PurgeBot. Wraps a pgx connection pool and exposes typed query functions. One file per table.

Usage

import "github.com/PurgeBot-net/database"

db, err := database.New(ctx, os.Getenv("DATABASE_URL"))
if err != nil {
    log.Fatal(err)
}
defer db.Close()

c, err := db.GetCustomization(ctx, guildID)

Schema

The schema is in schema.sql and is idempotent (CREATE TABLE IF NOT EXISTS). It is mounted into the Postgres container on first start via the docker repo's docker-compose.yml.

Tables

Table	Description
customizations	Per-guild bot name, avatar, and branding toggle (Premium)

Documentation

Index

• type Customization
• type Database
  • func New(ctx context.Context, connStr string) (*Database, error)
  • func (db *Database) Close()
  • func (db *Database) DeleteCustomization(ctx context.Context, guildID int64) error
  • func (db *Database) GetCustomization(ctx context.Context, guildID int64) (*Customization, error)
  • func (db *Database) GetGuildStats(ctx context.Context, guildID int64) (GuildStats, error)
  • func (db *Database) RecordPurgeEvent(ctx context.Context, p RecordPurgeEventParams) error
  • func (db *Database) UpsertCustomization(ctx context.Context, p UpsertCustomizationParams) error
• type GuildStats
• type RecordPurgeEventParams
• type UpsertCustomizationParams

Types

type Customization

type Customization struct {
	GuildID        int64
	BotName        *string
	BotAvatar      *string
	RemoveBranding bool
	UpdatedAt      time.Time
	UpdatedBy      int64
}

type Database

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

func New

func New(ctx context.Context, connStr string) (*Database, error)

func (*Database) Close

func (db *Database) Close()

func (*Database) DeleteCustomization

func (db *Database) DeleteCustomization(ctx context.Context, guildID int64) error

func (*Database) GetCustomization

func (db *Database) GetCustomization(ctx context.Context, guildID int64) (*Customization, error)

func (*Database) GetGuildStats

func (db *Database) GetGuildStats(ctx context.Context, guildID int64) (GuildStats, error)

func (*Database) RecordPurgeEvent

func (db *Database) RecordPurgeEvent(ctx context.Context, p RecordPurgeEventParams) error

func (*Database) UpsertCustomization

func (db *Database) UpsertCustomization(ctx context.Context, p UpsertCustomizationParams) error

type GuildStats

type GuildStats struct {
	TotalPurges  int
	TotalDeleted int64
	LastPurgeAt  *time.Time
}

type RecordPurgeEventParams

type RecordPurgeEventParams struct {
	GuildID    int64
	PurgeType  string
	TargetType string
	Deleted    int
	DurationMs int
}

type UpsertCustomizationParams

type UpsertCustomizationParams struct {
	GuildID        int64
	BotName        *string
	BotAvatar      *string
	RemoveBranding bool
	UpdatedBy      int64
}