surrealize
v0.1.0
Published
Surrealize is a **ODM** and **Query Builder** for [**SurrealDB**](https://surrealdb.com/) written in **TypeScript**. It provides you with a Query Builder, a Repository API, an agnostic schema validation and many more features.
Maintainers
Readme
Surrealize
Surrealize is a ODM and Query Builder for SurrealDB written in TypeScript. It provides you with a Query Builder, a Repository API, an agnostic schema validation and many more features.
[!WARNING] This project is still in early development and is not ready for production use.
Features
- 📦 Object Document Mapper (ODM)
- 🛠️ Query Builder
- 🛡️ Type Safety
- 📜 Agnostic schema validation (using Standard Schema)
- ⚙️ TypeScript support
Installation
# Using npm
npm install surrealize# Using yarn
yarn add surrealize# Using pnpm
pnpm add surrealize# Using bun
bun add surrealizeDocumentation
Documentation is currently missing, but will be added soon. Feel free to contribute! (surrealize/docs)
Frequently Asked Questions
Why ODM and not ORM?
- ODM stands for Object Document Mapping.
- ORM stands for Object Relational Mapping.
SurrealDB at it's core is a document database (see Concepts), so ODM makes more sense than ORM.
