Skip to content

A lightweight, simple Database like MongoDB which uses Discord as storage.

License

Notifications You must be signed in to change notification settings

open-devhub/chorddb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Built with Node.js Built with Axios npm

Chorddb is a simple, lightweight package which is a database like MongoDB which uses Discord as storage with encryption. It works with JSON data.

NEXT UPDATE: Docs for image upload.

Docs

1.1 Installation

Install with npm

npm install chorddb

1.2 Importing ChordDB

Working with ChordDB

Start by importing ChordDB

const { UDB } = require("chorddb");

1.3 Initialize

Define Values for ChordDB

const db = new UDB("TOKEN", "ENCRYPTION_KEY", "CHANNEL_ID");

IMPORTANT: Be sure to call your DB and start it by:

db.start();

1.4 Functions

  • write(data): To write data to the channel. Returns true / false.
  • read(): To read all the data in the channel. Returns data / false.
  • find(identifier): Takes a list, [KEY, VALUE]. Returns data / false.
  • edit(identifier, modification): Takes a list, [KEY, VALUE] to find, Another list to change value [KEY, VALUE]. Returns true / false.

1.5 Example usage

const { UDB } = require("chorddb");

const db = new UDB("YOUR_DISCORD_TOKEN", "ENCRYPTION_KEY", "CHANNEL_ID");

(async () => {
  await db.start();

  const writeSuccess = await db.write({
    key: "user123",
    name: "Someone",
    coins: 100,
  });
  console.log("Write successful?", writeSuccess);

  const user = await db.find({ key: "key", value: "user123" });
  console.log("Found user:", user);

  const editSuccess = await db.edit(["key", "user123"], ["coins", 150]);
  console.log("Edit successful?", editSuccess);

  const allData = await db.read();
  console.log("All data in DB:", allData);
})();

Contributing & Bugs

For bugs & Contributing make a Pull Request and ill try to respond as fast as possible.

Licence

MIT Licence

About

A lightweight, simple Database like MongoDB which uses Discord as storage.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •