Guia completo: Prisma com PostgreSQL em projetos Node.js

A dupla dinâmica do backend

Nosso objetivo é te guiar, do setup à produção. Bora codar e construir o futuro do seu backend!

Entendendo o ecossistema: Prisma e PostgreSQL

O que é Prisma?

• Prisma Client: um gerador de cliente de banco de dados type-safe para Node.js e TypeScript, para interagir com seu banco de forma intuitiva e segura.

• Prisma Migrate: ferramenta para gerenciar migrações de schema, garantindo alterações controladas e versionadas.

• Prisma Studio: interface gráfica para visualizar e gerenciar os dados do seu banco.

Vantagens do Prisma:

• Type-safety: autocompletar e verificação de tipos com TypeScript, eliminando erros comuns.

• Produtividade: a API intuitiva e o foco em convenções reduzem o código boilerplate.

• Abstração de banco de dados: permite trocar o banco (SQLite para PostgreSQL, etc.) com poucas alterações, como demonstrado no vídeo de referência.

• Migrations declarativas: defina seu schema e o Prisma gera as migrações SQL.

O que é PostgreSQL?

• Conformidade ACID: garante a integridade dos dados.

• Extensibilidade: permite criar funções e tipos de dados personalizados.

• Suporte a JSONB: tipo de dado JSON binário eficiente.

• Comunidade ativa: vasta comunidade que contribui para seu aprimoramento.

Por que essa combinação é poderosa?

Configurando seu ambiente de desenvolvimento

• Node.js: versão LTS (recomendado 18.x ou 20.x).

• npm ou Yarn: gerenciadores de pacotes.

• Docker e Docker Compose: recomendados para configurar o PostgreSQL localmente.

Configurando PostgreSQL com Docker

version: '3.8'
services:
  db:
    image: postgres:15 # Versão estável recomendada
    restart: always
    environment:
      POSTGRES_USER: docker
      POSTGRES_PASSWORD: docker
      POSTGRES_DB: myapp
    ports:
      - "5432:5432"
    volumes:
      - pgdata:/var/lib/postgresql/data
volumes:
  pgdata:

docker-compose up -d

Inicializando um projeto Node.js

mkdir my-prisma-app
cd my-prisma-app
npm init -y
npm install express prisma @prisma/client
npm install -D typescript ts-node @types/node

{
  "compilerOptions": {
    "target": "es2021",
    "module": "commonjs",
    "rootDir": "./src",
    "outDir": "./dist",
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "strict": true,
    "skipLibCheck": true,
    "sourceMap": true
  },
  "include": ["src/**/*.ts"],
  "exclude": ["node_modules"]
}

Integrando Prisma ao seu projeto Node.js

Instalação e inicialização do Prisma

npx prisma init

DATABASE_URL="postgresql://docker:docker@localhost:5432/myapp?schema=public"

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

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

Definindo seu Schema (Models)

model User {
  id        String   @id @default(cuid()) // Melhor prática atual para IDs
  email     String   @unique
  name      String?
  posts     Post[]
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
}

model Post {
  id        String   @id @default(cuid()) // Melhor prática atual para IDs
  title     String
  content   String?
  published Boolean  @default(false)
  author    User     @relation(fields: [authorId], references: [id])
  authorId  String
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt

  @@map("posts") // Mapeia o nome da tabela para 'posts'
}

Migrações com Prisma Migrate

O que são migrações?

Criando sua primeira migração

npx prisma migrate dev --name init

Interagindo com o banco de dados usando Prisma Client

Gerando o Prisma Client

Operações CRUD básicas

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

const prisma = new PrismaClient();

async function main() {
  // CREATE
  const user = await prisma.user.create({
    data: {
      email: 'Isabela@rkct.team',
      name: 'Isabela',
      posts: {
        create: {
          title: 'Olá mundo!',
          content: 'Esse é meu primeiro post!',
          published: true,
        },
      },
    },
  });
  console.log('Usuário criado:', user);

  // READ
  const allUsers = await prisma.user.findMany({ include: { posts: true } });
  console.log('\nTodos os usuários e seus posts:');
  console.log(JSON.stringify(allUsers, null, 2));

  // UPDATE
  const updatedUser = await prisma.user.update({
    where: { email: 'Isabela@rkct.team' },
    data: { name: 'Isabela Castilho' },
  });
  console.log('\nUsuário atualizado:', updatedUser);

  // DELETE
  const deletedPost = await prisma.post.delete({
    where: { id: user.posts[0].id },
  });
  console.log('\nPost deletado:', deletedPost);
}

main()
  .catch(e => {
    console.error(e);
    process.exit(1);
  })
  .finally(async () => {
    await prisma.$disconnect();
  });

tsc
node dist/index.js

Explorando seus dados com Prisma Studio

O que é Prisma Studio?

Iniciando o Studio

npx prisma studio

Dicas para produção

• Variáveis de ambiente: nunca exponha credenciais de banco de dados diretamente no código. Use variáveis de ambiente (como DATABASE_URL no .env) e garanta que elas sejam gerenciadas de forma segura em produção, utilizando serviços como AWS Secrets Manager ou HashiCorp Vault.

• Migrações em produção: para aplicar migrações em ambientes de produção, utilize sempre npx prisma migrate deploy. Este comando é otimizado para ambientes de produção, garantindo que as migrações sejam aplicadas de forma segura e idempotente. Nunca use npx prisma migrate dev em produção, pois ele pode realizar operações destrutivas e não é projetado para esse ambiente.

• Pool de conexões: o Prisma Client gerencia automaticamente um pool de conexões, otimizando o uso de recursos. Em ambientes de alta carga, monitore o uso de conexões e ajuste as configurações do pool no seu schema.prisma ou na inicialização do PrismaClient se necessário, para evitar sobrecarga no banco de dados.

• Performance: otimize suas queries usando select para buscar apenas os campos necessários, e include para carregar relacionamentos de forma eficiente. Utilize ferramentas de monitoramento do PostgreSQL (como pg_stat_statements) para identificar e otimizar queries lentas. Considere índices adequados para suas tabelas.

• Segurança: o Prisma, por ser um ORM, protege automaticamente contra ataques de SQL Injection, pois parametriza todas as queries. No entanto, sempre valide e sanitize as entradas do usuário na sua aplicação para prevenir outras vulnerabilidades, como XSS (Cross-Site Scripting).

• Estratégias de backup e rollback: implemente rotinas de backup regulares para seu banco de dados PostgreSQL. Em caso de falha de uma migração ou implantação, tenha um plano de rollback bem definido, que pode incluir a restauração de um backup e a reversão do código da aplicação para uma versão anterior estável.

• Testes: integre testes unitários e de integração robustos para garantir que suas interações com o banco de dados funcionem como esperado. Use um banco de dados de teste separado (ou um ambiente de teste efêmero com Docker) para evitar conflitos com dados de desenvolvimento ou produção.

Seu próximo nível com Prisma e PostgreSQL