8000 GitHub - art-emini/BasketDB: BasketDB - Fast, Scalable, Extremely-Small, Open-Source, NodeJS Database for all use-cases. · GitHub
[go: up one dir, main page]

Skip to content
art-eminiPublic

About

BasketDB - Fast, Scalable, Extremely-Small, Open-Source, NodeJS Database for all use-cases.

Resources

Code of conduct

Security policy

Stars

2 stars

Watchers

1 watching

Forks

Repository files navigation

BasketDB

Fast, Scalable, Extremely-Small, Open-Source, NodeJS Database for all use-cases.

Features

  • 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...)
  • 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

Support

  • Node Version >= 16.0.0
  • Multi-platform (Windows, Linux, MacOS)

Performance

  • Linux machines outperform Windows machines

Download

NPM / YARN

  1. CD into your project that you would like to install BasketDB into.
  2. Run npm install basketdb or if using yarn, run yarn add basketdb.
  3. Import BasketDB using ES6 Import: import BasketDB from 'basketdb' or use require: const { default: BasketDB } = require('basketdb')
  4. Read Getting Started or the Docs

Github

  1. Download the latest release
  2. Unzip the package into a directory in your project
  3. Import BasketDB using ES6 Import: import BasketDB from 'path/to/BasketDB' or use require: const { default: BasketDB } = require('path/to/BasketDB')
  4. Read Getting Started or the Docs

CDN

  1. Copy the CDN Link https://cdn.jsdelivr.net/npm/basketdb@1.0.0/dist/index.js
  2. Import BasketDB using ES6 Import: import BasketDB from 'cdn/link/here' or use require: const { default: BasketDB } = require('cdn/link/here')
  3. Read Getting Started or the Docs

Download CLI Tool

  1. CD into your project that you would like to initialize a BasketDB CLI Project.
  2. Run npm install -g basketdb or if using yarn, run yarn add -g basketdb
    1. Note: root permission may be required if on a linux platform
  3. Now that basketdb is install globally along with the CLI tool, run basketdb to create a new BasketDB CLI Project
  4. While in the BasketDB CLI Tool, run help for the list of commands

License

MIT LICENSE

Author

Bleart Emini (ksplatdev)

About

BasketDB - Fast, Scalable, Extremely-Small, Open-Source, NodeJS Database for all use-cases.

Resources

Code of conduct

Security policy

Stars

2 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages

0