W3cubDocs

/CakePHP 4.1

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

Properties summary

  • $_schema protected
    \Cake\Database\Schema\CachedCollection

    Schema

Method Summary

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

array

Returns 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

array

Returns 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\CachedCollection

Throws

RuntimeException
If given connection object is not compatible with schema caching

Property Detail

$_schema protected

Schema

Type

\Cake\Database\Schema\CachedCollection

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Database.SchemaCache.html