Changeset 5023

Timestamp:

Jul 27, 2009, 1:14:07 PM (14 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #1351: Add a function that removes unwanted items from the database at regular intervals

Location:

trunk

Files:

• config/dist/base.config (modified) (1 diff)
• doc/src/docbook/appendix/base.config.xml (modified) (1 diff)
• src/core/net/sf/basedb/core/Application.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/ItemKey.java (modified) (3 diffs)
• src/core/net/sf/basedb/core/ProjectKey.java (modified) (3 diffs)
• src/test/TestItemKey.java (modified) (2 diffs)
• src/test/TestProjectKey.java (modified) (3 diffs)

trunk/config/dist/base.config

@@ -54 +54 @@
 db.raw-data-types      = /raw-data-types.xml
 db.batch-size          = 50
+# Number of hours between cleanup of unused items in the database
+# Set to 0 to disable (recommended for job agents)
+db.cleanup.interval    = 24
 
 

trunk/doc/src/docbook/appendix/base.config.xml

@@ -234 +234 @@
       </listitem>
     </varlistentry>
+
+    <varlistentry>
+      <term><property>db.cleanup.interval</property></term>
+      <listitem>
+        <para>
+        Interval in hours between database cleanups. Set this to
+        0 to disable (recommened for job agents). The default value 
+        is 24.
+          </para>
+      </listitem>
+    </varlistentry>
     
     <varlistentry>

trunk/src/core/net/sf/basedb/core/Application.java

@@ -505 +505 @@
         long milliSeconds = 60 * 1000 * sessionCacheTimeout;
         getScheduler().schedule(new SessionControlCacheCleaner(), milliSeconds, milliSeconds, false);
+        
+        // Adding a task that cleans the database at regular intervals
+        long cleanupInterval = 3600 * 1000 * Config.getInt("db.cleanup.interval", 24);
+        if (cleanupInterval > 0)
+        {
+          getScheduler().schedule(new DbCleaner(), cleanupInterval, cleanupInterval, false);
+        }
         
         // Adding a task that cleans the static cache at regular intervals
@@ -1084 +1091 @@
   }
   
+  private static class DbCleaner
+    extends TimerTask
+  {
+    /*
+      From the TimerTask class
+      -------------------------------------------
+    */
+    public void run()
+    {
+      log.info("Cleaning database");
+      // Stray any-to-any links
+      int numDeleted = AnyToAny.deleteStrayLinks(null);
+      log.info("Found " + numDeleted + " stray any-to-any links");
+      
+      // Item and project keys
+      numDeleted = ItemKey.deleteUnusedItemKeys();
+      log.info("Found " + numDeleted + " unused item keys");
+      numDeleted = ProjectKey.deleteUnusedProjectKeys();
+      log.info("Found " + numDeleted + " unused project keys");
+      
+      log.info("Finished cleaning of database");
+    }
+    // -------------------------------------------
+  }
+
+  
   private static class SecondaryStorageControllerTask
     extends TimerTask

trunk/src/core/net/sf/basedb/core/ItemKey.java

@@ -148 +148 @@
 
   /**
+    @deprecated Use {@link #deleteUnusedItemKeys()} instead which returns the number of
+      deleted keys
+  */
+  public static synchronized void deleteUnusedKeys()
+    throws BaseException
+  {
+    deleteUnusedItemKeys();
+  }
+
+  
+  /**
     Delete all keys that are currently not used by any item. This method 
     is intended to be executed at regular intervals by a cleanup application.
-    @throws BaseException If a unused key could not be deleted. 
-  */
-  public static synchronized void deleteUnusedKeys()
+    @return The number of deleted item keys
+    @throws BaseException If a unused key could not be deleted.
+    @since 2.13
+  */
+  public static synchronized int deleteUnusedItemKeys()
     throws BaseException
   {
     org.hibernate.Session session = null;
     org.hibernate.Transaction tx = null;
+    int numDeleted = 0;
     try
     {
@@ -179 +193 @@
       {
         HibernateUtil.deleteData(session, ik);
+        numDeleted++;
       }
       HibernateUtil.commit(tx);
@@ -191 +206 @@
       if (session != null) HibernateUtil.close(session);
     }
+    return numDeleted;
   }
   

trunk/src/core/net/sf/basedb/core/ProjectKey.java

@@ -122 +122 @@
 
   /**
+    @deprecated Use {@link #deleteUnusedProjectKeys()} instead which returns the number of
+      deleted keys
+  */
+  public static synchronized void deleteUnusedKeys()
+    throws BaseException
+  {
+    deleteUnusedProjectKeys();
+  }
+
+  /**
     Delete all keys that are currently not used by any item. This method 
     is intended to be executed at regular intervals by a cleanup application.
     @throws BaseException If there is some kind of error. 
   */
-  public static synchronized void deleteUnusedKeys()
+  public static synchronized int deleteUnusedProjectKeys()
     throws BaseException
   {
     org.hibernate.Session session = null;
     org.hibernate.Transaction tx = null;
+    int numDeleted = 0;
     try
     {
@@ -153 +164 @@
       {
         HibernateUtil.deleteData(session, pk);
+        numDeleted++;
       }
       HibernateUtil.commit(tx);
@@ -165 +177 @@
       if (session != null) HibernateUtil.close(session);
     }
+    return numDeleted;
   }
   

trunk/src/test/TestItemKey.java

@@ -62 +62 @@
     TestGroup.test_delete(groupId);
 
-    test_delete_unused();
+    test_delete_unused(2);
 
     write("++Testing item key "+(ok ? "OK" : "Failed")+"\n");
@@ -123 +123 @@
   }
   
-  static void test_delete_unused()
+  static void test_delete_unused(int expected)
   {
     try
     {
-      ItemKey.deleteUnusedKeys();
-      write("--Delete unused item keys OK");
+      int numDeleted = ItemKey.deleteUnusedItemKeys();
+      if (expected >= 0 && numDeleted != expected)
+      {
+        throw new BaseException("Unexpected number of unused item keys: " + 
+          numDeleted + "; expected " + expected);
+      }
+      write("--Delete unused item keys OK (" + expected + ")");
     }
     catch (Throwable ex)

trunk/src/test/TestProjectKey.java

@@ -22 +22 @@
 */
 import net.sf.basedb.core.*;
+
 import java.util.EnumSet;
 
@@ -80 +81 @@
 //    TestProject.test_delete(projectId2);
 
-    test_delete_unused();
+    test_delete_unused(2);
 
     write("++Testing project key "+(ok ? "OK" : "Failed")+"\n");
@@ -143 +144 @@
   }
   
-  static void test_delete_unused()
-  {
-    try
-    {
-      ProjectKey.deleteUnusedKeys();
-      write("--Delete unused project keys OK");
+  static void test_delete_unused(int expected)
+  {
+    try
+    {
+      int numDeleted = ProjectKey.deleteUnusedProjectKeys();
+      if (expected >= 0 && numDeleted != expected)
+      {
+        throw new BaseException("Unexpected number of unused item keys: " + 
+          numDeleted + "; expected " + expected);
+      }
+      write("--Delete unused project keys OK (" + expected + ")");
     }
     catch (Throwable ex)