🚀 SaralDBORM

saraldborm is the official JavaScript ORM and client library for SaralDB,
a high-performance, open-source database system built in Rust.

It provides a simple, developer-friendly API with a familiar ORM-style experience for building modern applications.

⚠️ Disclaimer

⚠️ DISCLAIMER: This package is under active development.
APIs may change, and some features may be incomplete or unstable.
Not recommended for production use yet.
Contributions and feedback are welcome ❤️

✨ Features

• Simple and easy-to-use API for Node.js and modern JavaScript frameworks.
• Helps developers write less code and build applications faster.
• Designed with performance in mind for large datasets and fast queries.

📦 Installation

Node.js (npm)

npm install saraldborm

Yarn

yarn add saraldborm

Bun

bun add saraldborm

Deno

deno add jsr:saraldborm

⚠️ Deno support is planned. JSR publish coming soon.

🚀 Quick Start

const saral = require("saraldborm");

async function main() {
  await saral.connect("saral://localhost:7373");

  const User = saral.model(
    "users",
    new saral.Schema({
      name: String,
      age: Number
    })
  );

  await User.create({ name: "Aman", age: 25 });

  const users = await User.find({ age: 25 }).limit(5).exec();
  console.log(users);
}

main();

⚙️ Configuration

await saral.connect("saral://localhost:7373", {
  poolSize: 10,
  timeout: 5000
});

🏷️ Property Decorators (Planned)

• @Property() – Basic property
• @Property({ unique: true }) – Unique property
• @Property({ required: true }) – Required property
• @Property({ type: 'string' }) – Type specification

🛣️ Roadmap

• Update & delete operations
• Schema validation rules
• Indexing support
• Relationship handling
• CLI tooling
• TypeScript support
• Plugin system

❓ FAQ

Is SaralDBORM production ready?
No. It is currently under active development.

Does it support TypeScript?
TypeScript support is planned.

Is this similar to MongoDB/Mongoose?
Yes, the API is inspired by MongoDB-style ORMs.

🤝 Contributing

Contributions are welcome.
Please feel free to submit issues or pull requests.

🆘 Support

• Report issues on GitHub
• Suggest features via discussions
• Contributions are welcome ❤️

📄 License

MIT License