CopyBot/PlexDBRepair
1
0
Fork 0
mirror of https://github.com/ChuckPa/PlexDBRepair.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: CopyBot:master
Branches Tags
CopyBot:master
CopyBot:v1.12.01
CopyBot:v1.12.00
CopyBot:v1.11.09
CopyBot:v1.11.08
CopyBot:v1.11.07
CopyBot:v1.11.06
CopyBot:v1.11.05
CopyBot:v1.11.04
CopyBot:v1.11.03
CopyBot:v1.11.02
CopyBot:v1.11.00
CopyBot:v1.10.05
CopyBot:v1.10.03
..
compare: CopyBot:v1.11.02
Branches Tags
CopyBot:master
CopyBot:v1.12.01
CopyBot:v1.12.00
CopyBot:v1.11.09
CopyBot:v1.11.08
CopyBot:v1.11.07
CopyBot:v1.11.06
CopyBot:v1.11.05
CopyBot:v1.11.04
CopyBot:v1.11.03
CopyBot:v1.11.02
CopyBot:v1.11.00
CopyBot:v1.10.05
CopyBot:v1.10.03

No commits in common. "master" and "v1.11.02" have entirely different histories.
master ... v1.11.02

7 changed files with 240 additions and 553 deletions
Show Stats Expand all files Collapse all files

415
DBRepair.sh
View File

