config

type Config struct {
	// ScriptsDir is where Go scripts live. Load leaves it absolute (see
	// ResolveScriptsDir in scripts.go): as written it is relative to the
	// config file, and absent it is ~/.config/dbc/scripts.
	ScriptsDir string `toml:"scripts_dir"`
	// PipelinesDir is where pipelines live (pipelines.go): absolute after
	// Load, ~/.config/dbc/pipelines when the file does not say.
	PipelinesDir string `toml:"pipelines_dir"`
	// JobsDir is where jobs live (jobs.go: DAGs of pipelines with
	// triggers), RunsDir where each run of a job or a pipeline leaves its
	// record; both absolute after Load, beside the scripts when the file
	// does not say.
	JobsDir string `toml:"jobs_dir"`
	RunsDir string `toml:"runs_dir"`
	// PluginsDir is where the user's pipeline plugins live (plugins.go:
	// Go files, each one kind of node), absolute after Load, beside the
	// scripts when the file does not say.
	PluginsDir string `toml:"plugins_dir"`
	// FilesDir is where a relative path in a pipeline's file node — and in
	// a script's s.Export or s.Path — resolves (files.go), whichever
	// process runs it: absolute after Load, the home directory when the
	// file does not say.
	FilesDir string `toml:"files_dir"`
	// RunsKeep is how many records of each job and of each pipeline are
	// kept, the oldest pruned after a run ends; 0 means DefaultRunsKeep.
	RunsKeep int `toml:"runs_keep"`
	MaxRows  int `toml:"max_rows"` // rows fetched from the server

	// PGBin is the directory holding PostgreSQL's client tools (pg_dump,
	// pg_restore) for dumps — `dbc dump` and both UIs' "Dump database…".
	// Empty means look for them (pgdump.Locate). Resolved like scripts_dir:
	// absolute after Load, relative to the config file as written.
	PGBin string `toml:"pg_bin"`

	// MaxDisplayRows caps how many of those rows the TUI table renders. It is
	// separate from MaxRows because the two are limited by different things:
	// fetching more is a question of memory and patience, rendering more costs
	// a widget per value and shows up as a sluggish scroll. Raising max_rows
	// for the sake of an export should not make the table crawl. Zero means no
	// display cap.
	MaxDisplayRows int `toml:"max_display_rows"`

	// ResultTabs caps the tabs in one connection's result set: each query
	// tab keeps a result set per connection it has been on, and a run
	// lands in the set's current tab, or in a new one when that tab is
	// pinned. Past the cap the oldest unpinned tab is dropped. Unset is
	// DefaultResultTabs; Load keeps it within 1…MaxResultTabs. Read it
	// through ResultTabLimit, which also covers a Config built in code.
	ResultTabs int `toml:"result_tabs"`

	// The AI assistant (package ai). AIAgent picks the ACP backend —
	// "copilot" (the default), "claude" or "gemini"; AIModel is a preferred
	// model id, applied when the agent offers it. AIContextRows caps how many
	// result rows go with a question on connections that allow rows at all
	// (ai_rows); 0 sends none, and unset means ai.DefaultContextRows.
	AIAgent       string `toml:"ai_agent"`
	AIModel       string `toml:"ai_model"`
	AIContextRows int    `toml:"ai_context_rows"`

	// ConnIdleTimeout is how long a pooled connection may sit idle before it
	// is closed; see DefaultConnIdleTimeout. Written as a duration string in
	// the file ("30m", "2h"); 0 keeps idle connections open indefinitely, as
	// database/sql does by default. It applies to every connection — it is a
	// question of how long dbc sits idle, not of which database it talks to.
	ConnIdleTimeout time.Duration `toml:"conn_idle_timeout"`

	// ConnectTimeout caps opening a connection; see DefaultConnectTimeout.
	// A duration string in the file ("10s"); 0 sets no limit of dbc's own,
	// leaving it to the driver (a DSN's own connect_timeout, say) and the OS.
	// A DSN-level timeout still applies either way — whichever is shorter
	// wins. Global for the same reason as ConnIdleTimeout.
	ConnectTimeout time.Duration `toml:"connect_timeout"`

	// PlanTheme is the palette of the plan pictures the shell and the TUI
	// draw — `dbc explain -t pdf|jpeg|png` and the TUI's Save as PDF /
	// JPEG, and the schema diagrams of `dbc erd -t png|jpeg` and the TUI's
	// Diagram items: "dark" (the default, dbc's own slate) or "light" (paper, kinder
	// to a printer). Load normalizes it to one of the two, so readers can
	// hand it to theme.ByName without a second error to handle. dbc web
	// ignores it: its files follow the light or dark the view is wearing.
	// A string rather than a theme.Palette so config stays a leaf package.
	PlanTheme string `toml:"plan_theme"`

	DefaultConnection string `toml:"default_connection"`

	// Connections is written freely while the config is being built (Load,
	// the demo pruning, an ad-hoc --dsn), when nothing else can see it. Once
	// something may run beside a change — dbc web adding a connection while
	// its tabs connect and run — the change goes through AddConn/RemoveConn/
	// ReplaceConn and every reader through Conns/ConnByName, which take connMu.
	//
	// The writers are copy-on-write: AddConn, RemoveConn and ReplaceConn
	// build a new slice rather than edit the old one in place, so a slice a
	// reader got from Conns (or a range over the field that began before the
	// change) never sees an element change under it.
	Connections []Connection `toml:"connection"`

	Path string `toml:"-"` // file the config was loaded from ("" if none)
	Demo bool   `toml:"-"` // true when running with the built-in demo connection

	// Warnings are load-time findings worth telling the user about but not
	// worth refusing to start over, e.g. a DSN referencing an unset env var.
	Warnings []string `toml:"-"`
	// contains filtered or unexported fields
}

