marcocesarato / cpdo
This package can retrieve PDO query results from cache variables. It extends the base PDO class and override some functions to handle database query execution and store the query results in variables. The class can also return query results for cached queries for previously executed queries to retr
Requires
- php: >=5.1.2
- ext-json: *
- ext-pdo: *
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.15
This package is auto-updated.
Last update: 2024-10-16 17:47:35 UTC
README
Version: 0.2.3.47 beta
Github: https://github.com/marcocesarato/PHP-CPDO
Author: Marco Cesarato
Description
This package can retrieve PDO query results from cache variables.
It extends the base PDO class and override some functions to handle database query execution and store the query results in variables.
The class can also return query results for cached queries for previously executed queries to retrieve the results faster for repeated queries.
It permit to have cached SELECT/SHOW/DESCRIBE
queries on Memory (RAM). Then after the execution the cache will be deleted.
Cache is cleaned on INSERT/UPDATE/DELETE/TRUNCATE...
only for the single table.
What problem this solves
When we call the same query (for example on ORM based system) we retrieve from the database the same data doing the same operation and some time we overload the database server (for example retrieving big data multiple times).
This class prevent to do the same query on the database, retrieving the data from memory without overload the database server in some cases.
Requirements
- PHP
- Database
Databases supported (CPDO::connect
)
- 4D
- CUBRID
- Firebird/Interbase
- IBM
- Informix
- MS SQL Server
- MySQL
- ODBC and DB2
- Oracle
- PostgreSQL
- SQLite
Install
Composer
- Install composer
- Type
composer require marcocesarato/cpdo
- Enjoy
Usage
You have to use this class as PDO.
CPDO introduced these new methods:
Method connect
This feature is a DSN autogeneration and you have to use it instead of the constructor.
Usage of connect
$db = CPDO::connect($database_type, $database_name, $database_host = null, $database_user = null, $database_pswd = null);
Method getTables
Return the names of all database tables as array
Method backup
You can backup Data (At the moment no TRIGGERS, VIEWS and EVENTS if you need it you can request it to the developer).
You can choose if you want the tables you want backup through an array
.
Usage of backup
$db->backup($backup_dir, $backup_tables = '*');
Cache
You can disable/enable the cache using the following methods (default is disabled):
$db->disableCache(); $db->enableCache();
or
CPDOCache::disable(); CPDOCache::enable();
Methods available:
void CPDOCache::enable()
ENABLE Cachevoid CPDOCache::disable()
DISABLE Cachevoid CPDOCache::populate(array $cache)
Populate cache (see below persistent cache)array CPDOCache::retrieve()
Retrieve cache (see below persistent cache)void CPDOCache::addException(string $table_name)
Add not cacheable tablevoid CPDOCache::addExceptions(array $tables_name)
Add not cacheable tables
Debugger
You can enable/disable the debugger using the following methods (default is enabled):
$db->enableDebug(); $db->disableDebug();
or
CPDOLogger::enable(); CPDOLogger::disable();
Methods available:
void CPDOLogger::enable()
ENABLE Cachevoid CPDOLogger::disable()
DISABLE Cachearray CPDOLogger::getLogs();
Get complete logs (with time of execution and if cache used)array CPDOLogger::getQueries()
Get all queries requestedint CPDOLogger::getCounter()
Get the counter of queries requestedvoid CPDOLogger::cleanLogs();
Clean Logs
Example of complete logs getLogs()
array ( 'count' => 3, 'queries' => array ( 'SET NAMES \'utf8\'' => array ( 0 => array ( 'time' => 1530610903, 'execution_time' => 0.000247955322265625, 'cached' => false, ), 1 => array ( 'time' => 1530610903, 'execution_time' => 0.000077955322265625, 'cached' => false, ), ), 'SELECT id FROM _deleted_records_ WHERE table = \'settings\' LIMIT 1' => array ( 0 => array ( 'time' => 1530610903, 'execution_time' => 0.00050687789916992188, 'cached' => false, ), ), ), )
(Not recommended) Persistent cache
PS: this usage is not recommended!!!
If you want a persitent you can use the method CPDOCache::populate
for populate the cache and CPDOCache::retrieve
for retrieve the cache.
Thanks these methods you could implement a persistent cache system saving the data encoded (with json or serialization) and after restore the cache.
Pro:
- Less database stress
- Less queries
Cons:
- Could compromise data
- Could be slower (disk performance/clients connected)
Example of usage
// Your loader/includes... => with require_once('CPDO.php'); $database_cache_path = '/your/cache/path/database.json'; $cache = file_get_contents($database_cache_path); $cache = json_decode($cache); // Or unserialize (slower) CPDOCache::populate($cache); unset($cache); // Your code... $cache = CPDOCache::retrieve(); $cache = json_encode($cache); // Or serialize (slower) file_put_contents($database_cache_path, $cache); unset($cache);
Methods
CPDO
Same methods of PDO in additions the following: