\Cake\Database\SchemaSqlGeneratorInterface

An interface used by TableSchema objects.

Summary

Methods
Constants
createSql()
dropSql()
truncateSql()
addConstraintSql()
dropConstraintSql()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

createSql()

createSql(\Cake\Database\Connection  $connection) : array

Generate 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

array —

List of SQL statements to create the table and the required indexes.

dropSql()

dropSql(\Cake\Database\Connection  $connection) : array

Generate 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

array —

SQL to drop a table.

truncateSql()

truncateSql(\Cake\Database\Connection  $connection) : array

Generate the SQL statements to truncate a table

Parameters

\Cake\Database\Connection $connection

The connection to generate SQL for.

Returns

array —

SQL to truncate a table.

addConstraintSql()

addConstraintSql(\Cake\Database\Connection  $connection) : array

Generate the SQL statements to add the constraints to the table

Parameters

\Cake\Database\Connection $connection

The connection to generate SQL for.

Returns

array —

SQL to add the constraints.

dropConstraintSql()

dropConstraintSql(\Cake\Database\Connection  $connection) : array

Generate the SQL statements to drop the constraints to the table

Parameters

\Cake\Database\Connection $connection

The connection to generate SQL for.

Returns

array —

SQL to drop a table.