UpdateSchemaOptions <DatabaseSchema>

Options for ISchemaGenerator.update() to apply incremental schema changes.

Index

Properties

• dropDb
• dropTables
• fromSchema
• includeWildcardSchema
• safe
• schema
• wrap

Properties

optionaldropDb

dropDb?: boolean

optionaldropTables

dropTables?: boolean

optionalfromSchema

fromSchema?: DatabaseSchema

optionalincludeWildcardSchema

includeWildcardSchema?: boolean

When true, entities with a wildcard schema (schema: '*') are included in the diff so migrations can be generated for them. The emitted SQL is unqualified — and therefore safe to apply against any schema at runtime — only when neither options.schema nor config.schema is set; otherwise wildcard tables inherit that schema qualifier.

optionalsafe

safe?: boolean

optionalschema

schema?: string

optionalwrap

wrap?: boolean