Class DB

Do database backup.

Start DB transaction. Note: From version 5.0.4 is async and returns Promise

Clears cache of data already read from DB.
It's useful when changing the DB externally or using executeQueryAsync
After calling app.db.clearCache() the MM5 internal cache is cleared and the data is reloaded from DB (e.g. when F5 is pressed or a view refreshed)
Note: Introduced in version 5.0.4

Example

// navigate to Music > All tracks
await app.db.executeQueryAsync("UPDATE Songs SET SongTitle = 'BlahBlah' WHERE ID = 1");
await app.db.clearCache();
uitools.refreshView(); // to reload the tracklist
Copy

Clears given tables in the database.

Commit DB transaction Note: From version 5.0.4 is async and returns Promise

Optimize database for faster access.

Executes SQL query.

Returns album for given album title, artist and year. Creates new, if not exists yet.

Gets album list by given SQL query

Gets artist list by given SQL query

Gets SQL of given auto-playlist ID
NOTE: Added in version 5.0.4

Since

5.0.4

Example

app.db.getAutoPlaylistQueryAsync( 1).then((sql) => {
   var trcklist = app.db.getTracklist(sql, -1);
   trcklist.whenLoaded().then(() => {
      // all tracks are loaded here
   });
});
Copy

Gets artist list from given JS array with artist names and MusicBrainz GID. JS array contains objects, with "name" and "mbgid" properties. It returns only artists, which are in Library.

Undocumented

Undocumented

Returns true if the database is locked (e.g. when doing DB optimizations, db rebuild, db backup etc.)

Get list of mood values.

Get list of occasion values.

Returns location of the current database file

Get list of "people", according to a specified category. Usage: app.db.getPeople({category: '<categoryname>'})

Example

var list = app.db.getPeople({category: 'artist'}); <br>
    <div data-control-class="Dropdown" data-init-params="{dbFunc: 'getPeople', dbFuncParams: {category: 'artist'}}">
Copy

Get list pinned objects (tracks, artists, albums etc.).

Undocumented

Get list of quality values.

Undocumented

Undocumented

Opens specified SQL query and returns promise with QueryResults class.

Get a list of strings, according to a specified category. Usage: app.db.getStringList({category: '<categoryname>'})

Example

var list = app.db.getStringList({category: 'genre'}); <br>
  <div data-control-class="Dropdown" data-init-params="{dbFunc: 'getStringList', dbFuncParams: {category: 'genre'}}">
Copy

Get list of tempo values.

Gets tracks based on given SQL and collection ID

Example

var trcklist = app.db.getTracklist('SELECT * FROM Songs', -1);
trcklist.whenLoaded().then(function () {
    // all tracks are loaded here
});
Copy

Executes SQL insert query and return promise with ID of a new record.

Undocumented

Undocumented

Reindex database.

Rebuilds database (copies and re-constructs tables), can fix malformed and databses

Undocumented

Do database restore.

Rollbacks DB transaction. Note: From version 5.0.4 is async and returns Promise

Undocumented

Undocumented