Database connection with Waddler

Waddler runs SQL queries on your database via database drivers.

index.ts

import { waddler } from "waddler/clickhouse"

const sql = waddler(process.env.DATABASE_URL);
const usersCount = await sql`select count(*) from ${sql.identifier('users')};`;

          ┌─────────────────────────────────────────────────────────┐
          │  sql`select count(*) from ${sql.identifier('users')};`  │ <--- waddler query
          └─────────────────────────────────────────────────────────┘     
                               │               ʌ
select count(*) from "users"; -│               │
                               │               │- [{ count: 0 }]
                               v               │
                            ┌─────────────────────┐
                            │     clickhouse      │ <--- database driver
                            └─────────────────────┘
                               │               ʌ
01101000 01100101 01111001    -│               │
                               │               │- 01110011 01110101 01110000
                               v               │
                            ┌────────────────────┐
                            │      Database      │ 
                            └────────────────────┘

Under the hood Waddler will create a clickhouse driver instance

// above is equivalent to
import { waddler } from "waddler/clickhouse";
import { createClient } from '@clickhouse/client';

const client = createClient({
  // url should have the following format: http[s]://<host>:<port>
  url: '...',
});

const sql = waddler({ client });

Waddler is by design natively compatible with every edge or serverless runtime, whenever you’d need access to a serverless database - we’ve got you covered

Neon HTTP

Neon with websockets

Vercel Postgres

PlanetScale HTTP

Cloudflare d1

import { waddler } from "waddler/neon-http";

const sql = waddler(process.env.DATABASE_URL);

import { waddler } from "waddler/neon-serverless";

const sql = waddler(process.env.DATABASE_URL);

import { waddler } from "waddler/vercel-postgres";

const sql = waddler();

import { waddler } from "waddler/planetscale";

const sql = waddler(process.env.DATABASE_URL);

import { waddler } from "waddler/d1";

const sql = waddler({ connection: env.DB });

And yes, we do support runtime specific drivers like Bun SQLite or Expo SQLite:

import { waddler } from "waddler/bun-sqlite"

const sql = waddler(); // <--- will create an in-memory db
const sql = waddler("./sqlite.db");

import { waddler } from "waddler/expo-sqlite";
import { openDatabaseSync } from "expo-sqlite";

const expo = openDatabaseSync("db.db");
const sql = waddler({ client: expo });

Database connection URL

Just in case if you’re not familiar with database connection URL concept

https://alex:[email protected]:8443/dbname
        └──┘ └───────┘ └─────────────────────────┘  └──┘  └──┘
          ʌ    ʌ          ʌ                           ʌ     ʌ
    role -│    │          │- hostname                 │     │ - database
               │                                      │ - port
               │- password

Next steps

Feel free to check out per-driver documentations

PostgreSQL drivers

PostgreSQL Neon Vercel Postgres Supabase Xata PGLite

Gel drivers

Gel

MySQL drivers

MySQL PlanetsScale TiDB

SQLite drivers

SQLite Turso Cloudflare D1 Bun SQLite

Native SQLite

Expo SQLite OP SQLite

ClickHouse

ClickHouse