migrationsapi

package
v1.153.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 5, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package migrationsapi serves the admin surface for an application database's schema migrations (#2404): the migrations the platform keeps for a connection, which of them the target's ledger records as applied, the history of each, and the plan of the pending ones. manage_schema is how migrations are added and applied; this is what the portal's connection page reads.

It is a decomposition seam of pkg/admin, which sits near its package size budget; the parent mounts it on the admin mux and hands it the live toolkit registry.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Register

func Register(mux *http.ServeMux, cfg Config)

Register mounts the migration routes on the admin mux.

Types

type Config

type Config struct {
	// Toolkits enumerates the live toolkits, so a connection added after
	// startup is reachable without a restart. nil disables the routes.
	Toolkits func() []registry.Toolkit
	// CatchUp puts a connection another replica saved into service here
	// before it is looked up, as the operation routes do (#2406); nil does
	// nothing.
	CatchUp interface {
		TakeOn(ctx context.Context, kind, name string)
	}
}

Config carries what the routes need from the parent.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL