database

type Analysis struct {
	// Kind is the statement category.
	Kind Kind
	// Unbounded marks a data-modifying statement whose blast radius cannot be
	// shown to be limited: no WHERE clause, a predicate that is really a
	// tautology, a multi-table target, or an INSERT that is not plain VALUES.
	Unbounded bool
	// Refused marks a statement that is rejected at every permission level,
	// because no permission level can make it safe to run here.
	Refused bool
	// Reason explains Unbounded or Refused, in terms an operator and a model
	// can both act on.
	Reason string
}

type Column struct {
	Name       string `json:"name"`
	Type       string `json:"type"`
	Nullable   bool   `json:"nullable"`
	Default    string `json:"default,omitempty"`
	Position   int    `json:"position"`
	PrimaryKey bool   `json:"primary_key,omitempty"`
}

type ConnectionDef struct {
	Name        string
	Type        string
	Dialect     string
	Source      string
	Description string
	Permission  Permission
	// Pool tunes the connection pool. Zero fields use DefaultPool.
	Pool PoolConfig
}

type ConnectionInfo struct {
	Name        string     `json:"name"`
	Type        string     `json:"type"`
	Dialect     string     `json:"dialect,omitempty"`
	Description string     `json:"description,omitempty"`
	Permission  Permission `json:"permission"`
}

type ExportOptions struct {
	Dialect   string
	Table     string
	BatchSize int
	MaxRows   int
	Timeout   time.Duration
}

type ExportResult struct {
	Rows       int
	Statements int
	Columns    int
}

type ForeignKey struct {
	Column          string `json:"column"`
	ReferencedTable string `json:"referenced_table"`
	// ReferencedColumn may be empty when the catalog does not expose it.
	ReferencedColumn string `json:"referenced_column,omitempty"`
}

type Format string

type Kind string

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

type Permission string

type PoolConfig struct {
	// MaxOpen caps open connections, idle or in use.
	MaxOpen int
	// MaxIdle caps idle connections kept for reuse.
	MaxIdle int
	// MaxLifetime retires a connection after this long, so the pool follows
	// DNS changes and failovers. Negative disables the limit.
	MaxLifetime time.Duration
	// MaxIdleTime closes a connection idle for this long. Negative disables it.
	MaxIdleTime time.Duration
}

type QueryOptions struct {
	// MaxRows limits the rows read from the result set. Zero means DefaultMaxRows.
	// A negative value disables the limit.
	MaxRows int
	// MaxCellChars limits the characters kept per text value. Zero means
	// DefaultMaxCellChars. A negative value disables the limit.
	MaxCellChars int
	// Timeout bounds the statement. Zero means no dbq-imposed deadline.
	Timeout time.Duration
}

type Result struct {
	// Columns are the result set column names, in order. Nil for Exec results.
	Columns []string `json:"columns,omitempty"`
	// Rows holds the result set. Values are normalized to JSON-friendly types.
	Rows [][]any `json:"rows,omitempty"`
	// RowCount is len(Rows).
	RowCount int `json:"row_count"`
	// Truncated is true when the result set hit the row limit and more rows exist.
	Truncated bool `json:"truncated,omitempty"`
	// CellsTruncated counts values that were shortened to the cell limit.
	// Non-zero means the displayed values are prefixes, not the stored data.
	CellsTruncated int `json:"cells_truncated,omitempty"`
	// RowsAffected is set for statements executed via Exec. Nil for queries.
	RowsAffected *int64 `json:"rows_affected,omitempty"`
	// Kind is how dbq classified the statement.
	Kind Kind `json:"kind"`
	// Duration is the wall-clock execution time.
	Duration time.Duration `json:"-"`
	// DurationMS is Duration in milliseconds, for JSON consumers.
	DurationMS int64 `json:"duration_ms"`
}

type StatementError struct {
	// Code is a stable machine-readable identifier.
	Code string
	// Connection is the profile the statement was aimed at.
	Connection string
	// Kind is how dbq classified the statement.
	Kind Kind
	// Granted and Required are the effective and needed permission levels.
	// Required is empty when the statement is refused unconditionally.
	Granted  Permission
	Required Permission
	// Detail explains the specific problem, e.g. why a DELETE is unbounded.
	Detail string
	// Advice tells the caller what to do about it.
	Advice string
}

type Table struct {
	Schema string `json:"schema,omitempty"`
	Name   string `json:"name"`
	Type   string `json:"type,omitempty"`
}

type TableDetail struct {
	Schema string `json:"schema,omitempty"`
	Name   string `json:"name"`
	// Type is BASE TABLE or VIEW. It matters: a model will otherwise happily
	// generate an INSERT against a view.
	Type        string       `json:"type,omitempty"`
	Columns     []Column     `json:"columns"`
	ForeignKeys []ForeignKey `json:"foreign_keys,omitempty"`
}