History

skyler d2166e080c Merge pull request #782 from sunny0826/feat/kwdb feat: add KWDB support		2026-06-05 18:16:17 +08:00
..
src	Merge pull request #782 from sunny0826/feat/kwdb	2026-06-05 18:16:17 +08:00
tests	feat: add rqlite database support	2026-06-05 01:02:07 +08:00
README.md	feat(cli): add dbx node packages	2026-05-18 00:53:06 +08:00
package.json	chore(packages): release 0.4.6 [skip node-packages-release]	2026-06-04 07:24:53 +00:00
tsconfig.json	feat(cli): add dbx node packages	2026-05-18 00:53:06 +08:00

README.md

DBX Node Core

Shared Node.js runtime utilities for DBX CLI and DBX MCP Server.

This package reads DBX Desktop connection storage, redacts connection summaries, builds schema context, applies SQL safety rules, and executes supported direct database queries.

Supported Runtime

Requires Node.js 22.13.0 or newer.

Direct Query Support

Direct execution currently supports:

PostgreSQL and Redshift
MySQL-compatible databases, including MySQL, Doris, and StarRocks
SQLite

Other DBX connection types can be routed through DBX Desktop bridge integrations used by the CLI and MCP server.

Public Modules

import {
  createBackend,
  loadConnections,
  getDbxDiagnostics,
  evaluateSqlSafety,
  buildSchemaContext,
} from "@dbx-app/node-core";

The package is intended as a shared implementation layer for official DBX Node packages. Applications should prefer @dbx-app/cli for terminal workflows and @dbx-app/mcp-server for MCP clients.