Prisma ORM: Mulakan dengan Projek menggunakan JS

Apa itu Prisma?

Prisma: ORM Generasi Seterusnya untuk Node.js dan TypeScript

ORM: Pemetaan Perkaitan Objek ialah cara untuk berkomunikasi dengan pangkalan data menggunakan bahasa OOP, tanpa perlu menulis pertanyaan yang rumit.

• Prisma bertujuan untuk menjadikan pangkalan data mudah untuk pembangun.
• Ia menyediakan keselamatan jenis, API intuitif dan meningkatkan produktiviti pembangun.
• Memfokus pada pengalaman pembangun.

Komponen Utama

• Skema Prisma: Sumber tunggal kebenaran untuk skema pangkalan data anda. Mentakrifkan model dan hubungannya.
• Klien Prisma: Pembina pertanyaan yang dijana secara automatik yang disesuaikan dengan skema anda. Menyediakan akses selamat jenis kepada pangkalan data anda.
• Prisma Migrate: Alat untuk mengurus migrasi skema pangkalan data.

---

Kenapa Prisma?

1. Memudahkan interaksi pangkalan data: Prisma ORM menyediakan pertanyaan intuitif dan pemindahan skema.
2. Meningkatkan kualiti kod: Prisma ORM menjana pertanyaan selamat jenis dan disepadukan dengan IDE yang popular.
3. Menyokong berbilang pangkalan data: Prisma ORM menjadikannya lebih mudah untuk menyesuaikan dan mengembangkan aplikasi. (cth., MongoDB, MySQL, MariaDB, PostgreSQL, Microsoft SQL, dll.)
4. Mengurangkan masalah ORM tradisional: Prisma ORM menangani isu seperti contoh model yang membengkak dan pertanyaan yang tidak dapat diramalkan.

Persediaan Projek

1. Persediaan Projek

Buat direktori projek baharu

mkdir prisma-example
cd prisma-example

Mulakan projek Node.js

npm init -y

Pasang Prisma CLI

npm install prisma dotenv express --save-dev

Pasang Pelanggan Prisma

npm install @prisma/client --save-dev

Ini memasang Klien Prisma untuk pangkalan data anda.

2. Mulakan Prisma

npx prisma init

Ini mencipta direktori prisma yang mengandungi:

• schema.prisma: Fail skema Prisma anda.
• .env: Untuk rentetan sambungan pangkalan data anda.

3. Konfigurasikan Sambungan Pangkalan Data

Pilih Pangkalan Data

Video mungkin menggunakan PostgreSQL, tetapi anda boleh menyesuaikannya dengan MySQL, SQLite atau lain-lain. Untuk contoh ini, kami akan menggunakan PostgreSQL.

Tetapkan DATABASE_URL

Dalam fail .env anda, tambahkan rentetan sambungan. Contoh untuk PostgreSQL:

DATABASE_URL="postgresql://your_user:your_password@localhost:5432/your_database"

Gantikan pengguna_anda, kata laluan_anda dan pangkalan data_anda dengan bukti kelayakan sebenar anda. Jika anda tidak mempunyai pelayan PostgreSQL setempat, anda perlu memasang dan mengkonfigurasinya.

4. Tentukan Model Data (schema.prisma)

Gantikan kandungan prisma/schema.prisma dengan yang berikut:

mkdir prisma-example
cd prisma-example

5. Menjana Pelanggan Prisma

npm init -y

Ini menjana Klien Prisma selamat jenis dalam node_modules/@prisma/client.

6. Buat Migrasi

npm install prisma dotenv express --save-dev

Ini mencipta fail migrasi baharu dalam direktori prisma/migrasi dan menggunakannya pada pangkalan data anda, mencipta jadual. --name init memberikan penghijrahan nama deskriptif.

7. Mencipta Fail Berasingan untuk Persediaan Prisma

Buat fail db.config.js dalam direktori akar dan tambah kod berikut:

npm install @prisma/client --save-dev

Ini akan mencipta contoh baharu PrismaClient dan mengeksportnya supaya ia boleh digunakan dalam fail lain. Pilihan log: ['query'] akan log semua pertanyaan ke konsol.

8. Mencipta API Ekspres Asas untuk Memahami Kerja Prisma

1. Pengawal

Buat fail controllers.js dalam akar projek. Berikut ialah kod untuk operasi CRUD dalam fail controllers.js:

npx prisma init

2. Laluan

Buat fail route.js dalam akar projek. Berikut ialah kod untuk operasi CRUD dalam fail route.js:

DATABASE_URL="postgresql://your_user:your_password@localhost:5432/your_database"

3. Pelayan

Buat fail server.js dalam akar projek. Berikut ialah kod untuk operasi CRUD dalam fail server.js:

