mirror of
https://github.com/ChuckPa/PlexDBRepair.git
synced 2025-11-05 18:58:53 -05:00
Add Deflate command
Deflate - Create new bandwidth_statistics table with proper schema. - Transfer only valid data from existing bandwidth statistics into new. - Drop old table. - Vacuum into new database. Merge Prune & Purge as one proper command Update ASUSTOR documentation error.
This commit is contained in:
ChuckPa
parent
dea8a805ce
commit
dc5fa1742b
239
DBRepair.sh
239
DBRepair.sh
@ -2,12 +2,12 @@
|
||||
#########################################################################
|
||||
# Database Repair Utility for Plex Media Server. #
|
||||
# Maintainer: ChuckPa #
|
||||
# Version: v1.11.09 #
|
||||
# Date: 31-Jul-2025 #
|
||||
# Version: v1.12.00 #
|
||||
# Date: 06-Oct-2025 #
|
||||
#########################################################################
|
||||
|
||||
# Version for display purposes
|
||||
Version="v1.11.09"
|
||||
Version="v1.12.00"
|
||||
|
||||
# Have the databases passed integrity checks
|
||||
CheckedDB=0
|
||||
@ -1405,6 +1405,179 @@ DoReplace() {
|
||||
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
|
||||
|
||||
# Continue
|
||||
DoUpdateTimestamp
|
||||
#Output "Backing up databases using timestamp: $TimeStamp"
|
||||
|
||||
# Make a backup
|
||||
if ! MakeBackups "Deflate"; then
|
||||
Output "Error making backups. Cannot continue."a
|
||||
WriteLog "Deflate - MakeBackups - FAIL"
|
||||
Fail=1
|
||||
return 1
|
||||
else
|
||||
WriteLog "Deflate - MakeBackups - PASS"
|
||||
fi
|
||||
|
||||
# Inform user
|
||||
Output "Starting Deflate. (There will be no output until complete.)"
|
||||
WriteLog "Deflate - Start Deflate - PASS"
|
||||
|
||||
# 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 "Reducing main database size."
|
||||
|
||||
"$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
|
||||
|
||||
Output "PMS main database deflate completed."
|
||||
|
||||
# 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
|
||||
#mv "$TMPDIR/$CPPL.blobs.db-DEFLATE-$TimeStamp" $CPPL.blobs.db
|
||||
|
||||
Output "Deflate complete. Please check your library settings and contents for completeness."
|
||||
|
||||
# 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"
|
||||
|
||||
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
|
||||
DoVacuum(){
|
||||
@ -1655,7 +1828,7 @@ DoStop(){
|
||||
else
|
||||
|
||||
if IsRunning; then
|
||||
Output "Stopping PMS."
|
||||
Output "Stopping PMS. (60 second max delay)"
|
||||
else
|
||||
Output "PMS already stopped."
|
||||
return 0
|
||||
@ -1672,7 +1845,7 @@ DoStop(){
|
||||
Count=10
|
||||
while IsRunning && [ $Count -gt 0 ]
|
||||
do
|
||||
sleep 3
|
||||
sleep 6
|
||||
Count=$((Count - 1))
|
||||
done
|
||||
|
||||
@ -1682,7 +1855,7 @@ DoStop(){
|
||||
return 0
|
||||
else
|
||||
WriteLog "Stop - FAIL (Timeout)"
|
||||
Output "Could not stop PMS. PMS did not shutdown within 30 second limit."
|
||||
Output "Could not stop PMS. PMS did not shutdown within 60 second limit."
|
||||
fi
|
||||
fi
|
||||
return $Result
|
||||
@ -2020,6 +2193,7 @@ do
|
||||
|
||||
echo ""
|
||||
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 1 ] && echo " 42 - 'honor' - Honor all database errors."
|
||||
|
||||
@ -2337,6 +2511,59 @@ 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
|
||||
30|coun*)
|
||||
|
||||
|
||||
@ -1,7 +1,9 @@
|
||||
Copyright (c) 2022, ChuckPa.
|
||||
Copyright (c) 2025, 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.
|
||||
This software is the intellectual property of ChuckPa
|
||||
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.
|
||||
38
README.md
38
README.md
@ -113,7 +113,7 @@ Enter command # -or- command name (4 char min) :
|
||||
-------------------+---------------------+------------------------------------------
|
||||
Apple | Downloads | ~/Downloads
|
||||
Arch Linux | N/A | Anywhere
|
||||
ASUSTOR | Public | /volume1/Public
|
||||
ASUSTOR | Plex | /volume1/Plex
|
||||
Binhex | N/A | Container root (adjacent /config)
|
||||
Docker (Plex,LSIO) | N/A | Container root (adjacent /config)
|
||||
Hotio | N/A | Container root (adjacent /config)
|
||||
@ -226,10 +226,9 @@ These examples
|
||||
3. (6) Reindex - Generate new indexes so PMS doesn't need to at startup
|
||||
4. (99) Exit
|
||||
|
||||
C. Database sizes excessively large when compared to amount of media indexed (item count)
|
||||
1. (3) Check - Make certain both databases are fully intact (repair if needed)
|
||||
2. (4) Vacuum - Instruct SQLite to rebuild its tables and recover unused space.
|
||||
3. (6) Reindex - Rebuild Indexes.
|
||||
C. Database sizes excessively large/bloated 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.
|
||||
2. (2) Auto - Perform automated check, repair, and reindex of the deflated database
|
||||
4. (99) Exit
|
||||
|
||||
D. User interface has become 'sluggish' as more media was added
|
||||
@ -348,7 +347,9 @@ Select
|
||||
11 - 'status' - Report status of PMS (run-state and databases).
|
||||
12 - 'undo' - Undo last successful command.
|
||||
|
||||
21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache.
|
||||
21 - 'prune' - Remove old image files (jpeg,jpg,png) from PhotoTranscoder cache & all temp files left by PMS.
|
||||
22 - 'purge' - Remove unused temp files.
|
||||
23 - 'deflate' - Deflate a bloated PMS main database.
|
||||
42 - 'ignore' - Ignore duplicate/constraint errors.
|
||||
|
||||
88 - 'update' - Check for updates.
|
||||
@ -376,7 +377,9 @@ Select
|
||||
11 - 'status' - Report status of PMS (run-state and databases).
|
||||
12 - 'undo' - Undo last successful command.
|
||||
|
||||
21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache.
|
||||
21 - 'prune' - Remove old image files (jpeg,jpg,png) from PhotoTranscoder cache & all temp files left by PMS.
|
||||
22 - 'purge' - Remove unused temp files.
|
||||
23 - 'deflate' - Deflate a bloated PMS main database.
|
||||
42 - 'ignore' - Ignore duplicate/constraint errors.
|
||||
|
||||
88 - 'update' - Check for updates.
|
||||
@ -430,7 +433,9 @@ Select
|
||||
11 - 'status' - Report status of PMS (run-state and databases).
|
||||
12 - 'undo' - Undo last successful command.
|
||||
|
||||
21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache.
|
||||
21 - 'prune' - Remove old image files (jpeg,jpg,png) from PhotoTranscoder cache & all temp files left by PMS.
|
||||
22 - 'purge' - Remove unused temp files.
|
||||
23 - 'deflate' - Deflate a bloated PMS main database.
|
||||
42 - 'ignore' - Ignore duplicate/constraint errors.
|
||||
|
||||
88 - 'update' - Check for updates.
|
||||
@ -458,7 +463,9 @@ Select
|
||||
11 - 'status' - Report status of PMS (run-state and databases).
|
||||
12 - 'undo' - Undo last successful command.
|
||||
|
||||
21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache.
|
||||
21 - 'prune' - Remove old image files (jpeg,jpg,png) from PhotoTranscoder cache & all temp files left by PMS.
|
||||
22 - 'purge' - Remove unused temp files.
|
||||
23 - 'deflate' - Deflate a bloated PMS main database.
|
||||
42 - 'ignore' - Ignore duplicate/constraint errors.
|
||||
|
||||
88 - 'update' - Check for updates.
|
||||
@ -489,7 +496,9 @@ Select
|
||||
11 - 'status' - Report status of PMS (run-state and databases).
|
||||
12 - 'undo' - Undo last successful command.
|
||||
|
||||
21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache.
|
||||
21 - 'prune' - Remove old image files (jpeg,jpg,png) from PhotoTranscoder cache & all temp files left by PMS.
|
||||
22 - 'purge' - Remove unused temp files.
|
||||
23 - 'deflate' - Deflate a bloated PMS main database.
|
||||
42 - 'ignore' - Ignore duplicate/constraint errors.
|
||||
|
||||
88 - 'update' - Check for updates.
|
||||
@ -636,6 +645,13 @@ root@lizum:/sata/plex/Plex Media Server/Plug-in Support/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
|
||||
|
||||
Exits the utility and removes all temporary database files created during processing.
|
||||
@ -935,6 +951,8 @@ Select
|
||||
|
||||
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.'
|
||||
23 - 'deflate' - Deflate a bloated PMS main database.
|
||||
|
||||
|
||||
42 - 'ignore' - Ignore duplicate/constraint errors.
|
||||
|
||||
|
||||
10
ReleaseNotes
10
ReleaseNotes
@ -8,9 +8,19 @@
|
||||
|
||||
|
||||
# Release Info:
|
||||
v1.12.00
|
||||
|
||||
1. Deflate capability - Deflate a bloated PMS main database and retain bandwidth statistics.
|
||||
Recommended usage: "Deflate" followed by "Auto" to optimize the DB after reduction.
|
||||
2. Purge/Prune merged - Purge and Prune commands have been merged. This was done because most
|
||||
folks will run both when cleaning up. This merge simplifies operation.
|
||||
Internally, the code will silently support both commands for a few more
|
||||
releases.
|
||||
|
||||
v1.11.09
|
||||
|
||||
1. HotIO Paths - Path defined for Cache dir (and PhotoTranscoder) incorrect. Fixed.
|
||||
|
||||
v1.11.08
|
||||
|
||||
1. Restart after update - Sometimes restart after update would reference the wrong path. Fixed.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user