halo kawan-kawan semuaaa... pada kesempatan ini saya ingin sharing mengenai setup database (dalam contoh ini saya pakai postgresql) di nest js menggunakan typeorm, mengapa nest js? karena menurut saya mengerjakan project dengan typescript dapat mempermudah proses pengembangan suatu aplikasi serta beberapa library nest js yang mudah untuk diintegrasikan dengan teknologi lain.

sebelum kita lanjut pastikan kita sudah memahami prerequisites berikut biar ga bingung di pertengahan nantinya

node js dasar (termasuk typescript-nya)
database (postgresql atau mysql)

oke jika sudah clear maka langsung saja kita masuk ke langkah yang pertama

1. Setup Nest JS

pertama-tama kita create project nya dengan nest cli dengan mengetikkan command berikut di terminal

    $ npm i -g @nestjs/cli
$ nest new nest-typeorm

akan muncul pertanyaan mengenai package manager yang kita gunakan, pilih yang diinginkan (saya pilih yarn karena sudah terbiasa) setelah itu tunggu sampai proses instalasi selesai, jika sudah akan terbuat directory/folder baru dengan nama nest-typeorm (sesuai nama project nya), buka directory tersebut dengan visual studio code

    $ code nest-typeorm

langsung aja kita coba jalanin projectnya pakai mode development dengan command berikut (di terminal vs-code)

    $ yarn start:dev

jika tidak ada error maka project kita berhasil berjalan di port 3000 (default), kita bisa mengeceknya dengan mengetikkan http://localhost:3000 di browser, akan muncul pesan Hello World!

2. Install TypeORM

kita buat dulu database postgresql yang mau kita pakai di project ini, bisa menggunakan psql atau di aplikasi database viewer seperti dbeaver, heidisql, dll.

    $ psql -U postgres -c "create database \"nestjs-typeorm\""

selanjutnya kita akan install library typeorm, di nestjs ada library @nestjs/typeorm untuk mempermudah integrasi nya, kita install terlebih dahulu

    $ yarn add @nestjs/typeorm typeorm pg

3. Datasource

setelah selesai diinstall, buat folder database di dalam folder src, kegunaannya adalah untuk menyimpan segala file yang berkaitan dengan database. Lalu kita buat file datasource.ts di dalam folder src/database, untuk konfigurasi database yang akan kita pakai, kita akan gunakan file ini saat migration (karna migration dapat dilakukan meski server sedang tidak berjalan)

    import { join } from 'path';
import { DataSource } from 'typeorm';

const datasource = new DataSource({
  type: 'postgres',
  host: 'localhost',
  port: 5432,
  username: 'postgres',
  password: 'contoh-password', // sesuaikan dengan password masing-masing
  database: 'nestjs-typeorm',
  entities: [join(__dirname, '..', '**', 'entities', '*.entity.{ts,js}')],
  migrations: [join(__dirname, 'migrations', '*')],
  migrationsTableName: 'migrations',
  synchronize: false,
  logging: false,
});

export default datasource;

4. Migration

setelah koneksi berhasil maka selanjutnya adalah membuat migration dari table-table yang akan kita gunakan di dalam project, yang saya ketahui terdapat 2 cara untuk membuat migration, yang pertama membuat file migration lalu mendeskripsikan migration-nya, atau yang kedua membuat entity terlebih dahulu, lalu men-generate migration berdasarkan entity, pada kesempatan kali ini kita lakukan yang pertama, misalkan buat migration untuk create table users dengan typeorm cli

    $ npx typeorm-ts-node-commonjs migration:create src/database/migrations/create-table-users

command tersebut akan membuat file {timestamp}-create-table-users.ts di dalam folder src/database/migrations, lalu kita ubah file tersebut seperti ini

    import { MigrationInterface, QueryRunner, Table } from 'typeorm';

export class CreateTableUsers1692867883026 implements MigrationInterface {
  public async up(queryRunner: QueryRunner): Promise {
    await queryRunner.createTable(
      new Table({
        name: 'users',
        columns: [
          { name: 'id', type: 'uuid', isPrimary: true },
          { name: 'name', type: 'varchar' },
          { name: 'email', type: 'varchar', isUnique: true },
          { name: 'password', type: 'varchar' },
        ],
      }),
      true,
    );
  }

  public async down(queryRunner: QueryRunner): Promise {
    await queryRunner.dropTable('users', true);
  }
}

jika sudah kita bisa running semua migrasi (yang belum dijalankan) dengan command berikut

    $ npx typeorm-ts-node-commonjs -d src/database/datasource.ts migration:run

jika berhasil maka table users sudah berhasil dibuat, kita bisa mengecek dengan psql di terminal

    $ psql -U postgres -d "nestjs-typeorm" -c "\d"

5. Persiapan Seeder

selanjutnya adalah seeder, mengapa perlu seeder? dalam suatu aplikasi pastinya jika ada data-data yang diperlukan maka kita akan input ke dalam database baik itu data production ataupun data dummy, dalam hal ini kita bisa memanfaatkan seeder agar developer lain (jika ada) saat meng-clone project nya cukup menjalankan seeder yang ada.

Sebelum kita membuat seeder, kita buat terlebih dahulu entity/table untuk menyimpan history seeding (belum dibuat otomatis dari library seperti migrations), buat file entity seeder.entity.ts di folder src/database/entities

    import {
  Column,
  CreateDateColumn,
  Entity,
  PrimaryGeneratedColumn,
} from 'typeorm';
@Entity('seeders')