generator client {
    provider = "prisma-client-js"
}

datasource db {
    provider = "postgresql" // Or "mysql", "sqlite", etc.
    url      = env("DATABASE_URL")
}

model Post {
    id        String   @id @default(uuid())
    title     String
    content   String?
    createdAt DateTime @default(now())
    author    User     @relation(fields: [user_id], references: [id])
    user_id   Int
}

model User {
    id    Int     @id @default(autoincrement())
    email String  @unique
    name  String?
    posts Post[]
}

9. Jalankan Skrip

npx prisma generate

Ini akan melaksanakan skrip, mencipta pengguna dan siaran dalam pangkalan data anda, kemudian mengemas kini pengguna dan memadamkan siaran.

Anda boleh menggunakan Posmen untuk menguji API dengan laluan berikut:

• POST: http://localhost:5000/api/users
• DAPATKAN: http://localhost:5000/api/users
• DAPATKAN: http://localhost:5000/api/users/1
• PUT: http://localhost:5000/api/users/1
• PADAM: http://localhost:5000/api/users/1

Tetapkan badan dalam Posmen untuk permintaan POST sebagai JSON dengan data berikut:

npx prisma migrate dev --name init

Perkara Utama untuk Dipertimbangkan untuk Sintaks Prisma

• findUnique/findFirst - untuk mendapatkan satu rekod, tidak mengembalikan tatasusunan.
• findMany - untuk mendapatkan berbilang rekod, mengembalikan tatasusunan.
• sertakan - untuk memasukkan data yang berkaitan.
• pilih - untuk memilih medan tertentu.
• Anda hanya boleh menggunakan salah satu atribut, sama ada pilih atau sertakan.

Contoh Sintaksis Prisma

import { PrismaClient } from "@prisma/client";

const prisma = new PrismaClient({
    log: ["query"],
});

export default prisma;

Lagi tentang Pengagregatan Prisma, Penapisan, Susunan dan Perhubungan

1. Fungsi Pengagregatan dalam Prisma

Prisma menyediakan beberapa fungsi pengagregatan yang membolehkan anda melakukan pengiraan pada set data terus dalam pertanyaan pangkalan data anda. Fungsi ini berguna untuk meringkaskan data dan mendapatkan cerapan tanpa perlu mengambil sejumlah besar data ke aplikasi anda.

Fungsi Pengagregatan Biasa

• _count: Mengira bilangan rekod yang sepadan dengan kriteria yang diberikan.
• _avg: Mengira purata medan angka.
• _sum: Mengira jumlah medan angka.
• _min: Mencari nilai minimum medan.
• _maks: Mencari nilai maksimum medan.

Contoh Agregasi

Anggap kita mempunyai model Produk berikut:

mkdir prisma-example
cd prisma-example

Mengira Bilangan Produk dalam Setiap Kategori

npm init -y

Mengira Harga Purata Semua Produk

npm install prisma dotenv express --save-dev

Mencari Harga Minimum dan Maksimum Produk dalam Kategori Tertentu

npm install @prisma/client --save-dev

Jumlah Harga untuk Produk Yang Dicipta dalam Minggu Lalu

npx prisma init

2. Penapisan dalam Prisma

Prisma menawarkan set pilihan penapisan yang kaya yang membolehkan anda menanyakan pangkalan data anda dengan tepat. Berikut ialah gambaran menyeluruh dengan contoh:

Penapisan Asas

• sama dengan (Lalai): Menyemak kesamaan yang tepat.
  

  DATABASE_URL="postgresql://your_user:your_password@localhost:5432/your_database"
  

• bukan: Meniadakan syarat.
  

  generator client {
      provider = "prisma-client-js"
  }
  
  datasource db {
      provider = "postgresql" // Or "mysql", "sqlite", etc.
      url      = env("DATABASE_URL")
  }
  
  model Post {
      id        String   @id @default(uuid())
      title     String
      content   String?
      createdAt DateTime @default(now())
      author    User     @relation(fields: [user_id], references: [id])
      user_id   Int
  }
  
  model User {
      id    Int     @id @default(autoincrement())
      email String  @unique
      name  String?
      posts Post[]
  }
  

Operator Perbandingan

• gt (Lebih Besar Daripada), gte (Lebih Besar Daripada atau Sama Dengan), lt (Kurang Daripada), lte (Kurang Daripada atau Sama Dengan): Digunakan untuk perbandingan angka dan tarikh/masa.
  

  npx prisma generate
  

Penapis Rentetan

• mengandungi: Menyemak sama ada rentetan mengandungi subrentetan.
  

  npx prisma migrate dev --name init
  

