Taiga 576: Adds parameters to delete-items cron job description
authorCaroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com>
Mon, 27 Aug 2018 21:55:31 +0000 (17:55 -0400)
committerCaroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com>
Mon, 27 Aug 2018 21:55:31 +0000 (17:55 -0400)
source/cron_jobs.rst

index 8986045..dac249e 100644 (file)
@@ -571,6 +571,29 @@ Does: generates a query against the items
 database and deletes the items matching the criteria specified in the
 command line arguments.
 
+    **PARAMETERS**
+    
+    -  --verbose
+       Send the "WHERE" clause generated by the collected C<--where> 
+       arguments, as well as items affected to Standard Out.
+
+    -  --where
+       The C<--where> option may called multiple times. The following 
+       argument must be a syntactically valid SQL statement which is 
+       part of the C<WHERE> clause querying the items table. 
+       These are joined by C<AND>.
+
+    -  --commit
+       No items will be deleted unless the C<--commit> flag is present.
+
+    **EXAMPLES**
+
+    The following are examples of this script:
+
+    delete_items.pl --where "items.withdrawn ! 0" --where "items.withdrawn_on < $(date --date="13 month ago" --rfc-3339=date)" --commit
+
+    delete_items.pl --where "itemlost >= '1'" --where "itemlost <='4'" --where "itemlost_on < '2014-04-28'" --commit
+
 .. _check-url-quick-label:
 
 Check URL quick