sql

type BrowseFilter struct {
	Column   string               `json:"column"`
	Operator BrowseFilterOperator `json:"operator"`
	Value    string               `json:"value"`
}

type BrowseFilterOperator string

type BrowseOptions struct {
	Columns []string       `json:"columns"`
	Filters []BrowseFilter `json:"filters"`
	Sorts   []BrowseSort   `json:"sorts"`
	Offset  int            `json:"offset"`
	Limit   int            `json:"limit"`
}

type BrowseSort struct {
	Column     string `json:"column"`
	Descending bool   `json:"descending"`
}

type ColumnChange struct {
	PreviousName string  `json:"previous_name"`
	Name         string  `json:"name"`
	Type         string  `json:"type"`
	Nullable     bool    `json:"nullable"`
	DefaultValue *string `json:"default_value"`
	Attributes   *string `json:"attributes"`
}

type ColumnDef struct {
	Name         string  `json:"name"`
	Type         string  `json:"type"`
	Nullable     bool    `json:"nullable"`
	DefaultValue *string `json:"default_value"`
	Attributes   *string `json:"attributes"`
}

type ColumnInfo struct {
	Name         string      `json:"name"`
	Type         string      `json:"type"`
	Attributes   string      `json:"attributes"`
	Nullable     bool        `json:"nullable"`
	DefaultValue *string     `json:"default_value"`
	PrimaryKey   int         `json:"primary_key"`
	Indexes      []IndexKind `json:"indexes"`
}

type ColumnType struct {
	Name       string
	Parameters []ColumnTypeParameter
	Attributes []string
	// Label is the human-friendly picker entry, e.g. "VARCHAR — variable-length
	// string". Empty means the type name is shown as-is.
	Label string
}

type ColumnTypeParameter struct {
	Name    string
	Default string
}

type CompletionContext int

type CustomWorkspaceView struct {
	ID     string              `json:"id"`
	Label  string              `json:"label"`
	Scopes []WorkspaceViewKind `json:"scopes"`
}

type DatabaseInfo struct {
	Product string `json:"product"`
	Version string `json:"version"`
}

type DocumentFormat string

type DocumentPayload struct {
	Format DocumentFormat `json:"format"`
	Data   []byte         `json:"data"`
}

type DocumentReader interface {
	ReadDocument(context.Context, string, DocumentPayload) (DocumentPayload, error)
}

type DocumentWriteCapability struct {
	Format DocumentFormat `json:"format"`
	Text   bool           `json:"text"`
}

type DocumentWriteOperation string

type DocumentWriteRequest struct {
	Operation  DocumentWriteOperation `json:"operation"`
	Collection string                 `json:"collection"`
	ID         *DocumentPayload       `json:"id,omitempty"`
	Document   *DocumentPayload       `json:"document,omitempty"`
}

type DocumentWriteResponse struct {
	Result   WriteResult      `json:"result"`
	Document *DocumentPayload `json:"document,omitempty"`
}

type DocumentWriter interface {
	InsertDocument(context.Context, string, DocumentPayload) (Result, error)
	ReplaceDocument(context.Context, string, DocumentPayload, DocumentPayload) (Result, error)
	DeleteDocument(context.Context, string, DocumentPayload) (Result, error)
}

type ForeignKeyChange struct {
	Columns          []string `json:"columns"`
	ReferenceTable   string   `json:"reference_table"`
	ReferenceColumns []string `json:"reference_columns"`
	OnDelete         string   `json:"on_delete"`
	OnUpdate         string   `json:"on_update"`
}

type ForeignKeyInfo struct {
	ID               string   `json:"id"`
	Columns          []string `json:"columns"`
	ReferenceTable   string   `json:"reference_table"`
	ReferenceColumns []string `json:"reference_columns"`
	OnDelete         string   `json:"on_delete"`
	OnUpdate         string   `json:"on_update"`
}

type IndexChange struct {
	Name       string   `json:"name"`
	Unique     bool     `json:"unique"`
	PrimaryKey bool     `json:"primary_key"`
	Columns    []string `json:"columns"`
}

