Skip to content

armgit / dbx

Public Imported from GitHub
0

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。

14.8 KB
Raw Blame
import type { DatabaseType } from "@/types/database";
import { COLUMN_NAME_COPY_SEPARATOR_VALUES, loadColumnNameCopySeparator, type ColumnNameCopySeparator, isColumnNameCopySeparator } from "@/lib/dataGrid/dataGridColumnNameCopy";
import { qualifiedTableName, quoteTableIdentifier } from "@/lib/table/tableSelectSql";
import { requiresClickhouseIdentifierQuote, requiresMysqlIdentifierQuote, requiresPostgresIdentifierQuote } from "@/lib/sql/sqlIdentifier.ts";

/** 智能引号使用反引号的方言族。 */
const SMART_QUOTE_BACKTICK_TYPES = new Set<DatabaseType>(["mysql", "hive", "argo", "transwarp", "kyuubi", "impala", "spark", "databricks", "databend", "tdengine", "access", "doris", "starrocks", "goldendb"]);
/** 智能引号使用双引号的方言族(SQL Server 方括号除外)。 */
const SMART_QUOTE_DOUBLE_TYPES = new Set<DatabaseType>(["postgres", "gaussdb", "opengauss"]);
/** SQL Server 族智能引号使用方括号。 */
const SMART_QUOTE_BRACKET_TYPES = new Set<DatabaseType>(["sqlserver"]);

/**
 * 列引用插入的按需引号:普通名称(合法标识符字符、非保留字)裸输出,
 * 保留字或含特殊字符时按方言加引号。表名/库名仍走全量引号。
 *
 * MySQL/PG/SQL Server 族用各自的保留字判定;其余方言无专属保留字表,
 * 用「严格标识符正则 + PG/MySQL 保留字并集」做通用保守判定。
 */
function quoteColumnReferenceName(databaseType: DatabaseType | undefined, name: string): string {
  if (databaseType === "clickhouse") {
    return requiresClickhouseIdentifierQuote(name) ? `\`${name.replace(/`/g, "``")}\`` : name;
  }
  if (databaseType && SMART_QUOTE_BACKTICK_TYPES.has(databaseType)) {
    return requiresMysqlIdentifierQuote(name) ? `\`${name.replace(/`/g, "``")}\`` : name;
  }
  if (databaseType && SMART_QUOTE_DOUBLE_TYPES.has(databaseType)) {
    // PG 族裸标识符会折叠为小写,混合大小写必须加引号保留原样。
    return requiresPostgresIdentifierQuote(name) ? `"${name.replace(/"/g, '""')}"` : name;
  }
  if (databaseType && SMART_QUOTE_BRACKET_TYPES.has(databaseType)) {
    return requiresPostgresIdentifierQuote(name) ? `[${name.replace(/\]/g, "]]")}]` : name;
  }
  // 其余方言:引号格式仍由 quoteTableIdentifier 按方言决定,是否加引号
  // 用通用保守判定(严格标识符正则 + PG/MySQL 保留字并集)。
  return requiresMysqlIdentifierQuote(name) ? quoteTableIdentifier(databaseType, name) : name;
}

export const DBX_TABLE_REFERENCE_MIME = "application/x-dbx-table-reference";
export const DBX_TABLE_REFERENCE_DROP_EVENT = "dbx-table-reference-drop";
export const DBX_TABLE_REFERENCE_HOVER_EVENT = "dbx-table-reference-hover";
export const DBX_TABLE_REFERENCE_DRAG_END_EVENT = "dbx-table-reference-drag-end";

export interface QueryEditorTableReferenceEntry {
  schema?: string;
  tableName: string;
}

export interface QueryEditorTableReferencePayload {
  kind: "dbx-table-reference";
  connectionId: string;
  database: string;
  schema?: string;
  tableName?: string;
  tableReferences?: QueryEditorTableReferenceEntry[];
  columnName?: string;
  /** 多个结果列一起拖入时按选择顺序排列;单列沿用 columnName。 */
  columnNames?: string[];
  referenceType?: "database" | "table" | "column";
  databaseType?: DatabaseType;
  driverProfile?: string;
  columnNameSeparator?: ColumnNameCopySeparator;
  tableNameSeparator?: ColumnNameCopySeparator;
  includeTableSchema?: boolean;
}

