{"id":15562528,"url":"https://github.com/lorencerri/quick.db-docs","last_synced_at":"2025-04-16T03:48:02.293Z","repository":{"id":52827215,"uuid":"123404194","full_name":"lorencerri/quick.db-docs","owner":"lorencerri","description":"Quick.db Documentation","archived":false,"fork":false,"pushed_at":"2021-04-17T17:30:05.000Z","size":129,"stargazers_count":5,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-13T10:01:23.271Z","etag":null,"topics":["docs","documentation","quickdb"],"latest_commit_sha":null,"homepage":"https://quickdb.js.org","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lorencerri.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-01T08:19:12.000Z","updated_at":"2021-08-06T06:29:22.000Z","dependencies_parsed_at":"2022-08-23T08:41:01.452Z","dependency_job_id":null,"html_url":"https://github.com/lorencerri/quick.db-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lorencerri%2Fquick.db-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lorencerri%2Fquick.db-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lorencerri%2Fquick.db-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lorencerri%2Fquick.db-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lorencerri","download_url":"https://codeload.github.com/lorencerri/quick.db-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249192387,"owners_count":21227774,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","documentation","quickdb"],"created_at":"2024-10-02T16:15:23.541Z","updated_at":"2025-04-16T03:48:02.268Z","avatar_url":"https://github.com/lorencerri.png","language":null,"readme":"# Introduction\n\n_This package is meant to provide an easy way to create and use a database, **all data is stored persistently**, and comes with additional easy to use features._\n\n**Installation**\n\n```ruby\nnpm install quick.db\n```\n\n**Require Package**\n\n```javascript\nvar db = require('quick.db')\n```\n\n## What is Quick.db?\n\n\u003e Quick.db is an easy-to-use database manager built with better-sqlite3. It's simple by design and perfect for smaller projects where you don't want to set up a separate database server or individuals who may be getting started with programming.\n\n## Example\n\n\u003e _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 \u0026 the full object._\n\n```javascript\nconst db = require('quick.db');\n\n// Setting an object in the database:\ndb.set('userInfo', { difficulty: 'Easy' })\n// -\u003e { difficulty: 'Easy' }\n\n// Pushing an element to an array (that doesn't exist yet) in an object:\ndb.push('userInfo.items', 'Sword')\n// -\u003e { difficulty: 'Easy', items: ['Sword'] }\n\n// Adding to a number (that doesn't exist yet) in an object:\ndb.add('userInfo.balance', 500)\n// -\u003e { difficulty: 'Easy', items: ['Sword'], balance: 500 }\n\n// Repeating previous examples:\ndb.push('userInfo.items', 'Watch')\n// -\u003e { difficulty: 'Easy', items: ['Sword', 'Watch'], balance: 500 }\ndb.add('userInfo.balance', 500)\n// -\u003e { difficulty: 'Easy', items: ['Sword', 'Watch'], balance: 1000 }\n\n// Fetching individual properties\ndb.get('userInfo.balance') // -\u003e 1000\ndb.get('userInfo.items') // -\u003e ['Sword', 'Watch']\n\n// Showing dot notation setting\ndb.set('userInfo.difficulty', 'Hard')\n// -\u003e { difficulty: 'Hard', items: ['Sword', 'Watch'], balance: 1000 }\n\ndb.get('userInfo.difficulty') // -\u003e 'Hard'\n```\n\n## Our Sponsor\n\n**Need A VPS?** Get started with **Contabo**!   Up to 60 GB RAM - 10 Cores - Unlimited Traffic   **Starting at €3.99**  \n\n[**Click To Learn More \u0026 View Prices**](http://www.anrdoezrs.net/click-9103034-12740668)\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Florencerri%2Fquick.db-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Florencerri%2Fquick.db-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Florencerri%2Fquick.db-docs/lists"}