Skip to content

README.md

Latest commit

 

History

History
148 lines (104 loc) · 3.64 KB

README.md

File metadata and controls

148 lines (104 loc) · 3.64 KB

📦 Database Schema Management with Prisma

This project uses Prisma for database schema management, type-safe database access, and migrations.

🛠️ Setup

  1. Install Prisma CLI:
npm install -g prisma
# or using your preferred package manager
  1. Install dependencies:
cd schema
pnpm install
  1. Set up environment variables: Make sure your DATABASE_URL is properly configured in your environment:
export DATABASE_URL="postgresql://username:password@localhost:5432/your_database"
  1. Generate Prisma Client:
cd schema
pnpm exec prisma generate

🚀 Common Commands

Generate Prisma Client (after schema changes)

cd schema
pnpm exec prisma generate

Create and apply migrations

cd schema
# Create a new migration
pnpm exec prisma migrate dev --name "description_of_changes"

# Apply migrations to production
pnpm exec prisma migrate deploy

Database introspection (sync schema with existing DB)

cd schema
pnpm exec prisma db pull

Push schema changes without migrations (for development)

cd schema
pnpm exec prisma db push

Reset database (careful in production!)

cd schema
pnpm exec prisma migrate reset

Open Prisma Studio (database GUI)

cd schema
pnpm exec prisma studio

📊 Database Models

This schema includes the following models:

Core Business Models

  • Company - Comprehensive company data with financial information (2018-2023)
  • Leader - Company leadership and management information

Reference Data Models

  • City - City reference data for autocomplete
  • IndustrySector - Industry sector classifications
  • LegalForm - Legal form types
  • Region - Geographic regions

User Management Models

  • UserCompanyStatus - User interaction tracking with companies
  • UserQuota - User quota management system

Configuration Models

  • AppSettings - System configuration settings

🧠 Migration from Alembic

This project has been migrated from SQLAlchemy + Alembic to Prisma. Key benefits:

  • Type Safety: Auto-generated, fully typed database client
  • Better DX: Intuitive query API and excellent IntelliSense
  • Database GUI: Built-in Prisma Studio for data exploration
  • Migration Management: Robust migration system with rollback support
  • Multi-language Support: Works with JavaScript, TypeScript, Python, and more
  • I don't like Python: I understand Python but I don't like it and I prefer TypeScript

Key Changes:

  • All SQLAlchemy models converted to Prisma schema
  • Preserved all existing indexes and constraints
  • Maintained database compatibility (same table names and structure)
  • Enhanced with proper relations between models

🧭 Tips

  • Always run prisma generate after modifying the schema file
  • Use prisma migrate dev during development for schema changes
  • Use prisma migrate deploy for production deployments
  • Backup your database before running prisma migrate reset
  • Check the generated client in ./generated/prisma for available methods
  • Use Prisma Studio (prisma studio) for easy data visualization and editing
  • Make sure the correct DATABASE_URL is set in your environment variables

📚 Useful Resources