• bermula Dengan: Menyemak sama ada rentetan bermula dengan awalan.
  

  import { PrismaClient } from "@prisma/client";
  
  const prisma = new PrismaClient({
      log: ["query"],
  });
  
  export default prisma;
  

• berakhirDengan: Menyemak sama ada rentetan berakhir dengan akhiran.
  

  import prisma from "./db.config.js";
  
  // create user
  export const createUser = async (req, res) => {
      const { name, email } = req.body;
  
      const existing_user = await prisma.user.findUnique({
          where: {
              email,
          },
      });
  
      if (existing_user) {
          return res.status(400).json({ message: "User already exists" });
      }
  
      const user = await prisma.user.create({
          data: {
              email,
              name,
          },
      });
  
      return res.status(201).json(user);
  };
  
  // create post
  export const createPost = async (req, res) => {
      const { title, content, user_id } = req.body;
  
      const post = await prisma.post.create({
          data: {
              title,
              content,
              user_id,
          },
      });
  
      return res.status(201).json(post);
  };
  
  // get all users
  export const getUsers = async (req, res) => {
      const users = await prisma.user.findMany({
          include: {
              posts: true,
          },
      });
  
      return res.status(200).json(users);
  };
  
  // read specific user by id
  export const getUserById = async (req, res) => {
      const { id } = req.params;
  
      const user = await prisma.user.findUnique({
          where: {
              id: parseInt(id),
          },
          include: {
              posts: true,
          },
      });
  
      if (!user) {
          return res.status(404).json({ message: "User not found" });
      }
  
      return res.status(200).json(user);
  };
  
  // update user
  export const updateUser = async (req, res) => {
      const { id } = req.params;
      const { name, email } = req.body;
  
      const user = await prisma.user.update({
          where: {
              id: parseInt(id),
          },
          data: {
              name,
              email,
          },
      });
  
      return res.status(200).json(user);
  };
  
  // delete user
  export const deleteUser = async (req, res) => {
      const { id } = req.params;
  
      const user = await prisma.user.delete({
          where: {
              id: parseInt(id),
          },
      });
  
      return res.status(200).json(user);
  };
  
  // create similar for post
  

• mod: tidak sensitif: Melakukan carian tidak peka huruf besar-besaran.
  

  import express from "express";
  import {
      createUser,
      createPost,
      getUsers,
      getUserById,
      updateUser,
      deleteUser,
  } from "./controllers.js";
  
  const router = express.Router();
  
  router.post("/users", createUser);
  router.get("/users", getUsers);
  router.get("/users/:id", getUserById);
  router.put("/users/:id", updateUser);
  router.delete("/users/:id", deleteUser);
  // create similar for post
  router.post("/posts", createPost);
  // router.get('/posts', getPosts);
  // router.get('/posts/:id', getPostById);
  // router.put('/posts/:id', updatePost);
  // router.delete('/posts/:id', deletePost);
  
  export default router;
  

Senaraikan Penapis

• dalam: Menyemak sama ada nilai terdapat dalam senarai.
  

  import express from "express";
  import dotenv from "dotenv";
  import router from "./routes.js";
  
  dotenv.config();
  
  const app = express();
  
  app.use(express.json());
  app.use("/api", router);
  
  const PORT = process.env.PORT || 5000;
  
  app.listen(PORT, () => {
      console.log(`Server running on port ${PORT}`);
  });
  

• notIn: Menyemak sama ada nilai tidak hadir dalam senarai.
  

  node index.js
  

Operator Logik

• DAN: Menggabungkan berbilang keadaan dengan logik DAN.
  

  {
      "name": "John Doe",
      "email": "sample@example.com"
  }
  

• ATAU: Menggabungkan berbilang keadaan dengan OR logik.
  

  // get all posts of a user with id
  const user = await prisma.user.findUnique({
      where: {
          id: parseInt(id),
      },
      include: {
          posts: true,
      },
  });
  
  // select specific fields of user with post details
  const user = await prisma.user.findUnique({
      where: {
          id: parseInt(id),
      },
      select: {
          name: true,
          posts: {
              select: {
                  title: true,
                  content: true,
              },
          },
      },
  });
  
  // get all users name with their posts count (Aggregation)
  const req_data = await prisma.user.findMany({
      select: {
          id: true,
          name: true,
          _count: {
              select: {
                  post: true,
              },
          },
      },
  });
  

• BUKAN: Meniadakan sekumpulan syarat.
  

  model Product {
      id        Int      @id @default(autoincrement())
      name      String
      price     Float
      category  String
      createdAt DateTime @default(now())
  }
  

Penapis Bersarang (Penapisan pada Perhubungan)

Anda boleh menapis berdasarkan model yang berkaitan.

mkdir prisma-example
cd prisma-example

Penapisan pada Perhubungan Pilihan

