ORM

Bueno's ORM layer provides entity definition, relationship mapping, and a fluent query builder on top of the database module.

Defining entities

import { Entity, Column, PrimaryKey, HasMany, BelongsTo } from '@buenojs/bueno/orm';

@Entity('users')
class User {
  @PrimaryKey()
  id: number;

  @Column()
  name: string;

  @Column({ unique: true })
  email: string;

  @Column({ default: () => new Date() })
  createdAt: Date;

  @HasMany(() => Post)
  posts: Post[];
}

@Entity('posts')
class Post {
  @PrimaryKey()
  id: number;

  @Column()
  title: string;

  @Column({ type: 'text' })
  content: string;

  @Column()
  userId: number;

  @BelongsTo(() => User)
  author: User;
}

Repository pattern

import { getRepository } from '@buenojs/bueno/orm';

const userRepo = getRepository(User);

// Find by primary key
const user = await userRepo.findById(1);

// Find with conditions
const admins = await userRepo.find({ role: 'admin' });

// Find one
const alice = await userRepo.findOne({ email: 'alice@example.com' });

Creating and saving

const user = userRepo.create({
  name: 'Bob',
  email: 'bob@example.com',
});

await userRepo.save(user);
// user.id is now set

Updating

await userRepo.update(1, { name: 'Robert' });

// Or via entity
user.name = 'Robert';
await userRepo.save(user);

Deleting

await userRepo.delete(1);
await userRepo.deleteWhere({ active: false });

Query builder

const results = await userRepo
  .query()
  .where('active', true)
  .where('role', 'in', ['admin', 'editor'])
  .orderBy('createdAt', 'desc')
  .limit(20)
  .offset(0)
  .include('posts')
  .execute();

Relations

HasMany

const user = await userRepo.findById(1, { include: ['posts'] });
user.posts;  // Post[]

BelongsTo

const post = await postRepo.findById(1, { include: ['author'] });
post.author;  // User

Migrations

Schema