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.
Namespace: Cake\Database
Property 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(stringCake\Datasource\ConnectionInterface $connection)Constructor
Parameters
-
stringCake\Datasource\ConnectionInterface$connection Connection name to get the schema for or a connection instance
build() ¶ public
build(string|null $name = null): arrayBuild metadata.
Parameters
-
string|null$name optional The name of the table to build cache data for.
Returns
arrayclear() ¶ public
clear(string|null $name = null): arrayClear metadata.
Parameters
-
string|null$name optional The name of the table to clear cache data for.
Returns
arraygetSchema() ¶ public
getSchema(Cake\Database\Connection $connection): Cake\Database\Schema\CollectionCake\Database\Schema\CachedCollectionHelper method to get the schema collection.
Parameters
-
Cake\Database\Connection$connection Connection object
Returns
Cake\Database\Schema\CollectionCake\Database\Schema\CachedCollectionThrows
RuntimeExceptionIf given connection object is not compatible with schema caching