# v_database

> v_database is a small/basic database solution that utilizes filesystem to manipulate database

Latest version **0.1.8** (published 2022-01-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install v_database
pnpm add v_database
yarn add v_database
bun add v_database
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2022-01-10 |
| First published | 2021-12-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 73.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | V-core9 |
| Maintainers | v-core9 |
| Keywords | database, filesystem, v_database, v_file_system, v_scrolls, v_to_sha256, v-core9, db, JSON |

## Links

- npm: https://www.npmjs.com/package/v_database
- Repository: https://github.com/V-core9/v_database
- Issues: https://github.com/V-core9/v_database/issues
- npm.io page: https://npm.io/package/v_database

## Dependencies (3)

- [uuid](https://npm.io/package/uuid.md) ^8.3.2
- [v_to_sha256](https://npm.io/package/v_to_sha256.md) ^1.0.7
- [v_file_system](https://npm.io/package/v_file_system.md) ^1.0.3

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.1.8 (latest) — 2022-01-10
- 0.1.7 — 2021-12-31
- 0.1.6 — 2021-12-20
- 0.1.5 — 2021-12-20
- 0.1.4 — 2021-12-19
- 0.1.3 — 2021-12-19
- 0.1.2 — 2021-12-19
- 0.1.1 — 2021-12-19
- 0.0.37 — 2021-12-19
- 0.0.36 — 2021-12-19
- 0.0.35 — 2021-12-19
- 0.0.34 — 2021-12-19
- 0.0.33 — 2021-12-19
- 0.0.32 — 2021-12-19
- 0.0.31 — 2021-12-19
- … 29 more at https://npm.io/package/v_database/versions

## README

# **🧾 V_Database - README.md**    
 

 **Description**: _Simple way to make data available in your website/application for a single database._  
  
>---  
>### 🚧 **WARNING: APPLICATION STILL IN 🧱 [ALPHA] **  🚧  
>---   
## **🚕 Install and Setting up**    

Currently only through the github repo can be installed...
    Run these commands in sequence to install:

          // Install the dependency
          npm i v_database --save
          // Start node
          node
          // Load it into the console
          const v_db = require('.');
          // Trigger the install
          await v_db.install();

    Soon... 🚀    

---
## **⚡ How to actually use it ?**    

here is an example code that is being used to export this example readme file in the fist place.


          const v_database = require('v_database');

          v_database.type.new('books'); // returns true if it created new type or false if it already exists or fails
          v_database.type.new('links');

          v_database.item.new('books', {name: 'book title text' , description : 'demo' });
          v_database.item.new('links', {name: 'v-core9' , path : 'https://v-core9.com/' });

          v_database.item.new('books', { id: 'sample_id', name: 'book title text' , description : 'demo' }); //Adding ID will try to use it as an ID

          v_database.install() // trigger installation process
          v_database.data_size() // returns the size of the data
          v_database.purge_data() // removes all data from the database
        

---
## **📁 Project Folders Structure Info**    

Look into system folder for more info about project structure.

    These are some important folders that are used when generating this document:
      📁 __tests__ /
      📁 __tests__ / v_database /
      📁 __tests__ / v_lidator /

      📁 _tDdata_ /
      📁 _tDdata_ / _test-data /

      📁 $_HELP_$ /
      📁 $_HELP_$ / readme /

      📁 v_database /
      📁 v_database / config /
      📁 v_database / config / version /
      📁 v_database / helpers /
      📁 v_database / info /
      📁 v_database / item /
      📁 v_database / modules /
      📁 v_database / type /

      📁 v_lidator /
      📁 v_lidator / src /
      📁 v_lidator / src / helpers /
      📁 v_lidator / src / templates /
      📁 v_lidator / src / user /         

---
## **✅ Tests and Coverage with Jest**    

![Test and Coverage with Jest](coverage.png)    

---
>### 🔻 **WARRNING: GENERATED FILE NOTICE**  🔻 
> ⛔ Any Edits Done To Generated Files Will Be Overwritten Next Time These Files Get Re-Generated!  
>  
> _Made 💖 using [v_scrolls]("https://github.com/V-core9/v_scrolls")_      
> Last Updated:  2021/12/19 13:40:26

---
_Source: https://npm.io/package/v_database · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._