const db = new PGClient(); // or: MySQLClient | FlashQL | EdgeClient | etc

const result = await db.query(
  `SELECT {
    id,
    profile: { name, email },
    parent: parent_user ~> { name, email }
  } FROM users@3_2;`,

  { live: true }
);

Show result: output shape + live behaviour

// Structured output (via "{ ... }"):
result.rows[0].profile.name;

// Foreign key traversal (via "~>"):
result.rows[0].parent.name;

// Live queries:
// result.rows updates automatically as underlying data changes

// (any reactive system can observe these updates)
Observer.observe(result.rows[0].parent, 'email', (c) => {
  console.log(c.value, c.oldValue);
});

---

[!IMPORTANT] LinkedQL is in active development. The core query model and interfaces are stabilizing and backed by 1,200+ tests. MySQL/MariaDB live query support is still in progress. Feedback, issues, and PRs are welcome — see Contributing; see Issues.

---

Installation & Overview

LinkedQL is distributed as an npm package:

npm install @linked-db/linked-ql

It provides clients for all supported SQL dialects — including FlashQL, the embeddable SQL engine for local and offline storage.

Clients, Runtimes & Dialects

Import and use the client for your database:

import { PGClient } from '@linked-db/linked-ql/postgres';

const db = new PGClient();
await db.connect();

Client/Model	Import Path	Guide
PGClient	@linked-db/linked-ql/postgres	PostgreSQL ↗
MySQLClient	@linked-db/linked-ql/mysql	MySQL ↗
MariaDBClient	@linked-db/linked-ql/mariadb	MariaDB ↗
FlashQL	@linked-db/linked-ql/flashql	FlashQL ↗
EdgeClient	@linked-db/linked-ql/edge	Edge / Browser ↗
EdgeWorker	@linked-db/linked-ql/edge-worker	Edge Worker ↗

See:

• LinkedQL Guides ↗

---

Core Interface

LinkedQL exposes a minimal and consistent database interface:

await db.query(sql, options);
await db.query(sql, { live: true, ...options });
await db.stream(sql, options);
await db.transaction(fn);
await db.wal.subscribe(selector, handler);
await db.sync.sync(); // (FlashQL)

The same surface applies whether db is a direct PostgreSQL client, a local FlashQL engine, or an EdgeClient.

See:

• The Core API

---

What can you do with LinkedQL

1. Shape data directly in the query
2. Traverse relationships directly
3. Run Live Queries
4. Run SQL locally with FlashQL
5. Build distributed or offline-first architectures with Sync

...and more

1. Shape data directly in the query

JSON Literals let you define the exact shape your application expects directly in SQL.

const result = await db.query(`
  SELECT {
    id: u.id,
    name: u.name,
    profile: {
      email: u.email,
      age: u.age
    }
  } AS user
  FROM users u;
`);

No remapping step or post-processing code. The query itself defines the shape.

This is fully covered in JSON Literals ↗

2. Traverse relationships directly

DeepRefs let you follow relationships directly in SQL using simple arrow notations.

Notation	Meaning
~>	forward traversal (follow a reference)
<~	reverse traversal (find dependents)

Forward Traversal

const result = await db.query(`
  SELECT
    id,
    parent_user ~> email AS parent_email
  FROM users;
`);

This says:

→ "Given a foreign key (parent_user)"
→ "Tie in the referenced row; select email"

Reverse Traversal

const result = await db.query(`
  SELECT
    id,
    (parent_user <~ users) ~> email AS child_email
  FROM users;
`);

This walks “backwards” through a relationship:

• Ties in rows that reference the current row
• Selects the email column from each

Structured Traversal

const result = await db.query(`
  SELECT {
    id,
    profile: { name, email },
    parent: parent_user ~> { id, name, email }
  } FROM users;
`);

• Lets you model structures deeply
• Swaps complex alias bookkeeping with clear mental models

Insert and update into relationships

await db.query(`
  INSERT INTO users
    (email, parent_user ~> (id, email))
  VALUES
    ('[email protected]', ROW (50, '[email protected]'));
`);

This lets you construct relationships directly in an insert:

→ "Given a base row"
→ "Insert a related row that automatically references the base"

What this changes

No need for an ORM or manual JOIN logic.

If you've defined foreign key relationships in your tables, you can traverse them directly in the query.

Deeper syntax and traversal patterns are fully covered in DeepRefs ↗.

3. Run Live Queries

LinkedQL brings live queries to your database: PostgreSQL, FlashQL, MySQL/MariaDB*.