type IndexInfo struct {
	Name       string   `json:"name"`
	Unique     bool     `json:"unique"`
	PrimaryKey bool     `json:"primary_key"`
	Columns    []string `json:"columns"`
}

type IndexKind uint8

type NamedValue struct {
	Name  string `json:"name"`
	Value Value  `json:"value"`
}

type Opened struct {
	Target  string
	Service Service
	Info    DatabaseInfo
	Objects []SchemaObject
	// QueryLanguage advertises how the query editor presents this
	// connection's statements; a zero value (no advertisement) falls
	// back to the legacy SQL defaults in the UI.
	QueryLanguage QueryLanguage
	// Workspace advertises the connection's workspace tab capability:
	// the standard tabs it supports beyond Query/Browse and its custom
	// plain-data views. Nil keeps the legacy per-product tab policy
	// exactly; a non-nil advertisement is authoritative for the tab row.
	Workspace *WorkspaceCapability
}

type QueryCommand struct {
	Name    string `json:"name"`
	Usage   string `json:"usage"`
	Summary string `json:"summary"`
}

type QueryLanguage struct {
	Name        string         `json:"name"`
	EditorLabel string         `json:"editor_label"`
	Placeholder string         `json:"placeholder"`
	Lexer       string         `json:"lexer,omitempty"`
	Examples    []string       `json:"examples,omitempty"`
	Commands    []QueryCommand `json:"commands,omitempty"`
}

type ReferencingForeignKeyInfo struct {
	Table string `json:"table"`
	ForeignKeyInfo
}

type Result struct {
	Columns         []string      `json:"columns"`
	ColumnTypes     []string      `json:"column_types"`
	Rows            [][]*string   `json:"rows"`
	UntruncatedRows [][]*string   `json:"untruncated_rows"`
	RowsAffected    int64         `json:"rows_affected"`
	HasMore         bool          `json:"has_more"`
	Duration        time.Duration `json:"duration_ns"`
	Truncated       bool          `json:"truncated"`
	// DocumentIDs carries one stable document identity per row, parallel to
	// Rows, for document-capable browse results. Empty when the backend is
	// not document-capable or a row has no identity.
	DocumentIDs []DocumentPayload `json:"document_ids"`
	// Statement is an optional backend-native statement for the operation
	// that produced this result (external plugins return the exact command
	// they executed; compiled-in drivers leave it empty). The workbench
	// logs it in place of the generic write preview when non-blank.
	// Replayability and sensitivity are described by StatementMetadata.
	// Omitted from the wire when empty.
	Statement string `json:"statement,omitempty"`
	// StatementMetadata optionally describes Statement. It is meaningful
	// only when Statement is nonblank; orphan metadata (metadata without a
	// statement) is rejected at the plugin boundary. Omitted from the wire
	// when nil, so older plugins keep the prior shape.
	StatementMetadata *StatementMetadata `json:"statement_metadata,omitempty"`
}

type RowValue struct {
	Name  string `json:"name"`
	Value Value  `json:"value"`
}

type RowWriteOperation string

type RowWriteRequest struct {
	Operation RowWriteOperation `json:"operation"`
	Table     string            `json:"table"`
	Key       []RowValue        `json:"key,omitempty"`
	Values    []RowValue        `json:"values,omitempty"`
}

type RowWriteResponse struct {
	Result WriteResult `json:"result"`
}

type RowWriter interface {
	InsertRow(context.Context, string, []RowValue) (Result, error)
	UpdateRow(context.Context, string, []RowValue, []RowValue) (Result, error)
	DeleteRow(context.Context, string, []RowValue) (Result, error)
}

type SQLAnalysis struct {
	Context          CompletionContext
	Prefix           string
	Qualifier        string            // for CtxQualified: schema or table name before the dot
	Aliases          map[string]string // alias → table name (lowercase)
	ReferencedTables []string          // table names mentioned in the query
	Words            []string          // uppercased tokens of the whole value, shared with callers
}

type SchemaObject struct {
	Database string `json:"database"`
	Type     string `json:"type"`
	Name     string `json:"name"`
	// RowCount is the estimated row count where the engine exposes one
	// (PostgreSQL pg_class.reltuples, MySQL information_schema.table_rows);
	// nil when unknown or when only an exact count exists (SQLite, views).
	RowCount *int64 `json:"row_count"`
}

