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。

8.6 KB
Raw Blame
import type { DatabaseType } from "@/types/database";
import { isSchemaAware, usesTreeSchemaMode } from "@/lib/database/databaseFeatureSupport";

export type SyntheticEditKey = "oracle-rowid" | "xugu-rowid" | "postgres-ctid" | "neo4j-element-id";

export interface TableDataCapability {
  insert: boolean;
  updateRequiresPrimaryKey: boolean;
  deleteRequiresPrimaryKey: boolean;
  keylessRowPredicate?: boolean;
  requiresTransactionalTableForExistingRows: boolean;
  existingRowsReadonly?: boolean;
  transaction: boolean;
  readonly?: boolean;
}

export interface DatabaseCapability {
  schemaAware: boolean;
  treeSchemaMode: boolean;
  tableData: TableDataCapability;
  syntheticKey?: SyntheticEditKey;
}

const DEFAULT_TABLE_DATA_CAPABILITY: TableDataCapability = {
  insert: false,
  updateRequiresPrimaryKey: true,
  deleteRequiresPrimaryKey: true,
  keylessRowPredicate: false,
  requiresTransactionalTableForExistingRows: false,
  transaction: true,
};

const NAVICAT_STYLE_TABLE_DATA_CAPABILITY: TableDataCapability = {
  insert: true,
  updateRequiresPrimaryKey: false,
  deleteRequiresPrimaryKey: false,
  keylessRowPredicate: true,
  requiresTransactionalTableForExistingRows: false,
  transaction: true,
};

const DEFAULT_CAPABILITY: DatabaseCapability = {
  schemaAware: false,
  treeSchemaMode: false,
  tableData: DEFAULT_TABLE_DATA_CAPABILITY,
};

const NAVICAT_STYLE_TABLE_DATA_TYPES = new Set<DatabaseType>([
  "mysql",
  "manticoresearch",
  "postgres",
  "sqlite",
  "rqlite",
  "turso",
  "cloudflare-d1",
  "duckdb",
  "sqlserver",
  "oracle",
  "doris",
  "starrocks",
  "redshift",
  "dameng",
  "gaussdb",
  "kwdb",
  "kingbase",
  "highgo",
  "uxdb",
  "vastbase",
  "goldendb",
  "yashandb",
  "databricks",
  "saphana",
  "teradata",
  "vertica",
  "firebird",
  "exasol",
  "opengauss",
  "questdb",
  "oceanbase-oracle",
  "gbase",
  "gbase8s",
  "access",
  "h2",
  "snowflake",
  "db2",
  "informix",
  "bigquery",
  "spanner",
  "sundb",
  "oscar",
  "databend",
  "iris",
]);

