Class DatabaseCommands

Counts the number of songs and their total playtime in the database that match exactly. filter is either a filter expression as described here or an array of tuples containing a tag and the value that it should match. Note that tags are case sensitive and that the MPD documentation incorrectly lists all tags as lower-case. Use mpc.reflection.tagTypes() to get the correct list of tags supported by MPD.

Counts the number of songs and their total playtime in the database that match exactly. filter is either a filter expression as described here or an array of tuples containing a tag and the value that it should match. The results are grouped by tag groupingTag (e.g. 'Artist', 'Album', 'Date', 'Genre') Note that tags are case sensitive and that the MPD documentation incorrectly lists all tags as lower-case. Use mpc.reflection.tagTypes() to get the correct list of tags supported by MPD.

Finds songs in the database that match exactly. start and end can be used to query only a portion of the real response. sort sorts the result by the specified tag. The sort is descending if the tag is prefixed with a minus (‘-‘). Without sort, the order is undefined. Only the first tag value will be used, if multiple of the same type exist. To sort by “Artist”, “Album” or “AlbumArtist”, you should specify “ArtistSort”, “AlbumSort” or “AlbumArtistSort” instead. These will automatically fall back to the former if “*Sort” doesn’t exist. “AlbumArtist” falls back to just “Artist”. The type “Last-Modified” can sort by file modification time. filter is either a filter expression as described here or an array of tuples containing a tag or one of the special parameters listed below and the value that it should match. Supported special parameters are:

• 'any' checks all tag values
• 'file' checks the full path (relative to the music directory)
• 'base' restricts the search to songs in the given directory (also relative to the music directory)
• 'modified-since' compares the file's time stamp with the given value (ISO 8601 or UNIX time stamp) Note that tags are case sensitive and that the MPD documentation incorrectly lists all tags as lower-case. Use mpc.reflection.tagTypes() to get the correct list of tags supported by MPD.

Finds songs in the database that match exactly and adds them to the current playlist. Parameters have the same meaning as for find().

Lists unique tags values of the specified type. type can be any tag supported by MPD or 'file', but 'file' is deprecated. filter specifies a filter like the one in find(). groupingTags may be used to group the results by one or more tags. Note that tags are case sensitive and that the MPD documentation incorrectly lists all tags as lower-case. Use mpc.reflection.tagTypes() to get the correct list of tags supported by MPD.

Lists all songs and directories in uri recursively. Do not use this command to manage a client-side copy of MPD's database. That is fragile and adds huge overhead. It will break with large databases. Instead, query MPD whenever you need something.

Same as listAll(), except it also returns metadata info. Do not use this command to manage a client-side copy of MPD's database. That is fragile and adds huge overhead. It will break with large databases. Instead, query MPD whenever you need something.

Lists the contents of the directory uri, including files are not recognized by MPD. uri can be a path relative to the music directory or an URI understood by one of the storage plugins. For example, "smb://SERVER" returns a list of all shares on the given SMB/CIFS server; "nfs://servername/path" obtains a directory listing from the NFS server.

Lists the contents of the directory uri. When listing the root directory, this currently returns the list of stored playlists. This behavior is deprecated; use listPlaylists() instead. This command may be used to list metadata of remote files (e.g. uri beginning with "http://" or "smb://"). Clients that are connected via UNIX domain socket may use this command to read the tags of an arbitrary local file (uri is an absolute path).

Read "comments" (i.e. key-value pairs) from the file specified by uri. This uri can be a path relative to the music directory or an absolute path. This command may be used to list metadata of remote files (e.g. uri beginning with "http://" or "smb://"). Comments with suspicious characters (e.g. newlines) are ignored silently. The meaning of these depends on the codec, and not all decoder plugins support it. For example, on Ogg files, this lists the Vorbis comments.

Same as update(), but also rescans unmodified files.

Searches for any song that matches. Parameters have the same meaning as for find(), except that the search is a case insensitive substring search.

Searches for any song that matches and adds them to the current playlist. Parameters have the same meaning as for find(), except that the search is a case insensitive substring search.

Searches for any song that matches and adds them to the playlist named name. If a playlist by that name doesn't exist it is created. Parameters have the same meaning as for find(), except that the search is a case insensitive substring search.

Updates the music database: find new files, remove deleted files, update modified files. uri is a particular directory or song/file to update. If you do not specify it, everything is updated. Returns a positive number identifying the update job. You can read the current job id in the status response.