ePages 6.10 - DE_EPAGES/WebInterfacePoolDB/API/Table/Pool.pm

Package DE_EPAGES::WebInterfacePoolDB::API::Table::Pool

interface for table Pool

@EXPORT_OK
InsertPool
UpdatePool
DeletePool
GetAllPKeyPools
GetAllInfoPools
GetInfoPool
ExistsPool
GetPKeyPoolByName
GetInfoPoolByName
ExistsPoolByName
GetPKeyPoolsByName
GetInfoPoolsByName

Functions

DeletePool
ExistsPool
ExistsPoolByName
GetAllInfoPools
GetAllPKeyPools
GetInfoPool
GetInfoPoolByName
GetInfoPoolsByName
GetPKeyPoolByName
GetPKeyPoolsByName
InsertPool
UpdatePool

DeletePool

Deletes a(n) Pool.

Syntax
DeletePool($PoolID);
DeletePool($hPool); # if $hPool includes PoolID
Input
$PoolID (int)
pool id (primary key)

ExistsPool

Returns true if the Pool exists.

Syntax
$exists = ExistsPool($PoolID);
Input
$PoolID (int)
pool id
Return
$exists (boolean)
1/0 the Pool exists (yes/no)

ExistsPoolByName

Returns true if a Pool by alternate key Name exists.

Syntax
$Exists = ExistsPoolByName($Name);
Input
$Name (varchar(100))
pool name
Return
$Exists (boolean)
1/0 the u_pool_name exists (yes/no)

GetAllInfoPools

Returns all objects of Pool.

Syntax
$ahPools = GetAllInfoPools();
Return
$ahPools (reference to array of hashes)
with following keys:
  • PoolID - pool id (primary key)- int
  • Name - pool name - varchar(100)
  • MaxServersPerSite - maximum number of parallel processes for one site (optional)- int
  • MaxServersPerClient - maximum number of parallel processes for the same client IP (optional)- int

GetAllPKeyPools

Returns all Pool identifiers.

Syntax
$aPoolIDs = GetAllPKeyPools();
Return
$aPoolIDs (reference to array of int)
pool id

GetInfoPool

Returns the Pool by identifier.

Syntax
$hPool = GetInfoPool($PoolID);
Input
$PoolID (int)
pool id (primary key)
Return
$hPool (reference to hash)
with following keys:
  • PoolID - pool id (primary key)- int
  • Name - pool name - varchar(100)
  • MaxServersPerSite - maximum number of parallel processes for one site (optional)- int
  • MaxServersPerClient - maximum number of parallel processes for the same client IP (optional)- int

GetInfoPoolByName

Returns the object of Pool by alternate key Name.

Syntax
$hPool = GetInfoPoolByName($Name);
Input
$Name (varchar(100))
pool name
Return
$hPool (reference to hash)
with following keys:
  • PoolID - pool id (primary key)- int
  • Name - pool name - varchar(100)
  • MaxServersPerSite - maximum number of parallel processes for one site (optional)- int
  • MaxServersPerClient - maximum number of parallel processes for the same client IP (optional)- int

GetInfoPoolsByName

Returns objects of Pool by alternate key Name.

Syntax
$ahPools = GetInfoPoolsByName($Name);
Input
$Name (varchar(100))
pool name
Return
$ahPools (reference to array of hashes)
with following keys:
  • PoolID - pool id (primary key)- int
  • Name - pool name - varchar(100)
  • MaxServersPerSite - maximum number of parallel processes for one site (optional)- int
  • MaxServersPerClient - maximum number of parallel processes for the same client IP (optional)- int

GetPKeyPoolByName

Returns primary key of Pool by alternate key Name.

Syntax
$PoolID = GetPKeyPoolByName($Name);
Input
$Name (varchar(100))
pool name
Return
$PoolID (int)
pool id (primary key)

GetPKeyPoolsByName

Returns primary keys of Pool by alternate key Name.

Syntax
$aKeys = GetPKeyPoolsByName($Name);
Input
$Name (varchar(100))
pool name
Return
$aKeys (reference to array of int)
pool id (primary key)

InsertPool

Creates an entry of Pool.

Syntax
$PoolID = InsertPool($hPool);
Input
$hPool (reference to hash)
with following keys:
  • PoolID - pool id (primary key)(optional)- int
  • Name - pool name - varchar(100)
  • MaxServersPerSite - maximum number of parallel processes for one site (optional)- int
  • MaxServersPerClient - maximum number of parallel processes for the same client IP (optional)- int
Return
$PoolID (int)
pool id (primary key)

UpdatePool

Updates a(n) Pool if any element was changed.

Syntax
UpdatePool($PoolID, $hPool);
UpdatePool($hPool); # if $hPool includes PoolID
Input
$PoolID (int)
pool id (primary key)
$hPool (reference to hash)
with following keys:
  • Name - pool name - varchar(100)
  • MaxServersPerSite - maximum number of parallel processes for one site (optional)- int
  • MaxServersPerClient - maximum number of parallel processes for the same client IP (optional)- int