https://github.com/artegoser/tessradb

TessraDB is local noSQL database
https://github.com/artegoser/tessradb

database db embedded-database json-database nosql nosql-database serverless tessradb typescript

Last synced: 2 months ago
JSON representation

TessraDB is local noSQL database

• Host: GitHub
• URL: https://github.com/artegoser/tessradb
• Owner: artegoser
• License: mit
• Created: 2022-01-01T17:09:29.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-04-03T16:11:06.000Z (about 4 years ago)
• Last Synced: 2024-11-23T03:38:32.872Z (over 1 year ago)
• Topics: database, db, embedded-database, json-database, nosql, nosql-database, serverless, tessradb, typescript
• Language: TypeScript
• Homepage: https://artegoser.github.io/TessraDB/
• Size: 505 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  


    

  


  TessraDB 

  

  




Local noSQL database for Node.js




  

    

  

  

    

  

  

    

  





  





  Features •

  How To Use •

  Roadmap •

  Contributing •

  Credits •

  License





  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

  ```bash

  npm i tessradb

  ```

- #### YARN

  ```bash

  yarn add tessradb

  ```

### Usage

- ### Import

  ```js

  let { TessraDB } = require("tessradb");

  //or

  import { TessraDB } from "tessradb";

  ```

- ### First DataBase

  ```js

  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](https://github.com/artegoser/TessraDB/blob/main/.github/todo.md)  

You can also suggest new features in [issues](https://github.com/artegoser/TessraDB/issues) yourself.

## Contributing

![Our contributors](https://badges.pufler.dev/contributors/artegoser/tessradb?size=50&padding=2&bots=false)

Your contributions are always welcome! Please look at the [contribution guidelines](https://github.com/artegoser/TessraDB/blob/main/.github/CONTRIBUTING.md) first. 🎉

## Credits

TessraDB uses:

- [JSONStream](https://www.npmjs.com/package/JSONStream) for stream reading and writing JSON

## License

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/artegoser/TessraDB/blob/main/LICENSE)  

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fartegoser%2FTessraDB.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fartegoser%2FTessraDB?ref=badge_large)