Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/studiowebux/petitedb
In-memory with persistance local JSON database
https://github.com/studiowebux/petitedb
database deno in-memory json local nosql on-disk typescript
Last synced: 20 days ago
JSON representation
In-memory with persistance local JSON database
- Host: GitHub
- URL: https://github.com/studiowebux/petitedb
- Owner: studiowebux
- License: mit
- Created: 2024-11-15T03:49:32.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-01-12T16:53:03.000Z (24 days ago)
- Last Synced: 2025-01-12T17:35:36.070Z (24 days ago)
- Topics: database, deno, in-memory, json, local, nosql, on-disk, typescript
- Language: TypeScript
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Petite DB
[](https://jsr.io/@studiowebux/petitedb)
The minimalistic NoSQL in-memory/on-disk database
---
## About
* Manage data in memory
* Store and load data securely to/from a JSON file
* Core operations:
+ Create, update, upsert, delete records
+ Read, Read all and find specific records
+ Snapshot and Clear data
+ Retrieve the raw data using GetData
+ Option to automatically add a `_id` per record
+ Option to manually save the data to disk
+ Retrieve configurable amount of random records
+ Option to watch local DB File and reload content automatically when its content is modified
* Ideal for test and offline applications
---
## Installation and Usage
1. Install deno: https://deno.com
2. `deno add @studiowebux/petitedb`
**Example:**
```ts
import { PetiteDB } from "@studiowebux/petitedb";
const db = new PetiteDB("database.json");
// Collection name: Category
// Record id: shoes
db.create("category", "shoes", { name: "Shoe" });
db.upsert("category", "shoes", { name: "shoes" });
db.update("category", "shoes", { name: "Shoes" });
db.read("category", "shoes");
db.find("category", { name: "Shoes" });
db.delete("category", "shoes");
```
```ts
const db1 = new PetiteDB("autoid.json");
db1.upsert("movies", "movie1", { title: "test 1" });
db1.upsert("movies", "movie2", { title: "test 2" });
db1.upsert("movies", "movie3", { title: "test 3" });
console.log(db1.readAll("movies"));
```
### Releases and Github Actions
```bash
git tag -a X.Y.Z -m "Version X.Y.Z"
git push origin tags/X.Y.Z
```
---
## Contributing
1. Fork the project
2. Create a Feature Branch
3. Commit your changes
4. Push your changes
5. Create a PR
Working with your local branch
**Branch Checkout:**
```bash
git checkout -b /prefix-name
```
> Your branch name must starts with [feature|fix|release|chore|hotfix] and use a / before the name;
> Use hyphens as separator;
> The prefix correspond to your Kanban tool id (e.g. abc-123)
**Keep your branch synced:**
```bash
git fetch origin
git rebase origin/master
```
**Commit your changes:**
```bash
git add .
git commit -m ": commit message"
```
> Follow this convention commitlint for your commit message structure
**Push your changes:**
```bash
git push origin /prefix-name
```
**Examples:**
```bash
git checkout -b release/v1.15.5
git checkout -b feature/abc-123-something-awesome
git checkout -b hotfix/abc-432-something-bad-to-fix
```
```bash
git commit -m "docs: added awesome documentation"
git commit -m "feat: added new feature"
git commit -m "test: added tests"
```
## License
Distributed under the MIT License. See LICENSE for more information.
## Contact
- Tommy Gingras @ [email protected] | Studio Webux
Webux Lab