Kodi uses SQLite, an open source light-weight SQL database-engine, to store all its library related data (Music, Video, and Program databases). By default, the database files (*.db) are stored in the Userdata folder, specifically in userdata/Database.
Performing certain actions on video files will also add content to the database even if it has not been scanned or scraped. For example if you change any OSD setting while watching it, this will be saved in the database as a preference. Resume points are also stored in this database for unscraped videos.
2 Using the Databases
Databasess are automatically maintained whenever you use Kodi. You can activate the most powerful database functionality by setting the Content property on all of your media sources, and using Kodi Library Mode. This view mode allows you to browse your media based on the details available in the databases, rather than using simple folder and filenames for details. You can read more about Library Mode for Music and Video files on their respective pages.
The following sections detail the database structure, tables, fields and their properties.
2.1 Building SQL Queries
SQLite queries can be incredibly powerful (and extraordinarily complicated). If you are not already familiar with SQL syntax, it would probably be a good idea to check out a general tutorial, such as this one.
For most Kodi development projects, you're going to be doing select statements. "Select" is a SQL command used to gather data (in the form of "rows") out of a SQL database. Your select statement will include:
- A list of all the data fields (columns in the database table) you want for each row.
- A list of all the tables you need to get information from
- A list of comparisons used to narrow down your results. This last component is optional, but it makes sure your results are relevant and is often used to link database entries across multiple tables.
Below are a few sample select statements, so you can see how it works.
This query grabs all of the information for every movie in the Video Library.
select * from movie
Note that "*" is used to indicate all fields. Also,there is no "where" clause in this statement, so it returns every row in the table.
This query narrows down the results to just those movies released in 2007.
select * from movie where c07 = 2007
Note that the column containing the movie's release year is labelled simply "c07." The tables further down this page help you find out which columns contain the information you're looking for.
This query example is more semantic. Lists your movies including, in this order, internal ID, internal file ID, rating, movie year, IMDB ID, movie name and movie plot.
select idMovie,idFile,c05,c07,c09,c00,c03,c02 from movie;
Now the following query is a bit more complex because it joins 3 movie-related tables (movie, files and path) to list a single useful view of your movies. In human language it lists movie ID, movie year, IMDB rating, IMDB ID, movie name and full path of the movie file, ordered by IMDB rating with highest rating appearing first:
select idMovie,c07,c05,c09,c00,path.strPath||files.strFilename from movie, files,path where movie.idFile=files.idFile and files.idPath=path.idPath order by c05 desc;
You could also use less than or greater than symbols to get newer or older movies.
This query gets just the path and filename of all of the video files from season two of Chuck.
If you're not familiar with SQL queries, this query probably looks pretty complicated. It serves as a good demonstration of why there are so many tables in the list below, and how to use them. Many of the elements of a TV show's path and filename and used repeatedly, so SQL allows us to save space and speed up our searches by storing each of those elements just once, in one place, and referencing them repeatedly by the same ID.
In this case, the root path that contains your video files is a long string that repeats at the beginning of many files. The name of a TV series, too, is repeated in every single episode of that series, so it makes the most sense to save the series name once (along with all information relevant to the series). We do that in the table tvshow, and every episode of the TV show can access all of that information using just the TV show's ID.
2.2 Accessing the Databases with Kodi Python
Many Python plugins (and some scripts) can use the information in the Kodi database to offer users additional convenience and functionality. The easiest way to access the databases via Kodi Python is using JSON RPC
Incorporated into the tables below are the related music metadata tags that are read from music files, and the NFO XML tags exported and imported by Kodi.
3 Database Versions
The following tables shows what database version is used for various Kodi versions. This can be useful to see what versions of Kodi can use MySQL sharing.
|v10 - Dharma||December 2010||37||7||1||1||1||N/A||N/A||N/A|
|v11 - Eden||March 2012||60||18||6||15||4||N/A||N/A||N/A|
|v12 - Frodo||January 2013||75||32||13||15||4||22||7||N/A|
|v13 - Gotham||May 2014||78||46||13||16||6||22||7||N/A|
|v14 - Helix||December 2014||90||48||13||16||6||26||8||N/A|
|v15 - Isengard||July 2015||93||52||13||19||6||29||10||N/A|
|v16 - Jarvis||February 2016||99||56||13||20||6||29||11||0|
|v17 - Krypton||February 2017||107||60||13||27||6||29||11||0|
|v18 - Leia||January 2019||116||72||13||27||6||32||12||0|
|v19 - Matrix||July 2019||116||72||13||27||6||34||12||0|
|Red||In development and subject to change without notice|
- http://www.rieter.net/content/xot/xbmc-database-versions/ - another site keeping track of Kodi DB changes
- https://github.com/xbmc/xbmc/commits/master/xbmc/video/VideoDatabase.cpp - Tracking the Video Database schema version
- https://github.com/xbmc/xbmc/commits/master/xbmc/music/MusicDatabase.cpp - Tracking the Music Database schema version
3.2 See also
|Return to top|