type Connection struct {
	Name   string `toml:"name"`
	Driver string `toml:"driver"` // postgres | mysql | sqlite | bytdb
	DSN    string `toml:"dsn"`    // env vars are expanded, e.g. ${PGPASS}

	// TLSOpts holds the tls, tls_ca, tls_cert and tls_key keys: TLS for
	// postgres and mysql, one spelling for both — see tls.go. Embedded
	// untagged so the keys sit flat beside dsn. Load leaves the paths
	// absolute (ExpandTLS), so the db package never has to know which file
	// they were written in.
	TLSOpts

	// Migrations is the directory `dbc migrate` reads for this connection,
	// relative to the working directory. Per connection rather than global
	// because a config typically lists several databases and each has its
	// own schema. Empty means the -dir flag (or ".") decides.
	Migrations string `toml:"migrations"`

	// AIRows lets the AI assistant see this connection's result ROWS (up to
	// ai_context_rows of them). Off by default and per connection, because
	// rows are the database's contents and sending them to a hosted model is
	// a decision about that data: fine for a scratch database, not
	// something a production connection should do because a global switch
	// was flipped. The query text and errors go regardless — see package ai.
	AIRows bool `toml:"ai_rows"`

	// Demo marks a built-in demo connection, the only kind db.Manager seeds
	// with the demo cats table when it opens it. Set by demoFallback alone,
	// never read from a file: seeding runs CREATE TABLE and DELETE FROM cats,
	// so it must not be possible to switch on for a real database. It is a
	// per-connection flag rather than Config.Demo because a demo config can
	// also carry the ad-hoc --dsn connection, which is the user's database.
	Demo bool `toml:"-"`

	// Web marks a connection added from inside dbc — dbc web's browser UI
	// or the TUI's connection form (package connedit) — and kept in the
	// saved-connections file (connections.toml, see SavedStore), not in the
	// config file. Never read from a file's key — MergeSaved sets it — so
	// both UIs can tell which ones they may edit or remove: the config file's
	// connections are the file's to change. Every dbc merges the saved ones,
	// so the TUI and headless runs list them too.
	Web bool `toml:"-"`

	// Base and Database describe a connection derived from a configured
	// one: the same server, credentials and TLS, opened on another database
	// of that server. ConnByName makes one up for a name of the form
	// "<base>/<database>" (see DatabaseSep); none is ever stored, in the
	// config or the saved-connections file. Database overrides whatever
	// database the DSN names when the pool is opened (db.openPool); "" keeps
	// the DSN's. Both are "" on a configured connection.
	Base     string `toml:"-"`
	Database string `toml:"-"`
}

type DemoEngine string

type JobRef struct {
	Path    string
	Example *scripts.Job
}

type PipelineRef struct {
	Path    string
	Example *scripts.Pipeline
}

type SavedConn struct {
	Name   string `toml:"name"`
	Driver string `toml:"driver"`
	DSN    string `toml:"dsn"` // as typed: ${VAR}s unexpanded
	// TLSOpts is Connection.TLSOpts, with its paths as typed too: ${VAR}s
	// unexpanded and a relative path left relative (to SavedDir). Each
	// process resolves them as it merges the entry, as it does the DSN.
	TLSOpts
	// AIRows is Connection.AIRows: the assistant may see result rows.
	AIRows bool `toml:"ai_rows"`
	// Added orders the sidebar in dbc web (after the config file's). It is
	// kept across an edit so an edited entry does not move.
	Added time.Time `toml:"added"`
}

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

type ScriptRef struct {
	Path    string           // the file to run or check
	Example *scripts.Example // the built-in sample, with its source
}

type TLSOpts struct {
	TLS     string `toml:"tls,omitempty" json:"tls,omitempty"`           // a mode above; "" leaves TLS to the DSN
	TLSCA   string `toml:"tls_ca,omitempty" json:"tls_ca,omitempty"`     // PEM file of CA certificates to trust
	TLSCert string `toml:"tls_cert,omitempty" json:"tls_cert,omitempty"` // PEM client certificate, for servers that ask for one
	TLSKey  string `toml:"tls_key,omitempty" json:"tls_key,omitempty"`   // its PEM private key
	// TLSKeyPassword is "${VAR}" (or "$VAR"): the environment variable
	// holding tls_key's passphrase, when the key is encrypted. The
	// reference, never the passphrase — see "AN ENCRYPTED tls_key" above.
	TLSKeyPassword string `toml:"tls_key_password,omitempty" json:"tls_key_password,omitempty"`
}