database

type Capabilities struct {
	Name    string          `json:"name"`
	Display string          `json:"display"`
	Targets []TargetPattern `json:"targets,omitempty"`
	Form    *FormSpec       `json:"form,omitempty"`
	// QueryLanguage advertises the query editor language for this
	// driver, or nil when the plugin does not advertise one. The host
	// normalizes nil and zero advertisements to the legacy SQL default
	// at registration.
	QueryLanguage *QueryLanguage `json:"query_language,omitempty"`
	// WriteCapabilities advertises the optional row/document write
	// interfaces a plugin's sessions implement. A zero value means no
	// write support: the workbench never attempts row or document writes.
	WriteCapabilities sharedsql.WriteCapabilities `json:"write_capabilities"`
	// Workspace advertises the optional workspace tab metadata: the
	// standard tabs beyond Query/Browse the driver supports and its
	// ordered custom plain-data views. Absent (nil) keeps the legacy
	// per-product tab policy exactly, so old plugins load unchanged.
	Workspace *sharedsql.WorkspaceCapability `json:"workspace,omitempty"`
}

type CustomWorkspaceView = sharedsql.CustomWorkspaceView

type FormField struct {
	Key         string        `json:"key"`
	Title       string        `json:"title"`
	Kind        FormFieldKind `json:"kind"`
	Placeholder string        `json:"placeholder,omitempty"`
	// Default is the well-known value shown when the field is blank
	// (e.g. the default port).
	Default string       `json:"default,omitempty"`
	Options []FormOption `json:"options,omitempty"`
	// Validate is the rule applied to the field value; Error is the
	// message shown when the rule fails. Kind and Validate are the Go
	// iota constants — a transport must not reorder them.
	Validate FormValidation `json:"validate"`
	Error    string         `json:"error,omitempty"`
}

type FormFieldKind int

type FormOption struct {
	Label string `json:"label"`
	Value string `json:"value"`
}

type FormSpec struct {
	Fields []FormField `json:"fields"`
	// Prefix is prepended to the serialized target so Match can route it
	// back to this driver ("" for SQLite).
	Prefix string `json:"prefix,omitempty"`
}

type FormValidation int

type FormValues struct {
	Host     string            `json:"host,omitempty"`
	Port     string            `json:"port,omitempty"`
	User     string            `json:"user,omitempty"`
	Pass     string            `json:"pass,omitempty"`
	Database string            `json:"database,omitempty"`
	TLS      string            `json:"tls,omitempty"`
	Extras   map[string]string `json:"extras,omitempty"`
}

type QueryCommand = sharedsql.QueryCommand

type QueryLanguage = sharedsql.QueryLanguage

type Shim interface {
	Capabilities() Capabilities
	BuildTarget(values FormValues) (string, bool)
	Open(ctx context.Context, target string) (sharedsql.Service, error)
}

type Spec struct {
	// Name identifies the driver. It is the profile driver name
	// ("sqlite", "mysql", "postgres").
	Name string

	// Display is the human-readable driver label ("SQLite").
	Display string

	// Targets lists the target forms this driver addresses, in check
	// order. Empty means the driver is reached only through the default
	// fallback (SQLite).
	Targets []TargetPattern

	// Open opens a service for a matched target.
	Open func(ctx context.Context, target string) (sharedsql.Service, error)

	// Form describes the connection form for this driver, or nil when the
	// driver has no form entry (MongoDB is opened by target URL only).
	// Target serialization is a registered in-process builder (see
	// BuildTarget), not part of the spec.
	Form *FormSpec

	// QueryLanguage describes how the query editor presents this
	// driver's language. A zero value carries no advertisement (the UI
	// falls back to its defaults); built-ins and registered shims always
	// carry an explicit one.
	QueryLanguage QueryLanguage

	// Workspace advertises the driver's workspace tab capability: the
	// standard tabs it supports beyond Query/Browse and its ordered
	// custom plain-data views. Nil keeps the legacy per-product tab
	// policy exactly; a present advertisement is authoritative for the
	// tab row.
	Workspace *sharedsql.WorkspaceCapability
}

type StandardWorkspaceTab = sharedsql.StandardWorkspaceTab

type TargetBuilder func(values FormValues) (string, bool)

type TargetPattern struct {
	Prefix string `json:"prefix"`
	// KeepTarget keeps the whole target for Open when true (URL scheme
	// forms); when false the prefix is stripped.
	KeepTarget bool `json:"keep_target,omitempty"`
}

type WorkspaceCapability = sharedsql.WorkspaceCapability

type WorkspaceViewKind = sharedsql.WorkspaceViewKind

type WorkspaceViewRequest = sharedsql.WorkspaceViewRequest

type WorkspaceViewTarget = sharedsql.WorkspaceViewTarget