Installation

DortDB is distributed as a set of npm packages. You always install the core, and then add one or more language packages.

Core

npm

npm install @dortdb/core

Yarn

yarn add @dortdb/core

pnpm

pnpm add @dortdb/core

Bun

bun add @dortdb/core

@dortdb/core contains the DortDB engine, the optimizer, the index abstractions, and all the extension points. It ships no query language on its own; you add those separately.

Language packages

Install whichever of the provided languages you want to use:

npm

npm install @dortdb/lang-sql
npm install @dortdb/lang-cypher graphology
npm install @dortdb/lang-xquery

Yarn

yarn add @dortdb/lang-sql
yarn add @dortdb/lang-cypher graphology
yarn add @dortdb/lang-xquery

pnpm

pnpm add @dortdb/lang-sql
pnpm add @dortdb/lang-cypher graphology
pnpm add @dortdb/lang-xquery

Bun

bun add @dortdb/lang-sql
bun add @dortdb/lang-cypher graphology
bun add @dortdb/lang-xquery

• @dortdb/lang-sql: SQL over object-shaped rows.
• @dortdb/lang-cypher: Cypher over property graphs. Its default data adapter is backed by Graphology, so install graphology alongside it (it is a peer dependency).
• @dortdb/lang-xquery: XQuery over XML / DOM / tree-shaped data.

Each language package declares @dortdb/core as a peer dependency, so a single core instance is shared across all of them.

Bundle size

Because the core and each language are separate packages, a browser bundle only includes the languages and extensions you actually import. Loading SQL does not pull in the Cypher or XQuery parsers.

Optional extensions

Extensions bundle extra functions, operators, or aggregates. The provided datetime extension adds date/time helpers:

npm

npm install @dortdb/datetime

Yarn

yarn add @dortdb/datetime

pnpm

pnpm add @dortdb/datetime

Bun

bun add @dortdb/datetime

See Extending DortDB for how extensions work and how to write your own.

Next step

Continue to Your First Query to construct an engine and run a query.