Drizzle CRUD/Getting Started
Installation
Install and set up Drizzle CRUD in your project
Installation
Install the package
npm install drizzle-crud
yarn add drizzle-crud
pnpm add drizzle-crud
Requirements
- Node.js 16+
- TypeScript 4.7+
- Drizzle ORM
- Zod v4
Prerequisites
Before using Drizzle CRUD, you need to have:
- Drizzle ORM set up in your project
- A database connection configured
- Database schema defined using Drizzle
Basic Setup
Once installed, you can start using Drizzle CRUD by importing the main function:
import { drizzleCrud } from 'drizzle-crud'
import { zod } from 'drizzle-crud/zod'
import { drizzle } from 'drizzle-orm/postgres-js'
// Initialize your database connection
const db = drizzle(/* your database connection */)
// Create the CRUD factory
const createCrud = drizzleCrud(db, {
validation: zod(), // Optional: Add validation
})
Next Steps
- Basic Usage - Learn how to create and use CRUD operations
- Core Operations - Explore all available operations