scripts/cleanup_digikamdb/cleanup_digikamdb.1

0001 .\" -*- coding: us-ascii -*-
0002 .if \n(.g .ds T< \\FC
0003 .if \n(.g .ds T> \\F[\n[.fam]]
0004 .de URL
0005 \\$2 \(la\\$1\(ra\\$3
0006 ..
0007 .if \n(.g .mso www.tmac
0008 .TH cleanup_digikamdb 1 "24 October 2011" cleanup_digikamdb ""
0009 .SH NAME
0010 cleanup_digikamdb \- Cleanup the digiKam databases to reduce their sizes and increase access speed
0011 .SH SYNOPSIS
0012 'nh
0013 .fi
0014 .ad l
0015 \fBcleanup_digikamdb\fR \kx
0016 .if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
0017 'in \n(.iu+\nxu
0018 [-t] [-T] [-p] [-h]
0019 'in \n(.iu-\nxu
0020 .ad b
0021 'hy
0022 .SH OPTIONS
0023 .TP
0024 \*(T<\fB\-t\fR\*(T>
0025 Include thumbnail databases.
0026 .TP
0027 \*(T<\fB\-T\fR\*(T>
0028 Only cleanup thumbnail databases.
0029 .TP
0030 \*(T<\fB\-p \fR\*(T>\*(T<\fB\fIpath\fR\fR\*(T>\*(T<\fB \fR\*(T>
0031 Specify a different database \fIpath\fR.
0032 If this option is not set or the specified \fIpath\fR is invalid, the entry from the configuration file will be used.
0033 .TP
0034 \*(T<\fB\-h\fR\*(T>
0035 Show command line options.
0036 .SH DESCRIPTION
0037 \fBcleanup_digikamdb\fR will cleanup and optimize the digiKam database file.
0038 This will, in most cases, lead to a smaller database file size and an increased access speed, because unneeded elements are removed from the database and data is optimized.
0039 .PP
0040 The program will make sure that no instance of digiKam is running, because it is more safe to have no database access during
0041 the optimization process. It then will read the digiKam configuration file and determine the database location.
0042 In a final step the database will be optimized by invoking the sqlite command '\fIVACUUM\fR;' on it.
0043 If more then one database is found in this location, \fBcleanup_digikamdb\fR will optimize every database found in this path and below.
0044 .PP
0045 For further explanation, see the following description of the \fIVACUUM\fR command from the sqlite3 website:
0046 .PP
0047 When an object (table, index, or trigger) is dropped from the database, it leaves behind empty space.
0048 This empty space will be reused the next time new information is added to the database.
0049 But in the meantime, the database file might be larger than strictly necessary.
0050 Also, frequent inserts, updates, and deletes can cause the information in the database to become fragmented - scrattered out all
0051 across the database file rather than clustered together in one
0052 place.
0053 .PP
0054 The \fIVACUUM\fR command cleans the main database by copying its contents to a temporary database file and reloading
0055 the original database file from the copy.
0056 This eliminates free pages, aligns table data to be contiguous, and otherwise cleans up the database file structure.
0057 .SH AUTHOR
0058 \fBcleanup_digikamdb\fR was written by Andi Clemens <andi dot clemens at gmail dot com>