Database API: Management

listDatabases()

• Summary

  function listDatabases(): Promise<string[]>;

  Gets a list of all databases.

dropDatabase()

• Summary

  function dropDatabase(name: string): Promise<void>;

  Attempts to delete a database.

• Parameters

  • name — The name of the database to delete.

defineDatabase()

• Summary

  function defineDatabase<Schema>(options: DefineDatabaseOptions): DatabaseFactory;

  Defines a database.

• Parameters

  • options — The database definition options.
    • name — The name of the database.
    • migrations — An array of Migration function.
    • persist — Request that the user agent persist the database, even under storage pressure.

• Type Parameters

  • Schema — The definition of the object store schemas.

• Returns

  Returns a factory to create a connection to the Database.