Class Collection
Represents a database schema collection
Used to access information about the tables, and other data in a database.
Properties summary
-
$_connection protected
\Cake\Database\Connection
Connection object
-
$_dialect protected
\Cake\Database\Schema\BaseSchema
Schema dialect instance.
Method Summary
-
__construct() public
Constructor.
-
_reflect() protected
Helper method for running each step of the reflection process.
-
describe() public
Get the column metadata for a table.
-
listTables() public
Get the list of tables available in the current connection.
Method Detail
__construct() public ¶
__construct(\Cake\Database\Connection $connection)
Constructor.
Parameters
-
\Cake\Database\Connection
$connection The connection instance.
_reflect() protected ¶
_reflect(string $stage, string $name, array $config, \Cake\Database\Schema\TableSchema $schema)
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\TableSchema
$schema The table schema instance.
Throws
Cake\Database\Exception
on query failure.
describe() public ¶
describe(string $name, array $options)
Get the column metadata for a table.
The name can include a database schema name in the form 'schema.table'.
Caching will be applied if cacheMetadata
key is present in the Connection
configuration options. Defaults to _cakemodel when true.
Options
forceRefresh
- Set to true to force rebuilding the cached metadata. Defaults to false.
Parameters
-
string
$name The name of the table to describe.
-
array
$options optional The options to use, see above.
Returns
\Cake\Database\Schema\TableSchema
Object with column metadata.
Throws
Cake\Database\Exception
when table cannot be described.
listTables() public ¶
listTables()
Get the list of tables available in the current connection.
Returns
string[]
The list of tables in the connected database/schema.