Dongoose is a simple ( but intelligent ), lightweight, and easy to use ORM for Deno KV. It is written in Typescript and is inspired by Mongoose.
- 📄 Schema - Dongoose leverages Zod for easy data structuring and validation through a simple schema API.
- 🔍 Indexes - Dongoose enables automatic data insertion, update, and deletion through defined indexes.
- ✔️ Validation - Dongoose validates data before inserting or updating it using Zod.
- ⏰ Timestamps - Dongoose automatically adds timestamps to your data ( createdAt, updatedAt ).
- 📝 Typescript - Dongoose is written in Typescript and provides type definitions for all of its methods.
- 🍃 Lightweight - Dongoose is very lightweight and has no dependencies other than Zod.
- 👍 Easy to use - Dongoose is very easy to use and has a simple API.
- 💯 Coverage - Dongoose has 100% test coverage.
- 🔗 Relations - Dongoose will soon support relations between collections.
- 🪝 Hooks - Dongoose will soon support hooks for pre and post operations.
- 💰 Transactions - Dongoose will soon support transactions.
- ➕ More - Dongoose will soon support more features.
import { d, Dongoose } from "https://deno.land/x/dongoose/mod.ts";
const db = await Deno.openKv();
const users = Dongoose(
{
email: d.string().email(),
username: d.string(),
password: d.string().min(8).max(32),
firstname: d.string().optional(),
lastname: d.string().optional(),
},
{
db, // Your Deno KV intance
name: "users", // Your collection name
indexes: ["email", "username"],
}
);
await users.create({
email: "[email protected]",
username: "Emmet",
password: "Homenick",
});
const user = await users.findOne({ email: "[email protected]" });
const _sameUserWithId = await users.findById(user!.id);
await users.updateById(user.id, { firstname: "John" });
await users.deleteById(user.id);Dongoose uses Zod to validate data before inserting or updating it. It also uses Zod to create a schema for your data. Dongoose uses the schema to automatically add timestamps to your data and to automatically insert, update, and delete data through defined indexes.
Let's say you have a collection of users and you want to be able to find a user by their email or username. You can define indexes for your collection like this:
const users = Dongoose(
{
email: d.string().email(),
username: d.string(),
firstname: d.string().optional(),
lastname: d.string().optional(),
},
{
db,
name: "users", // Your collection name
indexes: ["email", "username"],
}
);Upon user creation, update or delete, your data will be automatically inserted, updated or delete into/from these indexes: ["users_by_id", USER_ID], ["users_by_email", USER_EMAIL], and ["users_by_username", USER_EMAIL].
Dongoose automatically adds timestamps to your data ( createdAt, updatedAt ) upon user creation or update.
Dongoose(schema, options);{
db: KVStore;
name: string;
indexes?: string[];
}await users.create({
email: "[email protected]",
username: "Emmet",
});await users.findOne({ email: "[email protected]" });await users.findById("076520f1-cbf1-4e29-8af5-d6db8c851371");await users.updateOne({ username: "Emmet" });await users.updateById("076520f1-cbf1-4e29-8af5-d6db8c851371", {
username: "garrett.guzman",
});await users.deleteOne({ username: "Emmet" });await users.deleteById("076520f1-cbf1-4e29-8af5-d6db8c851371");Dongoose is licensed under the MIT license. See LICENSE for more information.
