Sibyl is a lightweight SQLite query builder for SQL.js, Bun's sqlite3 driver, and libSQL, providing a Prisma-like query builder. Sibyl is in early development, so expect breaking changes and rapid development.
Dependant on your chosen SQLite driver, you'll want to follow one of the following installation methods:
If you choose to use Sibyl with sql.js, sql.js will provide 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.
The SQL.js implementation has been tested against SQL.js version 1.10.2.
With the .wasm file now available, you can install Sibyl with the following command:
bun install sql.js @types/sql.js @crbroughton/sibylIf you are using Sibyl with Bun, you should already have access to the driver, and can refer to the Bun documentation. The Bun implemenation of Sibyl can be installed with the following command:
bun install @crbroughton/sibyl_bunSibyl will then accept the native Bun SQLite Database, again, see the
Bun documentation.
The Bun implementation has been tested against Bun version 1.1.3.
The libSQL implemenation of Sibyl can be installed with the following command:
bun install @crbroughton/sibyl_libsql libsqlSibyl will then accept libSQL Database, then see the
libSQL Getting Started Guide.
The libSQL implementation has been tested against libSQL version 0.3.11.
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
hasReadTheReadme: boolean
}
interface secondRowType {
id: number
}
interface Tables {
firstTable: tableRowType
secondTable: secondRowType
}
const SQL = await sql({ // sql.js implementation
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 tableCreate- Creates and returns a new entry into your selected tableInsert- Allows you to provide an array of insertable entries into your selected tableSelect- Returns a type-safe array of entries from the selected tableLimitedSelect- Returns a type-safe, limited array of entries from the selected tableAll- Returns all entries from the selected tableUpdateUpdates and returns a single entry from the selected tableDelete- Deletes an entry from a selected table
To create a new table, use the createTable command:
createTable('firstTable', { // inferred table name and entry
id: {
autoincrement: true,
type: 'INTEGER', // only allows for known data types ('int', 'char', 'blob')
primary: true,
unique: true,
},
job: {
type: 'varchar',
size: 100, // specify the size of the varchar
nullable: true
},
name: {
type: 'char',
size: 4,
},
sex: {
type: 'char',
size: 3,
},
hasReadTheReadme: {
type: 'bool',
},
})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.
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',
hasReadTheReadme: true,
})To insert new entries into the database, you can use the Insert function:
let insertions: SibylResponse<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(),
hasReadTheReadme: true,
})
}
// execute the provided instruction - Data will now be in the DB
const test = Insert('firstTable', insertions)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 Sibyl 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
})When selecting entries from the database but you want to be selective about the responses values, you can utilise the LimitedSelect function
to retrieve an array of type-safe entries, based from the generic interface
you have supplied to Sibyl main function (see above tableRowType).
The core difference here is that the where clause now also controls
what values you get back.
selection.value = LimitedSelect('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
})When selecting entries from the database, the Select function, by
default, uses an AND statement to build you query. You can however,
include an optional OR array to select entries:
const response = Select('firstTable', { // Returns all entries where name is Craig OR Bob
where: {
OR: [
{
name: 'Craig'
},
{
name: 'Bob'
}
]
}
})You can also combine multiple OR statements as part of a single object, if the keys do no clash:
const response = Select('firstTable', { // Returns all entries where name is Craig OR Bob OR hasReadTheReadme is false
where: {
OR: [
{
name: 'Craig',
hasReadTheReadme: 0, // boolean values need to be selected
// based on their database values
// and will be returned as such
},
{
name: 'Bob'
}
]
}
})When using the optional OR array to build a query, you can still use
the optional offset and limit keys.
To update a single entry in the database, you can use the Update function:
const updatedEntry = Update('firstTable', { // infers the table and response type
where: { // Can combine multiple where clauses
id: 1,
name: 'Craig',
},
updates: {
name: 'Bob', // Can update multiple values at once
job: 'Engineer',
}
})Sibyl offers some basic sorting options, whenever you're returning entries from the database:
const actual = All('firstTable', {
sort: {
name: 'ASC', // This can be 'ASC' or 'DESC'
},
})Sibyl offers a custom type, called the 'primary' type. When using this type, Sibyl will automatically set the entry to a primary key, not nullable and unique. Sibyl will also ensure that the underlying type changes, so your editor gives feedback about no longer requiring you to manually set these keys. Currently the primary type is only available as an integer type.
Sibyl also offers a custom type the SibylResponse type; This type can be helpful
when wanting to convert data types to TypeScript types; At the moment the custom type
only support boolean conversions from boolean to 0 | 1. It's recommended to use
this type as a wrapper, if you're ever using boolean values.
When working with any front-end framework, you'll want to combine Sibyl with your frameworks reactivity engine. I've provided some examples in the playground, in this case using Vue, but in general you should follow the following rules:
- Sibyl is not responsive by default; You should aim for Sibyls responses to end up in a reactive object (see ref for Vue).
- When working with your reactive state, it's good practice to ensure that the states type is the same of that of the response type from Sibyl
- Sibyl provides the
SibylResponsetype; You can use this type as a 'wrapper' type like so:
const results = ref<SibylResponse<Order>[]>([])This ensures that when you work with the results array, it conforms
to the shape and type Sibyl will return.
To install dependencies:
bun installYou can then try Sibyl in the playground, first install the dependencies:
cd playground && bun installand then run the playground:
bun run devThis project was created using bun init in bun v1.0.29. Bun is a fast all-in-one JavaScript runtime.