Getting Started Guide

import { DBType, type DBConfig } from "stabilize-orm";

const dbConfig: DBConfig = {
  type: DBType.SQLite,
  connectionString: "./data/app.db",
  retryAttempts: 3,
  retryDelay: 1000,
};

export default dbConfig;

import { Stabilize, type CacheConfig, type LoggerConfig, LogLevel } from "stabilize-orm";
import dbConfig from "../config/database";

const cacheConfig: CacheConfig = {
  enabled: false,
  ttl: 60,
};

const loggerConfig: LoggerConfig = {
  level: LogLevel.Info,
  filePath: "logs/stabilize.log",
  maxFileSize: 5 * 1024 * 1024,
  maxFiles: 3,
};

export const orm = new Stabilize(dbConfig, cacheConfig, loggerConfig);

import { defineModel, DataTypes } from "stabilize-orm";

export const User = defineModel({
  tableName: "users",
  timestamps: { createdAt: "createdAt", updatedAt: "updatedAt" },
  columns: {
    id: { type: DataTypes.STRING, required: true, unique: true },
    email: { type: DataTypes.STRING, length: 255, required: true, unique: true },
    name: { type: DataTypes.STRING, length: 100, required: true },
    isActive: { type: DataTypes.BOOLEAN, defaultValue: true },
  },
});

import { orm } from "../db";
import { User } from "../models/User";
import { generateUUID } from "stabilize-orm";

const userRepo = orm.getRepository(User);

// Create a user
const newUser = await userRepo.create({
  id: generateUUID(),
  email: "alice@example.com",
  name: "Alice Johnson",
});
console.log("Created:", newUser);

// Find all users
const allUsers = await userRepo.find().execute(orm.client);

// Find by conditions
const user = await userRepo.findOneBy({ email: "alice@example.com" });

// Update
await userRepo.update(user.id, { name: "Alice Smith" });

// Delete
await userRepo.delete(user.id);