Kadak

Quick Start

Install, define schema, sync manifest, connect, then query and insert.

Quick Start

1) Install

pnpm add @shyk/kadak-orm
pnpm add -D @shyk/kadak-cli

2) Define schema

import { table } from '@shyk/kadak-orm'

export const users = table('users', {
  id: 'id',
  email: 'email',
  name: 'text',
  isActive: 'boolean',
})

3) Generate manifest

pnpm kadak sync
pnpm kadak doctor

4) Connect

import './kadak.manifest'
import { connect } from '@shyk/kadak-orm'

export const db = connect(process.env.DATABASE_URL!)

5) Query safely

await db.users.findMany({ isActive: true, $limit: 50 })
await db.users.findMany({ age: { $gte: 18 }, $limit: 50 })

6) Insert

const row = await db.users.insert({
  email: 'riya@example.com',
  name: 'Riya',
  isActive: true,
})

console.log(row)

Next: Schema, Kadak CLI, Debug. Reference: Query Operators, Column Methods.

On this page