ePages 7.17.0 - DE_EPAGES/Installer/API/Patch.pm

Package DE_EPAGES::Installer::API::Patch

Functions for starting patching cartridges to the current version and others directly related to the patching process.

@EXPORT_OK
IsPatchRunning
TestPatchStores
TestPatchStore
PatchStore
PatchStores
SetPatchRunning

Functions

IsPatchRunning
PatchDBStructureStore
PatchStore
PatchStores
SetPatchRunning
TestPatchStore
TestPatchStores

IsPatchRunning

Retrieves the information whether the zero downtime patch is currently running or not. The store of the current data base connection is retrieved implicitly.

Syntax
IsPatchRunning();
Return
$IsPatchRunning (boolean)
1 if the zero downtime patch is currently running,
otherwise 0.

PatchDBStructureStore

Patches db structure (multiple packages) in an active store (no tests).

Syntax
PatchDBStructureStore($aPackages);
Input
$aPackages (ref.array.string)
test these packages

PatchStore

Patches (multiple packages) in an active store (no tests).

Syntax
PatchStore($aPackages, $hOptions);
Input
$aPackages (ref.array.string)
test these packages
$hOptions (ref.hash.string)
options for cartridge constructor *::API::Cartrdge->new

PatchStores

Patches (multiple packages) in all given stores (no tests).

Syntax
PatchStores($ahStores, $aPackages);
PatchStores($ahStores, $aPackages, $hOptions);
Input
$ahStores (ref.array.hash.string)
store names and password keys :
  • Name - store name - string
  • DBPassword - password (optional) - string
$aPackages (ref.array.string)
test these packages
$hOptions (ref.hash.string)
options for cartridge constructor *::API::Cartrdge->new

SetPatchRunning

Sets the attribute which stores the information whether the zero downtime patch is currently running or not.

Syntax
SetPatchRunning($StoreName, $TrueOrFalse);
Input
$Store (string)
The name of the store for which the patch status is to be
checked.
$IsPatchRunning (boolean)
A boolean value which describes whether the patch is
currently running

TestPatchStore

Tests patches (multiple packages) in an active store.

Syntax
$ahReasons = TestPatchStore($aPackages, $hOptions);
Input
$aPackages (ref.array.string)
test these packages
$hOptions (ref.hash.string)
options for cartridge constructor *::API::Cartrdge->new
Return
$ahReasons (ref.array.hash.string)
reasons why patch is not possible

TestPatchStores

Test patches (multiple packages) in all given stores.

Syntax
$ahReasons = TestPatchStores($ahStores, $aPackages);
$ahReasons = TestPatchStores($ahStores, $aPackages, $hOptions);
Input
$ahStores (ref.array.hash.string)
store names and password keys :
  • Name - store name - string
  • DBPassword - password - string
$aPackages (ref.array.string)
test these packages
$hOptions (ref.hash.string)
options for cartridge constructor *::API::Cartrdge->new
Return
$ahReasons (ref.array.hash.string)
reasons why patch is not possible