@ -2,12 +2,12 @@
######################################################################### #########################################################################
# Database Repair Utility for Plex Media Server. # # Database Repair Utility for Plex Media Server. #
# Maintainer: ChuckPa # # Maintainer: ChuckPa #
# Version: v1.12.01 # # Version: v1.11.02 #
# Date: 21-Oct-2025 # # Date: 30-May-2025 #
######################################################################### #########################################################################
# Version for display purposes # Version for display purposes
Version="v1.12.01" Version="v1.11.02"
# Have the databases passed integrity checks # Have the databases passed integrity checks
CheckedDB=0 CheckedDB=0
@ -65,9 +65,6 @@ DFFLAGS="-m"
# If LC_ALL is null, default to C # If LC_ALL is null, default to C
[ "$LC_ALL" = "" ] && export LC_ALL=C [ "$LC_ALL" = "" ] && export LC_ALL=C
# Check Restart
[ "$DBRepairRestartedAfterUpdate" = "" ] && DBRepairRestartedAfterUpdate=0
# Universal output function # Universal output function
Output() { Output() {
if [ $Scripted -gt 0 ]; then if [ $Scripted -gt 0 ]; then
@ -377,7 +374,7 @@ GetOverride() {
# Determine which host we are running on and set variables # Determine which host we are running on and set variables
HostConfig() { HostConfig() {
# On all hosts except Mac/FreeBSD # On all hosts except Mac
PIDOF="pidof" PIDOF="pidof"
STATFMT="-c" STATFMT="-c"
STATBYTES="%s" STATBYTES="%s"
@ -626,66 +623,6 @@ HostConfig() {
HostType="Mac" HostType="Mac"
return 0 return 0
# FreeBSD 14+
elif [ -e /etc/os-release ] && [ "$(cat /etc/os-release | grep FreeBSD)" != "" ]; then
# Load functions for interacting with FreeBSD RC System
. /etc/rc.subr
# Find PMS
PLEXPKG=$(pkg info | grep plexmediaserver | awk '{print $1}')
if [ "x$PLEXPKG" != "x" ]; then # Plex ports package is installed
BsdRcFile=$(pkg list $PLEXPKG | grep "/usr/local/etc/rc.d")
BsdService=$(basename $BsdRcFile)
# FreeBSD Ports has two packages for Plex - determine which one is installed
BsdPlexPass="$(pkg info $PLEXPKG | grep ^Name | awk '{print $3}' | sed -e 's/plexmediaserver//')"
# Load FreeBSD RC configuration for Plex
load_rc_config $BsdService
# Use FreeBSD RC configuration to set paths
if [ "x$plexmediaserver_plexpass_support_path" != "x" ]; then
DBDIR="${plexmediaserver_plexpass_support_path}/Plex Media Server/Plug-in Support/Databases"
CACHEDIR="${plexmediaserver_plexpass_support_path}/Plex Media Server/Cache"
elif [ "x$plexmediaserver_support_path" != "x" ]; then
DBDIR="${plexmediaserver_support_path}/Plex Media Server/Plug-in Support/Databases"
CACHEDIR="${plexmediaserver_support_path}/Plex Media Server/Cache"
else
# System is using default Ports package configuration paths
DBDIR="/usr/local/plexdata${BsdPlexPass}/Plex Media Server/Plug-in Support/Databases"
CACHEDIR="/usr/local/plexdata${BsdPlexPass}/Plex Media Server/Cache"
fi
# Where is the software
AppSuppDir=$(dirname `pkg list $PLEXPKG | grep Plex_Media_Server`)
PLEX_SQLITE="${AppSuppDir}/Plex SQLite"
LOGFILE="$DBDIR/DBRepair.log"
LOG_TOOL="logger"
TMPDIR="/tmp"
SYSTMP="$TMPDIR"
else
Output "Plex Media Server FreeBSD PKG is not installed!"
Fail=1
return 1
fi
# FreeBSD uses pgrep and uses different stat options
PIDOF="pgrep"
STATFMT="-f"
STATBYTES="%z"
STATPERMS="%Lp"
# User 'plex' exists on FreeBSD, but the tool may not be run as that service account.
RootRequired=1
HaveStartStop=1
StartCommand="/usr/sbin/service ${BsdService} start"
StopCommand="/usr/sbin/service ${BsdService} stop"
HostType="FreeBSD"
return 0
# Western Digital (OS5) # Western Digital (OS5)
elif [ -f /etc/system.conf ] && [ -d /mnt/HD/HD_a2/Nas_Prog/plexmediaserver ] && \ elif [ -f /etc/system.conf ] && [ -d /mnt/HD/HD_a2/Nas_Prog/plexmediaserver ] && \
grep "Western Digital Corp" /etc/system.conf >/dev/null; then grep "Western Digital Corp" /etc/system.conf >/dev/null; then
@ -719,7 +656,7 @@ HostConfig() {
AppSuppDir="/config" AppSuppDir="/config"
PID_FILE="$AppSuppDir/plexmediaserver.pid" PID_FILE="$AppSuppDir/plexmediaserver.pid"
DBDIR="$AppSuppDir/Plug-in Support/Databases" DBDIR="$AppSuppDir/Plug-in Support/Databases"
CACHEDIR="$AppSuppDir/Cache/PhotoTranscoder" CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
LOGFILE="$DBDIR/DBRepair.log" LOGFILE="$DBDIR/DBRepair.log"
LOG_TOOL="logger" LOG_TOOL="logger"
@ -779,12 +716,6 @@ HostConfig() {
LOGFILE="$DBDIR/DBRepair.log" LOGFILE="$DBDIR/DBRepair.log"
LOG_TOOL="logger" LOG_TOOL="logger"
if grep rpcinterface /etc/supervisor.conf > /dev/null; then
HaveStartStop=1
StartCommand="supervisorctl start plexmediaserver"
StopCommand="supervisorctl stop plexmediaserver"
fi
HostType="BINHEX" HostType="BINHEX"
return 0 return 0
@ -1166,7 +1097,7 @@ DoRepair() {
[ -e $CPPL.blobs.db ] && mv $CPPL.blobs.db "$TMPDIR/$CPPL.blobs.db-BACKUP-$TimeStamp" [ -e $CPPL.blobs.db ] && mv $CPPL.blobs.db "$TMPDIR/$CPPL.blobs.db-BACKUP-$TimeStamp"
Output "Making repaired databases active" Output "Making repaired databases active"
WriteLog "Repair - Making repaired databases active" WriteLog "Making repaired databases active"
mv "$TMPDIR/$CPPL.db-REPAIR-$TimeStamp" $CPPL.db mv "$TMPDIR/$CPPL.db-REPAIR-$TimeStamp" $CPPL.db
mv "$TMPDIR/$CPPL.blobs.db-REPAIR-$TimeStamp" $CPPL.blobs.db mv "$TMPDIR/$CPPL.blobs.db-REPAIR-$TimeStamp" $CPPL.blobs.db
@ -1405,183 +1336,6 @@ DoReplace() {
fi fi
} }
##### Deflate
DoDeflate() {
Damaged=0
Fail=0
# Verify DBs are here
if [ ! -e $CPPL.db ]; then
Output "No main Plex database exists to deflate. Exiting."
WriteLog "Deflate - No main database - FAIL"
Fail=1
return 1
fi
# Check size
Size=$(stat $STATFMT $STATBYTES $CPPL.db)
# Exit if not valid
if [ $Size -lt 300000 ]; then
Output "Main database is too small/truncated, deflate is not possible. Please try restoring a backup. "
WriteLog "Deflate - Main databse too small - FAIL"
Fail=1
return 1
fi
# Calculate DBsize in GB
DBSize=$(( $Size / 1000000000 + 2 ))
# Continue
DoUpdateTimestamp
#Output "Backing up databases using timestamp: $TimeStamp"
# Make a backup
if ! MakeBackups "Deflate"; then
Output "Error making backups. Cannot continue."
WriteLog "Deflate - MakeBackups - FAIL"
Fail=1
return 1
else
WriteLog "Deflate - MakeBackups - PASS"
fi
# Inform user
Output "Starting Deflate (Part 1 of 2 - Repair database table)"
Output "Estimated completion is $((DBSize / 3)) minutes but is CPU & I/O speed dependent"
Output ""
WriteLog "Deflate - Start Deflate Pass 1"
# Library and blobs successfully exported, create new
"$PLEX_SQLITE" "$TMPDIR/$CPPL.db-BACKUP-$TimeStamp" << EOF
-- Exclusive DB access
BEGIN IMMEDIATE;
-- Create new table
CREATE TABLE temp_bandwidth (
id INTEGER PRIMARY KEY,
account_id INTEGER,
device_id INTEGER,
timespan INTEGER,
at INTEGER,
lan INTEGER,
bytes INTEGER
);
-- Copy good data to new table
INSERT INTO temp_bandwidth (
account_id, device_id, timespan, at, lan, bytes
)
SELECT account_id, device_id, timespan, at, COALESCE(lan, 0), bytes
FROM statistics_bandwidth WHERE account_id not null;
-- Swap new for old
DROP TABLE statistics_bandwidth;
ALTER TABLE temp_bandwidth RENAME TO statistics_bandwidth;
-- Create Indexes
CREATE INDEX IF NOT EXISTS index_statistics_bandwidth_on_at
ON statistics_bandwidth(at);
CREATE INDEX IF NOT EXISTS index_statistics_bandwidth_on_account_id_and_timespan_and_at
ON statistics_bandwidth(account_id, timespan, at);
-- Make it so
COMMIT;
EOF
Result=$?
if [ $Result -ne 0 ]; then
Output "Error: Could not correct statistics_bandwidth table (error $Result)"
Output " Please seek additional help"
WriteLog "Deflate: Error $Result during dodeflate."
Fail=1
return $Fail
fi
# Vacuum the DB to the new DB
Output "PMS main database successfully repaired."
Output "Starting Deflate (Part 2 of 2 - Reduce size)"
WriteLog "Deflate - Start Deflate Pass 2"
"$PLEX_SQLITE" "$TMPDIR/$CPPL.db-BACKUP-$TimeStamp" \
"VACUUM main into '$TMPDIR/$CPPL.db-DEFLATE-$TimeStamp'"
Result=$?
# Good result?
if [ $Result -eq 0 ]; then
Output "PMS main database size reduced."
WriteLog "Deflate - PMS main vacuum successful."
Output "Verifying PMS main database."
if CheckDB "$TMPDIR/$CPPL.db-DEFLATE-$TimeStamp" ; then
SizeStart=$(GetSize "$CPPL.db")
SizeFinish=$(GetSize "$TMPDIR/$CPPL.db-DEFLATE-$TimeStamp")
Output "Verification complete. PMS main database is OK."
Output "PMS main database reduced from $SizeStart MB to $SizeFinish MB"
WriteLog "Deflate - Verify main database - PASS (Size: ${SizeStart} MB / ${SizeFinish} MB."
else
Output "Verification complete. PMS main database import failed."
WriteLog "Deflate - Verify main database - FAIL ($SQLerror)"
Fail=1
fi
else
Output "Error: Error code $Result while vacuuming PMS main DB file."
Output " Please seek additional help."
return $Fail
fi
# If not failed, move files normally
if [ $Fail -eq 0 ]; then
Output "Saving current main database with '-BLOATED-$TimeStamp'"
[ -e $CPPL.db ] && mv $CPPL.db "$TMPDIR/$CPPL.db-BLOATED-$TimeStamp"
#[ -e $CPPL.blobs.db ] && mv $CPPL.blobs.db "$TMPDIR/$CPPL.blobs.db-BLOATED-$TimeStamp"
Output "Making deflated database active"
WriteLog "Deflate - Making deflated database active"
mv "$TMPDIR/$CPPL.db-DEFLATE-$TimeStamp" $CPPL.db
# Ensure WAL and SHM are gone
[ -e $CPPL.blobs.db-wal ] && rm -f $CPPL.blobs.db-wal
[ -e $CPPL.blobs.db-shm ] && rm -f $CPPL.blobs.db-shm
[ -e $CPPL.db-wal ] && rm -f $CPPL.db-wal
[ -e $CPPL.db-shm ] && rm -f $CPPL.db-shm
# Set ownership on new files
chmod $Perms $CPPL.db $CPPL.blobs.db
chown $Owner $CPPL.db $CPPL.blobs.db
Result=$?
if [ $Result -ne 0 ]; then
Output "ERROR: Cannot set permissions on new databases. Error $Result"
Output " Please exit tool, keeping temp files, seek assistance."
Output " Use files: $TMPDIR/*-DEFLATE-$TimeStamp"
WriteLog "Deflate - Move files - FAIL"
Fail=1
return 1
fi
# We didn't fail, set CheckedDB status true (passed above checks)
CheckedDB=1
WriteLog "Deflate - Move files - PASS"
WriteLog "Deflate - PASS"
Output "PMS main database deflate completed."
SetLast "Deflate" "$TimeStamp"
return 0
else
rm -f "$TMPDIR/$CPPL.db-REPAIR-$TimeStamp"
rm -f "$TMPDIR/$CPPL.blobs.db-REPAIR-$TimeStamp"
Output "Deflate has failed. No files changed"
WriteLog "Deflate - $TimeStamp - FAIL"
CheckedDB=0
return 1
fi
}
##### VACUUM ##### VACUUM
DoVacuum(){ DoVacuum(){
@ -1832,7 +1586,7 @@ DoStop(){
else else
if IsRunning; then if IsRunning; then
Output "Stopping PMS. (60 second max delay)" Output "Stopping PMS."
else else
Output "PMS already stopped." Output "PMS already stopped."
return 0 return 0
@ -1849,7 +1603,7 @@ DoStop(){
Count=10 Count=10
while IsRunning && [ $Count -gt 0 ] while IsRunning && [ $Count -gt 0 ]
do do
sleep 6 sleep 3
Count=$((Count - 1)) Count=$((Count - 1))
done done
@ -1859,7 +1613,7 @@ DoStop(){
return 0 return 0
else else
WriteLog "Stop - FAIL (Timeout)" WriteLog "Stop - FAIL (Timeout)"
Output "Could not stop PMS. PMS did not shutdown within 60 second limit." Output "Could not stop PMS. PMS did not shutdown within 30 second limit."
fi fi
fi fi
return $Result return $Result
@ -1984,6 +1738,60 @@ DoPrunePhotoTranscoder() {
} }
##### Special function
# Remove bloat records from PMS database on a full disk
DoDeflate() {
if IsRunning; then
Output "Please stop PMS first and try again."
return 1
fi
# Get into DBDIR
cd "$DBDIR"
# Run this loop until we get a partial block
Removed=100000000
Limit=100000000
TotalRemoved=0
# Turn it off
Result="$("$PLEX_SQLITE" "$CPPL.db" 'PRAGMA journal_mode = off;')"
InitialSize=$(stat $STATFMT $STATBYTES $CPPL.db)
SQL="PRAGMA journal_mode = off;"
SQL="$SQL Begin transaction; "
SQL="$SQL DELETE from statistics_bandwidth where rowid in ("
SQL="$SQL select rowid from statistics_bandwidth where account_id is null limit 100000000 );"
SQL="$SQL Commit;"
SQL="$SQL select changes();"
Count=1
while [ $Removed -eq $Limit ]
do
Output "Removing - block $Count"
Removed=$("$PLEX_SQLITE" "$CPPL.db" "$SQL" | tail -1)
TotalRemoved=$(($TotalRemoved + $Removed))
Count=$((Count+1))
done
Output "Removed $TotalRemoved records."
Output "Vacuuming DB to reclaim working space."
"$PLEX_SQLITE" "$CPPL.db" "vacuum;"
# Check size
Size=$(stat $STATFMT $STATBYTES $CPPL.db)
Output "Initial Database size = $((InitialSize / 1000000)) MB"
Output "Final Database size = $((Size / 1000000)) MB"
# Turn journal mode back on
Result="$("$PLEX_SQLITE" "$CPPL.db" "PRAGMA journal_mode = WAL;")"
}
############################################################# #############################################################
# Main utility begins here # # Main utility begins here #
############################################################# #############################################################
@ -2071,7 +1879,7 @@ Scripted=0
# Identify this host # Identify this host
if [ $ManualConfig -eq 0 ] && ! HostConfig; then if [ $ManualConfig -eq 0 ] && ! HostConfig; then
Output 'Error: Unknown host. Current supported hosts are: QNAP, Syno, Netgear, Mac, ASUSTOR, WD (OS5), Linux wkstn/svr, SNAP, FreeBSD 14+' Output 'Error: Unknown host. Current supported hosts are: QNAP, Syno, Netgear, Mac, ASUSTOR, WD (OS5), Linux wkstn/svr, SNAP'
Output ' Current supported container images: Plexinc, LinuxServer, HotIO, & BINHEX' Output ' Current supported container images: Plexinc, LinuxServer, HotIO, & BINHEX'
Output ' Manual host configuration is available in most use cases.' Output ' Manual host configuration is available in most use cases.'
Output ' ' Output ' '
@ -2194,16 +2002,18 @@ do
echo " 10 - 'show' - Show logfile." echo " 10 - 'show' - Show logfile."
echo " 11 - 'status' - Report status of PMS (run-state and databases)." echo " 11 - 'status' - Report status of PMS (run-state and databases)."
echo " 12 - 'undo' - Undo last successful command." echo " 12 - 'undo' - Undo last successful command."
echo "" echo ""
echo " 21 - 'prune' - Remove old image files from PhotoTranscoder cache & all temp files left by PMS." echo " 21 - 'prune' - Remove old image files (jpeg,jpg,png) from PhotoTranscoder cache & all temp files left by PMS."
echo " 23 - 'deflate' - Deflate a bloated PMS main database."
[ $IgnoreErrors -eq 0 ] && echo " 42 - 'ignore' - Ignore duplicate/constraint errors." [ $IgnoreErrors -eq 0 ] && echo " 42 - 'ignore' - Ignore duplicate/constraint errors."
[ $IgnoreErrors -eq 1 ] && echo " 42 - 'honor' - Honor all database errors." [ $IgnoreErrors -eq 1 ] && echo " 42 - 'honor' - Honor all database errors."
echo "" echo ""
echo " 88 - 'update' - Check for updates." echo " 88 - 'update' - Check for updates."
echo " 98 - 'quit' - Quit immediately. Keep all temporary files." echo " 98 - 'quit' - Quit immediately. Keep all temporary files."
echo " 99 - 'exit' - Exit with cleanup options." echo " 99 - 'exit' - Exit with cleanup options."
echo " "
echo "911 - 'deflate' - Deflate a bloated PMS database"
fi fi
if [ $Scripted -eq 0 ]; then if [ $Scripted -eq 0 ]; then
@ -2259,8 +2069,12 @@ do
# Automatic of all common operations # Automatic of all common operations
2|auto*) 2|auto*)
# Get current status
RunState=0
# Check if PMS running # Check if PMS running
if IsRunning; then if IsRunning; then
RunState=1
WriteLog "Auto - FAIL - PMS runnning" WriteLog "Auto - FAIL - PMS runnning"
Output "Unable to run automatic sequence. PMS is running. Please stop PlexMediaServer." Output "Unable to run automatic sequence. PMS is running. Please stop PlexMediaServer."
continue continue
@ -2286,7 +2100,6 @@ do
else else
WriteLog "Check - FAIL" WriteLog "Check - FAIL"
CheckedDB=0 CheckedDB=0
continue
fi fi
# Now Repair # Now Repair
@ -2514,59 +2327,6 @@ do
;; ;;
# Deflate the DB because Plex isn't doing a good job during scheduled tasks.
23|defl*)
# Check if PMS running
if IsRunning; then
WriteLog "Deflate - FAIL - PMS runnning"
Output "Unable to deflate. PMS is running. Please stop PlexMediaServer."
continue
fi
# Is there enough room to work
if ! FreeSpaceAvailable; then
WriteLog "Deflate - FAIL - Insufficient free space on $AppSuppDir"
Output "Error: Unable to deflate. Insufficient free space available on $AppSuppDir"
Output " Space needed = $SpaceNeeded MB, Space available = $SpaceAvailable MB"
continue
fi
# Start auto
Output "Check and Deflate started."
WriteLog "Deflate - START"
# Check the databases (forced)
Output ""
if CheckDatabases "Check " force ; then
WriteLog "Check - PASS"
CheckedDB=1
else
WriteLog "Check - FAIL"
CheckedDB=0
fi
# Now Deflate
Output ""
if ! DoDeflate; then
WriteLog "Deflate - FAIL"
CheckedDB=0
Output "Deflate failed. Please repair using Automatic mode."
continue
else
WriteLog "Deflate - PASS"
CheckedDB=1
fi
# All good to here
WriteLog "Deflate - PASS"
Output "Deflate successful."
Output "Recommend running "Auto" next to complete optimization of new database."
;;
# Records count # Records count
30|coun*) 30|coun*)
@ -2606,13 +2366,6 @@ do
88|upda*) 88|upda*)
# Don't update again after restarting after updating
if [ $DBRepairRestartedAfterUpdate -eq 1 ]; then
Output "Already updated. Continuing."
WriteLog "Update - Ignore Update request after updating."
continue
fi
DoUpdate=0 DoUpdate=0
Output "Checking for update" Output "Checking for update"
GetLatestRelease GetLatestRelease
@ -2634,15 +2387,8 @@ do
Result=$? Result=$?
if [ $Result -eq 0 ]; then if [ $Result -eq 0 ]; then
chmod +x "$ScriptWorkingDirectory/$ScriptName" chmod +x "$ScriptWorkingDirectory/$ScriptName"
if [ $Scripted -eq 0 ] && ConfirmYesNo "Restart and use $LatestVersion ?" ; then
WriteLog "Restarting after upgrade"
Output "Restarting"
export DBRepairRestartedAfterUpdate=1
exec "$ScriptWorkingDirectory/$ScriptName" "$*"
else
Output "Restart to launch updated DBRepair.sh ($LatestVersion)" Output "Restart to launch updated DBRepair.sh ($LatestVersion)"
WriteLog "Update - Updated to version $LatestVersion." WriteLog "Update - Updated to version $LatestVersion."
fi
exit 0 exit 0
else else
Output "Unable to download and update. Error $Result." Output "Unable to download and update. Error $Result."
@ -2696,6 +2442,21 @@ do
exit 0 exit 0
;; ;;
# Deflate
911|defl*)
Output "This command operates directly on your existing PMS DB."
Output "There are no backups however the DB is protected by transaction blocking."
Output "DO NOT INTERRUPT once started but you can if you must (It will resume where it left off)."
Output " "
if ! ConfirmYesNo "Ok to begin deflating the databases?" ; then
Output "No action taken."
WriteLog "Deflate - No action taken."
else
DoDeflate
fi
;;
# Unknown command # Unknown command
*) *)
WriteLog "Unknown command: '$Input'" WriteLog "Unknown command: '$Input'"

8
License.md
View File

@ -1,9 +1,7 @@
Copyright (c) 2025, ChuckPa. Copyright (c) 2022, ChuckPa.
This software is the intellectual property of ChuckPa Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use the Software for personal use only. The Software may not be modified, merged, published, distributed, sublicensed, and/or used in other form without the express written consent of the author.
and used in conjunction with Plex Media Server (which is Copyright & Trademark of Plex, Inc.)
It may not be copied, modified, or redistributed in any way without expressly written permission of ChuckPa.
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

196
README.md
View File

@ -31,7 +31,6 @@ If sufficient privleges exist (root), and supported by the environment, the opti
``` ```
AUTO(matic) - Automatically check, repair/optimize, and reindex the databases in one step. AUTO(matic) - Automatically check, repair/optimize, and reindex the databases in one step.
CHEC(k) - Check the main and blob databases integrity CHEC(k) - Check the main and blob databases integrity
DEFL(ate) - Deflate a bloated PMS database (faulty statistics data)
EXIT - Exit the utility EXIT - Exit the utility
IGNOre/HONOr - Ignore/Honor constraint errors when IMPORTing additional data into DB. IGNOre/HONOr - Ignore/Honor constraint errors when IMPORTing additional data into DB.
IMPO(rt) - Import viewstate / watch history from another database IMPO(rt) - Import viewstate / watch history from another database
@ -73,12 +72,11 @@ If sufficient privleges exist (root), and supported by the environment, the opti
21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache. 21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache.
22 - 'purge' - Purge (delete) all temporary files left behind by PMS & the transcoder. 22 - 'purge' - Purge (delete) all temporary files left behind by PMS & the transcoder.
23 - 'deflate' - Deflate a bloated PMS main database.
42 - 'ignore' - Ignore duplicate/constraint errors. 42 - 'ignore' - Ignore duplicate/constraint errors.
88 - 'update' - Check for updates. 88 - 'update' - Check for updates.
98 - 'quit' - Quit immediately. Keep all temporary files. 99 - 'quit' - Quit immediately. Keep all temporary files.
99 'exit' - Exit with cleanup options. 'exit' - Exit with cleanup options.
Enter command # -or- command name (4 char min) : Enter command # -or- command name (4 char min) :
@ -94,13 +92,12 @@ Enter command # -or- command name (4 char min) :
- BINHEX - BINHEX
- HOTIO - HOTIO
- Podman (libgpod) - Podman (libgpod)
4. FreeBSD (14+) 4. Linux workstation & server
5. Linux workstation & server 5. MacOS
6. MacOS 6. Netgear (OS5 Linux-based systems)
7. Netgear (OS5 Linux-based systems) 7. QNAP (QTS & QuTS)
8. QNAP (QTS & QuTS) 8. Synology (DSM 6 & DSM 7)
9. Synology (DSM 6 & DSM 7) 9. Western Digital (OS5)
10. Western Digital (OS5)
``` ```
# Installation # Installation
@ -115,11 +112,10 @@ Enter command # -or- command name (4 char min) :
-------------------+---------------------+------------------------------------------ -------------------+---------------------+------------------------------------------
Apple | Downloads | ~/Downloads Apple | Downloads | ~/Downloads
Arch Linux | N/A | Anywhere Arch Linux | N/A | Anywhere
ASUSTOR | Plex | /volume1/Plex ASUSTOR | Public | /volume1/Public
Binhex | N/A | Container root (adjacent /config) Binhex | N/A | Container root (adjacent /config)
Docker (Plex,LSIO) | N/A | Container root (adjacent /config) Docker (Plex,LSIO) | N/A | Container root (adjacent /config)
Hotio | N/A | Container root (adjacent /config) Hotio | N/A | Container root (adjacent /config)
FreeBSD (14+) | N/A | Anywhere
Kubernetes | N/A | Container root (adjacent /config) Kubernetes | N/A | Container root (adjacent /config)
Linux (wkstn/svr) | N/A | Anywhere Linux (wkstn/svr) | N/A | Anywhere
MacOS | N/A | Anywhere MacOS | N/A | Anywhere
@ -228,18 +224,19 @@ These examples
3. (6) Reindex - Generate new indexes so PMS doesn't need to at startup 3. (6) Reindex - Generate new indexes so PMS doesn't need to at startup
4. (99) Exit 4. (99) Exit
D. Database sizes excessively large/bloated when compared to amount of media indexed (item count) C. Database sizes excessively large when compared to amount of media indexed (item count)
1. (23) Deflate - Correct the known problem with a database table and recover the wasted space. 1. (3) Check - Make certain both databases are fully intact (repair if needed)
2. (2) Auto - Perform automated check, repair, and reindex of the deflated database 2. (4) Vacuum - Instruct SQLite to rebuild its tables and recover unused space.
3. (6) Reindex - Rebuild Indexes.
4. (99) Exit 4. (99) Exit
E. User interface has become 'sluggish' as more media was added D. User interface has become 'sluggish' as more media was added
1. (3) Check - Confirm there is no database damage 1. (3) Check - Confirm there is no database damage
2. (5) Repair - You are not really repairing. You are rebuilding the DB in perfect sorted order. 2. (5) Repair - You are not really repairing. You are rebuilding the DB in perfect sorted order.
3. (6) Reindex - Rebuild Indexes. 3. (6) Reindex - Rebuild Indexes.
4. (99) Exit 4. (99) Exit
F. Undo E. Undo
Undo is a special case where you need the utility to backup ONE step. Undo is a special case where you need the utility to backup ONE step.
This is rarely needed. The only time you might want/need to backup one step is if Replace leaves you worse off This is rarely needed. The only time you might want/need to backup one step is if Replace leaves you worse off
than you were before. In this case, UNDO then Repair. Undo can only undo the single most-recent action. than you were before. In this case, UNDO then Repair. Undo can only undo the single most-recent action.
@ -269,10 +266,14 @@ Attention:
-- This is for when DB operations keep getting worse and you don't know what to do. -- This is for when DB operations keep getting worse and you don't know what to do.
"99" is an old 'Get Smart' TV series reference where agent 99 would try to save agent 86 from harm. "99" is an old 'Get Smart' TV series reference where agent 99 would try to save agent 86 from harm.
Community feedback has resulted in: "99" was originally going to be "Quit immediately save all files" but development feedback
resulted in this configuration
"99" or "Exit" - Preferred way to exit and cleanup temp databases "Exit" is the preferred method to leave.
"98" or "Quit" - Get out now without deleting the temp databases (Usually used only during unexpected failures)
"Quit" was desired instead of "99" but there are those who didn't understand the difference or references.
If community feedback wants both "Quit. save temps" and "Exit, delete temps", behavior is easily changed.
Also please be aware the script understands interactive versus scripted mode. Also please be aware the script understands interactive versus scripted mode.
@ -349,14 +350,12 @@ Select
11 - 'status' - Report status of PMS (run-state and databases). 11 - 'status' - Report status of PMS (run-state and databases).
12 - 'undo' - Undo last successful command. 12 - 'undo' - Undo last successful command.
21 - 'prune' - Remove old image files (jpeg,jpg,png) from PhotoTranscoder cache & all temp files left by PMS. 21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache.
22 - 'purge' - Remove unused temp files.
23 - 'deflate' - Deflate a bloated PMS main database.
42 - 'ignore' - Ignore duplicate/constraint errors. 42 - 'ignore' - Ignore duplicate/constraint errors.
88 - 'update' - Check for updates. 88 - 'update' - Check for updates.
98 - 'quit' - Quit immediately. Keep all temporary files. 99 - 'quit' - Quit immediately. Keep all temporary files.
99 - 'exit' - Exit with cleanup options. 'exit' - Exit with cleanup options.
Enter command # -or- command name (4 char min) : 1 Enter command # -or- command name (4 char min) : 1
@ -379,14 +378,12 @@ Select
11 - 'status' - Report status of PMS (run-state and databases). 11 - 'status' - Report status of PMS (run-state and databases).
12 - 'undo' - Undo last successful command. 12 - 'undo' - Undo last successful command.
21 - 'prune' - Remove old image files (jpeg,jpg,png) from PhotoTranscoder cache & all temp files left by PMS. 21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache.
22 - 'purge' - Remove unused temp files.
23 - 'deflate' - Deflate a bloated PMS main database.
42 - 'ignore' - Ignore duplicate/constraint errors. 42 - 'ignore' - Ignore duplicate/constraint errors.
88 - 'update' - Check for updates. 88 - 'update' - Check for updates.
98 - 'quit' - Quit immediately. Keep all temporary files. 99 - 'quit' - Quit immediately. Keep all temporary files.
99 - 'exit' - Exit with cleanup options. 'exit' - Exit with cleanup options.
Enter command # -or- command name (4 char min) : auto Enter command # -or- command name (4 char min) : auto
@ -435,14 +432,12 @@ Select
11 - 'status' - Report status of PMS (run-state and databases). 11 - 'status' - Report status of PMS (run-state and databases).
12 - 'undo' - Undo last successful command. 12 - 'undo' - Undo last successful command.
21 - 'prune' - Remove old image files (jpeg,jpg,png) from PhotoTranscoder cache & all temp files left by PMS. 21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache.
22 - 'purge' - Remove unused temp files.
23 - 'deflate' - Deflate a bloated PMS main database.
42 - 'ignore' - Ignore duplicate/constraint errors. 42 - 'ignore' - Ignore duplicate/constraint errors.
88 - 'update' - Check for updates. 88 - 'update' - Check for updates.
98 - 'quit' - Quit immediately. Keep all temporary files. 99 - 'quit' - Quit immediately. Keep all temporary files.
99 - 'exit' - Exit with cleanup options. 'exit' - Exit with cleanup options.
Enter command # -or- command name (4 char min) : start Enter command # -or- command name (4 char min) : start
@ -465,14 +460,12 @@ Select
11 - 'status' - Report status of PMS (run-state and databases). 11 - 'status' - Report status of PMS (run-state and databases).
12 - 'undo' - Undo last successful command. 12 - 'undo' - Undo last successful command.
21 - 'prune' - Remove old image files (jpeg,jpg,png) from PhotoTranscoder cache & all temp files left by PMS. 21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache.
22 - 'purge' - Remove unused temp files.
23 - 'deflate' - Deflate a bloated PMS main database.
42 - 'ignore' - Ignore duplicate/constraint errors. 42 - 'ignore' - Ignore duplicate/constraint errors.
88 - 'update' - Check for updates. 88 - 'update' - Check for updates.
98 - 'quit' - Quit immediately. Keep all temporary files. 99 - 'quit' - Quit immediately. Keep all temporary files.
99 - 'exit' - Exit with cleanup options. 'exit' - Exit with cleanup options.
Enter command # -or- command name (4 char min) : stat Enter command # -or- command name (4 char min) : stat
@ -498,14 +491,12 @@ Select
11 - 'status' - Report status of PMS (run-state and databases). 11 - 'status' - Report status of PMS (run-state and databases).
12 - 'undo' - Undo last successful command. 12 - 'undo' - Undo last successful command.
21 - 'prune' - Remove old image files (jpeg,jpg,png) from PhotoTranscoder cache & all temp files left by PMS. 21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache.
22 - 'purge' - Remove unused temp files.
23 - 'deflate' - Deflate a bloated PMS main database.
42 - 'ignore' - Ignore duplicate/constraint errors. 42 - 'ignore' - Ignore duplicate/constraint errors.
88 - 'update' - Check for updates. 88 - 'update' - Check for updates.
98 - 'quit' - Quit immediately. Keep all temporary files. 99 - 'quit' - Quit immediately. Keep all temporary files.
99 - 'exit' - Exit with cleanup options. 'exit' - Exit with cleanup options.
Enter command # -or- command name (4 char min) : exit Enter command # -or- command name (4 char min) : exit
@ -647,13 +638,6 @@ root@lizum:/sata/plex/Plex Media Server/Plug-in Support/Databases#
Checks the integrity of the Plex main and blobs databases. Checks the integrity of the Plex main and blobs databases.
### Deflate
Repairs a known error in the PMS main database "statistics_bandwidth" table.
After repairing it, it purges all the errant data from the table (reducing DB size)
This task can take a significant amount of time. It's frequently used when the DB size is an order of magnitude above what it should be (e.g. 31 GB vs 206 MB). Reductions from 134 GB to 210 MB have been realized.
### Exit ### Exit
Exits the utility and removes all temporary database files created during processing. Exits the utility and removes all temporary database files created during processing.
@ -831,77 +815,55 @@ root@lizum:/sata/plex/Plex Media Server/Plug-in Support/Databases#
1. Remove the environment variable. 1. Remove the environment variable.
2. Run DBRepair again using "automatic". Your databases will revert to the host OS's default. 2. Run DBRepair again using "automatic". Your databases will revert to the host OS's default.
### Usage: (QNAP example shown) ### Usage: (Linux example shown)
``` ```
# export DBREPAIR_PAGESIZE=65534 # export DBREPAIR_PAGESIZE=65534
# ./DBRepair.sh stop deflate auto start exit # ./DBRepair.sh stop auto start exit
Database Repair Utility for Plex Media Server (QNAP) Database Repair Utility for Plex Media Server (Ubuntu 22.04.3 LTS)
Version v1.12.00 Version v1.03.01
[2025-10-21 16.54.00] PMS already stopped. [2024-01-14 17.25.35] Stopping PMS.
[2024-01-14 17.25.35] Stopped PMS.
[2025-10-21 16.54.00] Check and Deflate started. [2024-01-14 17.25.35] Automatic Check,Repair,Index started.
[2025-10-21 16.54.00] [2024-01-14 17.25.35]
[2025-10-21 16.54.00] Checking the PMS databases [2024-01-14 17.25.35] Checking the PMS databases
[2025-10-21 16.54.19] Check complete. PMS main database is OK. [2024-01-14 17.25.48] Check complete. PMS main database is OK.
[2025-10-21 16.54.21] Check complete. PMS blobs database is OK. [2024-01-14 17.25.48] Check complete. PMS blobs database is OK.
[2025-10-21 16.54.21] [2024-01-14 17.25.48]
[2025-10-21 16.54.21] Backup current databases with '-BACKUP-2025-10-21_16.54.21' timestamp. [2024-01-14 17.25.48] Exporting current databases using timestamp: 2024-01-14_17.25.35
[2025-10-21 16.56.29] Starting Deflate (Part 1 of 2 - Repair database table) [2024-01-14 17.25.48] Exporting Main DB
[2025-10-21 16.56.29] Estimated completion is approx 6 minutes but is CPU & I/O speed dependent [2024-01-14 17.25.59] Exporting Blobs DB
[2025-10-21 16.56.29] [2024-01-14 17.26.00] Successfully exported the main and blobs databases. Proceeding to import into new databases.
[2025-10-21 16.56.30] PMS main database successfully repaired. [2024-01-14 17.26.00] Importing Main DB.
[2025-10-21 16.56.30] Starting Deflate (Part 2 of 2 - Reduce size) [2024-01-14 17.26.00] Setting Plex SQLite page size (65536)
[2025-10-21 16.56.35] PMS main database size reduced. [2024-01-14 17.26.29] Importing Blobs DB.
[2025-10-21 16.56.35] Verifying PMS main database. [2024-01-14 17.26.29] Setting Plex SQLite page size (65536)
[2025-10-21 16.56.50] Verification complete. PMS main database is OK. [2024-01-14 17.26.30] Successfully imported databases.
[2025-10-21 16.56.50] PMS main database reduced from 31586 MB to 206 MB [2024-01-14 17.26.30] Verifying databases integrity after importing.
[2025-10-21 16.56.51] Saving current main database with '-BLOATED-2025-10-21_16.54.21' [2024-01-14 17.27.43] Verification complete. PMS main database is OK.
[2025-10-21 16.56.51] Making deflated database active [2024-01-14 17.27.43] Verification complete. PMS blobs database is OK.
[2025-10-21 16.56.51] PMS main database deflate completed. [2024-01-14 17.27.43] Saving current databases with '-BACKUP-2024-01-14_17.25.35'
[2025-10-21 16.56.51] Deflate successful. [2024-01-14 17.27.43] Making repaired databases active
[2025-10-21 16.56.51] Recommend running Auto next to complete optimization of new database. [2024-01-14 17.27.43] Repair complete. Please check your library settings and contents for completeness.
[2024-01-14 17.27.43] Recommend: Scan Files and Refresh all metadata for each library section.
[2024-01-14 17.27.43]
[2024-01-14 17.27.43] Backing up of databases
[2024-01-14 17.27.43] Backup current databases with '-BACKUP-2024-01-14_17.27.43' timestamp.
[2024-01-14 17.27.44] Reindexing main database
[2024-01-14 17.28.08] Reindexing main database successful.
[2024-01-14 17.28.08] Reindexing blobs database
[2024-01-14 17.28.08] Reindexing blobs database successful.
[2024-01-14 17.28.08] Reindex complete.
[2024-01-14 17.28.08] Automatic Check, Repair/optimize, & Index successful.
[2025-10-21 16.56.51] Automatic Check,Repair,Index started. [2024-01-14 17.28.08] Starting PMS.
[2025-10-21 16.56.51] [2024-01-14 17.28.08] Started PMS
[2025-10-21 16.56.51] Checking the PMS databases
[2025-10-21 16.57.04] Check complete. PMS main database is OK.
[2025-10-21 16.57.05] Check complete. PMS blobs database is OK.
[2025-10-21 16.57.05]
[2025-10-21 16.57.05] Exporting current databases using timestamp: 2025-10-21_16.56.51
[2025-10-21 16.57.05] Exporting Main DB
[2025-10-21 16.57.24] Exporting Blobs DB
[2025-10-21 16.59.18] Successfully exported the main and blobs databases.
[2025-10-21 16.59.18] Start importing into new databases.
[2025-10-21 16.59.18] Importing Main DB.
[2025-10-21 16.59.18] Setting Plex SQLite page size (65536)
[2025-10-21 17.00.19] Importing Blobs DB.
[2025-10-21 17.00.19] Setting Plex SQLite page size (65536)
[2025-10-21 17.00.32] Successfully imported databases.
[2025-10-21 17.00.32] Verifying databases integrity after importing.
[2025-10-21 17.01.59] Verification complete. PMS main database is OK.
[2025-10-21 17.02.01] Verification complete. PMS blobs database is OK.
[2025-10-21 17.02.01] Saving current databases with '-BACKUP-2025-10-21_16.56.51'
[2025-10-21 17.02.01] Making repaired databases active
[2025-10-21 17.02.01] Repair complete. Please check your library settings and contents for completeness.
[2025-10-21 17.02.01] Recommend: Scan Files and Refresh all metadata for each library section.
[2025-10-21 17.02.01]
[2025-10-21 17.02.01] Backing up of databases
[2025-10-21 17.02.01] Backup current databases with '-BACKUP-2025-10-21_17.02.01' timestamp.
[2025-10-21 17.02.02] Reindexing main database
[2025-10-21 17.02.13] Reindexing main database successful.
[2025-10-21 17.02.13] Reindexing blobs database
[2025-10-21 17.02.14] Reindexing blobs database successful.
[2025-10-21 17.02.14] Reindex complete.
[2025-10-21 17.02.14] Automatic Check, Repair/optimize, & Index successful.
[2025-10-21 17.02.14] Starting PMS.
[2025-10-21 17.02.14] Started PMS
# #
``` ```
@ -975,14 +937,12 @@ Select
21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache older than specific age. 21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache older than specific age.
22 - 'purge' - Purge (remove) all temporary files left by PMS & Transcoder in Temp Dir.' 22 - 'purge' - Purge (remove) all temporary files left by PMS & Transcoder in Temp Dir.'
23 - 'deflate' - Deflate a bloated PMS main database.
42 - 'ignore' - Ignore duplicate/constraint errors. 42 - 'ignore' - Ignore duplicate/constraint errors.
88 - 'update' - Check for updates. 88 - 'update' - Check for updates.
98 - 'quit' - Quit immediately. Keep all temporary files. 99 - 'quit' - Quit immediately. Keep all temporary files.
99 - 'exit' - Exit with cleanup options. 'exit' - Exit with cleanup options.
Enter command # -or- command name (4 char min) : Enter command # -or- command name (4 char min) :
``` ```

46
ReleaseNotes
View File

@ -8,45 +8,25 @@
![Maintenance](https://img.shields.io/badge/Maintained-Yes-green.svg) ![Maintenance](https://img.shields.io/badge/Maintained-Yes-green.svg)
# Release Info: # Release Info:
v1.12.00 v1.11.02 - Special release
1. Deflate capability - Deflate a bloated PMS main database and retain bandwidth statistics. 1. Database bloat - (Enh) A better method was found to handle bloat processing.
Recommended usage: "Deflate" followed by "Auto" to optimize the DB after reduction. This new method works on SSD/HDDs where the disk is full and PMS can't run.
- Method changed to reconstruction of bandwidth table versus selective copy. There is no free space required to perform this task.
This results in correct operation of bandwidth statistics functionality
as well as significantly improved performance.
2. ASUSTOR - Documentation error README.md corrected Each "block" being removed is 100 million records.
The CPU will have one core maxed at 100% for the duration.
Before & after info will be printed after final cleanup is finished.
v1.11.09 New command name: Deflate ( # 911 )
1. HotIO Paths - Path defined for Cache dir (and PhotoTranscoder) incorrect. Fixed. v1.11.01
v1.11.08 1. Database bloat - (New) Database bloat processing now surrounded by TRANSACTION/COMMIT to speed processing.
2. Space Needed - (Fix) Handle cases where "Databases" directory is not on the same volume as AppSuppDir.
1. Restart after update - Sometimes restart after update would reference the wrong path. Fixed. 3. Menu options - (New) Add option 98 = quit. Rename 99 = exit.
4. Reporting - (Fix) When insufficient space available, Now print out how much is needed
v1.11.07
1. Add support FreeBSD - Add support for FreeBSD (14+)
Thanks to @cdf-eagles for the work.
v1.11.06
1. Restart after update - Correct missing variable initialization.
v1.11.05
1. Remove menu option - Deflate menu option wasn't previously removed. Now removed.
v1.11.04
1. Binhex start/stop - Add support for stopping and starting PMS in Binhex containers.
2. Restart after update - Add option to restart after live updating.
3. Remove temp Deflate - Remove deflate function as of PMS 1.41.8 availability
v1.11.01 - v1.11.03 - Temporary versions to assist PMS database bloat issue.
v1.11.00 v1.11.00

10
Windows/DBRepair-Windows.bat
View File

@ -12,7 +12,7 @@ setlocal enabledelayedexpansion
echo. echo.
echo NOTE: This script is being replaced with the PowerShell script DBRepair-Windows.ps1, echo NOTE: This script is being replaced with the PowerShell script DBRepair-Windows.ps1,
echo which aims to better emulate DBRepair.sh (more options, interactive mode, etc). echo which aims to better emulate DBRepair.sh (more options, interative mode, etc).
echo Consider moving over to the new script. echo Consider moving over to the new script.
echo. echo.
@ -135,8 +135,8 @@ del "%TmpFile%"
echo %time% -- Main DB verification check is: %Result% echo %time% -- Main DB verification check is: %Result%
echo %time% -- Main DB verification check is: %Result% >> "%PlexData%\DBRepair.log" echo %time% -- Main DB verification check is: %Result% >> "%PlexData%\DBRepair.log"
if not "%Result%" == "ok" ( if not "%Result%" == "ok" (
echo %time% -- ERROR: Main DB verification failed. Exiting. echo %time% -- ERROR: Main DB verificaion failed. Exiting.
echo %time% -- ERROR: Main DB verification failed. Exiting. >> "%PlexData%\DBRepair.log" echo %time% -- ERROR: Main DB verificaion failed. Exiting. >> "%PlexData%\DBRepair.log"
exit /B 4 exit /B 4
) )
echo %time% -- Main DB verification successful. echo %time% -- Main DB verification successful.
@ -161,8 +161,8 @@ del "%TmpFile%"
echo %time% -- Blobs DB verification check is: %Result% echo %time% -- Blobs DB verification check is: %Result%
echo %time% -- Blobs DB verification check is: %Result% >> "%PlexData%\DBRepair.log" echo %time% -- Blobs DB verification check is: %Result% >> "%PlexData%\DBRepair.log"
if not "%Result%" == "ok" ( if not "%Result%" == "ok" (
echo %time% -- ERROR: Blobs DB verification failed. Exiting. echo %time% -- ERROR: Blobs DB verificaion failed. Exiting.
echo %time% -- ERROR: Blobs DB verification failed. Exiting. >> "%PlexData%\DBRepair.log" echo %time% -- ERROR: Blobs DB verificaion failed. Exiting. >> "%PlexData%\DBRepair.log"
exit /B 6 exit /B 6
) )
echo %time% -- Blobs DB verification successful. echo %time% -- Blobs DB verification successful.

107
Windows/DBRepair-Windows.ps1
View File

@ -3,7 +3,7 @@
# # # #
######################################################################### #########################################################################
$DBRepairVersion = 'v1.01.02' $DBRepairVersion = 'v1.01.01'
class DBRepair { class DBRepair {
[DBRepairOptions] $Options [DBRepairOptions] $Options
@ -14,10 +14,7 @@ class DBRepair {
[string] $Timestamp # Timestamp used for temporary database files [string] $Timestamp # Timestamp used for temporary database files
[string] $LogFile # Path of our log file [string] $LogFile # Path of our log file
[string] $Version # Current script version [string] $Version # Current script version
[string] $Stage # Current stage of the script (e.g. "Auto", "Prune", etc.)
[bool] $IsError # Whether we're currently in an error state [bool] $IsError # Whether we're currently in an error state
[string] $MainDB = "com.plexapp.plugins.library.db"
[string] $BlobsDB = "com.plexapp.plugins.library.blobs.db"
DBRepair($Arguments, $Version) { DBRepair($Arguments, $Version) {
$this.Options = [DBRepairOptions]::new() $this.Options = [DBRepairOptions]::new()
@ -88,8 +85,8 @@ class DBRepair {
Write-Host " 42 - 'ignore' - Ignore duplicate/constraint errors." Write-Host " 42 - 'ignore' - Ignore duplicate/constraint errors."
} }
Write-Host Write-Host
Write-Host " 98 - 'quit' - Quit immediately. Keep all temporary files." Write-Host " 99 - 'quit' - Quit immediately. Keep all temporary files."
Write-Host " 99 'exit' - Exit with cleanup options." Write-Host " 'exit' - Exit with cleanup options."
Write-Host Write-Host
Write-Host " 'menu x' - Show this menu in interactive mode, where x is on/off/yes/no" Write-Host " 'menu x' - Show this menu in interactive mode, where x is on/off/yes/no"
} }
@ -193,14 +190,10 @@ class DBRepair {
switch -Regex ($Choice) { switch -Regex ($Choice) {
"^(1|stop)$" { $this.DoStop() } "^(1|stop)$" { $this.DoStop() }
"^(2|autom?a?t?i?c?)$" { "^(2|autom?a?t?i?c?)$" {
$this.SetStage("Auto")
$this.IsError = !$this.RunAutomaticDatabaseMaintenance() $this.IsError = !$this.RunAutomaticDatabaseMaintenance()
} }
"^(7|start?)$" { $this.StartPMS() } "^(7|start?)$" { $this.StartPMS() }
"^(21|(prune?|remov?e?))$" { "^(21|(prune?|remov?e?))$" { $this.PrunePhotoTranscoderCache() }
$this.SetStage("Prune")
$this.PrunePhotoTranscoderCache()
}
"^(42|ignor?e?|honor?)$" { "^(42|ignor?e?|honor?)$" {
if (($this.Options.IgnoreErrors -and ($Choice[0] -eq 'i')) -or (!$this.Options.IgnoreErrors -and ($Choice[0] -eq 'h'))) { if (($this.Options.IgnoreErrors -and ($Choice[0] -eq 'i')) -or (!$this.Options.IgnoreErrors -and ($Choice[0] -eq 'h'))) {
Write-Host "Honor/Ignore setting unchanged." Write-Host "Honor/Ignore setting unchanged."
@ -211,13 +204,13 @@ class DBRepair {
$msg = if ($this.Options.IgnoreErrors) { "Ignoring database errors." } else { "Honoring database errors." } $msg = if ($this.Options.IgnoreErrors) { "Ignoring database errors." } else { "Honoring database errors." }
$this.WriteOutputLog($msg) $this.WriteOutputLog($msg)
} }
"^(98|quit)$" { "^(99|quit)$" {
$this.Output("Retaining all temporary work files.") $this.Output("Retaining all remporary work files.")
$this.WriteLog("Exit - Retain temp files.") $this.WriteLog("Exit - Retain temp files.")
$this.WriteEnd() $this.WriteEnd()
return return
} }
"^(99|exit)$" { "^exit$" {
if ($EOFExit) { if ($EOFExit) {
$this.Output("Unexpected exit command. Keeping all temporary work files.") $this.Output("Unexpected exit command. Keeping all temporary work files.")
$this.WriteLog("EOFExit - Retain temp files.") $this.WriteLog("EOFExit - Retain temp files.")
@ -314,10 +307,10 @@ class DBRepair {
# All-in-one database utility - Repair/Check/Reindex # All-in-one database utility - Repair/Check/Reindex
[bool] RunAutomaticDatabaseMaintenance() { [bool] RunAutomaticDatabaseMaintenance() {
$this.Output("Automatic Check,Repair,Index started.") $this.Output("Automatic Check,Repair,Index started.")
$this.WriteLog($this.StageLog("START")) $this.WriteLog("Auto - START")
if ($this.PMSRunning()) { if ($this.PMSRunning()) {
$this.WriteLog($this.StageLog("FAIL - PMS running")) $this.WriteLog("Auto - FAIL - PMS running")
$this.OutputWarn("Unable to run automatic sequence. PMS is running. Please stop PlexMediaServer.") $this.OutputWarn("Unable to run automatic sequence. PMS is running. Please stop PlexMediaServer.")
return $false return $false
} }
@ -333,38 +326,48 @@ class DBRepair {
} }
} }
$MainDBName = "com.plexapp.plugins.library.db"
$MainDB = Join-Path $this.PlexDBDir -ChildPath $MainDBName
# Temporary DB actions
$this.WriteOutputLog("Performing DB cleanup tasks.")
$ignoreErrorsSaved = $this.Options.IgnoreErrors # This isn't a critical task, allow it to fail without stopping the script
$this.Options.IgnoreErrors = $true
$this.RunSqlCommand("""$MainDB"" ""DELETE from statistics_bandwidth WHERE account_id IS NULL;""", "Failed to clean up statistics_bandwidth table.")
$this.Options.IgnoreErrors = $ignoreErrorsSaved
$this.Output("Exporting Main DB") $this.Output("Exporting Main DB")
$MainDBPath = Join-Path $this.PlexDBDir -ChildPath $this.MainDB
$MainDBSQL = Join-Path $DBTemp -ChildPath "library.sql_$($this.TimeStamp)" $MainDBSQL = Join-Path $DBTemp -ChildPath "library.sql_$($this.TimeStamp)"
if (!$this.FileExists($MainDBPath)) { if (!$this.FileExists($MainDB)) {
$this.ExitDBMaintenance("Could not find $($this.MainDB) in database directory", $false) $this.ExitDBMaintenance("Could not find $MainDBName in database directory", $false)
return $false return $false
} }
if (!$this.ExportPlexDB($MainDBPath, $MainDBSQL)) { return $false } if (!$this.ExportPlexDB($MainDB, $MainDBSQL)) { return $false }
$this.Output("Exporting Blobs DB") $this.Output("Exporting Blobs DB")
$BlobsDBPath = Join-Path $this.PlexDBDir -ChildPath $this.BlobsDB $BlobsDBName = "com.plexapp.plugins.library.blobs.db"
$BlobsDB = Join-Path $this.PlexDBDir -ChildPath $BlobsDBName
$BlobsDBSQL = Join-Path $DBTemp -ChildPath "blobs.sql_$($this.Timestamp)" $BlobsDBSQL = Join-Path $DBTemp -ChildPath "blobs.sql_$($this.Timestamp)"
if (!$this.FileExists($BlobsDBPath)) { if (!$this.FileExists($BlobsDB)) {
$this.ExitDBMaintenance("Could not find $($this.BlobsDB) in database directory", $false) $this.ExitDBMaintenance("Could not find $BlobsDBName in database directory", $false)
return $false return $false
} }
if (!$this.ExportPlexDB($BlobsDBPath, $BlobsDBSQL)) { return $false } if (!$this.ExportPlexDB($BlobsDB, $BlobsDBSQL)) { return $false }
$this.Output("Successfully exported the main and blobs databases. Proceeding to import into new database.") $this.Output("Successfully exported the main and blobs databases. Proceeding to import into new database.")
$this.WriteLog("Repair - Export databases - PASS") $this.WriteLog("Repair - Export databases - PASS")
# Make sure Plex hasn't been started while we were exporting # Make sure Plex hasn't been started while we were exporting
if (!$this.CheckPMS("export")) { return $false } if (!$this.CheckPMS("Auto ", "export")) { return $false }
$this.Output("Importing Main DB.") $this.Output("Importing Main DB.")
$MainDBImport = Join-Path $this.PlexDBDir -ChildPath "$($this.MainDB)_$($this.Timestamp)" $MainDBImport = Join-Path $this.PlexDBDir -ChildPath "${MainDBName}_$($this.Timestamp)"
if (!$this.ImportPlexDB($MainDBSQL, $MainDBImport)) { return $false } if (!$this.ImportPlexDB($MainDBSQL, $MainDBImport)) { return $false }
$this.Output("Importing Blobs DB.") $this.Output("Importing Blobs DB.")
$BlobsDBImport = Join-Path $this.PlexDBDir -ChildPath "$($this.BlobsDB)_$($this.Timestamp)" $BlobsDBImport = Join-Path $this.PlexDBDir -ChildPath "${BlobsDBName}_$($this.Timestamp)"
if (!$this.ImportPlexDB($BlobsDBSQL, $BlobsDBImport)) { return $false } if (!$this.ImportPlexDB($BlobsDBSQL, $BlobsDBImport)) { return $false }
$this.Output("Successfully imported databases.") $this.Output("Successfully imported databases.")
@ -380,7 +383,7 @@ class DBRepair {
$this.Output("Verification complete. PMS blobs database is OK.") $this.Output("Verification complete. PMS blobs database is OK.")
$this.WriteLog("Repair - Verify blobs database - PASS") $this.WriteLog("Repair - Verify blobs database - PASS")
if (!$this.CheckPMS("import")) { return $false } if (!$this.CheckPMS("Auto ", "import")) { return $false }
# Import complete, now reindex # Import complete, now reindex
$this.WriteOutputLog("Reindexing Main DB") $this.WriteOutputLog("Reindexing Main DB")
@ -390,14 +393,14 @@ class DBRepair {
$this.WriteOutputLog("Reindexing complete.") $this.WriteOutputLog("Reindexing complete.")
$this.WriteOutputLog("Moving current DBs to DBTMP and making new databases active") $this.WriteOutputLog("Moving current DBs to DBTMP and making new databases active")
if (!$this.CheckPMS("new database copy")) { return $false } if (!$this.CheckPMS("Auto ", "new database copy")) { return $false }
try { try {
$this.MoveDatabase($MainDBPath, (Join-Path $DBTemp -ChildPath "$($this.MainDB)_$($this.Timestamp)"), "move Main DB to DBTMP") $this.MoveDatabase($MainDB, (Join-Path $DBTemp -ChildPath "${MainDBName}_$($this.Timestamp)"), "move Main DB to DBTMP")
$this.MoveDatabase($MainDBImport, $MainDBPath, "replace Main DB with rebuilt DB") $this.MoveDatabase($MainDBImport, $MainDB, "replace Main DB with rebuilt DB")
$this.MoveDatabase($BlobsDBPath, (Join-Path $DBTemp -ChildPath "$($this.BlobsDB)_$($this.Timestamp)"), "move Blobs DB to DBTMP") $this.MoveDatabase($BlobsDB, (Join-Path $DBTemp -ChildPath "${BlobsDBName}_$($this.Timestamp)"), "move Blobs DB to DBTMP")
$this.MoveDatabase($BlobsDBImport, $BlobsDBPath, "replace Blobs DB with rebuilt DB") $this.MoveDatabase($BlobsDBImport, $BlobsDB, "replace Blobs DB with rebuilt DB")
} catch { } catch {
$Error.Clear() $Error.Clear()
return $false return $false
@ -408,11 +411,11 @@ class DBRepair {
} }
# Return whether we can continue DB repair (i.e. whether PMS is running) at the given stage in the process. # Return whether we can continue DB repair (i.e. whether PMS is running) at the given stage in the process.
[bool] CheckPMS([string] $SubStage) { [bool] CheckPMS([string] $Stage, [string] $SubStage) {
if ($this.PMSRunning()) { if ($this.PMSRunning()) {
$SubMessage = if ($SubStage) { "during $SubStage" } else { "" } $SubMessage = if ($SubStage) { "during $SubStage" } else { "" }
$this.WriteLog($this.StageLog("FAIL - PMS running $SubMessage")) $this.WriteLog("$Stage - FAIL - PMS running $SubMessage")
$this.OutputWarn("Unable to run $($this.Stage.TrimEnd()). PMS is running. Please stop PlexMediaServer.") $this.OutputWarn("Unable to run $Stage. PMS is running. Please stop PlexMediaServer.")
return $false return $false
} }
@ -432,10 +435,10 @@ class DBRepair {
# Attempts to prune PhotoTranscoder images that are older than the specified date cutoff (30 days by default) # Attempts to prune PhotoTranscoder images that are older than the specified date cutoff (30 days by default)
[void] PrunePhotoTranscoderCache() { [void] PrunePhotoTranscoderCache() {
$this.WriteLog($this.StageLog("START")) $this.WriteLog("Prune - START")
if ($this.PMSRunning()) { if ($this.PMSRunning()) {
$this.OutputWarn("Unable to prune Phototranscoder cache. PMS is running.") $this.OutputWarn("Unable to prune Phototranscoder cache. PMS is running.")
$this.WriteLog($this.StageLog("FAIL - PMS running")) $this.WriteLog("Prune - FAIL - PMS running")
return return
} }
@ -449,7 +452,7 @@ class DBRepair {
if ($Prunable -eq 0) { if ($Prunable -eq 0) {
$this.Output("No files found to prune.") $this.Output("No files found to prune.")
$this.WriteLog($this.StageLog("PASS (no files found to prune)")) $this.WriteLog("Prune - PASS (no files found to prune)")
return return
} }
@ -462,13 +465,13 @@ class DBRepair {
$Pruned = $PruneResult.PrunableFiles $Pruned = $PruneResult.PrunableFiles
$Total = $PruneResult.TotalFiles $Total = $PruneResult.TotalFiles
$Saved = $PruneResult.SpaceSavings $Saved = $PruneResult.SpaceSavings
$this.WriteOutputLog($this.StageLog("Removed $Pruned files over $Cutoff days old ($Saved), out of $Total total files")) $this.WriteOutputLog("Prune - Removed $Pruned files over $Cutoff days old ($Saved), out of $Total total files")
$this.Output("Pruning completed.") $this.Output("Pruning completed.")
} else { } else {
$this.WriteOutputLog($this.StageLog("Prune cancelled by user")) $this.WriteOutputLog("Prune - Prune cancelled by user")
} }
$this.WriteLog($this.StageLog("PASS")) $this.WriteLog("Prune - PASS")
} }
# Traverses PhotoTranscoder cache to find and delete files older than the specified max age. # Traverses PhotoTranscoder cache to find and delete files older than the specified max age.
@ -541,16 +544,6 @@ class DBRepair {
$this.WriteLog("============================================================") $this.WriteLog("============================================================")
} }
# Set the current stage (with the right amount of padding)
[void] SetStage([string] $Stage) {
$this.Stage = $Stage + (" " * [math]::Max(0, 8 - $Stage.Length))
}
# Prepend the current stage to the given text
[string] StageLog([string] $text) {
return "$($this.Stage) - $text"
}
### File Helpers ### ### File Helpers ###
# Check whether the given directory exists (and is a directory) # Check whether the given directory exists (and is a directory)
@ -573,7 +566,7 @@ class DBRepair {
### Setup Helpers ### ### Setup Helpers ###
# Retrieve Plex's data directory, exiting the script on failure # Retrieve Plex's data directory, exiting the script on falure
[string] GetAppDataDir() { [string] GetAppDataDir() {
$PMSRegistry = $this.GetHKCU() $PMSRegistry = $this.GetHKCU()
$PlexAppData = $PMSRegistry.LocalAppDataPath $PlexAppData = $PMSRegistry.LocalAppDataPath
@ -688,11 +681,11 @@ class DBRepair {
[void] ExitDBMaintenance([string] $Message, [boolean] $Success) { [void] ExitDBMaintenance([string] $Message, [boolean] $Success) {
if ($Success) { if ($Success) {
$this.Output("Automatic Check,Repair,Index succeeded.") $this.Output("Automatic Check,Repair,Index succeeded.")
$this.WriteLog($this.StageLog("PASS")) $this.WriteLog("Auto - PASS")
} else { } else {
$this.OutputWarn("Database maintenance failed - $Message") $this.OutputWarn("Automatic maintenance failed - $Message")
$this.WriteLog($this.StageLog("$Message, cannot continue.")) $this.WriteLog("Auto - $Message, cannot continue.")
$this.WriteLog($this.StageLog("FAIL")) $this.WriteLog("Auto - FAIL")
} }
} }

5
Windows/ReleaseNotes-Windows
View File

@ -4,11 +4,6 @@ Release notes for the Windows counterpart to DBRepair.sh (DBRepair-Windows.ps1)
# Release Info # Release Info
v1.01.02
- Remove `statistics_bandwidth` pruning, as it's now part of PMS 1.41.8
- Change `quit` to 98 and `exit` to 99
- Minor logging refactoring
v1.01.01 v1.01.01
- Add `staticstics_bandwidth` pruning during automatic repair. - Add `staticstics_bandwidth` pruning during automatic repair.