Class SchemaCache
Schema Cache.
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.
Properties summary
-
$_schema protected
\Cake\Database\Schema\CachedCollectionSchema
Method Summary
-
__construct() public
Constructor
-
build() public
Build metadata.
-
clear() public
Clear metadata.
-
getSchema() public
Helper method to get the schema collection.
Method Detail
__construct() public ¶
__construct(\Cake\Database\Connection $connection)
Constructor
Parameters
-
\Cake\Database\Connection$connection Connection name to get the schema for or a connection instance
build() public ¶
build(?string $name)
Build metadata.
Parameters
-
string|null$name optional The name of the table to build cache data for.
Returns
arrayReturns a list build table caches
clear() public ¶
clear(?string $name)
Clear metadata.
Parameters
-
string|null$name optional The name of the table to clear cache data for.
Returns
arrayReturns a list of cleared table caches
getSchema() public ¶
getSchema(\Cake\Database\Connection $connection)
Helper method to get the schema collection.
Parameters
-
\Cake\Database\Connection$connection Connection object
Returns
\Cake\Database\Schema\CachedCollectionThrows
RuntimeExceptionIf given connection object is not compatible with schema caching