initial commit

app/Console/Documentation/Archive.txt

@@ -0,0 +1,75 @@
+/*
+ List of Archive Commands
+ * Command:
+ *  php app\Console\cake.php Backup initiateArchive <months> <limit>
+ *
+ * Description:
+   =======================================================
+    1. Get data from the "backup_expenses" table in the current database.
+    2. Save the data to the "expenses" table in the archive database(another database).
+    Steps
+    ======
+    1. Go to Project Folder
+    2. Run the command like
+            In Widows:
+             C:\xampp_php7\htdocs\expensecount> C:\xampp_php7\php\php.exe app\Console\cake.php Backup initiateArchive 50 100
+              (project dir)> "PHP executable" "Entry Point CakePHP shells" "Shell Class" "Function" "Months" "Rows"
+               (  it means
+                  1. 50 month before data from current month
+                  2. 100 record at a time
+               )
+ *===========================================================
+ * Parameters:
+ *   <months>  Number of months before the current date. Records older than
+ *             this period will be moved to the archive database.
+ *   <limit>   Maximum number of records to archive in a single execution.
+ *
+ * Example:
+ *   Console/cake Backup initiateArchive 100 100
+ *
+ *   This command archives up to 100 records that are older than
+ *   10 months from the current date.
+ *
+ * Usage Notes:
+ * - Suitable for scheduled execution via cron or manual maintenance tasks.
+ * - Ensure backup processes are functioning correctly before execution.
+ */
+
+/*
+Single Archive Commands
+
+  * Command:
+  *   php app\Console\cake.php Backup archieveSingleItem <unique_url>
+  *
+  * Description:
+  ===================
+      1. Get data from the "backup_expenses" table by unique_url in the current database.
+      2. Save the data to the "expenses" table in the archive database(another database).
+      Steps
+      ======
+      1. Go to Project Folder
+      2. Run the command like
+              In Widows:
+               C:\xampp_php7\htdocs\expensecount> C:\xampp_php7\php\php.exe app\Console\cake.php Backup archieveSingleItem 1ILcOUb0fe3JpgB
+                (project dir)> "PHP executable" "Entry Point CakePHP shells" "Shell Class" "Function" "unique_url"
+                 (  it means
+                    1. Archive data by unique_url 1ILcOUb0fe3JpgB
+                 )
+  *
+  * Parameters:
+  *   <unique_url>  The unique identifier of the expense to be archived.
+  *
+  * Usage:
+  *   Run this command to archive one specific expense on demand.
+  *   Example:
+  *     php app\Console\cake.php Backup archieveSingleItem 1ILcOUb0fe3JpgB
+  *
+  * Purpose:
+  * - Supports manual or targeted archival of individual expense records.
+  * - Helps keep backup and live databases lightweight.
+  *
+  * Notes:
+  * - Ensure the expense exists in the backup tables before running the command.
+
+
+*/