MongoSchemaGenerator

Hierarchy

• AbstractSchemaGenerator<MongoDriver>
  • MongoSchemaGenerator

Index

Constructors

• constructor

Methods

• clearDatabase
• createDatabase
• createSchema
• dropDatabase
• dropIndexes
• dropSchema
• ensureDatabase
• ensureIndexes
• execute
• getCreateSchemaSQL
• getDropSchemaSQL
• getUpdateSchemaMigrationSQL
• getUpdateSchemaSQL
• refreshDatabase
• updateSchema
• register

Constructors

constructor

• new MongoSchemaGenerator(em: EntityManager<IDatabaseDriver<Connection>> | MongoDriver): MongoSchemaGenerator

• Inherited from AbstractSchemaGenerator.constructor

  Parameters

  • em: EntityManager<IDatabaseDriver<Connection>> | MongoDriver

  Returns MongoSchemaGenerator

Methods

clearDatabase

• clearDatabase(options?: ClearDatabaseOptions): Promise<void>

• Inherited from AbstractSchemaGenerator.clearDatabase

  Parameters

  • optionaloptions: ClearDatabaseOptions

  Returns Promise<void>

createDatabase

• createDatabase(name?: string): Promise<void>

• Inherited from AbstractSchemaGenerator.createDatabase

  creates new database and connects to it

  ---

  Parameters

  • optionalname: string

  Returns Promise<void>

createSchema

• createSchema(options?: MongoCreateSchemaOptions): Promise<void>

• Overrides AbstractSchemaGenerator.createSchema

  Parameters

  • options: MongoCreateSchemaOptions = {}

  Returns Promise<void>

dropDatabase

• dropDatabase(name?: string): Promise<void>

• Inherited from AbstractSchemaGenerator.dropDatabase

  Parameters

  • optionalname: string

  Returns Promise<void>

dropIndexes

• dropIndexes(options?: { collectionsWithFailedIndexes?: string[]; skipIndexes?: { collection: string; indexName: string }[] }): Promise<void>

• Parameters

  • optionaloptions: { collectionsWithFailedIndexes?: string[]; skipIndexes?: { collection: string; indexName: string }[] }

  Returns Promise<void>

dropSchema

• dropSchema(options?: { dropMigrationsTable?: boolean }): Promise<void>

• Overrides AbstractSchemaGenerator.dropSchema

  Parameters

  • options: { dropMigrationsTable?: boolean } = {}

  Returns Promise<void>

ensureDatabase

• ensureDatabase(): Promise<boolean>

• Overrides AbstractSchemaGenerator.ensureDatabase

  Returns true if the database was created.

  ---

  Returns Promise<boolean>

ensureIndexes

• ensureIndexes(options?: EnsureIndexesOptions): Promise<void>

• Overrides AbstractSchemaGenerator.ensureIndexes

  Parameters

  • options: EnsureIndexesOptions = {}

  Returns Promise<void>

execute

• execute(query: string): Promise<void>

• Inherited from AbstractSchemaGenerator.execute

  Parameters

  • query: string

  Returns Promise<void>

getCreateSchemaSQL

• getCreateSchemaSQL(options?: CreateSchemaOptions): Promise<string>

• Inherited from AbstractSchemaGenerator.getCreateSchemaSQL

  Parameters

  • optionaloptions: CreateSchemaOptions

  Returns Promise<string>

getDropSchemaSQL

• getDropSchemaSQL(options?: Omit<DropSchemaOptions, dropDb>): Promise<string>

• Inherited from AbstractSchemaGenerator.getDropSchemaSQL

  Parameters

  • optionaloptions: Omit<DropSchemaOptions, dropDb>

  Returns Promise<string>

getUpdateSchemaMigrationSQL

• getUpdateSchemaMigrationSQL(options?: UpdateSchemaOptions<unknown>): Promise<{ down: string; up: string }>

• Inherited from AbstractSchemaGenerator.getUpdateSchemaMigrationSQL

  Parameters

  • optionaloptions: UpdateSchemaOptions<unknown>

  Returns Promise<{ down: string; up: string }>

getUpdateSchemaSQL

• getUpdateSchemaSQL(options?: UpdateSchemaOptions<unknown>): Promise<string>

• Inherited from AbstractSchemaGenerator.getUpdateSchemaSQL

  Parameters

  • optionaloptions: UpdateSchemaOptions<unknown>

  Returns Promise<string>

refreshDatabase

• refreshDatabase(options?: MongoCreateSchemaOptions): Promise<void>

• Overrides AbstractSchemaGenerator.refreshDatabase

  Parameters

  • options: MongoCreateSchemaOptions = {}

  Returns Promise<void>

updateSchema

• updateSchema(options?: MongoCreateSchemaOptions): Promise<void>

• Overrides AbstractSchemaGenerator.updateSchema

  Parameters

  • options: MongoCreateSchemaOptions = {}

  Returns Promise<void>

staticregister

• register(orm: MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>): void

• Parameters

  • orm: MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

  Returns void