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: 2 months 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 (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-12T16:53:03.000Z (over 1 year ago)
- Last Synced: 2025-01-12T17:35:36.070Z (over 1 year 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
- Ideal for test, offline applications and Proof-of-Concept
- Manage data in memory
- Store and load data to/from a JSON file
- Uses Write-Ahead Logging (WAL) to increase performance
- Collection data is split into individual files.
- Configurable (see table below)ù
- Core operations:
- Create, update, upsert, delete records
- `insertOne` / `insertMany`
- `updateOne`
- `upsert`
- `deleteOne` / `deleteMany`
- Drop Collection
- `drop`
- Count
- `count`
- Retrieve configurable amount of random records (`sample()`)
- `sample`
- Snapshot and Clear data
- `getData`
- `clear`
- Support Typescript Types: _Data_ (`Schema`) and _Collections_ (`string`)
- Support Saving BigInt in JSON file
- Added `_meta` object for each record (not fully implemented)
- createdAt
- updatedAt
- Version (increase when update and upsert)
- Added simple indexing (by _id)
---
## Installation and Usage
1. Install deno: https://deno.com
2. `deno add @studiowebux/petitedb`
3. `import { PetiteDB } from "@studiowebux/petitedb@^2.1.2";`
> Version 2.2.0+ has breaking changes.
**Example:**
see `demo/` directory, there are many examples.
**Clean Shutdown**
```ts
const db = new PetiteDB(...);
await db.shutdown()
```
**Options**
| Parameter | Description | Default |
| -------------------- | ------------------------------------------------------------------------------------------- | ----------------- |
| autoCommit | If true, the database will be commited automatically when `maxWritesBeforeFlush` is reached | `true` |
| walLogPath | WAL File name | `db_name.wal.log` |
| maxWritesBeforeFlush | Number of entries to store in the WAL before saving on-disk | `100` |
| memoryOnly | Ephemeral DB only | `false` |
| verbose | Enables all log levels | `false` |
---
## 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 @ tommy@studiowebux.com | Studio Webux
Webux Lab