Propel API
Class

PgsqlPlatform

class PgsqlPlatform extends DefaultPlatform

Postgresql 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 $config)

Sets the GeneratorConfig to use in the parsing.

from DefaultPlatform
string getDatabaseType()

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

from DefaultPlatform
getMaxColumnNameLength()

getNativeIdMethod()

isNativeIdMethodAutoIncrement()

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)

Override to provide sequence names that conform to postgres' standard when no id-method-parameter specified.

getAddTablesDDL(Database $database)

string getBeginDDL()

Gets the requests to execute at the beginning of a DDL file

from DefaultPlatform
string getEndDDL()

Gets the requests to execute at the end of a DDL file

from DefaultPlatform
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
getPrimaryKeyName(Table $table)

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.

from DefaultPlatform
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.

from DefaultPlatform
string getDropIndexDDL(Index $index)

Overrides the implementation from DefaultPlatform

string getIndexDDL(Index $index)

Builds the DDL SQL for an Index object.

from DefaultPlatform
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
string getDropForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to drop a foreign key.

from DefaultPlatform
string getForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL for a ForeignKey object.

from DefaultPlatform
getCommentLineDDL($comment)

from DefaultPlatform
getCommentBlockDDL($comment)

from DefaultPlatform
string getModifyDatabaseDDL(PropelDatabaseDiff $databaseDiff)

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

from DefaultPlatform
string getRenameTableDDL($fromTableName, $toTableName)

Builds the DDL SQL to rename a table

from DefaultPlatform
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

from DefaultPlatform
string getRenameColumnDDL($fromColumn, $toColumn)

Builds the DDL SQL to rename a column

from DefaultPlatform
string getModifyColumnDDL(PropelColumnDiff $columnDiff)

Overrides the implementation from DefaultPlatform

string getModifyColumnsDDL($columnDiffs)

Overrides the implementation from DefaultPlatform

string getAddColumnDDL(Column $column)

Builds the DDL SQL to remove a column

from DefaultPlatform
string getAddColumnsDDL($columns)

Overrides the implementation 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)

Quotes identifiers used in database SQL.

from DefaultPlatform
setIdentifierQuoting($enabled = true)

from DefaultPlatform
getIdentifierQuoting()

from DefaultPlatform
supportsNativeDeleteTrigger()

boolean supportsInsertNullPk()

Whether RDBMS supports INSERT null values in autoincremented primary keys

from DefaultPlatform
hasStreamBlobImpl()

supportsSchemas()

supportsMigrations()

from DefaultPlatform
supportsVarcharWithoutSize()

getBooleanString($b)

getPhpArrayString($stringValue)

from DefaultPlatform
string getTimestampFormatter()

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

from DefaultPlatform
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
getColumnBindingPHP($column, $identifier, $columnValueAccessor, $tab = ' ')

Get the PHP snippet for binding a value to a column.

from DefaultPlatform
getIdentifierPhp($columnValueMutator, $connectionVariableName = '$con', $sequenceName = '', $tab = ' ')

Get the PHP snippet for getting a Pk from the database.

string disconnectedEscapeText(string $text)

Escape the string for RDBMS.

getAddSchemasDDL(Database $database)

getAddSchemaDDL(Table $table)

getUseSchemaDDL(Table $table)

getResetSchemaDDL(Table $table)

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.

in DefaultPlatform at line 77
public setGeneratorConfig(GeneratorConfig $config)

Sets the GeneratorConfig to use in the parsing.

Parameters

GeneratorConfig $config

in DefaultPlatform at line 128
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 59
public getMaxColumnNameLength()

at line 49
public getNativeIdMethod()

in DefaultPlatform at line 156
public isNativeIdMethodAutoIncrement()

in DefaultPlatform at line 168
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.

Exceptions

EngineException

in DefaultPlatform at line 181
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 54
public getAutoIncrement()

at line 100
public string getSequenceName(Table $table)

Override to provide sequence names that conform to postgres' standard when no id-method-parameter specified.

Parameters

Table $table

Return Value

string

at line 201
public getAddTablesDDL(Database $database)

Parameters

Database $database

in DefaultPlatform at line 254
public string getBeginDDL()

Gets the requests to execute at the beginning of a DDL file

Return Value

string

in DefaultPlatform at line 263
public string getEndDDL()

Gets the requests to execute at the end of a DDL file

Return Value

string

at line 292
public getDropTableDDL(Table $table)

Parameters

Table $table

at line 219
public getAddTableDDL(Table $table)

Parameters

Table $table

at line 313
public getColumnDDL(Column $col)

Parameters

Column $col

in DefaultPlatform at line 351
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 395
public string getColumnListDDL($columns, $delimiter = ',')

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

Parameters

$columns
$delimiter

Return Value

string

at line 306
public getPrimaryKeyName(Table $table)

Parameters

Table $table

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

Returns the SQL for the primary key of a Table object

Parameters

Table $table

Return Value

string

in DefaultPlatform at line 436
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 454
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 472
public string getAddIndicesDDL(Table $table)

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

Parameters

Table $table

Return Value

string

in DefaultPlatform at line 488
public string getAddIndexDDL(Index $index)

Builds the DDL SQL to add an Index.

Parameters

Index $index

Return Value

string

at line 470
public string getDropIndexDDL(Index $index)