export class SeederEntity {
  @PrimaryGeneratedColumn('increment')
  id: number;
  @Column('varchar')
  name: string;
  @CreateDateColumn({ name: 'created_at', type: 'timestamp with time zone' })
  createdAt: Date;
}

lalu buat migration nya

    $ npx typeorm-ts-node-commonjs migration:create src/database/migrations/create-table-seeders

isi file migration yang baru dibuat dengan kode berikut, dimana kita membuat 3 field saja yakni id, name, created_at

    import { MigrationInterface, QueryRunner, Table } from 'typeorm';

export class CreateTableSeeders1692874947883 implements MigrationInterface {
  public async up(queryRunner: QueryRunner): Promise {
    await queryRunner.createTable(
      new Table({
        name: 'seeders',
        columns: [
          {
            name: 'id',
            type: 'int4',
            isPrimary: true,
            isGenerated: true,
            generationStrategy: 'increment',
          },
          {
            name: 'name',
            type: 'varchar',
          },
          {
            name: 'created_at',
            type: 'timestamp with time zone',
            default: 'now()',
          },
        ],
      }),
      true,
    );
  }

  public async down(queryRunner: QueryRunner): Promise {
    await queryRunner.dropTable('seeders');
  }
}

jalankan migration nya

    $ npx typeorm-ts-node-commonjs -d src/database/datasource.ts migration:run

6. Membuat User Entity

buat file user.entity.ts untuk user di folder user/entites

    import { Column, Entity, PrimaryColumn } from 'typeorm';

@Entity('users')
export class User {
  @PrimaryColumn('uuid')
  id: string;

  @Column('varchar')
  name: string;

  @Column('varchar')
  email: string;

  @Column('varchar', { select: false })
  password: string;
}

7. Membuat Utililty Hash Password

install library bcrypt dan types nya

    $ yarn add bcrypt
$ yarn add -D @types/bcrypt

buat file password.util.ts di folder src/shared/utils untuk mempermudah proses hashing password

    import { genSaltSync, hashSync } from 'bcrypt';

export const hashPassword = (password: string) {
  return hashSync(password, genSaltSync(10));
}

8. Seeder

sebelum membuat seeder, kita perlu menginstall library berikut

    $ yarn add @jorgebodega/typeorm-seeding uuid

saat tulisan ini dibuat, saya belum menemukan library lain yang dapat digunakan dan sebenarnya library ini juga fork dari library resmi nya namun saat ingin pull request ke repo utama, pembuat library ini tidak dapat menghubungi owner dari library resmi, maka dari itu ia mempublish library ini.

sekarang kita akan membuat file seeder nya, kita bisa create file di dalam folder src/database/seeders (buat jika belum ada), agar dapat mengurutkan berdasarkan timestamp, kita copy saja nama file timestamp dari migration create-table-users, lalu tambahkan nama file nya, misal jadi 1692867883026-users.seeder.ts lalu isi file tersebut dengan

    import { DataSource, DeepPartial } from 'typeorm';
import { Seeder } from '@jorgebodega/typeorm-seeding';
import { SeederEntity } from '../entities/seeder.entity';
import { v4 as uuidv4 } from 'uuid';
import { hashPassword } from '../../shared/utils/password.util';
import { User } from '../../user/entities/user.entity';

export default class UsersSeeder1692867883026 extends Seeder {
  public async run(datasource: DataSource): Promise {
    // if seeder already executed
    if (
      await datasource
        .getRepository(SeederEntity)
        .findOneBy({ name: UsersSeeder1692867883026.name })
    )
      return;

    const users: DeepPartial<User>[] = [
      {
        name: 'Roni',
        email: 'roni@email.com',
        password: 'Qwerty123',
      },
      {
        name: 'Teguh',
        email: 'teguh@email.com',
        password: 'Qwerty123',
      },
      {
        name: 'Rijal',
        email: 'rijal@email.com',
        password: 'Qwerty123',
      },
    ];

    await datasource.getRepository(User).save(
      users.map((user) => ({
        ...user,
        id: user.id ?? uuidv4(),
        password: hashPassword(user.password),
      })),
    );

    // add to seeders table
    await datasource
      .getRepository(SeederEntity)
      .save({ name: UsersSeeder1692867883026.name });
  }
}

di seeder tersebut kita menambahkan 3 data pengguna ke table users, tambahkan data lain jika diperlukan, terakhir jalankan seluruh seeder yang ada

    $ npx ts-node node_modules/@jorgebodega/typeorm-seeding/dist/cli.js seed -d src/database/datasource.ts src/database/seeders/*.seeder.ts

untuk command yang sekiranya panjang kita bisa persingkat dengan menaruhnya di package.json di dalam object scripts

baik itu saja setup database di nest js dengan typeorm, masih banyak yang bisa dilakukan mengenai migration & seeder nya, tinggal disesuaikan dengan kebutuhan masing-masing project dan tips dari saya adalah buatkan logika untuk data dummy yang tidak akan dimasukkan di environment production, karena sesuai namanya data tersebut hanyalah data untuk contoh saja.

kalo berhasil sampai di sini, thanks sudah baca blog ini 🙏🏽🙏🏽🙏🏽, semoga bermanfaat :-)