CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Team
    • Issues (Github)
    • YouTube Channel
    • Get Involved
    • Bakery
    • Featured Resources
    • Newsletter
    • Certification
    • My CakePHP
    • CakeFest
    • Facebook
    • Twitter
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 4.0 Strawberry API

  • Overview
  • Version:
    • 4.0
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
      • Dialect
      • Driver
      • Exception
      • Expression
      • Log
      • Retry
      • Schema
      • Statement
      • Type
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

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)

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.

createSql() public

¶

createSql(\Cake\Database\Connection $connection)

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.

dropConstraintSql() public

¶

dropConstraintSql(\Cake\Database\Connection $connection)

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.

dropSql() public

¶

dropSql(\Cake\Database\Connection $connection)

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() public

¶

truncateSql(\Cake\Database\Connection $connection)

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.