api

type Branch struct {
	Name   string `json:"name"`
	Source string `json:"source"`
	// Parent is the branch this one was created from (branch-from-branch);
	// "" when created directly from the source.
	Parent string `json:"parent,omitempty"`
	State  string `json:"state"`
	Host   string `json:"host"`
	Port   int    `json:"port"`
	User   string `json:"user"`
	// Password is the branch's own rotated password — present only when
	// branchd runs with --rotate-branch-credentials; otherwise the branch
	// inherits the source's credentials and the field is omitted.
	Password string `json:"password,omitempty"`
	// PasswordUnavailable is true when the branch has a rotated password that
	// branchd's at-rest key cannot decrypt (the key changed since it was
	// stored); password is then omitted. Reset the branch to mint a new one.
	PasswordUnavailable bool   `json:"password_unavailable,omitempty"`
	Database            string `json:"database"`
	// ProxyDatabase is the database param to use when connecting through the
	// wire-protocol router: dbname@branch.
	ProxyDatabase string `json:"proxy_database"`
	ExpiresAt     string `json:"expires_at,omitempty"`
	CreatedAt     string `json:"created_at"`
	// ProxyHost and ProxyPort locate the wire-protocol router, as advertised
	// by branchd's --advertise-proxy-addr (the port defaults to --pg-addr's).
	// ProxyHost is omitted when branchd knows no client-reachable name:
	// clients then use the API host. Both are absent from older servers.
	ProxyHost string `json:"proxy_host,omitempty"`
	ProxyPort int    `json:"proxy_port,omitempty"`
}

type CreateBranchRequest struct {
	Name       string `json:"name"`
	Source     string `json:"source,omitempty"`
	Parent     string `json:"parent,omitempty"`
	TTLSeconds int    `json:"ttl_seconds"`
}

type CreateSourceRequest struct {
	Name      string `json:"name"`
	Host      string `json:"host"`
	Port      int    `json:"port"`
	User      string `json:"user"`
	Database  string `json:"database"`
	Network   string `json:"network"`
	PGVersion string `json:"pg_version"`
	Password  string `json:"password"`
	// Via selects the seeding method: "basebackup" (default) or "dump".
	Via string `json:"via,omitempty"`
	// DumpSchemas scopes a via=dump seed to the given schemas (empty = the
	// whole database). Only valid with via=dump.
	DumpSchemas []string `json:"dump_schemas,omitempty"`
	// Image overrides the container image for the seed helpers and every
	// branch (default postgres:<pg_version>), e.g. postgis/postgis:17-3.5.
	// It must match the source's extensions, locales and libc.
	Image string `json:"image,omitempty"`
}

type CreateTokenRequest struct {
	Name string `json:"name"`
	Role string `json:"role"`
}

type CreateTokenResponse struct {
	Token string `json:"token"`
}

type ErrorResponse struct {
	Error string `json:"error"`
}

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

type MaskScript struct {
	Name string `json:"name"`
	SQL  string `json:"sql"`
}

type Ready func(ctx context.Context) error

type RefreshSourceRequest struct {
	Password string `json:"password"`
}

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

type Source struct {
	Name      string `json:"name"`
	PGVersion string `json:"pg_version"`
	Host      string `json:"host"`
	Port      int    `json:"port"`
	User      string `json:"user"`
	Database  string `json:"database"`
	Network   string `json:"network,omitempty"`
	// Via is the seeding method: "basebackup" (pg_basebackup) or "dump"
	// (pg_dump — managed Postgres without REPLICATION privilege).
	Via         string   `json:"via"`
	DumpSchemas []string `json:"dump_schemas,omitempty"`
	State       string   `json:"state"`
	Generation  int      `json:"generation"`
	CreatedAt   string   `json:"created_at"`

	// Image is the source's image override for its branches and seed
	// helpers; omitted when the default postgres:<pg_version> is used.
	Image string `json:"image,omitempty"`
}

type Token struct {
	Name      string `json:"name"`
	Role      string `json:"role"`
	CreatedAt string `json:"created_at"`
}

type Transition struct {
	FromState string `json:"from_state"`
	ToState   string `json:"to_state"`
	Reason    string `json:"reason"`
	Actor     string `json:"actor"`
	At        string `json:"at"`
}

type Usage struct {
	Bytes int64 `json:"bytes"`
}