3aa7199503
- Add Activepieces fork with SmoothSchedule custom piece - Create integrations app with Activepieces service layer - Add embed token endpoint for iframe integration - Create Automations page with embedded workflow builder - Add sidebar visibility fix for embed mode - Add list inactive customers endpoint to Public API - Include SmoothSchedule triggers: event created/updated/cancelled - Include SmoothSchedule actions: create/update/cancel events, list resources/services/customers 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
99 lines
3.2 KiB
Plaintext
99 lines
3.2 KiB
Plaintext
---
|
|
title: "Database Migrations"
|
|
description: "Guide for creating database migrations in Activepieces"
|
|
icon: "database"
|
|
---
|
|
|
|
Activepieces uses TypeORM as its database driver in Node.js. We support two database types across different editions of our platform.
|
|
|
|
The database migration files contain both what to do to migrate (up method) and what to do when rolling back (down method).
|
|
|
|
<Tip>
|
|
Read more about TypeORM migrations here:
|
|
https://orkhan.gitbook.io/typeorm/docs/migrations
|
|
</Tip>
|
|
|
|
## Database Support
|
|
|
|
- PostgreSQL
|
|
- PGlite
|
|
|
|
<Tip>
|
|
**Why Do we have PGlite?**
|
|
We support PGlite to simplify development and self-hosting. It's particularly helpful for:
|
|
|
|
- Developers creating pieces who want a quick setup
|
|
- Self-hosters using platforms to manage docker images but doesn't support docker compose.
|
|
|
|
PGlite is a lightweight PostgreSQL implementation that runs embedded, so migrations are compatible with PostgreSQL.
|
|
</Tip>
|
|
|
|
## Editions
|
|
|
|
- **Enterprise & Cloud Edition** (Must use PostgreSQL)
|
|
- **Community Edition** (Can use PostgreSQL or PGlite)
|
|
|
|
### How To Generate
|
|
|
|
<Steps>
|
|
<Step title="Setup AP_DB_TYPE">
|
|
Set the `AP_DB_TYPE` environment variable to `POSTGRES` after making sure have latest state by running Activepieces first.
|
|
</Step>
|
|
|
|
<Step title="Generate Migration">
|
|
Run the migration generation command:
|
|
```bash
|
|
nx db-migration server-api --name=<MIGRATION_NAME>
|
|
```
|
|
Replace `<MIGRATION_NAME>` with a descriptive name for your migration.
|
|
</Step>
|
|
|
|
<Step title="Review Migration File">
|
|
The command will generate a new migration file in `packages/server/api/src/app/database/migration/postgres/`.
|
|
|
|
Review the generated file and register it in `postgres-connection.ts`.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## PGlite Compatibility
|
|
|
|
While PGlite is mostly PostgreSQL-compatible, some features are not supported. When using features like `CONCURRENTLY` for index operations, you need to conditionally handle PGlite:
|
|
|
|
```typescript
|
|
import { AppSystemProp } from '@activepieces/server-shared'
|
|
import { MigrationInterface, QueryRunner } from 'typeorm'
|
|
import { DatabaseType, system } from '../../../helper/system/system'
|
|
|
|
const databaseType = system.get(AppSystemProp.DB_TYPE)
|
|
const isPGlite = databaseType === DatabaseType.PGLITE
|
|
|
|
export class AddMyIndex1234567890 implements MigrationInterface {
|
|
name = 'AddMyIndex1234567890'
|
|
transaction = false // Required when using CONCURRENTLY
|
|
|
|
public async up(queryRunner: QueryRunner): Promise<void> {
|
|
if (isPGlite) {
|
|
await queryRunner.query(`CREATE INDEX "idx_name" ON "table" ("column")`)
|
|
} else {
|
|
await queryRunner.query(`CREATE INDEX CONCURRENTLY "idx_name" ON "table" ("column")`)
|
|
}
|
|
}
|
|
|
|
public async down(queryRunner: QueryRunner): Promise<void> {
|
|
if (isPGlite) {
|
|
await queryRunner.query(`DROP INDEX "idx_name"`)
|
|
} else {
|
|
await queryRunner.query(`DROP INDEX CONCURRENTLY "idx_name"`)
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
<Warning>
|
|
`CREATE INDEX CONCURRENTLY` and `DROP INDEX CONCURRENTLY` are not supported in PGlite because PGLite is a single user/connection database. Always add a check for PGlite when using these operations.
|
|
</Warning>
|
|
|
|
<Tip>
|
|
Always test your migrations by running them both up and down to ensure they work as expected.
|
|
</Tip>
|