Propel API
Class

MysqlPlatform

class MysqlPlatform extends DefaultPlatform

MySql PropelPlatformInterface implementation.

Methods

__construct(PDO $con = null)

Default constructor.

 from DefaultPlatform
setConnection(PDO $con = null)

Set the database connection to use for this Platform class.

 from DefaultPlatform
PDO getConnection()

Returns the database connection to use for this Platform class.

 from DefaultPlatform
setGeneratorConfig(GeneratorConfig $generatorConfig)

string getDatabaseType()

Returns the short name of the database type that this platform represents.

 from DefaultPlatform
getMaxColumnNameLength()

string getNativeIdMethod()

Returns the native IdMethod (sequence|identity)

 from DefaultPlatform
Domain getDomainForType(string $propelType)

Returns the db specific domain for a propelType.

 from DefaultPlatform
string getNullString($notNull)

from DefaultPlatform
getAutoIncrement()

string getSequenceName(Table $table)

Gets the name to use for creating a sequence for a table.

 from DefaultPlatform
getAddTablesDDL(Database $database)

getBeginDDL()

getEndDDL()

getDropTableDDL(Table $table)

getAddTableDDL(Table $table)

getColumnDDL(Column $col)

string getColumnDefaultValueDDL(Column $col)

Returns the SQL for the default value of a Column object

 from DefaultPlatform
string getColumnListDDL($columns, $delimiter = ',')

Creates a delimiter-delimited string list of column names, quoted using quoteIdentifier().

 from DefaultPlatform
string getPrimaryKeyName(Table $table)

Returns the name of a table primary key

 from DefaultPlatform
string getPrimaryKeyDDL(Table $table)

Returns the SQL for the primary key of a Table object

 from DefaultPlatform
string getDropPrimaryKeyDDL(Table $table)

Builds the DDL SQL to drop the primary key of a table.
string getAddPrimaryKeyDDL(Table $table)

Builds the DDL SQL to add the primary key of a table.

 from DefaultPlatform
string getAddIndicesDDL(Table $table)

Builds the DDL SQL to add the indices of a table.

 from DefaultPlatform
string getAddIndexDDL(Index $index)

Builds the DDL SQL to add an Index.
string getDropIndexDDL(Index $index)

Builds the DDL SQL to drop an Index.
string getIndexDDL(Index $index)

Builds the DDL SQL for an Index object.
getUniqueDDL(Unique $unique)

string getAddForeignKeysDDL(Table $table)

Builds the DDL SQL to add the foreign keys of a table.

 from DefaultPlatform
string getAddForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to add a foreign key.

 from DefaultPlatform
getDropForeignKeyDDL(ForeignKey $fk)

string getForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL for a ForeignKey object.

 from DefaultPlatform
getCommentLineDDL($comment)

from DefaultPlatform
getCommentBlockDDL($comment)

string getModifyDatabaseDDL(PropelDatabaseDiff $databaseDiff)

Builds the DDL SQL to modify a database based on a PropelDatabaseDiff instance
string getRenameTableDDL($fromTableName, $toTableName)

Builds the DDL SQL to rename a table
string getModifyTableDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table based on a PropelTableDiff instance

 from DefaultPlatform
string getModifyTableColumnsDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table based on a PropelTableDiff instance

 from DefaultPlatform
string getModifyTablePrimaryKeyDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table's primary key based on a PropelTableDiff instance

 from DefaultPlatform
string getModifyTableIndicesDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table's indices based on a PropelTableDiff instance

 from DefaultPlatform
string getModifyTableForeignKeysDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table's foreign keys based on a PropelTableDiff instance

 from DefaultPlatform
string getRemoveColumnDDL(Column $column)

Builds the DDL SQL to remove a column
string getRenameColumnDDL($fromColumn, $toColumn)

Builds the DDL SQL to rename a column
string getModifyColumnDDL(PropelColumnDiff $columnDiff)

Builds the DDL SQL to modify a column
string getModifyColumnsDDL($columnDiffs)

