v2.0.3

• Updated db.static() to make it similar to quick.db (plexidev/quick.db#202)

v2.0.2

• added db.flat()

v2.0.1

• Rewrite iterator

v2.0.0

Hackable Quick.db v2.0.0
- TypeScript declarations
- Wal mode support

GitHub: https://github.com/DevSnowflake/quick.db
NPM: https://www.npmjs.com/package/@devsnowflake/quick.db

v1.0.1

• Support old versions

v1.0.0

Notes

• Stable release 🎉

---

Quick.DB

The hackable quick.db.

You can easily switch between this library and quick.db if you are using json.sqlite file as database.

Examples

Getting Started

const { Database } = require("@devsnowflake/quick.db");
const db = new Database(); // you can also specify custom path/name

// add some data
db.set("foo", "bar");
db.set("hello", "world");

// log all data. You can also use db.all()
for (const data of db) {
    console.log(data);
}

Basic Example

// Setting an object in the database:
console.log(db.set('userInfo', { difficulty: 'Easy' }))
// -> { difficulty: 'Easy' }

// Pushing an element to an array (that doesn't exist yet) in an object:
console.log(db.push('userInfo.items', 'Sword'))
// -> { difficulty: 'Easy', items: ['Sword'] }

// Adding to a number (that doesn't exist yet) in an object:
console.log(db.add('userInfo.balance', 500))
// -> { difficulty: 'Easy', items: ['Sword'], balance: 500 }

// Repeating previous examples:
console.log(db.push('userInfo.items', 'Watch'))
// -> { difficulty: 'Easy', items: ['Sword', 'Watch'], balance: 500 }
console.log(db.add('userInfo.balance', 500))
// -> { difficulty: 'Easy', items: ['Sword', 'Watch'], balance: 1000 }

// Fetching individual properties
console.log(db.get('userInfo.balance')) // -> 1000
console.log(db.get('userInfo.items')) // ['Sword', 'Watch']

Creating a table

const mytable = db.createTable("tableName");

db.set("foo", "bar");
mytable.set("foo", 123);

db.get("foo"); // bar
mytable.get("foo"); // 123

List all tables

const tables = db.tables();
console.log(tables);
// { count: 2, tables: [ 'JSON', 'tableName' ] }

Executing SQL query

const sqlite = db.database;

const statement = sqlite.prepare("SELECT * FROM JSON WHERE ID IS NOT NULL");

for (const item of statement.iterate()) {
    console.log(item);
}

Static usage

This db behaves like quick.db where you cannot specify custom path/default table while creating your database.

const db = require("@devsnowflake/quick.db").static();

db.set("foo", "bar");

console.log(db.get("foo"));

Quick.db API

• db.all()
• db.fetchAll()
• db.add()
• db.delete()
• db.fetch()
• db.get()
• db.set()
• db.subtract()
• db.has()
• db.type()
• db.push()

Non-quick.db API

Methods

• db.find()
• db.some()
• db.map()
• db.flatMap()
• db.forEach()
• db.every()
• db.findIndex()
• db.indexOf()
• db.reduce()
• db.reduceRight()
• db.sort()
• db.tables()
• db.createTable()
• db.drop()
• db.keyArray()
• db.valueArray()
• db.array()
• db.divide()
• db.multiply()
• db.modulus()
• db.startsWith()
• db.endsWith()
• db.pull()
• db.deleteAll()
• db.size()
• db.eval()
• db.prepareTable()
• db.export()
• db.use()
• db.allTableArray()

Properties

• db.database
• db.rowCount
• db.path
• db.name
• db.tableName
• db.length

Join our Discord Server

v1.0.0-dev

• Initial release