__construct()source public

__construct( Cake\Datasource\ConnectionInterface $connection , string|boolean $cacheKey true )

Constructor.

Parameters

Cake\Datasource\ConnectionInterface $connection

The connection instance.

string|boolean $cacheKey optional true

The cache key or boolean false to disable caching.

Overrides

Cake\Database\Schema\Collection::__construct()

cacheKey()source public

cacheKey( string $name )

Get the cache key for a given name.

Parameters

string $name

The name to get a cache key for.

Returns

string
The cache key.

cacheMetadata()source public

cacheMetadata( boolean|null $enable null )

Sets the cache config name to use for caching table metadata, or disables it if false is passed. If called with no arguments it returns the current configuration name.

Parameters

boolean|null $enable optional null

whether or not to enable caching

Returns

string|boolean

describe()source public

describe( string $name , array $options [] )

Get the column metadata for a table.

Parameters

string $name

The name of the table to describe.

array $options optional []

The options to use, see above.

Returns

Cake\Database\Schema\Table
Object with column metadata.

Throws

Cake\Database\Exception
when table cannot be described.

Overrides

Cake\Database\Schema\Collection::describe()

_reflect()source protected

_reflect( string $stage , string $name , array $config , Cake\Database\Schema\Table $table )

Helper method for running each step of the reflection process.

Parameters

string $stage

The stage name.

string $name

The table name.

array $config

The config data.

Cake\Database\Schema\Table $table

The table instance

Throws

Cake\Database\Exception
on query failure.

listTables()source public

listTables( )

Get the list of tables available in the current connection.

Returns

array
The list of tables in the connected database/schema.

false