Cara Menggunakan Database SQL dalam Aplikasi NestJS Dengan TypeORM

Object-Relational Mapper (ORM) adalah library yang mengimplementasikan teknik pemetaan Object-Relational. Ini memungkinkan Anda menulis kueri database SQL menggunakan paradigma berorientasi objek dari bahasa pilihan Anda.

TypeORM adalah TypeScript ORM yang membuat antarmuka dengan berbagai database menjadi sangat mudah. Ia bekerja dengan database SQL tetapi juga berinteraksi dengan baik dengan database NoSQL seperti MongoDB.

NestJS menyediakan dukungan tingkat tinggi untuk TypeORM secara langsung. Paket TypeORM khusus membuat integrasi relatif mudah.

Langkah 1: Menginstal Dependensi

Sebelum menggunakan TypeORM dalam aplikasi NestJS, Anda harus menginstalnya dengan paket NestJS asli dan database SQL pilihan Anda. SQLite adalah opsi sederhana dan bebas instalasi.

Jalankan perintah berikut untuk menginstal TypeORM dan paket NestJS aslinya, menggunakan manajer paket npm:

instal npm @nestjs/typeorm typeorm

Jalankan perintah berikut untuk menginstal SQLite:

npm Install sqlite3

Langkah 2: Membuat Entitas

Entitas adalah kumpulan bidang yang mendefinisikan data yang disimpan dalam database. TypeORM menggunakan file entitas untuk membuat tabel di database Anda.

Ikuti langkah-langkah di bawah ini untuk membuat entitas:

1. Buat file di modul aplikasi Anda dan beri nama mengikuti konvensi penamaan NestJS (.entitas.ts).
2. Di file entitas Anda, impor file Kesatuan, Kolom, dan Kolom Utama yang Dihasilkan dekorator dari typeorm.
3. Di file entitas Anda, buat dan ekspor kelas.
4. Isi kelas dengan nilai yang Anda inginkan di database Anda, seperti Indo, nama, dll.
5. Beri anotasi pada kelas entitas Anda dengan dekorator Entitas. Ini membuat kelas Anda dikenali oleh TypeORM sebagai entitas.
6. Beri anotasi pada properti id Anda dengan dekorator PrimaryGeneratedColumn. Ini memberitahu TypeORM untuk menandai Indo sebagai kunci utama dan menaikkannya secara otomatis.
7. Beri anotasi pada properti yang tersisa dengan dekorator Kolom. Ini menambahkannya sebagai kolom di database Anda.

Sebagai contoh:

// src/test/test.entity.ts
impor { Entitas, Kolom, PrimaryGeneratedColumn } dari 'ketik';
@Kesatuan()
eksporkelasUji{
@PrimaryGeneratedColumn()
 nomor ID;
@Kolom()
 properti_1: string;
@Kolom()
 properti_2: string;
@Kolom()
 properti_3: string;
}

File entitas di atas membuat tabel ini di database Anda:

Itu Dokumentasi TypeORM mencakup entitas secara lebih rinci.

Langkah 3: Menghubungkan Aplikasi Anda ke Database

Sekarang setelah entitas Anda disiapkan, Anda harus menghubungkan aplikasi Anda ke database. Contoh ini menggunakan SQLite.

Ikuti langkah-langkah di bawah ini untuk menghubungkan aplikasi Anda ke database:

1. Di modul root aplikasi Anda (Biasanya app.module.ts file), impor TypeOrmModul dari @nestjs/typeorm.
2. Dalam file yang sama, impor semua entitas Anda.
3. Dalam impor array, panggil untuk Root metode pada TypeOrmModule. Metode forRoot membagikan koneksi database melalui semua modul di aplikasi Anda.
4. Lewati objek kosong sebagai argumen ke dalam metode forRoot; ini akan menjadi objek konfigurasi TypeORM.
5. Tambahkan properti, Tipe, ke objek konfigurasi dan atur ke “sqlite”. Properti type menunjukkan nama database yang Anda gunakan.
6. Tambahkan properti lain, basis data, ke objek konfigurasi dan atur ke “tes.db”. Properti database menunjukkan nama pilihan Anda untuk database Anda.
7. Tambahkan properti lain, entitas, ke objek konfigurasi dan atur ke array kosong. Isi larik kosong dengan entitas yang Anda impor sebelumnya.
8. Tambahkan properti lain, menyinkronkan, dan atur BENAR; properti ini menyinkronkan entitas Anda ke database Anda dan memperbaruinya setiap kali Anda menjalankan kode. Anda hanya harus menyetel properti ini ke BENAR dalam pengembangan. Selama produksi, Anda harus mengaturnya ke Salah untuk menghindari kehilangan data.

