Abyjs.db NPM | npm.io

abyjs.db

About
Examples
API
- Database
Interfaces
Links

About

abyjs.db is a database that aims to be swift and optimal.

Examples

Setup

const abyjsDB = require("abyjs.db");
const db = new abyjsDB.Database({
  path: "database",
  tables: {{
    name: "test",
  }},
});

db.once("ready", () => {
  console.log("Database ready!");
});

db.connect();

Set

await db.set("test", "apple", "turtle.");
await db.set("test", "leref", "abyjs.db owner");

Get

const apple = await db.get("test", "apple");
const leref = await db.get("test", "leref");

Get All

const lerefAndApple = await db.all("test", {
  filter: ({ data }) => data.key.includes("w"),
});

Delete

await db.delete("test", "apple");
await db.delete("test", "leref");

API

#Database

Params	Description
options: DatabaseOptions	The database constructor to make a new database instance.

#set() | Params | Return | Description | | :--- | :---: | ---: | | table: string, key: string, value: any | Promise\ | Set method for the database. |
#get() | Params | Return | Description | | :--- | :---: | ---: | | table: string, key: string | Promise\<Data> | Get method for the database. |
#all() | Params | Return | Description | | :--- | :---: | ---: | | table: string, options: AllOptions | Promise\<AllData[]> | GetAll method for the database. |
#delete() | Params | Return | Description | | :--- | :---: | ---: | | table: string, key: string | Promise\ | Delete method for the database. |

Interfaces

Database Options

Property	Value	Default	Description
tables	Table[]		The reserved tables for the database.
path?	string	"database"	Path to main database folder.
maxFileData?	number	50000	The max data that a file can store.
debug?	boolean	false	Whether the database should send debug log events.
extension?	string	".sql"	The extension for each file in the database.
force?	boolean	false	Whether to force the database to save or delete data on the file.
cache?	number	3000	How many data can the database store in memory cache.
timestamp?	boolean	false	Whether the database should save timestamp for each data.
saveTime?	number	100	How long until the database can save the data into file (ms).
getTime?	number	1	How long until the database pull a data from file (ms).
allTime?	number	100	How long until the database pull some data from file (ms).
deleteTime?	number	100	How long until the database delete a data from file (ms).
cacheRouters?	boolean	true	Whether the database should cache data routers on startup.

Table

Property	Value	Description
name	string	Name for the table, this will also define the path to this table file.

Data

Property	Value	Description
key	string	The key of the data.
value	any	The value of the data.
ttl?	number	The ttl for the data.
createdAt?	number	The time which this data was created.
updatedAt?	number	The time which this data was last updated.