Builds the DDL SQL to modify a list of columns
string getAddColumnDDL(Column $column)

Builds the DDL SQL to remove a column

 from DefaultPlatform
string getAddColumnsDDL($columns)

Builds the DDL SQL to remove a list of columns

 from DefaultPlatform
hasSize($sqlType)

boolean hasScale(string $sqlType)

Returns if the RDBMS-specific SQL type has a scale attribute.

 from DefaultPlatform
string quote(string $text)

Quote and escape needed characters in the string for unerlying RDBMS.

 from DefaultPlatform
string quoteIdentifier(string $text)

MySQL documentation says that identifiers cannot contain '.'.
setIdentifierQuoting($enabled = true)

from DefaultPlatform
getIdentifierQuoting()

from DefaultPlatform
supportsNativeDeleteTrigger()

boolean supportsInsertNullPk()

Whether RDBMS supports INSERT null values in autoincremented primary keys

 from DefaultPlatform
boolean hasStreamBlobImpl()

Whether the underlying PDO driver for this platform returns BLOB columns as streams (instead of strings).

 from DefaultPlatform
supportsSchemas()

mixed getBooleanString($b)

Returns the boolean value for the RDBMS.

 from DefaultPlatform
getTimestampFormatter()

string getTimeFormatter()

Gets the preferred time formatter for setting date/time values.

 from DefaultPlatform
string getDateFormatter()

Gets the preferred date formatter for setting date/time values.

 from DefaultPlatform
setTableEngineKeyword(string $tableEngineKeyword)

Setter for the tableEngineKeyword property
string getTableEngineKeyword()

Getter for the tableEngineKeyword property
setDefaultTableEngine(string $defaultTableEngine)

Setter for the defaultTableEngine property
string getDefaultTableEngine()

Getter for the defaultTableEngine property
string getChangeColumnDDL($fromColumn, $toColumn)

Builds the DDL SQL to change a column
string disconnectedEscapeText(string $text)

Escape the string for RDBMS.

Details

in DefaultPlatform at line 48
public __construct(PDO $con = null)

Default constructor.

Parameters

PDO $con Optional database connection to use in this platform.

in DefaultPlatform at line 58
public setConnection(PDO $con = null)

Set the database connection to use for this Platform class.

Parameters

PDO $con Database connection to use in this platform.

in DefaultPlatform at line 67
public PDO getConnection()

Returns the database connection to use for this Platform class.

Return Value

PDO The database connection or NULL if none has been set.

at line 47
public setGeneratorConfig(GeneratorConfig $generatorConfig)

Parameters

GeneratorConfig $generatorConfig

in DefaultPlatform at line 127
public string getDatabaseType()

Returns the short name of the database type that this platform represents.

For example MysqlPlatform->getDatabaseType() returns 'mysql'.

Return Value

string

at line 102
public getMaxColumnNameLength()

in DefaultPlatform at line 149
public string getNativeIdMethod()

Returns the native IdMethod (sequence|identity)

Return Value

string The native IdMethod (PropelPlatformInterface:IDENTITY, PropelPlatformInterface::SEQUENCE).

in DefaultPlatform at line 160
public Domain getDomainForType(string $propelType)

Returns the db specific domain for a propelType.

Parameters

string $propelType the Propel type name.

Return Value

Domain The db specific domain.

in DefaultPlatform at line 172
public string getNullString($notNull)

Parameters

$notNull

Return Value

string The RDBMS-specific SQL fragment for <code>NULL</code> or <code>NOT NULL</code>.

at line 97
public getAutoIncrement()

in DefaultPlatform at line 195
public string getSequenceName(Table $table)

Gets the name to use for creating a sequence for a table.

This will create a new name or use one specified in an id-method-parameter
tag, if specified.

Parameters

Table $table

Return Value

string Sequence name for this table.

at line 112
public getAddTablesDDL(Database $database)

Parameters

Database $database

at line 124
public getBeginDDL()

at line 133
public getEndDDL()

at line 228
public getDropTableDDL(Table $table)

Parameters

Table $table

