@code-pieces/db-json
v0.2.0
Published
Lib to manipulate json files using knex syntax
Downloads
34
Readme
DB json
Manipule your json files with a Knexjs like builder.
This piece of code is a lib to read and manipulate json files.
We try to follow the same syntax as Knexjs project, so you will have a very clean and nice way to query your data with chain methods and a promise builder.
Installation
npm i @code-pieces/db-json@latest
Simple Usage
import { Query } from "@code-pieces/db-json";
Query.from("./users.json").then((users) => {
console.log("all-users", users);
});
// or using async/await syntax
const users = await Query.from("./users.json");
console.log("all-users", users);
// output : [ { id: 1, name: "Jonathan" }, { id: 2, name: "Dio" }, ... ]
Update the query before it's resolved
import { Query } from "@code-pieces/db-json";
const query = Query.from("./users.json");
query.select("name").where("name", "Dio");
const users = await query;
// output : [ { name: "Dio" } ]
Where method
Filter the array of items by a property and value
const result = await Query.from("./users.json").where("name", "Jonathan");
// output : [ { id: 1, name: "Jonathan" } ]
Insert method
Create a new item
await Query.from("./users.json").insert({ id: 3, name: "Dio" });
Update method
Update the items in the database, can be combined with where()
await Query.from("./users.json")
.where("name", "Jonathan")
.update({ name: "Dio" });
Delete method
Delete the items in the database, can be combined with where()
await Query.from("./users.json").where("name", "Jonathan").delete();
Notes & Recommendations
- This is very useful to make config files that uses json format.
- This lib is not recommended to deal with a huge amount of data because the database is read and manipulated in runtime.