Class default`Abstract`

Index

Constructors

Methods

afterUpSuccess? createCollection createCollections createIndex defer dropCollection dropIndex execUp up

Constructors

constructor

new default(): default
Returns default

Methods

`Optional`afterUpSuccess

afterUpSuccess(): unknown
Returns unknown
- Defined in adonis-typings/migration.ts:35

createCollection

createCollection(collectionName: string): void
Parameters
- collectionName: string
Returns void
- Defined in adonis-typings/migration.ts:20

createCollections

createCollections(collectionNames: string[]): void
Parameters
- collectionNames: string[]
Returns void
- Defined in adonis-typings/migration.ts:11

createIndex

createIndex(
    collectionName: string,
    index: IndexSpecification,
    options?: Omit<CreateIndexesOptions, "session">,
): void
Parameters
- collectionName: string
- index: IndexSpecification
- Optionaloptions: Omit<CreateIndexesOptions, "session">
Returns void
- Defined in adonis-typings/migration.ts:21

defer

defer(callback: (db: Db, client: ClientSession) => Promise<void>): void
Parameters
- callback: (db: Db, client: ClientSession) => Promise<void>
Returns void
- Defined in adonis-typings/migration.ts:31

dropCollection

dropCollection(collectionName: string): void
Drop a collection. This operation will be done last in the migration. It cannot be run in a transaction, so we recommend doing it in a separate migration file.
Parameters
- collectionName: string
Returns void
- Defined in adonis-typings/migration.ts:19

dropIndex

dropIndex(
    collectionName: string,
    indexName: string,
    options?: Omit<CommandOperationOptions, "session">,
): void
Parameters
- collectionName: string
- indexName: string
- Optionaloptions: Omit<CommandOperationOptions, "session">
Returns void
- Defined in adonis-typings/migration.ts:26

execUp

execUp(session: ClientSession): Promise<void>
Parameters
- session: ClientSession
Returns Promise<void>
- Defined in adonis-typings/migration.ts:36

`Abstract`up

up(): void
Returns void
- Defined in adonis-typings/migration.ts:34