1 /***********************************************************************
2  * Copyright (c) 2013-2024 Commonwealth Computer Research, Inc.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Apache License, Version 2.0
5  * which accompanies this distribution and is available at
6  * http://www.opensource.org/licenses/apache2.0.php.
7  ***********************************************************************/
8 
9 package org.locationtech.geomesa.gt.partition.postgis.dialect
10 package functions
11 
12 import org.locationtech.geomesa.gt.partition.postgis.dialect.procedures.{AnalyzePartitions, PartitionMaintenance, RollWriteAheadLog}
13 
14 /**
15  * Deletes history older than 7 days
16  */
17 object LogCleaner extends LogCleaner with AdvisoryLock {
18   override protected val lockId: Long = 6743164310736814350L
19 }
20 
21 class LogCleaner extends SqlFunction with CronSchedule {
22 
23   override def name(info: TypeInfo): FunctionName = FunctionName("cron_log_cleaner")
24 
25   override def jobName(info: TypeInfo): SqlLiteral = SqlLiteral(s"${info.typeName}-cron-log-cleaner")
26 
27   override protected def createStatements(info: TypeInfo): Seq[String] =
28     Seq(function()) ++ super.createStatements(info)
29 
30   override protected def dropStatements(info: TypeInfo): Seq[String] = Seq.empty // function is shared between types
31 
32   override protected def schedule(info: TypeInfo): SqlLiteral = SqlLiteral("30 1 * * *") // 01:30 every day
33 
34   override protected def invocation(info: TypeInfo): SqlLiteral =
35     SqlLiteral(s"SELECT cron_log_cleaner(${info.tables.view.name.asLiteral}, INTERVAL '7 DAYS')")
36 
37   private def function(): String = {
38     val info = TypeInfo(SchemaName("", ""), "", null, null, null)
39     val maintenanceSuffix = PartitionMaintenance.jobName(info).quoted
40     val rollSuffix = RollWriteAheadLog.jobName(info).quoted
41     val analyzeSuffix = AnalyzePartitions.jobName(info).quoted
42     val logsSuffix = jobName(info).quoted
43 
44     s"""CREATE OR REPLACE FUNCTION cron_log_cleaner(name text, tokeep interval) RETURNS void LANGUAGE plpgsql AS
45        |  $$BODY$$
46        |    DECLARE
47        |      maintenance_name text;
48        |      roll_name text;
49        |      analyze_name text;
50        |      logs_name text;
51        |    BEGIN
52        |      maintenance_name := name || $maintenanceSuffix;
53        |      roll_name := name || $rollSuffix;
54        |      analyze_name := name || $analyzeSuffix;
55        |      logs_name := name || $logsSuffix;
56        |      DELETE FROM cron.job_run_details
57        |        WHERE end_time < now() - tokeep
58        |        AND jobid IN (
59        |          SELECT jobid FROM cron.job
60        |            WHERE jobname IN (maintenance_name, roll_name, analyze_name, logs_name)
61        |        );
62        |    END;
63        |  $$BODY$$;""".stripMargin
64   }
65 }