export interface QueryEditorTableReferenceDropDetail {
  payload: QueryEditorTableReferencePayload;
  clientX: number;
  clientY: number;
}

export interface QueryEditorTableReferenceHoverDetail {
  clientX: number;
  clientY: number;
}

export interface TableReferenceInsertOptions {
  tableNameSeparator?: ColumnNameCopySeparator;
  includeTableSchema?: boolean;
  columnNameSeparator?: ColumnNameCopySeparator;
}

function normalizeColumnNames(value: unknown): string[] {
  if (!Array.isArray(value)) return [];
  return value.map((name) => (typeof name === "string" ? name.trim() : "")).filter((name) => name.length > 0);
}

function normalizeTableReferences(value: unknown): QueryEditorTableReferenceEntry[] {
  if (!Array.isArray(value)) return [];
  const entries: QueryEditorTableReferenceEntry[] = [];
  for (const item of value) {
    if (!item || typeof item !== "object") continue;
    const tableName = typeof (item as QueryEditorTableReferenceEntry).tableName === "string" ? (item as QueryEditorTableReferenceEntry).tableName.trim() : "";
    if (!tableName) continue;
    const schema = typeof (item as QueryEditorTableReferenceEntry).schema === "string" ? (item as QueryEditorTableReferenceEntry).schema : undefined;
    entries.push(schema ? { schema, tableName } : { tableName });
  }
  return entries;
}

/** schema/databaseType/driverProfile 为可选元数据,payload 各构造路径共用同一拷贝规则。 */
function applyOptionalReferenceMeta(payload: QueryEditorTableReferencePayload, source: Partial<QueryEditorTableReferencePayload>) {
  if (typeof source.schema === "string" && source.schema) payload.schema = source.schema;
  if (source.databaseType) payload.databaseType = source.databaseType;
  if (typeof source.driverProfile === "string" && source.driverProfile) payload.driverProfile = source.driverProfile;
  if (isColumnNameCopySeparator(source.columnNameSeparator)) payload.columnNameSeparator = source.columnNameSeparator;
  if (isColumnNameCopySeparator(source.tableNameSeparator)) payload.tableNameSeparator = source.tableNameSeparator;
  if (source.includeTableSchema === true) payload.includeTableSchema = true;
}

let activeTableReferencePayload: QueryEditorTableReferencePayload | null = null;

export function createTableReferencePayload(options: {
  connectionId?: string;
  database?: string;
  schema?: string;
  tableName?: string;
  columnName?: string;
  referenceType?: "database" | "table" | "column";
  databaseType?: DatabaseType;
  driverProfile?: string;
}): QueryEditorTableReferencePayload | null {
  if (!options.connectionId || options.database == null) return null;
  const referenceType = options.referenceType ?? (options.columnName ? "column" : "table");
  if (referenceType !== "database" && !options.tableName) return null;
  const payload: QueryEditorTableReferencePayload = {
    kind: "dbx-table-reference",
    connectionId: options.connectionId,
    database: options.database,
  };
  if (referenceType === "database") {
    payload.referenceType = "database";
  } else {
    payload.tableName = options.tableName;
  }
  if (referenceType === "column" && options.columnName) {
    payload.columnName = options.columnName;
    payload.referenceType = "column";
  }
  applyOptionalReferenceMeta(payload, options);
  return payload;
}

