25 MB lightweight cross-platform database client for 100+ databases, including MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, SQL Server, and Dameng. Built-in AI, MCP Server, CLI, desktop and Docker. | 轻量级跨平台数据库管理工具,支持 MySQL、PostgreSQL、SQLite、Redis、MongoDB、达梦等 100+ 数据库,提供桌面端、Docker、CLI、内置 AI 助手和 MCP。
TypeScript aicliclickhousedatabasedatabase-clientdatabase-managementdockerguimcpmongodbmysqlpostgresqlredisrustsql-serversqlitetaurivue
import { StateEffect, type Extension } from "@codemirror/state";
import { Decoration, EditorView, ViewPlugin, WidgetType, type DecorationSet, type ViewUpdate } from "@codemirror/view";
import { matchDollarQuoteTag } from "@/lib/sql/semantic/tokens";
import { buildInsertValueHints, expandToSqlStatementWindow, findEnclosingDollarQuoteStartInText, insertValueHintsNeedTableColumns, parseInsertValuesClauses, type InsertValueHint, type InsertValuesClause, type TextRange } from "@/lib/sql/insertValueHints";
export const refreshInsertValueHintsEffect = StateEffect.define<null>();
/** Shared dispatch options so hint refreshes never scroll the viewport. */
export const insertValueHintsRefreshDispatchSpec = {
scrollIntoView: false as const,
};
/** Debounce hint reparse while the user is typing / holding a key. */
const INSERT_HINT_REPARSE_DELAY_MS = 80;
export interface InsertValueHintsExtensionOptions {
isEnabled?: () => boolean;
/** Sync cache lookup for table columns when INSERT has no explicit column list. */
getTableColumns?: (table: string, schema?: string, database?: string) => string[] | undefined;
/** Async loader invoked when sync cache misses; should call refresh after load. */
requestTableColumns?: (table: string, schema?: string, database?: string) => void;
/** SQL dialect id ("mysql", "postgres", ...) for statement-window and tokenization. Defaults to "mysql". */
getDialectId?: () => string;
}
class InsertValueHintWidget extends WidgetType {
constructor(readonly column: string) {
super();
}
eq(other: InsertValueHintWidget) {
return other.column === this.column;
}
toDOM() {
const span = document.createElement("span");
span.className = "cm-insert-value-hint";
span.textContent = this.column;
span.setAttribute("aria-hidden", "true");
return span;
}
ignoreEvent() {
return true;
}
}
function decorationsForHints(hints: readonly InsertValueHint[]): DecorationSet {
if (hints.length === 0) return Decoration.none;
const deduped: InsertValueHint[] = [];
const seenFrom = new Set<number>();
for (const hint of [...hints].sort((a, b) => a.from - b.from || a.column.localeCompare(b.column))) {
if (seenFrom.has(hint.from)) continue;
seenFrom.add(hint.from);
deduped.push(hint);
}
const ranges = deduped.map((hint) =>
Decoration.widget({
widget: new InsertValueHintWidget(hint.column),
side: -1,
}).range(hint.from),
);
return Decoration.set(ranges);
}
/** @internal Exported for unit tests. */
/**
* Whether a database type runs SQL-family statements, where INSERT column
* hints (and their SELECT extension) apply. NoSQL/document stores are excluded;
* keep this list in sync instead of re-inlining it at call sites.
*/
export function supportsInsertValueHints(databaseType: string | undefined | null): boolean {
return databaseType !== "redis" && databaseType !== "mongodb" && databaseType !== "elasticsearch" && databaseType !== "easysearch" && databaseType !== "meilisearch" && databaseType !== "solr" && databaseType !== "couchdb" && databaseType !== "victoriametrics" && databaseType !== "salesforce";
}
export function buildInsertValueHintDecorations(hints: readonly InsertValueHint[]): DecorationSet {
return decorationsForHints(hints);
}
/** True when `pos` sits on an insert-value-hint widget anchor (value expression start). */
export function isInsertValueHintDecorationAt(decorations: DecorationSet, pos: number): boolean {
let found = false;
decorations.between(Math.max(0, pos - 1), pos + 1, (_from, _to, decoration) => {
const widget = decoration.spec?.widget;
if (widget instanceof InsertValueHintWidget) found = true;
});
return found;
}
function interestRanges(view: EditorView): TextRange[] {
const ranges: TextRange[] = view.visibleRanges.map((range) => ({ from: range.from, to: range.to }));
const cursor = view.state.selection.main.head;
ranges.push({ from: cursor, to: cursor });
return ranges;
}
function shiftClause(clause: InsertValuesClause, offset: number): InsertValuesClause {
if (offset === 0) return clause;
return {
...clause,
span: { start: clause.span.start + offset, end: clause.span.end + offset },
rows: clause.rows.map((row) => row.map((source) => ({ ...source, from: source.from + offset }))),
};
}
/** Parse INSERT hints using only local slices around interest ranges — no full-document tokenize. */
function parseClausesNearView(view: EditorView, dialectId: string): InsertValuesClause[] {
const doc = view.state.doc;
const clauses: InsertValuesClause[] = [];
const seenStmtStarts = new Set<number>();
for (const range of interestRanges(view)) {
// Pull a bounded neighborhood from the doc instead of materializing the whole script.
const pad = 32 * 1024;
let sliceFrom = Math.max(0, range.from - pad);
// When the cursor sits inside a PostgreSQL dollar-quoted routine body, a slice that still
// includes the opening $tag$ makes expandToSqlStatementWindow treat the whole body as one
// opaque literal. Advance sliceFrom past the opening delimiter instead.
const sliceTo = Math.min(doc.length, range.to + pad);
let dollarQuoteStart: number | null = null;
if (sliceTo > sliceFrom && doc.sliceString(sliceFrom, sliceTo).includes("$")) {
const probePos = Math.min(doc.length, Math.max(range.from, range.to));
dollarQuoteStart = findEnclosingDollarQuoteStartInText(doc, probePos) ?? findEnclosingDollarQuoteStartInText(doc, range.from);
}
if (dollarQuoteStart !== null) {
const openingTag = matchDollarQuoteTag(doc.sliceString(dollarQuoteStart, Math.min(doc.length, dollarQuoteStart + 64)), 0);
if (openingTag) sliceFrom = Math.max(sliceFrom, dollarQuoteStart + openingTag.length);
}
if (sliceTo <= sliceFrom) continue;
const slice = doc.sliceString(sliceFrom, sliceTo);
const window = expandToSqlStatementWindow(slice, range.from - sliceFrom, range.to - sliceFrom, dialectId);
if (window.to <= window.from) continue;
const absStart = sliceFrom + window.from;
if (seenStmtStarts.has(absStart)) continue;
seenStmtStarts.add(absStart);
const stmt = slice.slice(window.from, window.to);
// Cheap reject: skip tokenize when the window clearly has no INSERT.
if (!/\binsert\b/i.test(stmt)) continue;
for (const clause of parseInsertValuesClauses(stmt, dialectId)) {
clauses.push(shiftClause(clause, absStart));
}
}
return clauses;
}
function buildHints(view: EditorView, options: InsertValueHintsExtensionOptions): InsertValueHint[] {
const clauses = parseClausesNearView(view, options.getDialectId?.() ?? "mysql");
for (const clause of clauses) {
if (clause.columns !== null) continue;
const cached = options.getTableColumns?.(clause.table, clause.schema, clause.database);
if (!cached) options.requestTableColumns?.(clause.table, clause.schema, clause.database);
}
return buildInsertValueHints(clauses, {
resolveTableColumns: (table, schema, database) => options.getTableColumns?.(table, schema, database),
});
}
const insertValueHintsTheme = EditorView.baseTheme({
".cm-insert-value-hint": {
display: "inline-block",
marginRight: "0.35em",
padding: "0 0.3em",
borderRadius: "3px",
fontSize: "0.85em",
lineHeight: "1.2",
verticalAlign: "baseline",
color: "var(--cm-insert-value-hint-color, rgba(120, 120, 120, 0.95))",
backgroundColor: "var(--cm-insert-value-hint-bg, rgba(120, 120, 120, 0.18))",
pointerEvents: "none",
userSelect: "none",
fontStyle: "normal",
fontWeight: "500",
},
"&dark .cm-insert-value-hint": {
color: "var(--cm-insert-value-hint-color, rgba(180, 180, 180, 0.9))",
backgroundColor: "var(--cm-insert-value-hint-bg, rgba(180, 180, 180, 0.16))",
},
});
export function createInsertValueHintsExtension(options: InsertValueHintsExtensionOptions = {}): Extension {
const plugin = ViewPlugin.fromClass(
class {
decorations: DecorationSet;
private lastEnabled = true;
private reparseTimer: ReturnType<typeof setTimeout> | null = null;
constructor(view: EditorView) {
this.decorations = this.compute(view);
}
update(update: ViewUpdate) {
const refreshed = update.transactions.some((tr) => tr.effects.some((effect) => effect.is(refreshInsertValueHintsEffect)));
const enabled = options.isEnabled?.() ?? true;
if (!enabled) {
this.clearTimer();
this.lastEnabled = false;
this.decorations = Decoration.none;
return;
}
// Keep widget positions valid while a debounced reparse is pending.
if (update.docChanged) {
this.decorations = this.decorations.map(update.changes);
}
if (refreshed || enabled !== this.lastEnabled) {
this.clearTimer();
this.lastEnabled = enabled;
this.decorations = this.compute(update.view);
return;
}
this.lastEnabled = enabled;
if (update.docChanged || update.viewportChanged) {
// Do not reparse on the hot path — key-repeat would block the UI.
this.scheduleReparse(update.view);
}
}
destroy() {
this.clearTimer();
}
private scheduleReparse(view: EditorView) {
this.clearTimer();
this.reparseTimer = setTimeout(() => {
this.reparseTimer = null;
// Trigger a lightweight transaction so update() runs compute once typing pauses.
view.dispatch({
effects: refreshInsertValueHintsEffect.of(null),
...insertValueHintsRefreshDispatchSpec,
});
}, INSERT_HINT_REPARSE_DELAY_MS);
}
private clearTimer() {
if (this.reparseTimer !== null) {
clearTimeout(this.reparseTimer);
this.reparseTimer = null;
}
}
private compute(view: EditorView): DecorationSet {
if (!(options.isEnabled?.() ?? true)) return Decoration.none;
return decorationsForHints(buildHints(view, options));
}
},
{ decorations: (value) => value.decorations },
);
// Let CodeMirror handle pointer selection near hints. Consuming mousedown
// here prevents its drag-selection handler from starting.
return [insertValueHintsTheme, plugin];
}
export function requestInsertValueHintsRefresh(view: EditorView) {
view.dispatch({
effects: refreshInsertValueHintsEffect.of(null),
...insertValueHintsRefreshDispatchSpec,
});
}
export { insertValueHintsNeedTableColumns };