With just a mode switch { live: true }, you get back a live, self-updating result set.

const result = await db.query(`
  SELECT p.title, p.category
  FROM posts AS p
  WHERE p.published = true
  ORDER BY p.created_at DESC
`, { live: true });

result.rows updates automatically as the database changes:

• new rows appear
• removed rows disappear
• updated rows mutate in place

What this changes

No need for dedicated GraphQL servers in front of your database.

The query itself is the subscription.

Not limited by query complexity

const result = await db.query(`
  SELECT
    p.title,
    p.category,
    author ~> { name, email } AS author
  FROM posts AS p
  WHERE p.published = true
  ORDER BY p.created_at DESC
`, { live: true });

→ Supports the full SELECT range – joins, filters, aggregates, etc.
→ Supports the full set of LinkedQL syntax shorthands like DeepRefs and JSON Literals

Backed by a robust live query engine

See the full story in Live Queries ↗.
See the Realtime Engine ↗ paper for a deeper dive.

[!NOTE] Fully supported across:

• databases: PostgreSQL, FlashQL, etc. (MySQL/MariaDB support coming soon)
• runtimes and deployment models: client / server / worker / edge

4. Run SQL locally with FlashQL

Meet FlashQL – a full SQL engine that runs anywhere + inside your application.

It's LinkedQL's embeddable SQL engine.

import { FlashQL } from '@linked-db/linked-ql/flashql';

const db = new FlashQL();
await db.connect();

const result = await db.query(`
  CREATE TABLE users (
    id INT PRIMARY KEY,
    name TEXT
  );

  INSERT INTO users VALUES (1, 'Ada'), (2, 'Linus');

  SELECT * FROM users ORDER BY id;
`);

console.log(result.rows);

await db.disconnect();

FlashQL brings the full LinkedQL feature set into an embedded, local-first runtime.

Built for:

• local-first and offline-first architectures
• data federation and sync across local/remote boundaries

See FlashQL ↗ for a detailed overview.

5. Build distributed or offline-first architectures with Sync

LinkedQL uses a small set of primitives (EdgeClient, FlashQL) to unlock data federation, sync, and offline-first architectures.

For example:

You can spin up a FlashQL instance locally, backed by an upstream database.

const db = new FlashQL({
  getUpstreamClient: (url) =>
    new EdgeClient({ url, type: 'http' }),
});

await db.connect();

It lets you declare remote data as local tables (views):

await db.query(`
  CREATE VIEW users AS
  SELECT * FROM users
  WITH (replication_origin = 'postgres:/api/db');
`);

This simple setup gives you data federation across boundaries:

query both local and remote data as one relational graph:

const result = await db.query(`
  SELECT *
  FROM users u
  JOIN orders o ON o.user_id = u.id;
`);

With just an extra keyword, you get automatic sync between local and remote states:

await db.query(`
  CREATE REALTIME VIEW users AS
  SELECT * FROM users
  WITH (replication_origin = 'postgres:/api/db');
`);

• Upstream changes apply automatically
• Local changes sync back upstream

What this enables

With a single abstraction:

• remote data is materialized locally as tables
• queries span local and remote sources seamlessly
• changes sync in both directions automatically
• your app continues to work offline and on reconnects
• no separate sync engine, API layer, or replication pipeline

What typically takes a database, API layer, cache, and sync engine is reduced to one relational model — expressed entirely in SQL.

This is fully covered in:

• Federation, Materialization, and Sync ↗
• LinkedQL Integration Patterns ↗

---

Pattern Playground

A visual, interactive playground that lets you experiment with these integration patterns is coming soon.

But here are real samples you can play with now, right in the @webqit/playground repo:

Go to the playground ↗

---

Deep Dive

If you want to explore the full LinkedQL model, see:

The LinkedQL docs ↗

---

🤝 Contributing

LinkedQL is in active development — and contributions are welcome!

Here’s how you can jump in:

• Issues → Spot a bug or have a feature idea? Open an issue.
• Pull requests → PRs are welcome for fixes, docs, or new ideas.
• Discussions → Not sure where your idea fits? Start a discussion.

🛠️ Local Setup

⤷ clone → install → test

git clone https://github.com/linked-db/linked-ql.git
cd linked-ql
git checkout next
npm install
npm test

📝 Tips

• Development happens on the next branch — be sure to switch to it as above after cloning.
• Consider creating your feature branch from next before making changes (e.g. git checkout -b feature/my-idea).
• Remember to npm test before submitting a PR.
• Check the Progress section above to see where help is most needed.

---

🔑 License

MIT — see LICENSE