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。

5.3 KB
Raw Blame
import type { DatabaseType, TableInfoTab } from "@/types/database";

export interface TableMetadataCapabilities {
  columns: boolean;
  indexes: boolean;
  foreignKeys: boolean;
  constraints: boolean;
  triggers: boolean;
  partitions: boolean;
  ddl: boolean;
}

const defaultCapabilities: TableMetadataCapabilities = {
  columns: true,
  indexes: true,
  foreignKeys: true,
  // Structured constraint metadata (list_constraints) is only enabled for
  // drivers that implement it (PostgreSQL natively; Oracle/OceanBase/Xugu via agents);
  // leave it off by default so every other dialect doesn't grow a permanently
  // empty tab.
  constraints: false,
  triggers: true,
  // Declarative partitioning metadata (pg_partitioned_table / pg_get_partkeydef)
  // is PostgreSQL-only for now; other dialects leave the tab hidden.
  partitions: false,
  ddl: true,
};

const capabilityByType: Partial<Record<DatabaseType, Partial<TableMetadataCapabilities>>> = {
  oracle: {
    constraints: true,
  },
  "oceanbase-oracle": {
    constraints: true,
  },
  // KingbaseES V9 shares PostgreSQL's declarative partition catalog and DDL.
  kingbase: {
    constraints: true,
    partitions: true,
  },
  vastbase: {
    constraints: true,
  },
  opengauss: {
    constraints: true,
  },
  // PostgreSQL reports full pg_constraint metadata (PK/FK/UNIQUE/CHECK/
  // EXCLUDE/NOT NULL) through list_constraints.
  postgres: {
    constraints: true,
    partitions: true,
  },
  // SQL Server reports PK/UNIQUE/FOREIGN KEY/CHECK/DEFAULT constraints from the
  // sys.* catalog views through list_constraints.
  sqlserver: {
    constraints: true,
  },
  mongodb: {
    columns: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  clickhouse: {
    foreignKeys: false,
    triggers: false,
  },
  manticoresearch: {
    foreignKeys: false,
    triggers: false,
  },
  elasticsearch: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  easysearch: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  meilisearch: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  solr: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  couchdb: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  // A Salesforce object only has describe metadata: the driver lists fields, and
  // there is no index, foreign key, trigger or DDL surface behind an SObject, so
  // those structure tabs would render permanently empty.
  salesforce: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  hbase: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  qdrant: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  milvus: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  weaviate: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  chromadb: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  influxdb3: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  influxdb: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  victoriametrics: {
    indexes: false,
    foreignKeys: false,
    triggers: false,
    ddl: false,
  },
  questdb: {
    indexes: true,
    foreignKeys: false,
    triggers: false,
  },
};

export function getTableMetadataCapabilities(dbType?: DatabaseType, context?: { connectionType?: DatabaseType; exactIdentity?: boolean }): TableMetadataCapabilities {
  const capabilities = { ...defaultCapabilities, ...(dbType ? capabilityByType[dbType] : undefined) };
  // Exact JDBC currently implements columns, indexes and DDL only. Do not offer
  // metadata tabs whose requests cannot preserve the selected raw identity.
  if (context?.exactIdentity && context.connectionType === "jdbc") {
    return { ...capabilities, foreignKeys: false, constraints: false, triggers: false, partitions: false };
  }
  return capabilities;
}

export function firstStructureMetadataTab(capabilities: TableMetadataCapabilities, isCreateMode: boolean): TableInfoTab {
  // Structure editing should open on an editable metadata page; DDL remains a
  // read-only fallback for databases that do not expose editable metadata.
  if (capabilities.columns) return "columns";
  if (capabilities.indexes) return "indexes";
  if (capabilities.foreignKeys) return "foreignKeys";
  if (capabilities.constraints) return "constraints";
  if (capabilities.triggers) return "triggers";
  if (!isCreateMode && capabilities.ddl) return "ddl";
  return "columns";
}

export function isStructureMetadataTabSupported(tab: TableInfoTab, capabilities: TableMetadataCapabilities, isCreateMode: boolean): boolean {
  return (
    (tab === "columns" && capabilities.columns) ||
    (tab === "indexes" && capabilities.indexes) ||
    (tab === "foreignKeys" && capabilities.foreignKeys) ||
    (tab === "constraints" && capabilities.constraints) ||
    (tab === "triggers" && capabilities.triggers) ||
    (tab === "partitions" && capabilities.partitions) ||
    (tab === "ddl" && capabilities.ddl && !isCreateMode)
  );
}