Class DreamBin

Index

Constructors

Methods

dbCreate dbDrop dbEnsureAllMigrationsHaveBeenRun dbMigrate dbRollback generateDream generateMigration generateStiChild sync

Constructors

constructor

new DreamBin(): DreamBin
Returns DreamBin

Methods

`Static`dbCreate

dbCreate(): Promise<void>
Returns Promise<void>
- Defined in src/bin/index.ts:26

`Static`dbDrop

dbDrop(): Promise<void>
Returns Promise<void>
- Defined in src/bin/index.ts:33

`Static`dbEnsureAllMigrationsHaveBeenRun

dbEnsureAllMigrationsHaveBeenRun(): Promise<void>
Returns Promise<void>
- Defined in src/bin/index.ts:40

`Static`dbMigrate

dbMigrate(): Promise<void>
Returns Promise<void>
- Defined in src/bin/index.ts:47

`Static`dbRollback

dbRollback(opts: { steps: number }): Promise<void>
Parameters
- opts: { steps: number }
Returns Promise<void>
- Defined in src/bin/index.ts:54

`Static`generateDream

generateDream(
    fullyQualifiedModelName: string,
    columnsWithTypes: string[],
    options: {
        adminSerializers?: boolean;
        connectionName: string;
        internalSerializers?: boolean;
        modelName?: string;
        serializer: boolean;
        softDelete?: boolean;
        stiBaseSerializer: boolean;
        tableName?: string;
    },
): Promise<void>
Parameters
- fullyQualifiedModelName: string
- columnsWithTypes: string[]
- options: {
      adminSerializers?: boolean;
      connectionName: string;
      internalSerializers?: boolean;
      modelName?: string;
      serializer: boolean;
      softDelete?: boolean;
      stiBaseSerializer: boolean;
      tableName?: string;
  }
Returns Promise<void>
- Defined in src/bin/index.ts:61

`Static`generateMigration

generateMigration(
    migrationName: string,
    columnsWithTypes: string[],
    connectionName: string,
): Promise<void>
Parameters
- migrationName: string
- columnsWithTypes: string[]
- connectionName: string
Returns Promise<void>
- Defined in src/bin/index.ts:123

`Static`generateStiChild

generateStiChild(
    fullyQualifiedModelName: string,
    fullyQualifiedParentName: string,
    columnsWithTypes: string[],
    options: {
        adminSerializers?: boolean;
        connectionName?: string;
        internalSerializers?: boolean;
        modelName?: string;
        serializer: boolean;
    },
): Promise<void>
Parameters
- fullyQualifiedModelName: string
- fullyQualifiedParentName: string
- columnsWithTypes: string[]
- options: {
      adminSerializers?: boolean;
      connectionName?: string;
      internalSerializers?: boolean;
      modelName?: string;
      serializer: boolean;
  }
  - OptionaladminSerializers?: boolean
  - OptionalconnectionName?: string
    The connection whose migrations folder receives the child's migration. Defaults to the parent model's connection, which is the connection the child uses; the parent must then be one of the app's models, or this throws before any file is written.
  - OptionalinternalSerializers?: boolean
  - OptionalmodelName?: string
  - serializer: boolean
Returns Promise<void>
- Defined in src/bin/index.ts:86

`Static`sync

sync(
onSync: () => void | Promise<void>,
options?: { schemaOnly?: boolean },
): Promise<void>
Parameters
- onSync: () => void | Promise<void>
- Optionaloptions: { schemaOnly?: boolean }
Returns Promise<void>
- Defined in src/bin/index.ts:10