sqlcomplete

type Edit struct {
	From int    `json:"from"`
	To   int    `json:"to"`
	Text string `json:"text"`
}

type Item struct {
	Label  string `json:"label"`            // what the list shows
	Kind   Kind   `json:"kind"`             // see Kind
	Detail string `json:"detail,omitempty"` // one line beside the label: a type, a signature
	Doc    string `json:"doc,omitempty"`    // longer text: a table's DDL, a function's description
	Insert string `json:"insert"`           // what replaces [From, To) when picked
	// Filter is the text the typed prefix is matched against when it is
	// not the label — a column offered qualified ("o.id") still matches
	// "id". Empty means the label.
	Filter string `json:"filter,omitempty"`
	// Cursor is where the caret lands inside Insert after the pick, as a
	// byte offset into Insert; -1 means after it. A function lands
	// between its parentheses.
	Cursor int    `json:"cursor"`
	Sort   string `json:"sort"` // ascending sort key; the order Items is already in
}

type Kind string

type Request struct {
	// Schema is the connection's tables, columns and keys (the ERD's
	// reading of the catalog); nil offers only the dialect's vocabulary.
	Schema *erd.Schema
	// Driver is the connection's driver as configured (postgres, pg,
	// mysql, sqlite, bytdb …), for the dialect's vocabulary and quoting.
	Driver string
	// Focus is the schema the user is browsing (the sidebar's), whose
	// tables are ranked first; "" when there is none.
	Focus string
	// SearchPath is the schemas a bare table name resolves through, in
	// order (Postgres's current_schemas); nil means the dialect's default
	// (public on Postgres and bytdb). A table in one of them is inserted
	// bare unless a schema earlier on the path has a table of that name.
	SearchPath []string
	// Buffer is the whole editor text and Caret a byte offset into it.
	Buffer string
	Caret  int
}

type Result struct {
	From, To int    // the byte range a picked item replaces: the word being typed
	Prefix   string // buffer[From:To], what was matched against
	Items    []Item
	// Incomplete reports that Items was cut at MaxItems: a longer prefix
	// may surface items not listed now, so a client should ask again as
	// the prefix grows rather than filter this list itself.
	Incomplete bool
}

type Span struct {
	From int `json:"from"`
	To   int `json:"to"`
}

type Symbol struct {
	Kind SymbolKind `json:"kind"`
	Name string     `json:"name"` // as declared, without quotes
	At   Span       `json:"at"`   // the occurrence under the caret
	Def  Span       `json:"def"`  // where it is declared
	Uses []Span     `json:"uses"` // every occurrence, Def included, in buffer order
	// Fixed says why the name cannot be renamed here; "" when it can.
	Fixed string `json:"fixed,omitempty"`
}

type SymbolKind string