Interface SqlGeneratorInterface
An interface used by TableSchema objects.
Method Summary
-
addConstraintSql() public
Generate the SQL statements to add the constraints to the table
-
createSql() public
Generate the SQL to create the Table.
-
dropConstraintSql() public
Generate the SQL statements to drop the constraints to the table
-
dropSql() public
Generate the SQL to drop a table.
-
truncateSql() public
Generate the SQL statements to truncate a table
Method Detail
addConstraintSql() ¶ public
addConstraintSql(Cake\Database\Connection $connection): arrayGenerate the SQL statements to add the constraints to the table
Parameters
-
Cake\Database\Connection$connection The connection to generate SQL for.
Returns
arraySQL to add the constraints.
createSql() ¶ public
createSql(Cake\Database\Connection $connection): arrayGenerate the SQL to create the Table.
Uses the connection to access the schema dialect to generate platform specific SQL.
Parameters
-
Cake\Database\Connection$connection The connection to generate SQL for.
Returns
arrayList of SQL statements to create the table and the required indexes.
dropConstraintSql() ¶ public
dropConstraintSql(Cake\Database\Connection $connection): arrayGenerate the SQL statements to drop the constraints to the table
Parameters
-
Cake\Database\Connection$connection The connection to generate SQL for.
Returns
arraySQL to drop a table.
dropSql() ¶ public
dropSql(Cake\Database\Connection $connection): arrayGenerate the SQL to drop a table.
Uses the connection to access the schema dialect to generate platform specific SQL.
Parameters
-
Cake\Database\Connection$connection The connection to generate SQL for.
Returns
arraySQL to drop a table.
truncateSql() ¶ public
truncateSql(Cake\Database\Connection $connection): arrayGenerate the SQL statements to truncate a table
Parameters
-
Cake\Database\Connection$connection The connection to generate SQL for.
Returns
arraySQL to truncate a table.