Class BaseSchema
Base class for schema implementations.
This class contains methods that are common across the various SQL dialects.
Property Summary
-
$_driver protected
Cake\Database\DriverInterfaceThe driver instance being used.
Method Summary
-
__construct() public
Constructor
-
_convertConstraintColumns() protected
Convert foreign key constraints references to a valid stringified list
-
_convertOnClause() protected
Convert string on clauses to the abstract ones.
-
_foreignOnClause() protected
Generate an ON clause for a foreign key.
-
addConstraintSql() abstract public
Generate the SQL queries needed to add foreign key constraints to the table
-
columnSql() abstract public
Generate the SQL fragment for a single column in a table.
-
constraintSql() abstract public
Generate the SQL fragments for defining table constraints.
-
convertColumnDescription() abstract public
Convert field description results into abstract schema fields.
-
convertForeignKeyDescription() abstract public
Convert a foreign key description into constraints on the Table object.
-
convertIndexDescription() abstract public
Convert an index description results into abstract schema indexes or constraints.
-
convertOptionsDescription() public
Convert options data into table options.
-
createTableSql() abstract public
Generate the SQL to create a table.
-
describeColumnSql() abstract public
Generate the SQL to describe a table.
-
describeForeignKeySql() abstract public
Generate the SQL to describe the foreign keys in a table.
-
describeIndexSql() abstract public
Generate the SQL to describe the indexes in a table.
-
describeOptionsSql() public
Generate the SQL to describe table options
-
dropConstraintSql() abstract public
Generate the SQL queries needed to drop foreign key constraints from the table
-
dropTableSql() public
Generate the SQL to drop a table.
-
indexSql() abstract public
Generate the SQL fragment for a single index in a table.
-
listTablesSql() abstract public
Generate the SQL to list the tables.
-
truncateTableSql() abstract public
Generate the SQL to truncate a table.
Method Detail
__construct() ¶ public
__construct(Cake\Database\DriverInterface $driver)Constructor
This constructor will connect the driver so that methods like columnSql() and others will fail when the driver has not been connected.
Parameters
-
Cake\Database\DriverInterface$driver The driver to use.
_convertConstraintColumns() ¶ protected
_convertConstraintColumns(string|array $references): stringConvert foreign key constraints references to a valid stringified list
Parameters
-
string|array$references The referenced columns of a foreign key constraint statement
Returns
string_convertOnClause() ¶ protected
_convertOnClause(string $clause): stringConvert string on clauses to the abstract ones.
Parameters
-
string$clause The on clause to convert.
Returns
string_foreignOnClause() ¶ protected
_foreignOnClause(string $on): stringGenerate an ON clause for a foreign key.
Parameters
-
string$on The on clause
Returns
stringaddConstraintSql() ¶ abstract public
addConstraintSql(Cake\Database\Schema\TableSchema $schema): arrayGenerate the SQL queries needed to add foreign key constraints to the table
Parameters
-
Cake\Database\Schema\TableSchema$schema The table instance the foreign key constraints are.
Returns
arraycolumnSql() ¶ abstract public
columnSql(Cake\Database\Schema\TableSchema $schema, string $name): stringGenerate the SQL fragment for a single column in a table.
Parameters
-
Cake\Database\Schema\TableSchema$schema The table instance the column is in.
-
string$name The name of the column.
Returns
stringconstraintSql() ¶ abstract public
constraintSql(Cake\Database\Schema\TableSchema $schema, string $name): stringGenerate the SQL fragments for defining table constraints.
Parameters
-
Cake\Database\Schema\TableSchema$schema The table instance the column is in.
-
string$name The name of the column.
Returns
stringconvertColumnDescription() ¶ abstract public
convertColumnDescription(Cake\Database\Schema\TableSchema $schema, array $row): voidConvert field description results into abstract schema fields.
Parameters
-
Cake\Database\Schema\TableSchema$schema The table object to append fields to.
-
array$row The row data from
describeColumnSql.
Returns
voidconvertForeignKeyDescription() ¶ abstract public
convertForeignKeyDescription(Cake\Database\Schema\TableSchema $schema, array $row): voidConvert a foreign key description into constraints on the Table object.
Parameters
-
Cake\Database\Schema\TableSchema$schema The table object to append a constraint to.
-
array$row The row data from
describeForeignKeySql.
Returns
voidconvertIndexDescription() ¶ abstract public
convertIndexDescription(Cake\Database\Schema\TableSchema $schema, array $row): voidConvert an index description results into abstract schema indexes or constraints.
Parameters
-
Cake\Database\Schema\TableSchema$schema The table object to append an index or constraint to.
-
array$row The row data from
describeIndexSql.
Returns
voidconvertOptionsDescription() ¶ public
convertOptionsDescription(Cake\Database\Schema\TableSchema $schema, array $row): voidConvert options data into table options.
Parameters
-
Cake\Database\Schema\TableSchema$schema Table instance.
-
array$row The row of data.
Returns
voidcreateTableSql() ¶ abstract public
createTableSql(Cake\Database\Schema\TableSchema $schema, string[] $columns, string[] $constraints, string[] $indexes): string[]Generate the SQL to create a table.
Parameters
-
Cake\Database\Schema\TableSchema$schema Table instance.
-
string[]$columns The columns to go inside the table.
-
string[]$constraints The constraints for the table.
-
string[]$indexes The indexes for the table.
Returns
string[]describeColumnSql() ¶ abstract public
describeColumnSql(string $tableName, array $config): arrayGenerate the SQL to describe a table.
Parameters
-
string$tableName The table name to get information on.
-
array$config The connection configuration.
Returns
arraydescribeForeignKeySql() ¶ abstract public
describeForeignKeySql(string $tableName, array $config): arrayGenerate the SQL to describe the foreign keys in a table.
Parameters
-
string$tableName The table name to get information on.
-
array$config The connection configuration.
Returns
arraydescribeIndexSql() ¶ abstract public
describeIndexSql(string $tableName, array $config): arrayGenerate the SQL to describe the indexes in a table.
Parameters
-
string$tableName The table name to get information on.
-
array$config The connection configuration.
Returns
arraydescribeOptionsSql() ¶ public
describeOptionsSql(string $tableName, array $config): arrayGenerate the SQL to describe table options
Parameters
-
string$tableName Table name.
-
array$config The connection configuration.
Returns
arraydropConstraintSql() ¶ abstract public
dropConstraintSql(Cake\Database\Schema\TableSchema $schema): arrayGenerate the SQL queries needed to drop foreign key constraints from the table
Parameters
-
Cake\Database\Schema\TableSchema$schema The table instance the foreign key constraints are.
Returns
arraydropTableSql() ¶ public
dropTableSql(Cake\Database\Schema\TableSchema $schema): arrayGenerate the SQL to drop a table.
Parameters
-
Cake\Database\Schema\TableSchema$schema Schema instance
Returns
arrayindexSql() ¶ abstract public
indexSql(Cake\Database\Schema\TableSchema $schema, string $name): stringGenerate the SQL fragment for a single index in a table.
Parameters
-
Cake\Database\Schema\TableSchema$schema The table object the column is in.
-
string$name The name of the column.
Returns
stringlistTablesSql() ¶ abstract public
listTablesSql(array $config): arrayGenerate the SQL to list the tables.
Parameters
-
array$config The connection configuration to use for getting tables from.
Returns
arraytruncateTableSql() ¶ abstract public
truncateTableSql(Cake\Database\Schema\TableSchema $schema): arrayGenerate the SQL to truncate a table.
Parameters
-
Cake\Database\Schema\TableSchema$schema Table instance.
Returns
array