// src/app.module.ts
impor { Modul } dari '@nestjs/umum';
impor { TypeOrmModule } dari '@nestjs/typeorm';
impor { Uji } dari './test/test.entity';
impor { Entitas2 } dari './entitas/entitas.entitas';
impor { TestModule } dari './test/test.module';
@Modul({
 impor: [
TypeOrmModul.forRoot({
 Tipe: 'sqlite',
 basis data: 'tes.db',
entitas: [Uji, Entitas2],
 sinkronisasi: BENAR, //pengembangan saja
 }),
 modul tes,
 ],
pengontrol: [],
penyedia: [],
})
eksporkelasModul Aplikasi{}

Langkah 4: Membuat Repositori

Repositori adalah lapisan akses entitas yang digunakan untuk membuat kueri (menyisipkan, menghapus, menyimpan, menemukan, dll.) pada tabel yang dibuat oleh entitas dalam database. TypeORM mendukung pola desain repositori, dengan demikian, setiap entitas memiliki repositori sendiri.

TypeORM secara otomatis membuat repositori untuk entitas Anda ketika Anda mengikuti langkah-langkah di bawah ini:

1. Di file modul entitas Anda, impor TypeOrmModul dari @nestjs/typeorm dan impor entitas Anda.
2. Buat sebuah impor array di @Modul penghias.
3. Dalam larik impor, panggil perintah untukFitur metode pada TypeOrmModule.
4. Berikan array sebagai argumen ke dalam Anda dan isi array dengan entitas Anda.

// src/test/test.module.ts
impor { Modul } dari '@nestjs/umum';
impor { TypeOrmModule } dari '@nestjs/typeorm';
impor { Pengontrol Tes } dari './test.controller';
impor { Layanan Uji } dari './test.service';
impor { Uji } dari './test.entity';
@Modul({
impor: [TypeOrmModule.forFeature([Test])],
penyedia: [Layanan Uji],
pengontrol: [Pengendali Tes],
})

Langkah 5: Menyuntikkan Repositori Anda ke Layanannya Menggunakan Injeksi Ketergantungan

Dependency injection adalah salah satu teknik rekayasa perangkat lunak yang merupakan bentuk dari inversi prinsip kontrol. Ini menggeser beban manajemen ketergantungan dari kode klien ke perpustakaan atau layanan yang menjadi sandarannya.

Ikuti langkah-langkah di bawah ini untuk menyuntikkan repositori Anda ke dalam layanan:

1. Di file layanan Anda, impor Gudang dari typeorm dan InjectRepository dekorator dari @nestjs/typeorm. Juga impor entitas yang ingin Anda masukkan repositorinya.
2. Di kelas layanan Anda, buat konstruktor.
3. Nyatakan pribadi variabel, repo, sebagai parameter dalam konstruktor untuk menginisialisasinya.
4. Tetapkan jenis Repositori ke repo dengan tipe generik entitas Anda.
5. Beri anotasi repo dengan dekorator InjectRepository dan berikan entitas Anda sebagai argumen.

// tes.layanan.ts
impor { Suntik } dari '@nestjs/umum';
impor { Repositori } dari 'ketik';
impor { InjectRepository } dari '@nestjs/typeorm';
impor { Uji } dari './test.entity';
@suntik()
eksporkelasLayanan Uji{
konstruktor(
@InjectRepository(Uji)
 repo pribadi: Repositori<Uji>,
 ) {}
}

Sekarang setelah penyiapan Anda selesai, Anda dapat membuatnya kueri SQL di atasnya untuk mengambil atau mengubah data.

Membuat Query SQL dengan TypeORM

Anda dapat membuat kueri SQL sederhana dengan memanggil metode repositori TypeORM di repo variabel di dalam kelas layanan Anda. Anda juga dapat membuat kueri SQL kompleks dengan menggunakan pembuat kueri TypeORM.