Overrides the implementation from DefaultPlatform

Parameters

Index $index

Return Value

string

See also

DefaultPlatform::getDropIndexDDL

in DefaultPlatform at line 525
public string getIndexDDL(Index $index)

Builds the DDL SQL for an Index object.

Parameters

Index $index

Return Value

string

at line 341
public getUniqueDDL(Unique $unique)

Parameters

Unique $unique

in DefaultPlatform at line 551
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 567
public string getAddForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to add a foreign key.

Parameters

ForeignKey $fk

Return Value

string

in DefaultPlatform at line 588
public string getDropForeignKeyDDL(ForeignKey $fk)

Builds the DDL SQL to drop a foreign key.

Parameters

ForeignKey $fk

Return Value

string

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

Builds the DDL SQL for a ForeignKey object.

Parameters

ForeignKey $fk

Return Value

string

in DefaultPlatform at line 633
public getCommentLineDDL($comment)

Parameters

$comment

in DefaultPlatform at line 641
public getCommentBlockDDL($comment)

Parameters

$comment

in DefaultPlatform at line 658
public string getModifyDatabaseDDL(PropelDatabaseDiff $databaseDiff)

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

Parameters

PropelDatabaseDiff $databaseDiff

Return Value

string

in DefaultPlatform at line 692
public string getRenameTableDDL($fromTableName, $toTableName)

Builds the DDL SQL to rename a table

Parameters

$fromTableName
$toTableName

Return Value

string

in DefaultPlatform at line 710
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 775
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 804
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 822
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 849
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

in DefaultPlatform at line 875
public string getRemoveColumnDDL(Column $column)

Builds the DDL SQL to remove a column

Parameters

Column $column

Return Value

string

in DefaultPlatform at line 891
public string getRenameColumnDDL($fromColumn, $toColumn)

Builds the DDL SQL to rename a column

Parameters

$fromColumn
$toColumn

Return Value

string

at line 379
public string getModifyColumnDDL(PropelColumnDiff $columnDiff)

Overrides the implementation from DefaultPlatform

Parameters

PropelColumnDiff $columnDiff

Return Value

string

See also

DefaultPlatform::getModifyColumnDDL

at line 436
public string getModifyColumnsDDL($columnDiffs)

Overrides the implementation from DefaultPlatform

Parameters

$columnDiffs

Return Value

string

See also

DefaultPlatform::getModifyColumnsDDL

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

Builds the DDL SQL to remove a column

Parameters

Column $column

Return Value

string

at line 453
public string getAddColumnsDDL($columns)

Overrides the implementation from DefaultPlatform

Parameters

$columns

Return Value

string

See also

DefaultPlatform::getAddColumnsDLL

at line 357
public hasSize($sqlType)

Parameters

$sqlType

in DefaultPlatform at line 1021
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 1031
public string quote(string $text)

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

Parameters

string $text

Return Value

string

in DefaultPlatform at line 1059
public string quoteIdentifier(string $text)

Quotes identifiers used in database SQL.

Parameters

string $text

Return Value

string Quoted identifier.

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

Parameters

$enabled

in DefaultPlatform at line 1069
public getIdentifierQuoting()

at line 87
public supportsNativeDeleteTrigger()

in DefaultPlatform at line 1087
public boolean supportsInsertNullPk()

Whether RDBMS supports INSERT null values in autoincremented primary keys

Return Value

boolean

at line 362
public hasStreamBlobImpl()

at line 352
public supportsSchemas()

See also

Platform::supportsSchemas()

in DefaultPlatform at line 1112
public supportsMigrations()

See also

Platform::supportsMigrations()

at line 367
public supportsVarcharWithoutSize()

at line 78
public getBooleanString($b)

Parameters

$b

in DefaultPlatform at line 1141
public getPhpArrayString($stringValue)

Parameters

$stringValue

in DefaultPlatform at line 1166
public string getTimestampFormatter()

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

Return Value

string

in DefaultPlatform at line 1175
public string getTimeFormatter()

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

Return Value

string

in DefaultPlatform at line 1184
public string getDateFormatter()

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

Return Value

string

in DefaultPlatform at line 1194
public getColumnBindingPHP($column, $identifier, $columnValueAccessor, $tab = ' ')

Get the PHP snippet for binding a value to a column.

Warning: duplicates logic from DBAdapter::bindValue().
Any code modification here must be ported there.

Parameters

$column
$identifier
$columnValueAccessor
$tab

at line 491
public getIdentifierPhp($columnValueMutator, $connectionVariableName = '$con', $sequenceName = '', $tab = ' ')

Get the PHP snippet for getting a Pk from the database.

Warning: duplicates logic from DBPostgres::getId().
Any code modification here must be ported there.

Parameters

$columnValueMutator
$connectionVariableName
$sequenceName
$tab

at line 69
public string disconnectedEscapeText(string $text)

Escape the string for RDBMS.

Parameters

string $text

Return Value

string

at line 152
public getAddSchemasDDL(Database $database)

Parameters

Database $database

at line 167
public getAddSchemaDDL(Table $table)

Parameters

Table $table

at line 179
public getUseSchemaDDL(Table $table)

Parameters

Table $table

at line 191
public getResetSchemaDDL(Table $table)

Parameters

Table $table