ManuelMaciel / skyDB

a JSON powered database (yes, another one)

Home Page:https://www.npmjs.com/package/skydb

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Welcome to SkyDB πŸ‘‹

Version Documentation Maintenance License: GPL--3.0 Twitter: m_maciel6

a JSON powered database (yes, another one) so far you can create templates (kind of like documents), create data, search, filter, update and remove

🏠 Homepage

DB-1

TODO

TODO.


Install

npm install

Usage

  • create model
  • parameters: model: model name
import skyDB from 'skydb/lib'
skyDB.connection('users');

create records

  • parameters: model: model name, options: {data to be saved, pass as an object}
import skyDB from 'skydb/lib'
skyDB.create('users', { 'fieldName': 'manuel', 'age': 18 })
  • get data by id
  • parameters: model: model name, id: record id
import skyDB from 'skydb/lib'
const getDataById = async () => {
   const value = await skyDB.getById('users','v2dw1efZ5a')
   console.log(value)
}

getDataById()
  • get all data
  • parameters: model: model name, options: {order: [DESC or ASC, the name of the model data key], where: {the name of the model data key: value you want to find}}
import skyDB from 'skydb/lib'
const getAllData = async () => {
 const value = await skyDB.getAll('users', {order: ['DESC', 'fieldName'], where: {'fieldName': 'manuel'}})
 console.log(value)
}
getAllData()
  • update records
  • parameters: model: model name, id: record id, options: {value you want to find want to find}
import skyDB from 'skydb/lib'
const updateData = async () => {
 const value = await skyDB.update('users', 'v2dw1efZ5a', {'fieldName': 'manuel'})
 console.log(value)
}

updateData()
  • remove records
  • parameters: model: model name, id: id of the record to be deleted
import skyDB from 'skydb/lib'
const removeData = async () => {
 const value = await skyDB.remove('users', 'v2dw1efZ5a')
 console.log(value)
}

removeData()

Run tests

npm run test

Author

πŸ‘€ ManuelMaciel

🀝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

All Contributors

Thanks goes to these wonderful people (emoji key):


Diego Prestes

πŸš‡ ⚠️ πŸ’»

This project follows the all-contributors specification. Contributions of any kind welcome!

Show your support

Give a ⭐️ if this project helped you!

πŸ“ License

Copyright Β© 2021 ManuelMaciel.
This project is GPL--3.0 licensed.


This README was generated with ❀️ by readme-md-generator

About

a JSON powered database (yes, another one)

https://www.npmjs.com/package/skydb

License:GNU General Public License v3.0


Languages

Language:JavaScript 100.0%