db

type AZResource struct {
	ID               AZResourceID           `db:"id"`
	ResourceID       ResourceID             `db:"resource_id"`
	AvailabilityZone limes.AvailabilityZone `db:"az"`
	// a unique identifier for this record in the form "servicetype/resourcename"; mostly intended for manual lookup
	Path string `db:"path"`

	RawCapacity uint64         `db:"raw_capacity"`
	Usage       Option[uint64] `db:"usage"`
	// ” for az=total
	SubcapacitiesJSON string `db:"subcapacities"`

	// LastNonzeroRawCapacity is None initially, and gets filled whenever capacity scrape sees a non-zero capacity value.
	// We use this as a signal for ACPQ to distinguish new AZs in buildup that should be ignored for the purposes of base quota overcommit,
	// from existing AZs with faulty capacity recording that should block base quota overcommit.
	// None for az=total
	LastNonzeroRawCapacity Option[uint64] `db:"last_nonzero_raw_capacity"`
}

type AZResourceID int64

type CommitmentReason string

type CommitmentWorkflowContext struct {
	Reason                 CommitmentReason        `json:"reason"`
	RelatedCommitmentIDs   []ProjectCommitmentID   `json:"related_ids,omitempty"` // TODO: remove when v1 API is removed (v2 API uses only UUIDs to refer to commitments)
	RelatedCommitmentUUIDs []liquid.CommitmentUUID `json:"related_uuids,omitempty"`
}

type Domain struct {
	ID   DomainID `db:"id"`
	Name string   `db:"name"`
	UUID string   `db:"uuid"`
}

type DomainID int64

type Interface interface {
	// from database/sql
	sqlext.Executor

	// from github.com/go-gorp/gorp
	Insert(args ...any) error
	Update(args ...any) (int64, error)
	Delete(args ...any) (int64, error)
	Select(i any, query string, args ...any) ([]any, error)
}

type MailNotification struct {
	ID                int64     `db:"id"`
	ProjectID         ProjectID `db:"project_id"`
	Subject           string    `db:"subject"`
	Body              string    `db:"body"`
	NextSubmissionAt  time.Time `db:"next_submission_at"`
	FailedSubmissions int64     `db:"failed_submissions"`
}

type Project struct {
	ID         ProjectID          `db:"id"`
	DomainID   DomainID           `db:"domain_id"`
	Name       string             `db:"name"`
	UUID       liquid.ProjectUUID `db:"uuid"`
	ParentUUID string             `db:"parent_uuid"`
}

type ProjectAZResource struct {
	ID           ProjectAZResourceID `db:"id"`
	ProjectID    ProjectID           `db:"project_id"`
	AZResourceID AZResourceID        `db:"az_resource_id"`
	// None if hasQuota=false OR (az=total AND topology=az-separated) OR az=unknown
	Quota Option[uint64] `db:"quota"`
	// None if hasQuota=false OR (az=total AND topology=az-separated) OR (az!=total AND topology!=az-separated) OR az=unknown
	BackendQuota  Option[int64]  `db:"backend_quota"`
	Usage         uint64         `db:"usage"`
	PhysicalUsage Option[uint64] `db:"physical_usage"`
	// ” for az=total
	SubresourcesJSON string `db:"subresources"`
	// ” for az=total
	HistoricalUsageJSON string `db:"historical_usage"`
}

type ProjectAZResourceID int64

type ProjectCommitment struct {
	ID           ProjectCommitmentID               `db:"id"`
	UUID         liquid.CommitmentUUID             `db:"uuid"`
	ProjectID    ProjectID                         `db:"project_id"`
	AZResourceID AZResourceID                      `db:"az_resource_id"`
	Amount       uint64                            `db:"amount"`
	Duration     limesresources.CommitmentDuration `db:"duration"`
	CreatedAt    time.Time                         `db:"created_at"`
	CreatorUUID  string                            `db:"creator_uuid"` // format: "username@userdomainname"
	CreatorName  string                            `db:"creator_name"`
	ConfirmBy    Option[time.Time]                 `db:"confirm_by"`
	ConfirmedAt  Option[time.Time]                 `db:"confirmed_at"`
	ExpiresAt    time.Time                         `db:"expires_at"`

	// Commitments can be superseded due to splits, conversions or merges.
	// The context columns contain information about the reason and related commitments
	SupersededAt         Option[time.Time]       `db:"superseded_at"`
	CreationContextJSON  json.RawMessage         `db:"creation_context_json"`
	SupersedeContextJSON Option[json.RawMessage] `db:"supersede_context_json"`
	RenewContextJSON     Option[json.RawMessage] `db:"renew_context_json"`

	// For a commitment to be transferred between projects, it must first be
	// marked for transfer in the source project. Then a new commitment can be
	// created in the target project to supersede the transferable commitment.
	//
	// While a commitment is marked for transfer, it does not count towards quota
	// calculation, but it still blocks capacity and still counts towards billing.
	TransferStatus limesresources.CommitmentTransferStatus `db:"transfer_status"`
	TransferToken  Option[string]                          `db:"transfer_token"`
	// publicly transferred commitments are ordered by the time of their posting
	TransferStartedAt Option[time.Time] `db:"transfer_started_at"`

	// To a certain extent, this column is technically redundant, since the
	// status can often be derived from the values of other fields. For example,
	// a commitment is in status "superseded" iff `SupersededAt.IsSome()`.
	//
	// However, having this field simplifies lots of queries significantly
	// because we do not need to carry a NOW() argument into the query,
	// and complex conditions like `WHERE superseded_at IS NULL AND expires_at > $now AND confirmed_at IS NULL AND confirm_by < $now`
	// become simple readable conditions like `WHERE status IN ('pending', 'guaranteed')`.
	//
	// This field is updated by the CapacityScrapeJob.
	Status liquid.CommitmentStatus `db:"status"`

	// During commitment planning, a user can specify
	// if a mail should be sent after the commitments confirmation.
	NotifyOnConfirm bool `db:"notify_on_confirm"`

	// If commitments are about to expire, they get added into the mail queue.
	// This attribute helps to identify commitments that are already queued.
	NotifiedForExpiration bool `db:"notified_for_expiration"`
}

