Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.2 KB

generate-migration.md

File metadata and controls

32 lines (22 loc) · 1.2 KB
Raw
title isDefaultIndex generated
GenerateMigration
false
true

import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';

generateMigration

Generates a new migration file based on any schema changes (e.g. adding or removing CustomFields). See TypeORM migration docs for more information about the underlying migration mechanism.

function generateMigration(userConfig: Partial<VendureConfig>, options: MigrationOptions): Promise<string | undefined>

Parameters

userConfig

<MemberInfo kind="parameter" type={Partial&#60;<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>&#62;} />

options

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