migrations

Under the hood, Psychic leverages kysely to run our migrations. Whenever a new model is generated, a migration is automatically generated to pair with the model, as we have seen for the User model generated in the authentication example:

import { Kysely, sql } from 'kysely'

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export async function up(db: Kysely<any>): Promise<void> {
  await db.schema
    .createType('user_roles_enum')
    .asEnum([
      'App',
      'Admin'
    ])
    .execute()

  await db.schema
    .createTable('users')
    .addColumn('id', 'bigserial', col => col.primaryKey())
    .addColumn('email', 'varchar(255)')
    .addColumn('password_digest', 'varchar(255)')
    .addColumn('user_role', sql`user_roles_enum`)
    .addColumn('created_at', 'timestamp', col => col.notNull())
    .addColumn('updated_at', 'timestamp', col => col.notNull())
    .execute()
}

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export async function down(db: Kysely<any>): Promise<void> {
  await db.schema.dropTable('users').execute()
  await db.schema.dropType('user_roles_enum').execute()
}

To run this migration, we can use the migrate cli command, like so:

NODE_ENV=development yarn psy db:migrate
NODE_ENV=test yarn psy db:migrate

Along with migrations, Psychic provides additional cli commands for governing migrations:

NODE_ENV=test yarn psy db:drop
NODE_ENV=test yarn psy db:create
NODE_ENV=test yarn psy db:migrate
NODE_ENV=test yarn psy db:rollback
NODE_ENV=test yarn psy db:reset # drop, create, migrate