Class Collection
Represents a database schema collection
Gives a simple high-level schema reflection API that can be decorated or extended with additional behavior like caching.
See: \Cake\Database\Schema\SchemaDialect For lower level schema reflection API
Property Summary
-
$_connection protected
Cake\Database\ConnectionConnection object
-
$_dialect protected
Cake\Database\Schema\SchemaDialect|nullSchema dialect instance.
Method Summary
-
__construct() public
Constructor.
-
describe() public
Get the column metadata for a table.
-
getDialect() protected
Setups the schema dialect to be used for this collection.
-
listTables() public
Get the list of tables and views available in the current connection.
-
listTablesWithoutViews() public
Get the list of tables, excluding any views, available in the current connection.
Method Detail
__construct() ¶ public
__construct(Cake\Database\Connection $connection)Constructor.
Parameters
-
Cake\Database\Connection$connection The connection instance.
describe() ¶ public
describe(string $name, array<string, mixed> $options = []): Cake\Database\Schema\TableSchemaInterfaceGet the column metadata for a table.
The name can include a database schema name in the form 'schema.table'.
Parameters
-
string$name The name of the table to describe.
-
array<string, mixed>$options optional Unused
Returns
Cake\Database\Schema\TableSchemaInterfaceThrows
Cake\Database\Exception\DatabaseExceptionwhen table cannot be described.
getDialect() ¶ protected
getDialect(): Cake\Database\Schema\SchemaDialectSetups the schema dialect to be used for this collection.
Returns
Cake\Database\Schema\SchemaDialectlistTables() ¶ public
listTables(): array<string>Get the list of tables and views available in the current connection.
Returns
array<string>listTablesWithoutViews() ¶ public
listTablesWithoutViews(): array<string>Get the list of tables, excluding any views, available in the current connection.
Returns
array<string>