npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@llong2195/drizzle-migrations

v1.0.0

Published

Tiny tool for managing migrations in Drizzle

Downloads

24

Readme

Drizzle migrations

 This repository is a fork from drepkovsky/drizzle-migrations. Thanks to drepkovsky.

Simple tool that ads up and down migration capability for drizzle projects.

Automatic migration generation for drizzle was adapted from the PayloadCMS repository.

Warning! This tool is work in progress and was only tested on pg databases, but should be working on sqlite and mysql too. This is also something that drizzle will probably have built-in inside drizzle-kit in the future.

Installation

npm install @llong2195/drizzle-migrations # or yarn,pnpm,bun

Configuration

To make this work you have to make small changes inside your drizzle.migration.config.ts file

import { defineConfig } from '@llong2195/drizzle-migrations'
import { drizzle } from 'drizzle-orm/node-postgres'
import postgres from 'postgres'

// notice how we are not using `defineConfig` from drizzle but from `@llong2195/drizzle-migrations`
export default defineConfig({
  schema: './src/schema.ts',
  dialect: 'postgresql',
  dbCredentials: {  ...  },
  out: './src/migrations',

  // this is default if not provided. schema is for now supported only for postgres,
  migrations: {
    schema: 'public',
    table: 'drizzle_migrations',
  }, 

  // define your own client using adapter of your choice
  getMigrator: async () => {
    const migrationClient = postgres('postgres://postgres:postgres@localhost/postgres-db', {
      max: 1,
    })

    return drizzle(migrationClient)
  }, 

  // only needed if you want to use seed commands
  seed: { dirPath: './src/seeders', defaultSeeder: 'db-seeder' }
})

Usage

Generate migration

npm run drizzle-migrations generate --name <migration-name>

Run migrations

npm run drizzle-migrations up

Rollback migrations

npm run drizzle-migrations down

Rollback up to specific batch

npm run drizzle-migrations down --bach <batch-number>

Get status of migrations

npm run drizzle-migrations status

Rollback all migrations

npm run drizzle-migrations fresh

Rollback all migrations and run them again

npm run drizzle-migrations refresh

Create seeder

npm run drizzle-migrations seed:create --name <seeder-name>

Run seeders

npm run drizzle-migrations seed:run --name <seeder-name> // default seeder is db-seeder

Example of generated migration

import { sql } from 'drizzle-orm'
import type { MigrationArgs } from '@llong2195/drizzle-migrations'

export async function up({ db }: MigrationArgs<'postgresql'>): Promise<void> {
  await db.execute(sql`
        CREATE TABLE IF NOT EXISTS "posts" (
                "id" serial PRIMARY KEY NOT NULL,
                "title" varchar(255),
                "content" varchar,
                "user_id" integer
        );

        CREATE TABLE IF NOT EXISTS "users" (
                "id" serial PRIMARY KEY NOT NULL,
                "name" varchar,
                "slug" uuid
        );

        DO $$ BEGIN
        ALTER TABLE "posts" ADD CONSTRAINT "posts_user_id_users_id_fk" FOREIGN KEY ("user_id") REFERENCES "public"."users"("id") ON DELETE no action ON UPDATE no action;
        EXCEPTION
        WHEN duplicate_object THEN null;
        END $$;

        `)
}

export async function down({ db }: MigrationArgs<'postgresql'>): Promise<void> {
  await db.execute(sql`
        DROP TABLE "posts";
        DROP TABLE "users";
`)
}