npm init -y

Menggabungkan Penapis

Anda boleh menggabungkan operator ini untuk logik penapisan yang kompleks.

npm install prisma dotenv express --save-dev

Contoh ini merangkumi senario penapisan yang paling biasa dalam Prisma. Dengan menggabungkan pengendali dan penapis bersarang ini, anda boleh membuat pertanyaan yang sangat tepat untuk mendapatkan semula data tepat yang anda perlukan. Jangan lupa untuk merujuk dokumentasi rasmi Prisma untuk mendapatkan maklumat yang paling terkini dan terperinci.

Pesanan Rekod dalam Prisma

Pilihan pesananBy Prisma membolehkan anda mengisih hasil pertanyaan anda. Berikut ialah beberapa contoh yang menunjukkan penggunaannya:

Pesanan Asas

• Tertib Menaik (Lalai):
  

  npm install @prisma/client --save-dev
  

• Arahan Menurun:
  

  npx prisma init
  

Pesanan mengikut Pelbagai Medan

Anda boleh menentukan berbilang medan untuk dipesan, dengan arah yang berbeza untuk setiap satu. Prisma mula-mula akan mengisih mengikut medan pertama, kemudian mengikut medan kedua dalam kumpulan nilai yang sama dalam medan pertama, dan seterusnya.

DATABASE_URL="postgresql://your_user:your_password@localhost:5432/your_database"

Dalam contoh ini, siaran akan diisih terutamanya mengikut nama pengarang dalam tertib menaik. Jika berbilang siaran mempunyai pengarang yang sama, ia kemudiannya akan diisih mengikut tajuknya dalam tertib menurun.

Pesanan mengikut Medan Bersarang (Perhubungan)

Seperti yang ditunjukkan dalam contoh sebelumnya, anda boleh memesan mengikut medan pada model yang berkaitan.

generator client {
    provider = "prisma-client-js"
}

datasource db {
    provider = "postgresql" // Or "mysql", "sqlite", etc.
    url      = env("DATABASE_URL")
}

model Post {
    id        String   @id @default(uuid())
    title     String
    content   String?
    createdAt DateTime @default(now())
    author    User     @relation(fields: [user_id], references: [id])
    user_id   Int
}

model User {
    id    Int     @id @default(autoincrement())
    email String  @unique
    name  String?
    posts Post[]
}

Ini akan memesan siaran berdasarkan alamat e-mel pengarangnya.

Memesan mengikut Medan Tarikh/Masa

Anda boleh memesan mengikut medan tarikh dan masa juga.

npx prisma generate

Memesan mengikut Medan Berbeza daripada Medan Penapisan

Anda boleh menapis mengikut satu medan dan memesan mengikut medan yang lain. Sebagai contoh, anda mungkin ingin mencari semua pengguna dengan nama yang mengandungi "ujian" tetapi memesan mereka melalui alamat e-mel mereka:

npx prisma migrate dev --name init

Menggunakan nulls Option

Anda boleh mengawal cara nilai nol dikendalikan dalam pengisihan. Pilihan nulls boleh ditetapkan kepada sama ada yang pertama atau yang terakhir.

import { PrismaClient } from "@prisma/client";

const prisma = new PrismaClient({
    log: ["query"],
});

export default prisma;

Secara lalai, nilai nol diletakkan terakhir apabila mengisih dalam tertib menaik dan pertama apabila mengisih dalam tertib menurun. Pilihan nulls membolehkan anda mengatasi tingkah laku lalai ini.

Fungsi Perhubungan dalam Prisma

Prisma cemerlang dalam mengendalikan perhubungan pangkalan data dengan elegan. Berikut ialah aspek utama:

• Mentakrifkan Perhubungan dalam Skema: Anda mentakrifkan hubungan antara model secara langsung dalam fail schema.prisma anda menggunakan atribut @relation.

• Jenis Perhubungan: Prisma menyokong:

  • Satu-dengan-Satu: Satu rekod dalam model A berkaitan dengan tepat satu rekod dalam model B.
  • Satu-ke-Banyak: Satu rekod dalam model A berkaitan dengan berbilang rekod dalam model B.
  • Many-to-Many: Berbilang rekod dalam model A berkaitan dengan berbilang rekod dalam model B (memerlukan jadual gabungan).

Contoh Perhubungan

Mari kita gunakan model Pengguna dan Siaran daripada contoh sebelumnya:

mkdir prisma-example
cd prisma-example

Semoga ini membantu anda memahami Prisma ORM dengan cara yang lebih baik.
Sila berikan maklum balas dan cadangan anda.

Terima kasih kerana membaca! ?

Atas ialah kandungan terperinci Prisma ORM: Mulakan dengan Projek menggunakan JS. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!