type Service interface {
	Close() error
	Info() DatabaseInfo
	Execute(context.Context, string) (Result, error)
	ExecuteReadOnly(context.Context, string) (Result, error)
	Validate(context.Context, string) error
	ListSchema(context.Context) ([]SchemaObject, error)
	TableInfo(context.Context, string) ([]ColumnInfo, error)
	ListIndexes(context.Context, string) ([]IndexInfo, error)
	CreateIndex(context.Context, string, IndexChange) error
	ReplaceIndex(context.Context, string, string, IndexChange) error
	DropIndex(context.Context, string, string) error
	ListForeignKeys(context.Context, string) ([]ForeignKeyInfo, error)
	ListReferencingForeignKeys(context.Context, string) ([]ReferencingForeignKeyInfo, error)
	// ListForeignKeysAll returns every foreign key in the connected schema,
	// keyed by the table that declares it. Products without foreign keys
	// (MongoDB) return an empty map. The app derives inbound edges by
	// scanning for ReferenceTable.
	ListForeignKeysAll(context.Context) (map[string][]ForeignKeyInfo, error)
	// ListIndexesAll returns every index in the connected schema, keyed by
	// table name (collection name for MongoDB).
	ListIndexesAll(context.Context) (map[string][]IndexInfo, error)
	CreateForeignKey(context.Context, string, ForeignKeyChange) error
	ReplaceForeignKey(context.Context, string, string, ForeignKeyChange) error
	DropForeignKey(context.Context, string, string) error
	AlterColumn(context.Context, string, ColumnChange) error
	DropColumn(context.Context, string, string) error
	AddColumn(context.Context, string, ColumnDef) error
	BrowseTable(context.Context, string, BrowseOptions) (Result, error)
}

type StandardWorkspaceTab string

type StatementMetadata struct {
	Language   string `json:"language"`
	Replayable bool   `json:"replayable"`
	Sensitive  bool   `json:"sensitive"`
}

type Value struct {
	Kind      ValueKind    `json:"kind"`
	String    string       `json:"string,omitempty"`
	Bool      bool         `json:"bool,omitempty"`
	Integer   int64        `json:"integer,omitempty"`
	Float     float64      `json:"float,omitempty"`
	Bytes     []byte       `json:"bytes,omitempty"`
	Decimal   string       `json:"decimal,omitempty"`
	Timestamp string       `json:"timestamp,omitempty"` // RFC 3339
	Array     []Value      `json:"array,omitempty"`
	Object    []NamedValue `json:"object,omitempty"`
}

type ValueKind string

type WorkspaceCapability struct {
	StandardTabs []StandardWorkspaceTab `json:"standard_tabs,omitempty"`
	CustomViews  []CustomWorkspaceView  `json:"custom_views,omitempty"`
}

type WorkspaceViewKind string

type WorkspaceViewProvider interface {
	// WorkspaceView executes one advertised custom view for the active
	// structured target. It is a session operation: the caller's context
	// cancels it like any other session call, and the result follows the
	// bounded table-result conventions (500 rows / 300 runes per cell in
	// the display path).
	WorkspaceView(context.Context, WorkspaceViewRequest) (Result, error)
}

type WorkspaceViewRequest struct {
	ViewID string              `json:"view_id"`
	Target WorkspaceViewTarget `json:"target"`
}

type WorkspaceViewTarget struct {
	Kind     WorkspaceViewKind `json:"kind"`
	Database string            `json:"database,omitempty"`
	Schema   string            `json:"schema,omitempty"`
	Table    string            `json:"table,omitempty"`
}

type WriteCapabilities struct {
	RowWriter bool                     `json:"row_writer"`
	Document  *DocumentWriteCapability `json:"document,omitempty"`
}

type WriteCapabilitiesProvider interface {
	WriteCapabilities() WriteCapabilities
}

type WriteResult struct {
	RowsAffected      int64              `json:"rows_affected"`
	Statement         string             `json:"statement,omitempty"`
	StatementMetadata *StatementMetadata `json:"statement_metadata,omitempty"`
}