export function createMultiTableReferencePayload(options: {
  connectionId?: string;
  database?: string;
  tableReferences?: readonly QueryEditorTableReferenceEntry[];
  databaseType?: DatabaseType;
  driverProfile?: string;
  tableNameSeparator?: ColumnNameCopySeparator;
  includeTableSchema?: boolean;
}): QueryEditorTableReferencePayload | null {
  if (!options.connectionId || options.database == null) return null;
  const tableReferences = normalizeTableReferences(options.tableReferences);
  if (tableReferences.length === 0) return null;
  const payload: QueryEditorTableReferencePayload = {
    kind: "dbx-table-reference",
    connectionId: options.connectionId,
    database: options.database,
    referenceType: "table",
  };
  if (tableReferences.length === 1) {
    payload.tableName = tableReferences[0]!.tableName;
    if (tableReferences[0]!.schema) payload.schema = tableReferences[0]!.schema;
  } else {
    payload.tableReferences = tableReferences;
  }
  applyOptionalReferenceMeta(payload, {
    databaseType: options.databaseType,
    driverProfile: options.driverProfile,
    tableNameSeparator: options.tableNameSeparator,
    includeTableSchema: options.includeTableSchema,
  });
  return payload;
}

export function createColumnReferencePayload(options: { connectionId?: string; database?: string; schema?: string; columnNames?: readonly (string | undefined | null)[]; databaseType?: DatabaseType; columnNameSeparator?: ColumnNameCopySeparator }): QueryEditorTableReferencePayload | null {
  const columnNames = normalizeColumnNames(options.columnNames);
  if (!options.connectionId || options.database == null || columnNames.length === 0) return null;
  const payload: QueryEditorTableReferencePayload = {
    kind: "dbx-table-reference",
    connectionId: options.connectionId,
    database: options.database,
    referenceType: "column",
    columnNames,
  };
  applyOptionalReferenceMeta(payload, options as Partial<QueryEditorTableReferencePayload>);
  return payload;
}

export function serializeTableReferencePayload(payload: QueryEditorTableReferencePayload): string {
  return JSON.stringify(payload);
}

export function parseTableReferencePayload(value: string | undefined | null): QueryEditorTableReferencePayload | null {
  if (!value) return null;
  try {
    const parsed = JSON.parse(value) as Partial<QueryEditorTableReferencePayload>;
    if (parsed.kind !== "dbx-table-reference" || typeof parsed.connectionId !== "string" || typeof parsed.database !== "string" || !parsed.connectionId) {
      return null;
    }
    if (parsed.referenceType === "database") {
      const payload: QueryEditorTableReferencePayload = {
        kind: "dbx-table-reference",
        connectionId: parsed.connectionId,
        database: parsed.database,
        referenceType: "database",
      };
      if (parsed.databaseType) payload.databaseType = parsed.databaseType;
      if (typeof parsed.driverProfile === "string" && parsed.driverProfile) payload.driverProfile = parsed.driverProfile;
      return payload;
    }
    const columnNames = normalizeColumnNames(parsed.columnNames);
    if (columnNames.length > 0 && (parsed.referenceType === "column" || !parsed.tableName)) {
      const payload: QueryEditorTableReferencePayload = {
        kind: "dbx-table-reference",
        connectionId: parsed.connectionId,
        database: parsed.database,
        referenceType: "column",
        columnNames,
      };
      applyOptionalReferenceMeta(payload, parsed);
      return payload;
    }
    const tableReferences = normalizeTableReferences(parsed.tableReferences);
    if (tableReferences.length > 1) {
      const payload: QueryEditorTableReferencePayload = {
        kind: "dbx-table-reference",
        connectionId: parsed.connectionId,
        database: parsed.database,
        referenceType: "table",
        tableReferences,
      };
      applyOptionalReferenceMeta(payload, parsed);
      return payload;
    }
    if (typeof parsed.tableName !== "string" || !parsed.tableName) {
      return null;
    }
    const columnName = typeof parsed.columnName === "string" && parsed.columnName ? parsed.columnName : undefined;
    const referenceType = parsed.referenceType === "column" || columnName || columnNames.length > 0 ? "column" : "table";
    const payload: QueryEditorTableReferencePayload = {
      kind: "dbx-table-reference",
      connectionId: parsed.connectionId,
      database: parsed.database,
      tableName: parsed.tableName,
    };
    if (referenceType === "column") {
      payload.referenceType = "column";
      if (columnNames.length > 0) payload.columnNames = columnNames;
      else if (columnName) payload.columnName = columnName;
      else return null;
    }
    applyOptionalReferenceMeta(payload, parsed);
    return payload;
  } catch {
    return null;
  }
}