at line 141
public getAddTableDDL(Table $table)

Parameters

Table $table

at line 235
public getColumnDDL(Column $col)

Parameters

Column $col

in DefaultPlatform at line 340
public string getColumnDefaultValueDDL(Column $col)

Returns the SQL for the default value of a Column object

Parameters

Column $col

Return Value

string

in DefaultPlatform at line 376
public string getColumnListDDL($columns, $delimiter = ',')

Creates a delimiter-delimited string list of column names, quoted using quoteIdentifier().

Parameters

$columns
$delimiter

Return Value

string

in DefaultPlatform at line 392
public string getPrimaryKeyName(Table $table)

Returns the name of a table primary key

Parameters

Table $table

Return Value

string

in DefaultPlatform at line 402
public string getPrimaryKeyDDL(Table $table)

Returns the SQL for the primary key of a Table object

Parameters

Table $table

Return Value

string

at line 328
public string getDropPrimaryKeyDDL(Table $table)

Builds the DDL SQL to drop the primary key of a table.

Parameters

Table $table

Return Value

string

in DefaultPlatform at line 432
public string getAddPrimaryKeyDDL(Table $table)

Builds the DDL SQL to add the primary key of a table.

Parameters

Table $table

Return Value

string

in DefaultPlatform at line 449
public string getAddIndicesDDL(Table $table)

Builds the DDL SQL to add the indices of a table.

Parameters

Table $table

Return Value

string

at line 344
public string getAddIndexDDL(Index $index)

Builds the DDL SQL to add an Index.

Parameters

Index $index

Return Value

string

at line 363
public string getDropIndexDDL(Index $index)

Builds the DDL SQL to drop an Index.

Parameters

Index $index

Return Value

string

at line 378
public string getIndexDDL(Index $index)

Builds the DDL SQL for an Index object.

Parameters

Index $index

Return Value

string

at line 399
public getUniqueDDL(Unique $unique)

Parameters

Unique $unique

in DefaultPlatform at line 525
public string getAddForeignKeysDDL(Table $table)

Builds the DDL SQL to add the foreign keys of a table.

Parameters

Table $table

Return Value

string

in DefaultPlatform at line 540
public string getAddForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to add a foreign key.

Parameters

ForeignKey $fk

Return Value

string

at line 407
public getDropForeignKeyDDL(ForeignKey $fk)

Parameters

ForeignKey $fk

in DefaultPlatform at line 578
public string getForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL for a ForeignKey object.

Parameters

ForeignKey $fk

Return Value

string

in DefaultPlatform at line 604
public getCommentLineDDL($comment)

Parameters

$comment

at line 421
public getCommentBlockDDL($comment)

Parameters

$comment

at line 437
public string getModifyDatabaseDDL(PropelDatabaseDiff $databaseDiff)

Builds the DDL SQL to modify a database based on a PropelDatabaseDiff instance

Parameters

PropelDatabaseDiff $databaseDiff

Return Value

string

at line 466
public string getRenameTableDDL($fromTableName, $toTableName)

Builds the DDL SQL to rename a table

Parameters

$fromTableName
$toTableName

Return Value

string

in DefaultPlatform at line 675
public string getModifyTableDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table based on a PropelTableDiff instance

Parameters

PropelTableDiff $tableDiff

Return Value

string

in DefaultPlatform at line 740
public string getModifyTableColumnsDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table based on a PropelTableDiff instance

Parameters

PropelTableDiff $tableDiff

Return Value

string

in DefaultPlatform at line 769
public string getModifyTablePrimaryKeyDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table's primary key based on a PropelTableDiff instance

Parameters

PropelTableDiff $tableDiff

Return Value

string

in DefaultPlatform at line 787
public string getModifyTableIndicesDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table's indices based on a PropelTableDiff instance

Parameters

PropelTableDiff $tableDiff

Return Value

string

in DefaultPlatform at line 814
public string getModifyTableForeignKeysDDL(PropelTableDiff $tableDiff)

