Options
All
  • Public
  • Public/Protected
  • All
Menu

Module dbinit

Database initializer.

Functions

clearConnection

  • clearConnection(dbm: default): Promise<void>
  • Switch to using the database connection pool.

    Parameters

    • dbm: default

      The database manager.

    Returns Promise<void>

default

  • default(dbm: default, prune?: boolean): Promise<void>
  • Initialize the database.

    Parameters

    • dbm: default

      The database manager.

    • prune: boolean = true

    Returns Promise<void>

initMeta

  • initMeta(dbm: default): Promise<void>
  • Initialize values in the meta table.

    Parameters

    • dbm: default

      The database manager.

    Returns Promise<void>

populateTable

  • populateTable(dbm: default, table: string, column: string, values: any[], other?: boolean, otherID?: number): Promise<void>
  • Populate a static table.

    Parameters

    • dbm: default

      The database manager.

    • table: string

      Table name.

    • column: string

      Column name.

    • values: any[]

      Values to be inserted into the table.

    • other: boolean = false

      Whether or not to insert the "Other" option into the table.

    • otherID: number = 1000

      ID of the "Other" option, if it is set to true.

    Returns Promise<void>

useConnection

  • useConnection(dbm: default): Promise<void>
  • Switch to using a single database connection.

    Parameters

    • dbm: default

      The database manager.

    Returns Promise<void>

Generated using TypeDoc