@crbroughton/sibyl

Sibyl

Sibyl is a lightweight SQLite query builder for SQL.js, providing a Prisma-like query builder. Sibyl is in early development, so expect breaking changes and rapid development.

Getting Started

Installation

Sibyl depends on sql.js, which provides the lower-level API to interact with your embedded SQLite database. You'll also need to install the .wasm file that sql.js provides; Please see their documentation at https://sql.js.org.

With the .wasm file now available, you can install Sibyl with the following command:

bun install sql.js @types/sql.js @crbroughton/sibyl

You can download Sibyl at https://www.npmjs.com/package/@crbroughton/sibyl via NPM.

To start off with Sibyl, you'll first have to ensure Sibyl is able to be run inside of a top-level async/await file, alongside your sql.js database connection. As referenced from the sql.js documentation, you can provide Sibyl a database instance like so:

interface tableRowType {
  id: number
  name: string
  sex: string
  job: string
}

interface secondRowType {
  id: number
}

interface Tables {
  firstTable: tableRowType
  secondTable: secondRowType
}

const SQL = await sql({
  locateFile: () => {
    return '/sql-wasm.wasm'
  }
})
const db = new SQL.Database()

const { createTable, Insert, Select, All, Create } = await Sibyl<Tables>(db)

With top-level async/await enabled, you can then use Sibyl. Sibyl provides the following functions:

• createTable - Allows you to create a table
• Create - Creates and returns a new entry into your selected table
• Insert - Allows you to provide an array of insertable entries into your selected table
• Select - Returns a type-safe array of entries from the selected table
• All - Returns all entries from the selected table
• Delete - Deletes an entry from a selected table

Creating the table

To create a new table, use the createTable command:

createTable('firstTable', { // inferred table name and entry
  id: 'int', // only allows for known data types ('int', 'char', 'blob')
  job: 'char',
  name: 'char',
  sex: 'char'
})

createTable takes two arguments, the first is the name of the table you wish to select, This is based off the generic interface you first supplied to Sibyl. The second argument will create the specified columns for your database. Sibyl will handle the order and creation of each column you have specified, and only allow known data types.

Inserting a single entry into the DB

To create a new entry, you can use the Create function:

const result = Create('firstTable', { // returns the resulting entry
    id: faker.number.int(),
    name: 'Craig',
    sex: 'male',
    job: 'Software Engineer',
})

Inserting mutiple entries into the DB

To insert new entries into the database, you can use the Insert function:

let insertions: tableRowType[] = []
for (let index = 0; index < 1000; index++) {
  insertions.push({
    id: faker.number.int(),
    name: faker.person.firstName(),
    sex: faker.person.sex(),
    job: faker.person.jobTitle(),
  })
}
// execute the provided instruction - Data will now be in the DB
const test = Insert('firstTable', insertions)

Selecting entries from the DB

When selecting entries from the database, you can utilise the Select function to retrieve an array of type-safe entries, based from the generic interface you have supplied to Sybil main function (see above tableRowType).

selection.value = Select('firstTable', {
   where: {
    id: 1,
    name: "Craig", // can combine multiple where clauses
   },
   limit: 20, // limit the response from Sibyl
   offset: 10, // offset the response, useful for pagination
})

Development

To install dependencies:

bun install

You can then try Sibyl in the playground, first install the dependencies:

cd playground && bun install

and then run the playground:

bun run dev

This project was created using bun init in bun v1.0.29. Bun is a fast all-in-one JavaScript runtime.