gideaoms/clark-orm

Modern ORM for Typescript. Supports PostgreSQL, MySQL, MSSQL, Redshift, SQLite and many more

ClarkORM

If you like this project, please give us a star on Github.

ClarkORM is a Typescript ORM built on top of Lucid ORM (AdonisJS).

Why

AdonisJS is a great framework and it has one of the best ORM. But it works only in its ecosystem. Using ClarkORM you can have all the benefits of Lucid, but in any Node.js project you want.

How it works

ClarkORM is built on top of Lucid ORM and Lucid ORM is built on top of knex. The idea of ClarkORM is let you manage your migrations and seeds with knex the way you already do. But when it comes to Models ClarkORM comes on scene.

Installation

npm install clark-orm @adonisjs/lucid luxon

Usage

Here you can configure your connection like Adonis Lucid

// database.ts
import { defineConfig } from "clark-orm";

export const { BaseModel, Event, Database } = defineConfig({
  connection: "sqlite",
  connections: {
    sqlite: {
      client: "sqlite",
      debug: false,
      useNullAsDefault: true,
      connection: {
        filename: "./db.sqlite",
      },
    },
  },
})

// models/city.ts
import { DateTime } from "luxon";
import { column } from "@adonisjs/lucid/orm";
import { BaseModel } from "../database";

export class CityModel extends BaseModel {
  public static table = "cities";

  @column({ isPrimary: true })
  public id: number;

  @column()
  public name: string;

  @column.dateTime({ autoCreate: true })
  public createdAt: DateTime;

  @column.dateTime({ autoCreate: true, autoUpdate: true })
  public updatedAt: DateTime;
}

You can learn more about the models here.

Extra

To use ClarkORM you need to know at least a little about knex and Lucid

Do you like to learn with examples? We have one here

Remember to add it to your tsconfig.json

"emitDecoratorMetadata": true,
"experimentalDecorators": true,
"strictPropertyInitialization": false

clark-orm's Issues

Bot for autoupdate

A good idea is to configure a bot to automatically open PR's as soon as there is an update from lucid, as soon as I have time I will try to develop this idea.

Congratulations on the project haha, I was in a huge effort doing everything manually here as knex and I found this mention of the project: adonisjs/lucid#695 (comment)

Incomplete connection Config

Hi! 👋

Firstly, thanks for your work on this project! 🙂

Today I used patch-package to patch [email protected] for the project I'm working on.

Here is the diff that solved my problem:

diff --git a/node_modules/clark-orm/web-app.js b/node_modules/clark-orm/web-app.js
index 228753d..cd8d027 100644
--- a/node_modules/clark-orm/web-app.js
+++ b/node_modules/clark-orm/web-app.js
@@ -29,6 +29,7 @@ webApp.container.singleton('Adonis/Core/Config', () => {
                 user: knexfile.connection.user,
                 password: knexfile.connection.password,
                 database: knexfile.connection.database,
+                ssl: knexfile.connection.ssl,
             },
         };
     return new config_1.Config({

This issue body was partially generated by patch-package.