export function hasTableReferencePayloadType(types: Iterable<string> | undefined | null): boolean {
  if (!types) return false;
  for (const type of types) {
    if (type === DBX_TABLE_REFERENCE_MIME) return true;
  }
  return false;
}

export function setActiveTableReferencePayload(payload: QueryEditorTableReferencePayload | null) {
  activeTableReferencePayload = payload;
}

export function activeTableReferencePayloadValue(): QueryEditorTableReferencePayload | null {
  return activeTableReferencePayload;
}

export function clearActiveTableReferencePayload(payload?: QueryEditorTableReferencePayload | null) {
  if (!payload || activeTableReferencePayload === payload) {
    activeTableReferencePayload = null;
  }
}

export function createTableReferenceDropEvent(detail: QueryEditorTableReferenceDropDetail) {
  return new CustomEvent<QueryEditorTableReferenceDropDetail>(DBX_TABLE_REFERENCE_DROP_EVENT, { detail });
}

export function createTableReferenceHoverEvent(detail: QueryEditorTableReferenceHoverDetail) {
  return new CustomEvent<QueryEditorTableReferenceHoverDetail>(DBX_TABLE_REFERENCE_HOVER_EVENT, { detail });
}

export function createTableReferenceDragEndEvent(): Event {
  return new Event(DBX_TABLE_REFERENCE_DRAG_END_EVENT);
}

function separatorValue(payload: QueryEditorTableReferencePayload, options: TableReferenceInsertOptions | undefined, kind: "table" | "column"): string {
  const fromPayload = kind === "table" ? payload.tableNameSeparator : payload.columnNameSeparator;
  const fromOptions = kind === "table" ? options?.tableNameSeparator : options?.columnNameSeparator;
  const fallback = kind === "column" ? loadColumnNameCopySeparator() : "comma";
  const separator = fromOptions ?? fromPayload ?? fallback;
  return COLUMN_NAME_COPY_SEPARATOR_VALUES[separator] ?? (kind === "column" ? "\t" : ",");
}

export function tableReferenceInsertText(payload: QueryEditorTableReferencePayload, fallbackDatabaseType?: DatabaseType, options?: TableReferenceInsertOptions): string {
  const databaseType = payload.databaseType ?? fallbackDatabaseType;
  if (payload.referenceType === "database") {
    return quoteTableIdentifier(databaseType, payload.database);
  }
  const columnNames = payload.columnNames?.length ? payload.columnNames : payload.columnName ? [payload.columnName] : [];
  if (payload.referenceType === "column" && columnNames.length > 0) {
    return columnNames.map((name) => quoteColumnReferenceName(databaseType, name)).join(separatorValue(payload, options, "column"));
  }
  const includeSchema = payload.includeTableSchema ?? options?.includeTableSchema ?? false;
  const tableSeparator = separatorValue(payload, options, "table");
  const tableReferences = payload.tableReferences?.length ? payload.tableReferences : payload.tableName ? [{ schema: payload.schema, tableName: payload.tableName }] : [];
  if (tableReferences.length > 1 || (tableReferences.length === 1 && includeSchema)) {
    return tableReferences
      .map((entry) =>
        includeSchema
          ? qualifiedTableName({
              databaseType,
              driverProfile: payload.driverProfile,
              schema: entry.schema,
              tableName: entry.tableName,
              database: payload.database,
            })
          : entry.tableName,
      )
      .join(tableSeparator);
  }
  const tableName = payload.tableName || payload.database;
  return qualifiedTableName({
    databaseType,
    driverProfile: payload.driverProfile,
    schema: payload.schema,
    tableName,
  });
}