/
OrmCacheShell.php
143 lines (131 loc) · 4.47 KB
/
OrmCacheShell.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Shell;
use Cake\Cache\Cache;
use Cake\Console\Shell;
use Cake\Datasource\ConnectionManager;
/**
* ORM Cache Shell.
*
* Provides a CLI interface to the ORM metadata caching features.
* This tool is intended to be used by deployment scripts so that you
* can prevent thundering herd effects on the metadata cache when new
* versions of your application are deployed, or when migrations
* requiring updated metadata are required.
*/
class OrmCacheShell extends Shell
{
/**
* Build metadata.
*
* @param string|null $name The name of the table to build cache data for.
* @return bool
*/
public function build($name = null)
{
$schema = $this->_getSchema();
if (!$schema) {
return false;
}
$tables = [$name];
if (empty($name)) {
$tables = $schema->listTables();
}
foreach ($tables as $table) {
$this->_io->verbose('Building metadata cache for ' . $table);
$schema->describe($table, ['forceRefresh' => true]);
}
$this->out('<success>Cache build complete</success>');
return true;
}
/**
* Clear metadata.
*
* @param string|null $name The name of the table to clear cache data for.
* @return bool
*/
public function clear($name = null)
{
$schema = $this->_getSchema();
if (!$schema) {
return false;
}
$tables = [$name];
if (empty($name)) {
$tables = $schema->listTables();
}
$configName = $schema->getCacheMetadata();
foreach ($tables as $table) {
$this->_io->verbose(sprintf(
'Clearing metadata cache from "%s" for %s',
$configName,
$table
));
$key = $schema->cacheKey($table);
Cache::delete($key, $configName);
}
$this->out('<success>Cache clear complete</success>');
return true;
}
/**
* Helper method to get the schema collection.
*
* @return false|\Cake\Database\Schema\Collection|\Cake\Database\Schema\CachedCollection
*/
protected function _getSchema()
{
/* @var \Cake\Database\Connection $source */
$source = ConnectionManager::get($this->params['connection']);
if (!method_exists($source, 'schemaCollection')) {
$msg = sprintf(
'The "%s" connection is not compatible with orm caching, ' .
'as it does not implement a "schemaCollection()" method.',
$this->params['connection']
);
$this->abort($msg);
return false;
}
$config = $source->config();
if (empty($config['cacheMetadata'])) {
$this->_io->verbose('Metadata cache was disabled in config. Enabling to clear cache.');
$source->cacheMetadata(true);
}
return $source->getSchemaCollection();
}
/**
* Get the option parser for this shell.
*
* @return \Cake\Console\ConsoleOptionParser
*/
public function getOptionParser()
{
$parser = parent::getOptionParser();
$parser->addSubcommand('clear', [
'help' => 'Clear all metadata caches for the connection. If a ' .
'table name is provided, only that table will be removed.',
])->addSubcommand('build', [
'help' => 'Build all metadata caches for the connection. If a ' .
'table name is provided, only that table will be cached.',
])->addOption('connection', [
'help' => 'The connection to build/clear metadata cache data for.',
'short' => 'c',
'default' => 'default',
])->addArgument('name', [
'help' => 'A specific table you want to clear/refresh cached data for.',
'optional' => true,
]);
return $parser;
}
}