Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

quick.db

7.1.1 • Public • Published

Imgur

Discord Server

Website / Documentation Discord Support (17000+ Users) NPM Page
quickdb.js.org discord.gg/plexidev npmjs.com/package/quick.db

Quick.db is an open-sourced package meant to provide an easy way for beginners, and people of all levels to access & manage a database. All data is stored persistently, and comes with various extra features.


  • Persistent storage w/ no setup (Data doesn't disappear through restarts)
  • Beginner Friendly
  • Discord Support
  • Multiple tables support
  • and more!

Imgur

All data in quick.db is stored persistently in a database. Here is an example of setting an object in the database, then fetching parts & the full object.

const db = require('quick.db');
 
// Setting an object in the database:
db.set('userInfo', { difficulty: 'Easy' })
// -> { difficulty: 'Easy' }
 
// Pushing an element to an array (that doesn't exist yet) in an object:
db.push('userInfo.items', 'Sword')
// -> { difficulty: 'Easy', items: ['Sword'] }
 
// Adding to a number (that doesn't exist yet) in an object:
db.add('userInfo.balance', 500)
// -> { difficulty: 'Easy', items: ['Sword'], balance: 500 }
 
// Repeating previous examples:
db.push('userInfo.items', 'Watch')
// -> { difficulty: 'Easy', items: ['Sword', 'Watch'], balance: 500 }
db.add('userInfo.balance', 500)
// -> { difficulty: 'Easy', items: ['Sword', 'Watch'], balance: 1000 }
 
// Fetching individual properties
db.get('userInfo.balance') // -> 1000
db.get('userInfo.items') // ['Sword', 'Watch']

Imgur

If you're having troubles installing, please follow this troubleshooting guide.

Linux & Windows

  • npm i quick.db

Note: Windows users may need to do additional steps listed here.

Mac

  1. Install: XCode
  2. Run: npm i -g node-gyp in terminal
  3. Run: node-gyp --python /path/to/python2.7 (skip this step if you didn't install python 3.x)
  4. Run: npm i quick.db

Imgur

Quick.db is an easy to use database wrapper for better-sqlite3, it was designed to be simple to let new users who are just getting into development and don't want to worry about learning SQL just quite yet.


Over 16,000 open-source programs use Quick.db as a dependent! Source


Install

npm i quick.db

DownloadsWeekly Downloads

12,320

Version

7.1.1

License

MIT

Unpacked Size

30.9 kB

Total Files

16

Last publish

Collaborators

  • avatar
  • avatar