const DATABASE_CAPABILITY_OVERRIDES: Partial<Record<DatabaseType, Partial<DatabaseCapability>>> = {
  postgres: {
    // CTID is injected only by base-table data previews; it is not a schema key.
    syntheticKey: "postgres-ctid",
  },
  duckdb: {
    tableData: {
      insert: true,
      updateRequiresPrimaryKey: false,
      deleteRequiresPrimaryKey: false,
      keylessRowPredicate: true,
      requiresTransactionalTableForExistingRows: false,
      transaction: false,
    },
  },
  kyuubi: {
    tableData: {
      insert: false,
      updateRequiresPrimaryKey: false,
      deleteRequiresPrimaryKey: false,
      requiresTransactionalTableForExistingRows: false,
      existingRowsReadonly: true,
      transaction: false,
      readonly: true,
    },
  },
  impala: {
    tableData: {
      insert: false,
      updateRequiresPrimaryKey: false,
      deleteRequiresPrimaryKey: false,
      requiresTransactionalTableForExistingRows: false,
      existingRowsReadonly: true,
      transaction: false,
      readonly: true,
    },
  },
  hive: {
    tableData: {
      insert: true,
      updateRequiresPrimaryKey: false,
      deleteRequiresPrimaryKey: false,
      keylessRowPredicate: true,
      requiresTransactionalTableForExistingRows: true,
      transaction: false,
    },
  },
  argo: {
    tableData: {
      insert: true,
      updateRequiresPrimaryKey: false,
      deleteRequiresPrimaryKey: false,
      keylessRowPredicate: true,
      requiresTransactionalTableForExistingRows: true,
      transaction: false,
    },
  },
  transwarp: {
    tableData: {
      insert: true,
      updateRequiresPrimaryKey: false,
      deleteRequiresPrimaryKey: false,
      keylessRowPredicate: true,
      requiresTransactionalTableForExistingRows: true,
      transaction: true,
    },
  },
  jdbc: {
    tableData: {
      insert: false,
      updateRequiresPrimaryKey: true,
      deleteRequiresPrimaryKey: true,
      requiresTransactionalTableForExistingRows: false,
      transaction: false,
    },
  },
  manticoresearch: {
    tableData: {
      insert: true,
      updateRequiresPrimaryKey: false,
      deleteRequiresPrimaryKey: false,
      keylessRowPredicate: true,
      requiresTransactionalTableForExistingRows: false,
      transaction: false,
    },
  },
  neo4j: {
    syntheticKey: "neo4j-element-id",
  },
  oracle: {
    syntheticKey: "oracle-rowid",
  },
  xugu: {
    // Xugu exposes a stable ROWID pseudo-column for base, partitioned and
    // temporary tables. Keep this capability scoped to Xugu instead of
    // broadening Oracle-compatible behavior for other drivers.
    syntheticKey: "xugu-rowid",
    tableData: {
      insert: true,
      updateRequiresPrimaryKey: false,
      deleteRequiresPrimaryKey: false,
      keylessRowPredicate: true,
      requiresTransactionalTableForExistingRows: false,
      transaction: true,
    },
  },
  "oceanbase-oracle": {
    syntheticKey: "oracle-rowid",
  },
  trino: {
    tableData: {
      insert: true,
      updateRequiresPrimaryKey: true,
      deleteRequiresPrimaryKey: true,
      requiresTransactionalTableForExistingRows: false,
      transaction: false,
    },
  },
  databend: {
    // Databend's JDBC driver reports supportsTransactions() == false, and the
    // agent refuses an explicit transaction for exactly that reason
    // ("Transactions are not supported by this JDBC driver"). Grid saves must
    // therefore go through executeBatch, not executeInTransaction, or every
    // edit fails with that error (issue #12003). The capability override must
    // repeat the Navicat-style defaults, since an override replaces the whole
    // tableData object rather than merging field by field.
    tableData: {
      insert: true,
      updateRequiresPrimaryKey: false,
      deleteRequiresPrimaryKey: false,
      keylessRowPredicate: true,
      requiresTransactionalTableForExistingRows: false,
      transaction: false,
    },
  },
  prestosql: {
    tableData: {
      insert: true,
      updateRequiresPrimaryKey: true,
      deleteRequiresPrimaryKey: true,
      requiresTransactionalTableForExistingRows: false,
      transaction: false,
    },
  },
  clickhouse: {
    tableData: {
      insert: true,
      updateRequiresPrimaryKey: true,
      deleteRequiresPrimaryKey: true,
      requiresTransactionalTableForExistingRows: false,
      transaction: false,
    },
  },
  tdengine: {
    tableData: {
      insert: true,
      updateRequiresPrimaryKey: true,
      deleteRequiresPrimaryKey: true,
      requiresTransactionalTableForExistingRows: false,
      transaction: false,
    },
  },
  influxdb: {
    tableData: {
      insert: false,
      updateRequiresPrimaryKey: false,
      deleteRequiresPrimaryKey: true,
      keylessRowPredicate: false,
      requiresTransactionalTableForExistingRows: false,
      existingRowsReadonly: true,
      transaction: false,
      readonly: true,
    },
  },
  victoriametrics: {
    tableData: {
      insert: false,
      updateRequiresPrimaryKey: false,
      deleteRequiresPrimaryKey: true,
      keylessRowPredicate: false,
      requiresTransactionalTableForExistingRows: false,
      existingRowsReadonly: true,
      transaction: false,
      readonly: true,
    },
  },
  salesforce: {
    // SOQL has no DML. A grid save becomes one `DBX SALESFORCE DML` pseudo-command
    // per record (built by dbx-sql) which the driver turns into a REST call:
    // PATCH /sobjects/{object}/{id}, POST /sobjects/{object}, DELETE /sobjects/{object}/{id}.
    // Row identity is the `Id` column (the driver marks it is_primary_key), so both
    // update and delete require it. REST has no transactions: records are written
    // one by one, a failure leaves the earlier records applied, and nothing can be
    // rolled back — the grid therefore asks for confirmation before saving.
    tableData: {
      insert: true,
      updateRequiresPrimaryKey: true,
      deleteRequiresPrimaryKey: true,
      keylessRowPredicate: false,
      requiresTransactionalTableForExistingRows: false,
      existingRowsReadonly: false,
      transaction: false,
      readonly: false,
    },
  },
};

function defaultTableDataCapability(dbType?: DatabaseType): TableDataCapability {
  if (dbType && NAVICAT_STYLE_TABLE_DATA_TYPES.has(dbType)) return NAVICAT_STYLE_TABLE_DATA_CAPABILITY;
  return DEFAULT_TABLE_DATA_CAPABILITY;
}

export function getDatabaseCapability(dbType?: DatabaseType): DatabaseCapability {
  const override = dbType ? DATABASE_CAPABILITY_OVERRIDES[dbType] : undefined;
  const tableData = defaultTableDataCapability(dbType);
  return {
    ...DEFAULT_CAPABILITY,
    ...override,
    schemaAware: isSchemaAware(dbType),
    treeSchemaMode: usesTreeSchemaMode(dbType),
    tableData: {
      ...tableData,
      ...override?.tableData,
    },
  };
}