Builds the DDL SQL to alter a table's foreign keys based on a PropelTableDiff instance

Parameters

PropelTableDiff $tableDiff

Return Value

string

at line 482
public string getRemoveColumnDDL(Column $column)

Builds the DDL SQL to remove a column

Parameters

Column $column

Return Value

string

at line 497
public string getRenameColumnDDL($fromColumn, $toColumn)

Builds the DDL SQL to rename a column

Parameters

$fromColumn
$toColumn

Return Value

string

at line 507
public string getModifyColumnDDL(PropelColumnDiff $columnDiff)

Builds the DDL SQL to modify a column

Parameters

PropelColumnDiff $columnDiff

Return Value

string

at line 532
public string getModifyColumnsDDL($columnDiffs)

Builds the DDL SQL to modify a list of columns

Parameters

$columnDiffs

Return Value

string

in DefaultPlatform at line 921
public string getAddColumnDDL(Column $column)

Builds the DDL SQL to remove a column

Parameters

Column $column

Return Value

string

in DefaultPlatform at line 937
public string getAddColumnsDDL($columns)

Builds the DDL SQL to remove a list of columns

Parameters

$columns

Return Value

string

at line 551
public hasSize($sqlType)

Parameters

$sqlType

in DefaultPlatform at line 980
public boolean hasScale(string $sqlType)

Returns if the RDBMS-specific SQL type has a scale attribute.

Parameters

string $sqlType the SQL type

Return Value

boolean True if the type has a scale attribute

in DefaultPlatform at line 990
public string quote(string $text)

Quote and escape needed characters in the string for unerlying RDBMS.

Parameters

string $text

Return Value

string

at line 580
public string quoteIdentifier(string $text)

MySQL documentation says that identifiers cannot contain '.'.

Thus it
should be safe to split the string by '.' and quote each part individually
to allow for a <schema>.<table> or <table>.<column> syntax.

Parameters

string $text the identifier

Return Value

string the quoted identifier

in DefaultPlatform at line 1023
public setIdentifierQuoting($enabled = true)

Parameters

$enabled

in DefaultPlatform at line 1028
public getIdentifierQuoting()

at line 107
public supportsNativeDeleteTrigger()

in DefaultPlatform at line 1046
public boolean supportsInsertNullPk()

Whether RDBMS supports INSERT null values in autoincremented primary keys

Return Value

boolean

in DefaultPlatform at line 1055
public boolean hasStreamBlobImpl()

Whether the underlying PDO driver for this platform returns BLOB columns as streams (instead of strings).

Return Value

boolean

at line 546
public supportsSchemas()

See also

Platform::supportsSchemas()

in DefaultPlatform at line 1080
public mixed getBooleanString($b)

Returns the boolean value for the RDBMS.

This value should match the boolean value that is set
when using Propel's PreparedStatement::setBoolean().

This function is used to set default column values when building
SQL.

Parameters

$b

Return Value

mixed

at line 585
public getTimestampFormatter()

in DefaultPlatform at line 1099
public string getTimeFormatter()

Gets the preferred time formatter for setting date/time values.

Return Value

string

in DefaultPlatform at line 1108
public string getDateFormatter()

Gets the preferred date formatter for setting date/time values.

Return Value

string

at line 62
public setTableEngineKeyword(string $tableEngineKeyword)

Setter for the tableEngineKeyword property

Parameters

string $tableEngineKeyword

at line 72
public string getTableEngineKeyword()

Getter for the tableEngineKeyword property

Return Value

string

at line 82
public setDefaultTableEngine(string $defaultTableEngine)

Setter for the defaultTableEngine property

Parameters

string $defaultTableEngine

at line 92
public string getDefaultTableEngine()

Getter for the defaultTableEngine property

Return Value

string

at line 516
public string getChangeColumnDDL($fromColumn, $toColumn)

Builds the DDL SQL to change a column

Parameters

$fromColumn
$toColumn

Return Value

string

at line 563
public string disconnectedEscapeText(string $text)

Escape the string for RDBMS.

Parameters

string $text

Return Value

string