Futilities/server/backups/db-bak: Difference between revisions

Latest revision as of 15:43, 27 January 2023

Database Backup Futility

All are in namespace woozalia\backup unless otherwise noted.

name	parent	type	file
cFolderRotater		utility	blib.php
cSource		config	conf.php
cFileSource	caSource	config	conf.php
caDataSource	caSource	config	conf.php
caServer		config	conf.php
caDatabase		db	db.php
cPostgresDB	caDatabase	db	db.php
cMySQLDB	caDatabase	db	db.php
cOpts	WF\caOptsBase	UI	opts.php

@@ Line 1: / Line 1: @@
 {{fmt/title|Database Backup Futility}}
+==Classes==
-==Proposed Object API==
+All are in namespace <code>woozalia\backup</code> unless otherwise noted.
-===Manager===
+{| class="sortable wikitable"
-* function PublicKey() : string;
+|-
-* function SessionFromSpec(string $uri, string $sPwCrypt, string $fpDest) : Session;
+! name || parent || type || file || description
+|-
-The calling process uses Manager's public key to encrypt the db password, and then requests a Session object.
+| cFolderRotater || || utility || blib.php
-===Session===
+|-
-* function Start() : bool;
+| cSource || || config || conf.php
-* function CheckStatus() : Status;
+|-
+| cFileSource || caSource || config || conf.php
-The calling process calls Start() to initiate the backup, then repeatedly calls CheckStatus() to see how it's going. This can be reported to an interactive user or just checked for the completion flag.
+|-
-===Status===
+| caDataSource || caSource || config || conf.php
-* function UnitsDone() : int;
+|-
-* function UnitsTotal() : int; // can be zero if unknown
+| caServer || || config || conf.php
-* function IsDone() : bool;
+|-
-* function IsOkay() : bool;
+| caDatabase || || db || db.php
-* function Message() : string;
+|-
+| cPostgresDB || caDatabase || db || db.php
+|-
+| cMySQLDB || caDatabase || db || db.php
+|-
+| cOpts || WF\caOptsBase || UI || opts.php
+|}
+==Archive==
+* [[/back burner]]