[digikam-doc] digikam: Update handbook

Swati Lodha swatilodha27 at gmail.com
Sat Sep 3 12:09:57 UTC 2016


Git commit b3e54b4243d07bf06ee964ba8b88b1bcd6bff950 by Swati Lodha.
Committed on 03/09/2016 at 12:09.
Pushed by swatil into branch 'master'.

Update handbook

A  +-    --    digikam/intro-database-statistics.png
M  +50   -7    digikam/intro-database.docbook

http://commits.kde.org/digikam-doc/b3e54b4243d07bf06ee964ba8b88b1bcd6bff950

diff --git a/digikam/intro-database-statistics.png b/digikam/intro-database-statistics.png
new file mode 100644
index 0000000..0193c81
Binary files /dev/null and b/digikam/intro-database-statistics.png differ
diff --git a/digikam/intro-database.docbook b/digikam/intro-database.docbook
index 9140229..9ef8471 100644
--- a/digikam/intro-database.docbook
+++ b/digikam/intro-database.docbook
@@ -62,7 +62,7 @@
         </para>
 
         <para>
-            To make your application run fast and smoothly, it is recommended to check and optimize your databases once in awhile. This could be achieved using sqlite3 packages or sqlite browser (high quality, easy to use visual tool for managing database objects). For Ubuntu and its derivatives, it could be retrieved using <command>sudo apt-get install sqlite3</command> or <command>sudo apt-get install sqlitebrowser</command>. Now all remains is to open the terminal, switch to the directory where databases and stored.
+            To make your application run fast and smoothly, it is recommended to check and optimize your databases once in awhile. This could be achieved using sqlite3 packages or sqlite browser (high quality, easy to use visual tool for managing database objects). For Ubuntu and its derivatives, it could be retrieved using <command> sudo apt-get install sqlite3</command> or <command>sudo apt-get install sqlitebrowser</command>. Now all remains is to open the terminal, switch to the directory where databases and stored.
         </para>
 
         <note><para>
@@ -70,7 +70,7 @@
         </para></note>
 
         <para>
-            SQLite database files could be found in your “collection” folder, which you have added to &digikam;. (By default, if you add your “Pictures” collection, the DB files will be present in <filename class="directory">~/Pictures</filename> folder).
+            SQLite database files could be found in your “collection” folder, which you have added to &digikam;. (By default, if you add your “Pictures” collection, the DB files will be present in <filename class="directory"> ~/Pictures</filename> folder).
         </para>
 
         <para>
@@ -131,7 +131,7 @@
             </para>
 
             <para>
-                Using MySQL as &digikam;’s database back-end allows you to store the data on local as well as remote server. Local, to replace the local SQLite storage and latter, to use a shared computer through network. Using MySQL as &digikam;’s database back-end allows you to store the data on a remote server. This way, you can use multiple &digikam; installations (⪚ On your notebook and PC) to access and manage your photo collections. You can also use MySQL tools to backup and analyze &digikam;’s data.
+                Using MySQL as &digikam;’s database back-end allows you to store the data on local as well as remote server. Local, to replace the local SQLite storage and latter, to use a shared computer through network. Using MySQL as &digikam;’s database back-end allows you to store the data on a remote server. This way, you can use multiple &digikam; installations (For instance,on your notebook and PC) to access and manage your photo collections. You can also use MySQL tools to backup and analyze &digikam;’s data.
             </para>
 
             <para>
@@ -158,7 +158,15 @@
             <title>The MySQL Internal Server</title>
 
             <para>
-                <!-- TODO : add more description of mysql internal solutions, from a technical view -->
+                While using a large collection, of size greater than 10,000, the application tends to slow down. To avoid the delay and maintain efficiency, digiKam provides option of using “MySQL Internal Server”. To be clear, this isn’t an actual server, or a public network. Instead, it a server that runs only while application is running.
+            </para>
+            
+            <para>
+                Internal server creates a separate database that can be accessed (only while application is running) using the command: <command>mysql --socket=/home/[user_name]/.local/share/digikam/db_misc/mysql.socket digikam </command>
+            </para>
+            
+            <para>
+                Internal server uses two MySQL Binary Tools - “mysql_install_db” and “mysqld”. You can configure their locations in the Setup dialog. DigiKam will try to find these binaries automatically if they’re installed on your system. 
             </para>
 
             <para>
@@ -211,15 +219,19 @@
             </para>
 
             <para>
-                <!-- TODO : Remote Mysql will use network : Give all recommendation to have the best performance results -->
+                Recommendation for best results
+            </para>
+            
+            <para>
+                With slow network, digiKam hang a lots of time especially when album contents is important (>1000 items). This solution relies on network performance. Problem has been reproducible using Wifi connection, for instance. Switching to Ethernet solves the problem.
+
+                Also, If you have an enormous collection, you should start the MySQL server with “mysql --max_allowed_packet = 128M”. (If you’re well acquainted with using MySQL, you could also change your settings in my.ini or ~/.my.cnf files).
             </para>
 
         </sect3>
 
     </sect2>
 
-    <!-- TODO : add new sect2 about Database backup/maintenance recommendations -->
-
     <sect2 id="intro-database-migration">
         <title>Database Migration</title>
 
@@ -242,6 +254,37 @@
         </para>
 
     </sect2>
+    
+    <sect2 id="intro-database-backup">
+        <title>Database Backup Recommendation</title>
+        
+        <para>
+            For security reasons, planing a DB backup using crontab over the network can help against device dysfunctions. A NAS or an external drive can also be used for that. 
+        </para>
+        
+        <para>
+            Each database can be named with a different name, not only "digikam". This permits user  to backup only what is needed.For instance, naming “core” database as digikamCore, permits to isolate only this table (the most important file). Thumbnails and recognition databases can always be regenerated for scratch.
+        </para>
+    </sect2>
+    
+    <sect2 id="intro-database-statistics">
+        <title>Database Statistics</title>
+        
+        <para>
+            DigiKam provides a unique tool of maintaining the statistics of your collection. It includes count of images, videos (including individual count by image format), tags etc.
+            Also, includes the Database backend (QSQLITE or QMYSQL) and the Database Path (where your collection is located).
+        </para>
+        
+        <para>
+            You can view your statistics by going to <guibutton>Help</guibutton> | <guimenuitem>Database Statistics</guimenuitem>. A dialog box like this will appear:
+        </para>
+        
+        <para>
+                <inlinemediaobject><imageobject>
+                    <imagedata fileref="&path;intro-database-statistics.png" format="PNG" /></imageobject>
+                </inlinemediaobject>
+        </para>
+    </sect2>
 
 </sect1>
 


More information about the kde-doc-english mailing list