***

title: "GenerateMigration"
generated: true
---------------

<GenerationInfo sourceFile="packages/core/src/migrate.ts" sourceLine="118" packageName="@vendure/core" />

Generates a new migration file based on any schema changes (e.g. adding or removing CustomFields).
See [TypeORM migration docs](https://typeorm.io/#/migrations) for more information about the
underlying migration mechanism.

```ts title="Signature"
function generateMigration(userConfig: Partial<VendureConfig>, options: MigrationOptions): Promise<string | undefined>
```

Parameters

### userConfig

\<MemberInfo kind="parameter" type={`Partial<<a href='/current/core/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>`} />

### options

\<MemberInfo kind="parameter" type={`<a href='/current/core/reference/typescript-api/migration/migration-options#migrationoptions'>MigrationOptions</a>`} />
