Docs4dev
Docs
cakephp / 4.4 / interface-cake.database.schema.sqlgeneratorinterface.html

Interface SqlGeneratorInterface

An interface used by TableSchema objects.

Namespace: Cake\Database\Schema

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): 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

createSql() public

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

dropConstraintSql() public

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

dropSql() public

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

truncateSql() public

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

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/interface-Cake.Database.Schema.SqlGeneratorInterface.html