To use litdb with your favorite ORM, no driver is required. Just use the litdb package directly:

litdb is also available as a module, where it can be used directly in the browser:

<script type="module">
import { sqlite as $ } from "https://unpkg.com/litdb/dist/index.min.js"
const { sql, params } = $.from(Contact).select(c => $`${c.name}`).build()
</script>

To get the most out of litdb we recommend using text editors that supports TypeScript definitions (e.g. VS Code, JetBrains IDEs, neovim, etc.)

LitDB Drivers​

Lightweight drivers with native support for its typed SQL Builders and parameterized SQL Expressions are also available for the popular databases:

Bun SQLite​

Use with Bun's native SQLite3 driver (requires Bun):

See litdb Bun SQLite Docs

Node better-sqlite​

Use with better-sqlite3 (requires Node.js):

See litdb better-sqlite3 Docs

PostgreSQL​

Use with the postgres.js client:

See litdb postgres Docs

MySQL​

Use with the mysql2 client:

See litdb mysql2 Docs

Request a Driver​

If you'd like to see a driver for a specific client, please open or vote for a feature request on litdb's GitHub Discussions.

Driver Usage​

The litdb Drivers provide a unified interface for executing custom parameterized SQL, SQL Builders and SQL Fragments for their respective RDBMS. They're lightweight data adapters providing convenience APIs for executing SQL with named and positional parameters. They can be used without litdb SQL Builders, but offer the most value when used together.

The same APIs are available across all drivers, so you can easily switch between them. They include both sync APIs recommended for SQLite libraries that use SQLite's native blocking APIs, whilst async APIs should be used for all other remote databases, e.g. PostgreSQL and MySQL.

Example of using the Bun SQLite driver:

db.ts

import { connect } from "@litdb/bun-sqlite"

export const connection = connect("app.db") // WAL enabled by default
export const { $, sync:db, async, native } = connection

app.ts

import { $, db } from "./db"
import { Contact } from "./models"

db.dropTable(Contact)
db.createTable(Contact)
db.insertAll([
    new Contact({ name:"John Doe", email:"[email protected]" }),
    new Contact({ name:"Jane Doe", email:"[email protected]" }),
])

const janeEmail = '[email protected]'
const jane = db.one<Contact>($.from(Contact).where(c => $`${c.email} = ${janeEmail}`))!

// Insert examples
const { lastInsertRowid: bobId } = db.insert(new Contact({ name:"Bob", email:"[email protected]" }))
const { lastInsertRowid } = db.exec`INSERT INTO Contact(name,email) VALUES ('Jo','[email protected]')`
const name = 'Alice', email = '[email protected]'
db.exec`INSERT INTO Contact(name,email) VALUES (${name}, ${email})`

// Typed SQL fragment with named param example
const hasId = <Table extends { id:number }>(id:number|bigint) =>
    (x:Table) => $.sql($`${x.id} = $id`, { id })

const contacts = db.all($.from(Contact).into(Contact))                // => Contact[]
const bob = db.one($.from(Contact).where(hasId(bobId)).into(Contact)) // => Contact    
const contactsCount = db.value($.from(Contact).select`COUNT(*)`)      // => number
const emails = db.column($.from(Contact).select(c => $`${c.email}`))  // => string[]
const contactsArray = db.arrays($.from(Contact))                      // => any[][]
const bobArray = db.array($.from(Contact).where(hasId(bobId)))        // => any[]

// Update examples
jane.email = '[email protected]'
db.update(jane)                           // Update all properties
db.update(jane, { onlyProps:['email'] })  // Update only email
db.exec($.update(Contact).set({ email:jane.email }).where(hasId(jane.id))) // query builder

// Delete examples
db.delete(jane)
db.exec($.deleteFrom(Contact).where(hasId(jane.id))) // query builder

Same source is compatible with other sync drivers, e.g. can replace @litdb/bun-sqlite with @litdb/better-sqlite to use with better-sqlite. See also async usage docs for postgres and mysql2.