type ProjectCommitmentID int64

type ProjectID int64

type ProjectRate struct {
	ID            ProjectRateID             `db:"id"`
	ProjectID     ProjectID                 `db:"project_id"`
	RateID        RateID                    `db:"rate_id"`
	Limit         Option[uint64]            `db:"rate_limit"`      // None for rates that don't have a limit (just a usage)
	Window        Option[limesrates.Window] `db:"window_ns"`       // None for rates that don't have a limit (just a usage)
	UsageAsBigint string                    `db:"usage_as_bigint"` // empty for rates that don't have a usage (just a limit)

}

type ProjectRateID int64

type ProjectResource struct {
	ID                       ProjectResourceID `db:"id"`
	ProjectID                ProjectID         `db:"project_id"`
	ResourceID               ResourceID        `db:"resource_id"`
	Forbidden                bool              `db:"forbidden"`
	ForbidAutogrowth         bool              `db:"forbid_autogrowth"`
	MaxQuotaFromOutsideAdmin Option[uint64]    `db:"max_quota_from_outside_admin"`
	OverrideQuotaFromConfig  Option[uint64]    `db:"override_quota_from_config"`
}

type ProjectResourceID int64

type ProjectService struct {
	ID                    ProjectServiceID  `db:"id"`
	ProjectID             ProjectID         `db:"project_id"`
	ServiceID             ServiceID         `db:"service_id"`
	ScrapedAt             Option[time.Time] `db:"scraped_at"` // None if never scraped so far
	CheckedAt             Option[time.Time] `db:"checked_at"`
	NextScrapeAt          time.Time         `db:"next_scrape_at"`
	Stale                 bool              `db:"stale"`
	ScrapeDurationSecs    float64           `db:"scrape_duration_secs"`
	ScrapeErrorMessage    string            `db:"scrape_error_message"`
	SerializedScrapeState string            `db:"serialized_scrape_state"`
	SerializedMetrics     string            `db:"serialized_metrics"`
	QuotaDesyncedAt       Option[time.Time] `db:"quota_desynced_at"` // None if all quota = backend quota
	QuotaSyncDurationSecs float64           `db:"quota_sync_duration_secs"`
}

type ProjectServiceID int64

type Rate struct {
	ID        RateID          `db:"id"`
	ServiceID ServiceID       `db:"service_id"`
	Name      liquid.RateName `db:"name"`
	// following fields get filled from liquid.ServiceInfo
	LiquidVersion int64           `db:"liquid_version"`
	Unit          liquid.Unit     `db:"unit"`
	Topology      liquid.Topology `db:"topology"`
	HasUsage      bool            `db:"has_usage"`
}

type RateID int64

type Resource struct {
	ID        ResourceID          `db:"id"`
	ServiceID ServiceID           `db:"service_id"`
	Name      liquid.ResourceName `db:"name"`
	// a unique identifier for this record in the form "servicetype/resourcename"; mostly intended for manual lookup
	Path string `db:"path"`

	// following fields get filled from liquid.ServiceInfo
	LiquidVersion       int64           `db:"liquid_version"`
	Unit                liquid.Unit     `db:"unit"`
	Topology            liquid.Topology `db:"topology"`
	HasCapacity         bool            `db:"has_capacity"`
	NeedsResourceDemand bool            `db:"needs_resource_demand"`
	HasQuota            bool            `db:"has_quota"`
	AttributesJSON      string          `db:"attributes_json"`
	HandlesCommitments  bool            `db:"handles_commitments"`
}

type ResourceID int64

type Service struct {
	ID                 ServiceID         `db:"id"`
	Type               ServiceType       `db:"type"`
	ScrapedAt          Option[time.Time] `db:"scraped_at"` // None if never scraped so far
	ScrapeDurationSecs float64           `db:"scrape_duration_secs"`
	SerializedMetrics  string            `db:"serialized_metrics"`
	NextScrapeAt       time.Time         `db:"next_scrape_at"`
	ScrapeErrorMessage string            `db:"scrape_error_message"`
	// following fields get filled from liquid.ServiceInfo
	LiquidVersion                   int64  `db:"liquid_version"`
	CapacityMetricFamiliesJSON      string `db:"capacity_metric_families_json"`
	UsageMetricFamiliesJSON         string `db:"usage_metric_families_json"`
	UsageReportNeedsProjectMetadata bool   `db:"usage_report_needs_project_metadata"`
	QuotaUpdateNeedsProjectMetadata bool   `db:"quota_update_needs_project_metadata"`
}

type ServiceID int64

type ServiceType string

type SetUpdate[R any, K comparable] struct {
	// All relevant records that currently exist in the DB.
	ExistingRecords []R
	// All keys for which we want to have a record in the DB.
	WantedKeys []K

	// KeyForRecord reads the key out of an existing record.
	// This does not need to be the primary key.
	// Whatever unique identifier the caller has available is fine.
	KeyForRecord func(R) K

	// Callback for creating a new record for a missing key.
	//
	// After this, the Update callback will also be called on the new record.
	// This avoids code duplication between the create and update callbacks.
	Create func(K) (R, error)
	// Callback for updating an existing record.
	Update func(*R) error
}