Raw-node-orm NPM

⚙️ Raw ORM

Raw ORM is a modern, type-safe ORM for Node.js, inspired by Prisma architecture. Types for database models are automatically generated after every migration and are supported in any query to the database. Currently, only PostgreSQL is implemented as option for database management system.

✨ Features

⚡ Queries - Intuitive API for database queries.
🔄 Migrations - Simple CLI-based schema migration management.
🌱 Type-Safe Queries - Auto-generated types for your database models.
🔭 Flexibility - Designed to support any future SQL-based database.

📦 Installation

Install Raw ORM via npm or yarn:

npm install raw-node-orm
# or
yarn add raw-node-orm

🚀 Usage

1. Intialize Raw ORM

Type this command to generate the initialization file:

npx raw init

Provide configuration for database connection inside the generated file:

// src/lib/raw.ts

const raw = new Raw({
  DBMS: "PostgreSQL",
  connection: {
    database: "my_database",
    user: "my_user",
    password: "my_password",
    host: "localhost",
    port: 5432,
  },
});

2. Define the database schema

Type this command to generate the schema definition file:

npx raw migrate start
# or
npx raw migrate start -f path/to/raw.ts

Alter the schema to a desired one:

// raw/generated/schema-definition.ts

migrator.defineSchema({
  User: {
    id: {
      type: "INT",
      primaryKey: true,
    },
    name: "VARCHAR",
    email: {
      type: "VARCHAR",
      unique: true,
    },
  },
  Post: {
    id: "INT",
    title: "VARCHAR",
    authorId: {
      type: "INT",
      foreignKeyOptions: {
        fieldReference: "id",
        tableReference: "User",
      },
    },
  },
});

3. Apply the migration

Type this command:

npx raw migrate up

This will update the database schema and generate the following files:

SQL file

DROP TABLE IF EXISTS "User", "Post" CASCADE;

CREATE TABLE "User"("id" INT NOT NULL, "name" VARCHAR NOT NULL, "email" VARCHAR NOT NULL, CONSTRAINT "User_PK" PRIMARY KEY ("id"));

CREATE TABLE "Post"("id" INT NOT NULL, "title" VARCHAR NOT NULL, "authorId" INT NOT NULL);

ALTER TABLE "Post" ADD CONSTRAINT "Post_authorId_FK" FOREIGN KEY ("authorId") REFERENCES "User"("id");

CREATE UNIQUE INDEX "User_email_key" ON "User"("email");

Types file

export type UserData = {
  id: number;
  name: string;
  email: string;
};

export type PostData = {
  id: number;
  title: string;
  authorId: number;
};

export type PostRelations = {
  User?: UserData;
};

Mappers file

export const RELATIONS_MAPPER = [
  {
    tableName: "Post",
    fieldName: "authorId",
    fieldReference: "id",
    tableReference: "User",
  },
];

4. Write queries to the database

You can use the generated types to help you while writing queries:

async function query() {
  await client.table<UserData>("User").create({
    data: {
      id: 1,
      name: "example",
      email: "example1@gmail.com",
    },
  });

  const users = await client.table<UserData>("User").find();

  await client.table<PostData>("Post").create({
    data: {
      id: 2,
      title: "Example title",
      authorId: 1,
    },
  });

  const posts = await client
    .table<PostData, PostRelations>("Post", RELATIONS_MAPPER)
    .find({
      select: {
        title: true,
        id: true,
      },
      include: {
        User: {
          id: true,
          email: true,
        },
      },
    });

  console.log("Posts: ", posts, "\n\nUsers: ", users);

  await client.disconnect();
}

query();

Output:

Posts: [
  {
    title: "Example title",
    id: 2,
    User: {
      id: 1,
      email: "example1@gmail.com",
    },
  },
];

Users: [
  {
    id: 1,
    name: "example",
    email: "example1@gmail.com",
  },
];

📚 API Reference

Client

Client.table<TableType, RelationsType>(tableName, relations?) returns a Table.
- Table.find(findConfig?) returns rows from the database.
- Table.create(createConfig) create rows in the database.
- Table.update(updateConfig) update rows in the database.
- Table.delete(deleteConfig) delete rows in the database.
- Table.count(countConfig?) return amount of rows in the database.
Client.disconnect() ends pool connection.