neon

Documentation

Overview

Package neon reports on the database behind an app.

It plans no writes. What it checks is that the branch the config names still exists, and that the service's DATABASE_URL is the one the operator thinks it is — a service quietly pointing at a deleted branch, or at last month's project, is the failure this catches.

Index

• func Plan(ctx context.Context, api API, n config.Neon, liveDatabaseURL string, ...) (plan.Plan, error)
• type API

Functions

func Plan

func Plan(ctx context.Context, api API, n config.Neon, liveDatabaseURL string, getenv func(string) string) (plan.Plan, error)

Plan checks the declared branch exists. liveDatabaseURL is the service's current value; it is compared and discarded, never rendered.

Types

type API

type API interface {
	Branches(ctx context.Context, projectID string) ([]neonapi.Branch, error)
}

API is the read half, narrowed for tests.