Fast, Scalable, Extremely-Small, Open-Source, NodeJS Database for all use-cases.
- Basket -> Bag -> Task System
- Baskets (Databases) can be "splintered" into multiple Bags (nodes) to handle tasks
- This allows for easy scaling
- Tasks are smartly assigned to Bags (Nodes) to handle a task (ie: search, add, remove, modify, etc...)
- Baskets (Databases) can be "splintered" into multiple Bags (nodes) to handle tasks
- Performant & Efficient
- The Basket -> Bag -> Task System allows for tasks to be run efficiently and fast
- The Trashman marks a later removal time to free up tasks with removal calls
- Also marks an item in the Basket to be deleted so that it cannot be used while waiting to be removed
- Fast Serialization & Deserialization
- Uses Chrome V8 for Serialization & Deserialization of data
- Auto Read & Write
- Read and Write calls are automatically ran only when needed for a task
- Safe
- BasketDB includes an easy way to Backup and Restore a database
- Saves a copy of the database that is one task behind (Basket.InternalBag.oldRepel)
- This old copy is dumped when a Dump occurs
- Dumps Logger Trace and Copy of Database before error occurred for easy restore and debugging
- Easy to Debug Errors
- Includes a strong Logger for saving and showing debug, warn, and error messages
- Logger also includes a trace to see everything that happened before a Dump or anything
- Easy Statistics
- Get CPU, Memory, Disk, and other statistics that BasketDB is using
- Powerful CLI Tool
- Includes a powerful CLI Tool for managing & viewing Baskets (databases)
- Opens all Basket methods to the CLI
- Flexible & Schemas
- With the use of typescript, a database will always have a structure
- Small
- BasketDB comes in at a very small package size
- Written in TypeScript
- Builtin typedefs
- Less common for bugs
- Node Version >= 16.0.0
- Multi-platform (Windows, Linux, MacOS)
- Linux machines outperform Windows machines
- CD into your project that you would like to install BasketDB into.
- Run
npm install basketdbor if using yarn, runyarn add basketdb. - Import BasketDB using ES6 Import:
import BasketDB from 'basketdb'or use require:const { default: BasketDB } = require('basketdb') - Read Getting Started or the Docs
- Download the latest release
- Unzip the package into a directory in your project
- Import BasketDB using ES6 Import:
import BasketDB from 'path/to/BasketDB'or use require:const { default: BasketDB } = require('path/to/BasketDB') - Read Getting Started or the Docs
- Copy the CDN Link https://cdn.jsdelivr.net/npm/basketdb@1.0.0/dist/index.js
- Import BasketDB using ES6 Import:
import BasketDB from 'cdn/link/here'or use require:const { default: BasketDB } = require('cdn/link/here') - Read Getting Started or the Docs
- CD into your project that you would like to initialize a BasketDB CLI Project.
- Run
npm install -g basketdbor if using yarn, runyarn add -g basketdb- Note: root permission may be required if on a linux platform
- Now that basketdb is install globally along with the CLI tool, run
basketdbto create a new BasketDB CLI Project - While in the BasketDB CLI Tool, run
helpfor the list of commands
Bleart Emini (ksplatdev)