Skip to content

artegoser/TessraDB

Repository files navigation


Markdownify
TessraDB Tweet me

Local noSQL database for Node.js

npm Travis (.com) Coveralls

Subreddit subscribers

FeaturesHow To UseRoadmapContributingCreditsLicense

Documentation

Features

  • Low memory consumption and fast work due to streaming reading and writing.
  • Smart filter for extracting data from collections.
  • Atomic write, your data will not be corrupted.

How To Use

Installation

  • NPM

    npm i tessradb
  • YARN

    yarn add tessradb

Usage

  • Import

    let { TessraDB } = require("tessradb");
    //or
    import { TessraDB } from "tessradb";
  • First DataBase

    import { TessraDB } from "tessradb";
    let db = new TessraDB("first"); //create a db with name "first"
    run(db);
    
    async function run(db) {
      let firstCol = await db.getCollection("firstCollection");
      await firstCol.insertMany([
        { type: "man", age: 1, height: 56 },
        { type: "woman", age: 2, height: 76 },
      ]); //insert documents to collection
      console.log(await firstCol.findOne({ type: "man" }));
      //find one document with type "man"
      //output: { type: "man", age: 1, height: 56 }
    }

Roadmap

TODO list
You can also suggest new features in issues yourself.

Contributing

Our contributors

Your contributions are always welcome! Please look at the contribution guidelines first. 🎉

Credits

TessraDB uses:

License

License: MIT
FOSSA Status