1972 lines
88 KiB
HTML
1972 lines
88 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
|
|
<html lang="en">
|
|
<head>
|
|
|
|
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
|
|
<meta name="when" content="Wed, 14 Apr 2010 15:12:04 +0000">
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
|
|
<link rel="start" href="../../../overview-summary.html">
|
|
|
|
<title>AbstractPlatform (Doctrine)</title>
|
|
|
|
</head>
|
|
<body id="definition" onload="parent.document.title=document.title;">
|
|
|
|
<div class="header">
|
|
<h1>Doctrine</h1>
|
|
<ul>
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="../../../doctrine/dbal/platforms/package-summary.html">Namespace</a></li>
|
|
<li class="active">Class</li>
|
|
<li><a href="../../../doctrine/dbal/platforms/package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="small_links">
|
|
<a href="../../../index.html" target="_top">Frames</a>
|
|
<a href="../../../doctrine/dbal/platforms/abstractplatform.html" target="_top">No frames</a>
|
|
</div>
|
|
<div class="small_links">
|
|
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
|
|
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
|
|
</div>
|
|
<hr>
|
|
|
|
<div class="qualifiedName">Doctrine\DBAL\Platforms\AbstractPlatform</div>
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 47</div>
|
|
|
|
<h1>Class AbstractPlatform</h1>
|
|
|
|
<pre class="tree"><strong>AbstractPlatform</strong><br /></pre>
|
|
|
|
<hr>
|
|
|
|
<p class="signature">public abstract class <strong>AbstractPlatform</strong></p>
|
|
|
|
<div class="comment" id="overview_description"><p>Base class for all DatabasePlatforms. The DatabasePlatforms are the central
|
|
point of abstraction of platform-specific behaviors, features and SQL dialects.
|
|
They are a passive source of information.</p></div>
|
|
|
|
<dl>
|
|
<dt>License:</dt>
|
|
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
|
|
<dt>See Also:</dt>
|
|
<dd><code>www.doctrine-project.org</code></dd>
|
|
<dt>Since:</dt>
|
|
<dd>2.0</dd>
|
|
<dt>Version:</dt>
|
|
<dd>$Revision: 3938 $</dd>
|
|
<dt>Author:</dt>
|
|
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
|
|
<dd>Jonathan Wage <jonwage@gmail.com></dd>
|
|
<dd>Roman Borschel <roman@code-factory.org></dd>
|
|
<dd>Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)</dd>
|
|
<dt>Todo:</dt>
|
|
<dd>Remove any unnecessary methods.</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<table id="summary_field">
|
|
<tr><th colspan="2">Field Summary</th></tr>
|
|
<tr>
|
|
<td class="type">final int</td>
|
|
<td class="description"><p class="name"><a href="#CREATE_FOREIGNKEYS">CREATE_FOREIGNKEYS</a></p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">final int</td>
|
|
<td class="description"><p class="name"><a href="#CREATE_INDEXES">CREATE_INDEXES</a></p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">final int</td>
|
|
<td class="description"><p class="name"><a href="#TRIM_BOTH">TRIM_BOTH</a></p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">final int</td>
|
|
<td class="description"><p class="name"><a href="#TRIM_LEADING">TRIM_LEADING</a></p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">final int</td>
|
|
<td class="description"><p class="name"><a href="#TRIM_TRAILING">TRIM_TRAILING</a></p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">final int</td>
|
|
<td class="description"><p class="name"><a href="#TRIM_UNSPECIFIED">$TRIM_UNSPECIFIED</a></p><p class="description"></p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table id="summary_constr">
|
|
<tr><th colspan="2">Constructor Summary</th></tr>
|
|
<tr>
|
|
<td class="description"><p class="name"><a href="#AbstractPlatform()">AbstractPlatform</a>()</p><p class="description">Constructor.</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table id="summary_method">
|
|
<tr><th colspan="2">Method Summary</th></tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#convertBooleans()">convertBooleans</a>(mixed item)</p><p class="description">Some platforms need the boolean values to be converted.
|
|
</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> bool</td>
|
|
<td class="description"><p class="name"><a href="#createsExplicitIndexForForeignKeys()">createsExplicitIndexForForeignKeys</a>()</p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#fixSchemaElementName()">fixSchemaElementName</a>(mixed schemaElementName, string schemaName)</p><p class="description">Makes any fixes to a name of a schema element (table, sequence, ...) that are required
|
|
by restrictions of the platform, like a maximum length.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getAcosExpression()">getAcosExpression</a>(mixed value)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getAdvancedForeignKeyOptionsSQL()">getAdvancedForeignKeyOptionsSQL</a>(<a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> foreignKey)</p><p class="description">Return the FOREIGN KEY query section dealing with non-standard options
|
|
as MATCH, INITIALLY DEFERRED, ON UPDATE, ...</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#getAlterTableSQL()">getAlterTableSQL</a>(<a href="../../../doctrine/dbal/schema/tablediff.html">TableDiff</a> diff)</p><p class="description">Gets the sql statements for altering an existing table.
|
|
</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getAvgExpression()">getAvgExpression</a>(string column)</p><p class="description">Returns the average value of a column</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getBetweenExpression()">getBetweenExpression</a>(string expression, string value1, string value2)</p><p class="description">Returns SQL that checks if an expression evaluates to a value between
|
|
two values.
|
|
</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">abstract string</td>
|
|
<td class="description"><p class="name"><a href="#getBigIntTypeDeclarationSQL()">getBigIntTypeDeclarationSQL</a>(array columnDef)</p><p class="description">Gets the SQL snippet that declares an 8 byte integer column.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">abstract string</td>
|
|
<td class="description"><p class="name"><a href="#getBooleanTypeDeclarationSQL()">getBooleanTypeDeclarationSQL</a>(array columnDef)</p><p class="description">Gets the SQL snippet that declares a boolean column.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getCheckDeclarationSQL()">getCheckDeclarationSQL</a>(array definition)</p><p class="description">Obtain DBMS specific SQL code portion needed to set a CHECK constraint
|
|
declaration to be used in statements like CREATE TABLE.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">abstract void</td>
|
|
<td class="description"><p class="name"><a href="#getClobTypeDeclarationSQL()">getClobTypeDeclarationSQL</a>(array field)</p><p class="description">Gets the SQL snippet used to declare a CLOB column type.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getColumnCharsetDeclarationSQL()">getColumnCharsetDeclarationSQL</a>(string charset)</p><p class="description">Obtain DBMS specific SQL code portion needed to set the CHARACTER SET
|
|
of a field declaration to be used in statements like CREATE TABLE.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getColumnCollationDeclarationSQL()">getColumnCollationDeclarationSQL</a>(string collation)</p><p class="description">Obtain DBMS specific SQL code portion needed to set the COLLATION
|
|
of a field declaration to be used in statements like CREATE TABLE.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getColumnDeclarationListSQL()">getColumnDeclarationListSQL</a>(array fields)</p><p class="description">Get declaration of a number of fields in bulk</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getColumnDeclarationSQL()">getColumnDeclarationSQL</a>(string name, array field)</p><p class="description">Obtain DBMS specific SQL code portion needed to declare a generic type
|
|
field to be used in statements like CREATE TABLE.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getConcatExpression()">getConcatExpression</a>(string arg1,)</p><p class="description">Returns a series of strings concatinatedconcat() accepts an arbitrary number of parameters. </p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getCosExpression()">getCosExpression</a>(mixed value)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getCountExpression()">getCountExpression</a>(string|integer column)</p><p class="description">Returns the number of rows (without a NULL value) of a columnIf a '*' is used instead of a column the number of selected rows
|
|
is returned.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getCreateConstraintSQL()">getCreateConstraintSQL</a>(<a href="../../../doctrine/dbal/schema/constraint.html">Constraint</a> constraint, string|Table table)</p><p class="description">Gets the SQL to create a constraint on a table on this platform.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getCreateDatabaseSQL()">getCreateDatabaseSQL</a>(mixed database)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getCreateForeignKeySQL()">getCreateForeignKeySQL</a>(<a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> foreignKey, string|Table table)</p><p class="description">Create a new foreign key</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getCreateIndexSQL()">getCreateIndexSQL</a>(<a href="../../../doctrine/dbal/schema/index.html">Index</a> index, string|Table table)</p><p class="description">Gets the SQL to create an index on a table on this platform.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getCreateSequenceSQL()">getCreateSequenceSQL</a>(\Doctrine\DBAL\Schema\Sequence sequence)</p><p class="description">Gets the SQL to create a sequence on this platform.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#getCreateTableSQL()">getCreateTableSQL</a>(string table, int createFlags)</p><p class="description">Gets the SQL statement(s) to create a table with the specified name, columns and constraints
|
|
on this platform.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getCreateTemporaryTableSnippetSQL()">getCreateTemporaryTableSnippetSQL</a>()</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getCreateViewSQL()">getCreateViewSQL</a>(mixed name, mixed sql)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getCurrentDateSQL()">getCurrentDateSQL</a>()</p><p class="description">Gets the SQL specific for the platform to get the current date.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getCurrentTimeSQL()">getCurrentTimeSQL</a>()</p><p class="description">Gets the SQL specific for the platform to get the current time.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getCurrentTimestampSQL()">getCurrentTimestampSQL</a>()</p><p class="description">Gets the SQL specific for the platform to get the current timestamp</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getCustomTypeDeclarationSQL()">getCustomTypeDeclarationSQL</a>(mixed columnDef)</p><p class="description">getCustomTypeDeclarationSql
|
|
Obtail SQL code portion needed to create a custom column,
|
|
e.g. </p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getDateFormatString()">getDateFormatString</a>()</p><p class="description">Gets the format string, as accepted by the date() function, that describes
|
|
the format of a stored date value of this platform.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getDateTimeFormatString()">getDateTimeFormatString</a>()</p><p class="description">Gets the format string, as accepted by the date() function, that describes
|
|
the format of a stored datetime value of this platform.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getDateTimeTypeDeclarationSQL()">getDateTimeTypeDeclarationSQL</a>(array fieldDeclaration)</p><p class="description">Obtain DBMS specific SQL to be used to create datetime fields in
|
|
statements like CREATE TABLE</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getDateTypeDeclarationSQL()">getDateTypeDeclarationSQL</a>(array fieldDeclaration)</p><p class="description">Obtain DBMS specific SQL to be used to create date fields in statements
|
|
like CREATE TABLE.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getDecimalTypeDeclarationSQL()">getDecimalTypeDeclarationSQL</a>(array columnDef)</p><p class="description">Gets the SQL snippet that declares a floating point column of arbitrary precision.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> integer</td>
|
|
<td class="description"><p class="name"><a href="#getDefaultTransactionIsolationLevel()">getDefaultTransactionIsolationLevel</a>()</p><p class="description">Gets the default transaction isolation level of the platform.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getDefaultValueDeclarationSQL()">getDefaultValueDeclarationSQL</a>(array field)</p><p class="description">Obtain DBMS specific SQL code portion needed to set a default value
|
|
declaration to be used in statements like CREATE TABLE.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getDropConstraintSQL()">getDropConstraintSQL</a>(\Doctrine\DBAL\Schema\Constraint constraint, string|Table table)</p><p class="description">Get drop constraint sql</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getDropDatabaseSQL()">getDropDatabaseSQL</a>(mixed database)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getDropForeignKeySQL()">getDropForeignKeySQL</a>(ForeignKeyConstraint|string foreignKey, Table|string table)</p><p class="description"></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getDropIndexSQL()">getDropIndexSQL</a>(mixed index, string|Table table, Index|string name)</p><p class="description">Drop index from a table</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getDropSequenceSQL()">getDropSequenceSQL</a>(mixed sequence)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getDropTableSQL()">getDropTableSQL</a>(Table|string table)</p><p class="description">Drop a Table</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getDropViewSQL()">getDropViewSQL</a>(mixed name)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getEmptyIdentityInsertSQL()">getEmptyIdentityInsertSQL</a>(string tableName, string identifierColumnName)</p><p class="description">Get the insert sql for an empty insert statement</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getForUpdateSql()">getForUpdateSql</a>()</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getForeignKeyBaseDeclarationSQL()">getForeignKeyBaseDeclarationSQL</a>(<a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> foreignKey)</p><p class="description">Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
|
|
of a field declaration to be used in statements like CREATE TABLE.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getForeignKeyDeclarationSQL()">getForeignKeyDeclarationSQL</a>(mixed foreignKey, array definition)</p><p class="description">Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
|
|
of a field declaration to be used in statements like CREATE TABLE.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getForeignKeyReferentialActionSQL()">getForeignKeyReferentialActionSQL</a>(string action, string foreign)</p><p class="description">returns given referential action in uppercase if valid, otherwise throws
|
|
an exception</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getIdentifierQuoteCharacter()">getIdentifierQuoteCharacter</a>()</p><p class="description">Gets the character used for identifier quoting.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getIdentityColumnNullInsertSQL()">getIdentityColumnNullInsertSQL</a>()</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getInExpression()">getInExpression</a>(string column, string|array(string) values)</p><p class="description">Returns the SQL to check if a value is one in a set of
|
|
given values.
|
|
</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getIndexDeclarationSQL()">getIndexDeclarationSQL</a>(string name, <a href="../../../doctrine/dbal/schema/index.html">Index</a> index)</p><p class="description">Obtain DBMS specific SQL code portion needed to set an index
|
|
declaration to be used in statements like CREATE TABLE.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getIndexFieldDeclarationListSQL()">getIndexFieldDeclarationListSQL</a>(mixed fields)</p><p class="description">getIndexFieldDeclarationList
|
|
Obtain DBMS specific SQL code portion needed to set an index
|
|
declaration to be used in statements like CREATE TABLE.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">abstract string</td>
|
|
<td class="description"><p class="name"><a href="#getIntegerTypeDeclarationSQL()">getIntegerTypeDeclarationSQL</a>(array columnDef)</p><p class="description">Gets the SQL snippet that declares a 4 byte integer column.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getIsNotNullExpression()">getIsNotNullExpression</a>(string expression)</p><p class="description">Returns SQL that checks if a expression is not null.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getIsNullExpression()">getIsNullExpression</a>(string expression)</p><p class="description">Returns SQL that checks if a expression is null.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getLengthExpression()">getLengthExpression</a>(mixed column, string expression1, string expression2)</p><p class="description">Returns the length of a text field.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getListDatabasesSQL()">getListDatabasesSQL</a>()</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getListSequencesSQL()">getListSequencesSQL</a>(mixed database)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getListTableColumnsSQL()">getListTableColumnsSQL</a>(mixed table)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getListTableConstraintsSQL()">getListTableConstraintsSQL</a>(mixed table)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getListTableForeignKeysSQL()">getListTableForeignKeysSQL</a>(mixed table)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getListTableIndexesSQL()">getListTableIndexesSQL</a>(mixed table)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getListTablesSQL()">getListTablesSQL</a>()</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getListUsersSQL()">getListUsersSQL</a>()</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getListViewsSQL()">getListViewsSQL</a>(string database)</p><p class="description">Get the SQL to list all views of a database or user.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> integer</td>
|
|
<td class="description"><p class="name"><a href="#getLocateExpression()">getLocateExpression</a>(string str, string substr, mixed startPos, int pos)</p><p class="description">returns the position of the first occurrence of substring $substr in string $str</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getLowerExpression()">getLowerExpression</a>(string str)</p><p class="description">lower
|
|
Returns the string $str with all characters changed to
|
|
lowercase according to the current character set mapping.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getLtrimExpression()">getLtrimExpression</a>(string str)</p><p class="description">ltrim
|
|
returns the string $str with leading space characters removed</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getMaxExpression()">getMaxExpression</a>(string column)</p><p class="description">Returns the highest value of a column</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> int</td>
|
|
<td class="description"><p class="name"><a href="#getMaxIdentifierLength()">getMaxIdentifierLength</a>()</p><p class="description">Maximum length of any given databse identifier, like tables or column names.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getMd5Expression()">getMd5Expression</a>(mixed column)</p><p class="description">Returns the md5 sum of a field.
|
|
</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getMinExpression()">getMinExpression</a>(string column)</p><p class="description">Returns the lowest value of a column</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getModExpression()">getModExpression</a>(string expression1, string expression2)</p><p class="description">Returns the remainder of the division operation
|
|
$expression1 / $expression2.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">abstract string</td>
|
|
<td class="description"><p class="name"><a href="#getName()">getName</a>()</p><p class="description">Gets the name of the platform.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getNotExpression()">getNotExpression</a>(mixed expression)</p><p class="description">Returns the SQL for a logical not.
|
|
</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getNowExpression()">getNowExpression</a>()</p><p class="description">Returns the current system date.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getPiExpression()">getPiExpression</a>()</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getRegexpExpression()">getRegexpExpression</a>()</p><p class="description">Returns the regular expression operator.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getRoundExpression()">getRoundExpression</a>(mixed column, mixed decimals, string expression1, string expression2)</p><p class="description">Rounds a numeric field to the number of decimals specified.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getRtrimExpression()">getRtrimExpression</a>(string str)</p><p class="description">rtrim
|
|
returns the string $str with proceeding space characters removed</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getSQLResultCasing()">getSQLResultCasing</a>(string column)</p><p class="description">Gets the character casing of a column in an SQL result set of this platform.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getSequenceNextValSQL()">getSequenceNextValSQL</a>(mixed sequenceName)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getSetCharsetSQL()">getSetCharsetSQL</a>(string charset)</p><p class="description">Gets the SQL statement specific for the platform to set the charset.
|
|
</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getSetTransactionIsolationSQL()">getSetTransactionIsolationSQL</a>(integer level)</p><p class="description">Get sql to set the transaction isolation level</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getShowDatabasesSQL()">getShowDatabasesSQL</a>()</p><p class="description">Get sql query to show a list of database.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#getSinExpression()">getSinExpression</a>(mixed value)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">abstract string</td>
|
|
<td class="description"><p class="name"><a href="#getSmallIntTypeDeclarationSQL()">getSmallIntTypeDeclarationSQL</a>(array columnDef)</p><p class="description">Gets the SQL snippet that declares a 2 byte integer column.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getSqlCommentEndString()">getSqlCommentEndString</a>()</p><p class="description">Gets the string portion that ends an SQL comment.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getSqlCommentStartString()">getSqlCommentStartString</a>()</p><p class="description">Gets the string portion that starts an SQL comment.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getSubstringExpression()">getSubstringExpression</a>(string value, integer from, integer len)</p><p class="description">return string to call a function to get a substring inside an SQL statementNote: Not SQL92, but common functionality.
|
|
</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getSumExpression()">getSumExpression</a>(string column)</p><p class="description">Returns the total sum of a column</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getTemporaryTableSQL()">getTemporaryTableSQL</a>()</p><p class="description">A method to return the required SQL string that fits between CREATE ... </p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getTimeFormatString()">getTimeFormatString</a>()</p><p class="description">Gets the format string, as accepted by the date() function, that describes
|
|
the format of a stored time value of this platform.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getTimeTypeDeclarationSQL()">getTimeTypeDeclarationSQL</a>(array fieldDeclaration)</p><p class="description">Obtain DBMS specific SQL to be used to create time fields in statements
|
|
like CREATE TABLE.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getTrimExpression()">getTrimExpression</a>(string str, int pos, string char)</p><p class="description">Trim a string, leading/trailing/both and with a given char which defaults to space.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getTruncateTableSQL()">getTruncateTableSQL</a>(string tableName, bool cascade)</p><p class="description">Generate a Truncate Table SQL statement for a given table.
|
|
</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getUniqueConstraintDeclarationSQL()">getUniqueConstraintDeclarationSQL</a>(string name, <a href="../../../doctrine/dbal/schema/index.html">Index</a> index)</p><p class="description">Obtain DBMS specific SQL code portion needed to set a unique
|
|
constraint declaration to be used in statements like CREATE TABLE.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getUniqueFieldDeclarationSQL()">getUniqueFieldDeclarationSQL</a>()</p><p class="description">Obtain DBMS specific SQL code portion needed to set the UNIQUE constraint
|
|
of a field declaration to be used in statements like CREATE TABLE.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#getUpperExpression()">getUpperExpression</a>(string str)</p><p class="description">upper
|
|
Returns the string $str with all characters changed to
|
|
uppercase according to the current character set mapping.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> integer</td>
|
|
<td class="description"><p class="name"><a href="#getVarcharMaxLength()">getVarcharMaxLength</a>()</p><p class="description">Gets the maximum length of a varchar field.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">abstract void</td>
|
|
<td class="description"><p class="name"><a href="#getVarcharTypeDeclarationSQL()">getVarcharTypeDeclarationSQL</a>(array field)</p><p class="description">Gets the SQL snippet used to declare a VARCHAR column type.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> array</td>
|
|
<td class="description"><p class="name"><a href="#getWildcards()">getWildcards</a>()</p><p class="description">Gets all SQL wildcard characters of the platform.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#modifyLimitQuery()">modifyLimitQuery</a>(mixed query, mixed limit, mixed offset)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> boolean</td>
|
|
<td class="description"><p class="name"><a href="#prefersIdentityColumns()">prefersIdentityColumns</a>()</p><p class="description">Whether the platform prefers identity columns (eg. </p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> boolean</td>
|
|
<td class="description"><p class="name"><a href="#prefersSequences()">prefersSequences</a>()</p><p class="description">Whether the platform prefers sequences for ID generation.
|
|
</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> string</td>
|
|
<td class="description"><p class="name"><a href="#quoteIdentifier()">quoteIdentifier</a>(string str)</p><p class="description">Quotes a string so that it can be safely used as a table or column name,
|
|
even if it is a reserved word of the platform.
|
|
</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> void</td>
|
|
<td class="description"><p class="name"><a href="#supportsAlterTable()">supportsAlterTable</a>()</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> boolean</td>
|
|
<td class="description"><p class="name"><a href="#supportsForeignKeyConstraints()">supportsForeignKeyConstraints</a>()</p><p class="description">Does the platform supports foreign key constraints?</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> bool</td>
|
|
<td class="description"><p class="name"><a href="#supportsForeignKeyOnUpdate()">supportsForeignKeyOnUpdate</a>()</p><p class="description">Does this platform supports onUpdate in foreign key constraints?</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> boolean</td>
|
|
<td class="description"><p class="name"><a href="#supportsGettingAffectedRows()">supportsGettingAffectedRows</a>()</p><p class="description">Whether the platform supports getting the affected rows of a recent
|
|
update/delete type query.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> boolean</td>
|
|
<td class="description"><p class="name"><a href="#supportsIdentityColumns()">supportsIdentityColumns</a>()</p><p class="description">Whether the platform supports identity columns.
|
|
</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> boolean</td>
|
|
<td class="description"><p class="name"><a href="#supportsIndexes()">supportsIndexes</a>()</p><p class="description">Whether the platform supports indexes.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> boolean</td>
|
|
<td class="description"><p class="name"><a href="#supportsPrimaryConstraints()">supportsPrimaryConstraints</a>()</p><p class="description">Whether the platform supports primary key constraints.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> boolean</td>
|
|
<td class="description"><p class="name"><a href="#supportsSavepoints()">supportsSavepoints</a>()</p><p class="description">Whether the platform supports savepoints.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> boolean</td>
|
|
<td class="description"><p class="name"><a href="#supportsSchemas()">supportsSchemas</a>()</p><p class="description">Whether the platform supports database schemas.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> boolean</td>
|
|
<td class="description"><p class="name"><a href="#supportsSequences()">supportsSequences</a>()</p><p class="description">Whether the platform supports sequences.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> boolean</td>
|
|
<td class="description"><p class="name"><a href="#supportsTransactions()">supportsTransactions</a>()</p><p class="description">Whether the platform supports transactions.</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2 id="detail_field">Field Detail</h2>
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 57</div>
|
|
<h3 id="CREATE_FOREIGNKEYS">CREATE_FOREIGNKEYS</h3>
|
|
<code class="signature">public final int <strong>CREATE_FOREIGNKEYS</strong> = 2</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 52</div>
|
|
<h3 id="CREATE_INDEXES">CREATE_INDEXES</h3>
|
|
<code class="signature">public final int <strong>CREATE_INDEXES</strong> = 1</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 77</div>
|
|
<h3 id="TRIM_BOTH">TRIM_BOTH</h3>
|
|
<code class="signature">public final int <strong>TRIM_BOTH</strong> = 3</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 67</div>
|
|
<h3 id="TRIM_LEADING">TRIM_LEADING</h3>
|
|
<code class="signature">public final int <strong>TRIM_LEADING</strong> = 1</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 72</div>
|
|
<h3 id="TRIM_TRAILING">TRIM_TRAILING</h3>
|
|
<code class="signature">public final int <strong>TRIM_TRAILING</strong> = 2</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 62</div>
|
|
<h3 id="TRIM_UNSPECIFIED">TRIM_UNSPECIFIED</h3>
|
|
<code class="signature">public final int <strong>$TRIM_UNSPECIFIED</strong></code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<h2 id="detail_constr">Constructor Detail</h2>
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 82</div>
|
|
<h3 id="AbstractPlatform()">AbstractPlatform</h3>
|
|
<code class="signature">public <strong>AbstractPlatform</strong>()</code>
|
|
<div class="details">
|
|
<p>Constructor.</p></div>
|
|
|
|
<hr>
|
|
|
|
<h2 id="detail_method">Method Detail</h2>
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1382</div>
|
|
<h3 id="convertBooleans()">convertBooleans</h3>
|
|
<code class="signature">public void <strong>convertBooleans</strong>(mixed item)</code>
|
|
<div class="details">
|
|
<p>Some platforms need the boolean values to be converted.</p><p>The default conversion in this implementation converts to integers (false => 0, true => 1).</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1696</div>
|
|
<h3 id="createsExplicitIndexForForeignKeys()">createsExplicitIndexForForeignKeys</h3>
|
|
<code class="signature">public bool <strong>createsExplicitIndexForForeignKeys</strong>()</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1805</div>
|
|
<h3 id="fixSchemaElementName()">fixSchemaElementName</h3>
|
|
<code class="signature">public string <strong>fixSchemaElementName</strong>(mixed schemaElementName, string schemaName)</code>
|
|
<div class="details">
|
|
<p>Makes any fixes to a name of a schema element (table, sequence, ...) that are required
|
|
by restrictions of the platform, like a maximum length.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 471</div>
|
|
<h3 id="getAcosExpression()">getAcosExpression</h3>
|
|
<code class="signature">public void <strong>getAcosExpression</strong>(mixed value)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1246</div>
|
|
<h3 id="getAdvancedForeignKeyOptionsSQL()">getAdvancedForeignKeyOptionsSQL</h3>
|
|
<code class="signature">public string <strong>getAdvancedForeignKeyOptionsSQL</strong>(<a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> foreignKey)</code>
|
|
<div class="details">
|
|
<p>Return the FOREIGN KEY query section dealing with non-standard options
|
|
as MATCH, INITIALLY DEFERRED, ON UPDATE, ...</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>foreignKey - foreign key definition</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 829</div>
|
|
<h3 id="getAlterTableSQL()">getAlterTableSQL</h3>
|
|
<code class="signature">public array <strong>getAlterTableSQL</strong>(<a href="../../../doctrine/dbal/schema/tablediff.html">TableDiff</a> diff)</code>
|
|
<div class="details">
|
|
<p>Gets the sql statements for altering an existing table.</p><p>The method returns an array of sql statements, since some platforms need several statements.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 150</div>
|
|
<h3 id="getAvgExpression()">getAvgExpression</h3>
|
|
<code class="signature">public string <strong>getAvgExpression</strong>(string column)</code>
|
|
<div class="details">
|
|
<p>Returns the average value of a column</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>column - the column to use</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>generated sql including an AVG aggregate function</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 466</div>
|
|
<h3 id="getBetweenExpression()">getBetweenExpression</h3>
|
|
<code class="signature">public string <strong>getBetweenExpression</strong>(string expression, string value1, string value2)</code>
|
|
<div class="details">
|
|
<p>Returns SQL that checks if an expression evaluates to a value between
|
|
two values.</p><p>The parameter $expression is checked if it is between $value1 and $value2.</p><p>Note: There is a slight difference in the way BETWEEN works on some databases.
|
|
http://www.w3schools.com/sql/sql_between.asp. If you want complete database
|
|
independence you should avoid using between().</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>expression - the value to compare to</dd>
|
|
<dd>value1 - the lower value to compare with</dd>
|
|
<dd>value2 - the higher value to compare with</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>logical expression</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1014</div>
|
|
<h3 id="getBigIntTypeDeclarationSQL()">getBigIntTypeDeclarationSQL</h3>
|
|
<code class="signature">public abstract string <strong>getBigIntTypeDeclarationSQL</strong>(array columnDef)</code>
|
|
<div class="details">
|
|
<p>Gets the SQL snippet that declares an 8 byte integer column.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 998</div>
|
|
<h3 id="getBooleanTypeDeclarationSQL()">getBooleanTypeDeclarationSQL</h3>
|
|
<code class="signature">public abstract string <strong>getBooleanTypeDeclarationSQL</strong>(array columnDef)</code>
|
|
<div class="details">
|
|
<p>Gets the SQL snippet that declares a boolean column.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1063</div>
|
|
<h3 id="getCheckDeclarationSQL()">getCheckDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getCheckDeclarationSQL</strong>(array definition)</code>
|
|
<div class="details">
|
|
<p>Obtain DBMS specific SQL code portion needed to set a CHECK constraint
|
|
declaration to be used in statements like CREATE TABLE.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>definition - check definition</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>DBMS specific SQL code portion needed to set a CHECK constraint</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1778</div>
|
|
<h3 id="getClobTypeDeclarationSQL()">getClobTypeDeclarationSQL</h3>
|
|
<code class="signature">public abstract void <strong>getClobTypeDeclarationSQL</strong>(array field)</code>
|
|
<div class="details">
|
|
<p>Gets the SQL snippet used to declare a CLOB column type.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1335</div>
|
|
<h3 id="getColumnCharsetDeclarationSQL()">getColumnCharsetDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getColumnCharsetDeclarationSQL</strong>(string charset)</code>
|
|
<div class="details">
|
|
<p>Obtain DBMS specific SQL code portion needed to set the CHARACTER SET
|
|
of a field declaration to be used in statements like CREATE TABLE.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>charset - name of the charset</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>DBMS specific SQL code portion needed to set the CHARACTER SET of a field declaration.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1348</div>
|
|
<h3 id="getColumnCollationDeclarationSQL()">getColumnCollationDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getColumnCollationDeclarationSQL</strong>(string collation)</code>
|
|
<div class="details">
|
|
<p>Obtain DBMS specific SQL code portion needed to set the COLLATION
|
|
of a field declaration to be used in statements like CREATE TABLE.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>collation - name of the collation</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>DBMS specific SQL code portion needed to set the COLLATION of a field declaration.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 905</div>
|
|
<h3 id="getColumnDeclarationListSQL()">getColumnDeclarationListSQL</h3>
|
|
<code class="signature">public string <strong>getColumnDeclarationListSQL</strong>(array fields)</code>
|
|
<div class="details">
|
|
<p>Get declaration of a number of fields in bulk</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>fields - a multidimensional associative array. The first dimension determines the field name, while the second dimension is keyed with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows: length Integer value that determines the maximum length of the text field. If this argument is missing the field should be declared to have the longest length allowed by the DBMS. default Text value to be used as default for this field. notnull Boolean flag that indicates whether this field is constrained to not be set to null. charset Text value with the default CHARACTER SET for this field. collation Text value with the default COLLATION for this field. unique unique constraint</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 948</div>
|
|
<h3 id="getColumnDeclarationSQL()">getColumnDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getColumnDeclarationSQL</strong>(string name, array field)</code>
|
|
<div class="details">
|
|
<p>Obtain DBMS specific SQL code portion needed to declare a generic type
|
|
field to be used in statements like CREATE TABLE.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>name - name the field to be declared.</dd>
|
|
<dd>field - associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows: length Integer value that determines the maximum length of the text field. If this argument is missing the field should be declared to have the longest length allowed by the DBMS. default Text value to be used as default for this field. notnull Boolean flag that indicates whether this field is constrained to not be set to null. charset Text value with the default CHARACTER SET for this field. collation Text value with the default COLLATION for this field. unique unique constraint check column check constraint columnDefinition a string that defines the complete column</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>DBMS specific SQL code portion that should be used to declare the column.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 380</div>
|
|
<h3 id="getConcatExpression()">getConcatExpression</h3>
|
|
<code class="signature">public string <strong>getConcatExpression</strong>(string arg1,)</code>
|
|
<div class="details">
|
|
<p>Returns a series of strings concatinated</p><p>concat() accepts an arbitrary number of parameters. Each parameter
|
|
must contain an expression</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>arg1, - $arg2 ... $argN strings that will be concatinated.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 486</div>
|
|
<h3 id="getCosExpression()">getCosExpression</h3>
|
|
<code class="signature">public void <strong>getCosExpression</strong>(mixed value)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 164</div>
|
|
<h3 id="getCountExpression()">getCountExpression</h3>
|
|
<code class="signature">public string <strong>getCountExpression</strong>(string|integer column)</code>
|
|
<div class="details">
|
|
<p>Returns the number of rows (without a NULL value) of a column</p><p>If a '*' is used instead of a column the number of selected rows
|
|
is returned.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>column - the column to use</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>generated sql including a COUNT aggregate function</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 714</div>
|
|
<h3 id="getCreateConstraintSQL()">getCreateConstraintSQL</h3>
|
|
<code class="signature">public string <strong>getCreateConstraintSQL</strong>(<a href="../../../doctrine/dbal/schema/constraint.html">Constraint</a> constraint, string|Table table)</code>
|
|
<div class="details">
|
|
<p>Gets the SQL to create a constraint on a table on this platform.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1532</div>
|
|
<h3 id="getCreateDatabaseSQL()">getCreateDatabaseSQL</h3>
|
|
<code class="signature">public void <strong>getCreateDatabaseSQL</strong>(mixed database)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 810</div>
|
|
<h3 id="getCreateForeignKeySQL()">getCreateForeignKeySQL</h3>
|
|
<code class="signature">public string <strong>getCreateForeignKeySQL</strong>(<a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> foreignKey, string|Table table)</code>
|
|
<div class="details">
|
|
<p>Create a new foreign key</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>foreignKey - ForeignKey instance</dd>
|
|
<dd>table - name of the table on which the foreign key is to be created</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 761</div>
|
|
<h3 id="getCreateIndexSQL()">getCreateIndexSQL</h3>
|
|
<code class="signature">public string <strong>getCreateIndexSQL</strong>(<a href="../../../doctrine/dbal/schema/index.html">Index</a> index, string|Table table)</code>
|
|
<div class="details">
|
|
<p>Gets the SQL to create an index on a table on this platform.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd></dd>
|
|
<dd>table - name of the table on which the index is to be created</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 702</div>
|
|
<h3 id="getCreateSequenceSQL()">getCreateSequenceSQL</h3>
|
|
<code class="signature">public void <strong>getCreateSequenceSQL</strong>(\Doctrine\DBAL\Schema\Sequence sequence)</code>
|
|
<div class="details">
|
|
<p>Gets the SQL to create a sequence on this platform.</p><dl>
|
|
<dt>Throws:</dt>
|
|
<dd><a href="../../../doctrine/dbal/dbalexception.html">DBALException</a></dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 580</div>
|
|
<h3 id="getCreateTableSQL()">getCreateTableSQL</h3>
|
|
<code class="signature">public array <strong>getCreateTableSQL</strong>(string table, int createFlags)</code>
|
|
<div class="details">
|
|
<p>Gets the SQL statement(s) to create a table with the specified name, columns and constraints
|
|
on this platform.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>table - The name of the table.</dd>
|
|
<dd></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The sequence of SQL statements.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 691</div>
|
|
<h3 id="getCreateTemporaryTableSnippetSQL()">getCreateTemporaryTableSnippetSQL</h3>
|
|
<code class="signature">public void <strong>getCreateTemporaryTableSnippetSQL</strong>()</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1512</div>
|
|
<h3 id="getCreateViewSQL()">getCreateViewSQL</h3>
|
|
<code class="signature">public void <strong>getCreateViewSQL</strong>(mixed name, mixed sql)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1415</div>
|
|
<h3 id="getCurrentDateSQL()">getCurrentDateSQL</h3>
|
|
<code class="signature">public string <strong>getCurrentDateSQL</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the SQL specific for the platform to get the current date.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1425</div>
|
|
<h3 id="getCurrentTimeSQL()">getCurrentTimeSQL</h3>
|
|
<code class="signature">public string <strong>getCurrentTimeSQL</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the SQL specific for the platform to get the current time.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1435</div>
|
|
<h3 id="getCurrentTimestampSQL()">getCurrentTimestampSQL</h3>
|
|
<code class="signature">public string <strong>getCurrentTimestampSQL</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the SQL specific for the platform to get the current timestamp</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1136</div>
|
|
<h3 id="getCustomTypeDeclarationSQL()">getCustomTypeDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getCustomTypeDeclarationSQL</strong>(mixed columnDef)</code>
|
|
<div class="details">
|
|
<p>getCustomTypeDeclarationSql
|
|
Obtail SQL code portion needed to create a custom column,
|
|
e.g. when a field has the "columnDefinition" keyword.
|
|
Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1737</div>
|
|
<h3 id="getDateFormatString()">getDateFormatString</h3>
|
|
<code class="signature">public string <strong>getDateFormatString</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the format string, as accepted by the date() function, that describes
|
|
the format of a stored date value of this platform.</p><dl>
|
|
<dt>Returns:</dt>
|
|
<dd>The format string.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1726</div>
|
|
<h3 id="getDateTimeFormatString()">getDateTimeFormatString</h3>
|
|
<code class="signature">public string <strong>getDateTimeFormatString</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the format string, as accepted by the date() function, that describes
|
|
the format of a stored datetime value of this platform.</p><dl>
|
|
<dt>Returns:</dt>
|
|
<dd>The format string.</dd>
|
|
<dt>Todo:</dt>
|
|
<dd>We need to get the specific format for each dbms and override this function for each platform</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1554</div>
|
|
<h3 id="getDateTimeTypeDeclarationSQL()">getDateTimeTypeDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getDateTimeTypeDeclarationSQL</strong>(array fieldDeclaration)</code>
|
|
<div class="details">
|
|
<p>Obtain DBMS specific SQL to be used to create datetime fields in
|
|
statements like CREATE TABLE</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1566</div>
|
|
<h3 id="getDateTypeDeclarationSQL()">getDateTypeDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getDateTypeDeclarationSQL</strong>(array fieldDeclaration)</code>
|
|
<div class="details">
|
|
<p>Obtain DBMS specific SQL to be used to create date fields in statements
|
|
like CREATE TABLE.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 982</div>
|
|
<h3 id="getDecimalTypeDeclarationSQL()">getDecimalTypeDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getDecimalTypeDeclarationSQL</strong>(array columnDef)</code>
|
|
<div class="details">
|
|
<p>Gets the SQL snippet that declares a floating point column of arbitrary precision.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1589</div>
|
|
<h3 id="getDefaultTransactionIsolationLevel()">getDefaultTransactionIsolationLevel</h3>
|
|
<code class="signature">public integer <strong>getDefaultTransactionIsolationLevel</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the default transaction isolation level of the platform.</p><dl>
|
|
<dt>Returns:</dt>
|
|
<dd>The default isolation level.</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>constants.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1039</div>
|
|
<h3 id="getDefaultValueDeclarationSQL()">getDefaultValueDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getDefaultValueDeclarationSQL</strong>(array field)</code>
|
|
<div class="details">
|
|
<p>Obtain DBMS specific SQL code portion needed to set a default value
|
|
declaration to be used in statements like CREATE TABLE.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>field - field definition array</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>DBMS specific SQL code portion needed to set a default value</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 541</div>
|
|
<h3 id="getDropConstraintSQL()">getDropConstraintSQL</h3>
|
|
<code class="signature">public string <strong>getDropConstraintSQL</strong>(\Doctrine\DBAL\Schema\Constraint constraint, string|Table table)</code>
|
|
<div class="details">
|
|
<p>Get drop constraint sql</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 496</div>
|
|
<h3 id="getDropDatabaseSQL()">getDropDatabaseSQL</h3>
|
|
<code class="signature">public void <strong>getDropDatabaseSQL</strong>(mixed database)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 559</div>
|
|
<h3 id="getDropForeignKeySQL()">getDropForeignKeySQL</h3>
|
|
<code class="signature">public string <strong>getDropForeignKeySQL</strong>(ForeignKeyConstraint|string foreignKey, Table|string table)</code>
|
|
<div class="details">
|
|
<p></p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 523</div>
|
|
<h3 id="getDropIndexSQL()">getDropIndexSQL</h3>
|
|
<code class="signature">public string <strong>getDropIndexSQL</strong>(mixed index, string|Table table, Index|string name)</code>
|
|
<div class="details">
|
|
<p>Drop index from a table</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1522</div>
|
|
<h3 id="getDropSequenceSQL()">getDropSequenceSQL</h3>
|
|
<code class="signature">public void <strong>getDropSequenceSQL</strong>(mixed sequence)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 507</div>
|
|
<h3 id="getDropTableSQL()">getDropTableSQL</h3>
|
|
<code class="signature">public string <strong>getDropTableSQL</strong>(Table|string table)</code>
|
|
<div class="details">
|
|
<p>Drop a Table</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1517</div>
|
|
<h3 id="getDropViewSQL()">getDropViewSQL</h3>
|
|
<code class="signature">public void <strong>getDropViewSQL</strong>(mixed name)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1827</div>
|
|
<h3 id="getEmptyIdentityInsertSQL()">getEmptyIdentityInsertSQL</h3>
|
|
<code class="signature">public string <strong>getEmptyIdentityInsertSQL</strong>(string tableName, string identifierColumnName)</code>
|
|
<div class="details">
|
|
<p>Get the insert sql for an empty insert statement</p><dl>
|
|
<dt>Returns:</dt>
|
|
<dd>$sql</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 491</div>
|
|
<h3 id="getForUpdateSql()">getForUpdateSql</h3>
|
|
<code class="signature">public void <strong>getForUpdateSql</strong>()</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1289</div>
|
|
<h3 id="getForeignKeyBaseDeclarationSQL()">getForeignKeyBaseDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getForeignKeyBaseDeclarationSQL</strong>(<a href="../../../doctrine/dbal/schema/foreignkeyconstraint.html">ForeignKeyConstraint</a> foreignKey)</code>
|
|
<div class="details">
|
|
<p>Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
|
|
of a field declaration to be used in statements like CREATE TABLE.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1231</div>
|
|
<h3 id="getForeignKeyDeclarationSQL()">getForeignKeyDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getForeignKeyDeclarationSQL</strong>(mixed foreignKey, array definition)</code>
|
|
<div class="details">
|
|
<p>Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
|
|
of a field declaration to be used in statements like CREATE TABLE.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>definition - an associative array with the following structure: name optional constraint name local the local field(s) foreign the foreign reference field(s) foreignTable the name of the foreign table onDelete referential delete action onUpdate referential update action deferred deferred constraint checking The onDelete and onUpdate keys accept the following values: CASCADE: Delete or update the row from the parent table and automatically delete or update the matching rows in the child table. Both ON DELETE CASCADE and ON UPDATE CASCADE are supported. Between two tables, you should not define several ON UPDATE CASCADE clauses that act on the same column in the parent table or in the child table. SET NULL: Delete or update the row from the parent table and set the foreign key column or columns in the child table to NULL. This is valid only if the foreign key columns do not have the NOT NULL qualifier specified. Both ON DELETE SET NULL and ON UPDATE SET NULL clauses are supported. NO ACTION: In standard SQL, NO ACTION means no action in the sense that an attempt to delete or update a primary key value is not allowed to proceed if there is a related foreign key value in the referenced table. RESTRICT: Rejects the delete or update operation for the parent table. NO ACTION and RESTRICT are the same as omitting the ON DELETE or ON UPDATE clause. SET DEFAULT</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>DBMS specific SQL code portion needed to set the FOREIGN KEY constraint of a field declaration.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1266</div>
|
|
<h3 id="getForeignKeyReferentialActionSQL()">getForeignKeyReferentialActionSQL</h3>
|
|
<code class="signature">public void <strong>getForeignKeyReferentialActionSQL</strong>(string action, string foreign)</code>
|
|
<div class="details">
|
|
<p>returns given referential action in uppercase if valid, otherwise throws
|
|
an exception</p><dl>
|
|
<dt>Throws:</dt>
|
|
<dd>if unknown referential action given</dd>
|
|
<dt>Parameters:</dt>
|
|
<dd>action - foreign key referential action</dd>
|
|
<dd>foreign - key referential action in uppercase</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 89</div>
|
|
<h3 id="getIdentifierQuoteCharacter()">getIdentifierQuoteCharacter</h3>
|
|
<code class="signature">public string <strong>getIdentifierQuoteCharacter</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the character used for identifier quoting.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1712</div>
|
|
<h3 id="getIdentityColumnNullInsertSQL()">getIdentityColumnNullInsertSQL</h3>
|
|
<code class="signature">public void <strong>getIdentityColumnNullInsertSQL</strong>()</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 416</div>
|
|
<h3 id="getInExpression()">getInExpression</h3>
|
|
<code class="signature">public string <strong>getInExpression</strong>(string column, string|array(string) values)</code>
|
|
<div class="details">
|
|
<p>Returns the SQL to check if a value is one in a set of
|
|
given values.</p><p>in() accepts an arbitrary number of parameters. The first parameter
|
|
must always specify the value that should be matched against. Successive
|
|
must contain a logical expression or an array with logical expressions.
|
|
These expressions will be matched against the first parameter.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>column - the value that should be matched against</dd>
|
|
<dd>values - that will be matched against $column</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>logical expression</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1111</div>
|
|
<h3 id="getIndexDeclarationSQL()">getIndexDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getIndexDeclarationSQL</strong>(string name, <a href="../../../doctrine/dbal/schema/index.html">Index</a> index)</code>
|
|
<div class="details">
|
|
<p>Obtain DBMS specific SQL code portion needed to set an index
|
|
declaration to be used in statements like CREATE TABLE.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>name - name of the index</dd>
|
|
<dd>index - index definition</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>DBMS specific SQL code portion needed to set an index</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1148</div>
|
|
<h3 id="getIndexFieldDeclarationListSQL()">getIndexFieldDeclarationListSQL</h3>
|
|
<code class="signature">public string <strong>getIndexFieldDeclarationListSQL</strong>(mixed fields)</code>
|
|
<div class="details">
|
|
<p>getIndexFieldDeclarationList
|
|
Obtain DBMS specific SQL code portion needed to set an index
|
|
declaration to be used in statements like CREATE TABLE.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1006</div>
|
|
<h3 id="getIntegerTypeDeclarationSQL()">getIntegerTypeDeclarationSQL</h3>
|
|
<code class="signature">public abstract string <strong>getIntegerTypeDeclarationSQL</strong>(array columnDef)</code>
|
|
<div class="details">
|
|
<p>Gets the SQL snippet that declares a 4 byte integer column.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 446</div>
|
|
<h3 id="getIsNotNullExpression()">getIsNotNullExpression</h3>
|
|
<code class="signature">public string <strong>getIsNotNullExpression</strong>(string expression)</code>
|
|
<div class="details">
|
|
<p>Returns SQL that checks if a expression is not null.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>expression - the expression that should be compared to null</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>logical expression</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 435</div>
|
|
<h3 id="getIsNullExpression()">getIsNullExpression</h3>
|
|
<code class="signature">public string <strong>getIsNullExpression</strong>(string expression)</code>
|
|
<div class="details">
|
|
<p>Returns SQL that checks if a expression is null.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>expression - the expression that should be compared to null</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>logical expression</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 223</div>
|
|
<h3 id="getLengthExpression()">getLengthExpression</h3>
|
|
<code class="signature">public string <strong>getLengthExpression</strong>(mixed column, string expression1, string expression2)</code>
|
|
<div class="details">
|
|
<p>Returns the length of a text field.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1461</div>
|
|
<h3 id="getListDatabasesSQL()">getListDatabasesSQL</h3>
|
|
<code class="signature">public void <strong>getListDatabasesSQL</strong>()</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1466</div>
|
|
<h3 id="getListSequencesSQL()">getListSequencesSQL</h3>
|
|
<code class="signature">public void <strong>getListSequencesSQL</strong>(mixed database)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1476</div>
|
|
<h3 id="getListTableColumnsSQL()">getListTableColumnsSQL</h3>
|
|
<code class="signature">public void <strong>getListTableColumnsSQL</strong>(mixed table)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1471</div>
|
|
<h3 id="getListTableConstraintsSQL()">getListTableConstraintsSQL</h3>
|
|
<code class="signature">public void <strong>getListTableConstraintsSQL</strong>(mixed table)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1507</div>
|
|
<h3 id="getListTableForeignKeysSQL()">getListTableForeignKeysSQL</h3>
|
|
<code class="signature">public void <strong>getListTableForeignKeysSQL</strong>(mixed table)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1502</div>
|
|
<h3 id="getListTableIndexesSQL()">getListTableIndexesSQL</h3>
|
|
<code class="signature">public void <strong>getListTableIndexesSQL</strong>(mixed table)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1481</div>
|
|
<h3 id="getListTablesSQL()">getListTablesSQL</h3>
|
|
<code class="signature">public void <strong>getListTablesSQL</strong>()</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1486</div>
|
|
<h3 id="getListUsersSQL()">getListUsersSQL</h3>
|
|
<code class="signature">public void <strong>getListUsersSQL</strong>()</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1497</div>
|
|
<h3 id="getListViewsSQL()">getListViewsSQL</h3>
|
|
<code class="signature">public string <strong>getListViewsSQL</strong>(string database)</code>
|
|
<div class="details">
|
|
<p>Get the SQL to list all views of a database or user.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 335</div>
|
|
<h3 id="getLocateExpression()">getLocateExpression</h3>
|
|
<code class="signature">public integer <strong>getLocateExpression</strong>(string str, string substr, mixed startPos, int pos)</code>
|
|
<div class="details">
|
|
<p>returns the position of the first occurrence of substring $substr in string $str</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>substr - literal string to find</dd>
|
|
<dd>str - literal string</dd>
|
|
<dd>pos - position to start at, beginning of string by default</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 322</div>
|
|
<h3 id="getLowerExpression()">getLowerExpression</h3>
|
|
<code class="signature">public string <strong>getLowerExpression</strong>(string str)</code>
|
|
<div class="details">
|
|
<p>lower
|
|
Returns the string $str with all characters changed to
|
|
lowercase according to the current character set mapping.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>str - literal string or column name</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 296</div>
|
|
<h3 id="getLtrimExpression()">getLtrimExpression</h3>
|
|
<code class="signature">public string <strong>getLtrimExpression</strong>(string str)</code>
|
|
<div class="details">
|
|
<p>ltrim
|
|
returns the string $str with leading space characters removed</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>str - literal string or column name</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 175</div>
|
|
<h3 id="getMaxExpression()">getMaxExpression</h3>
|
|
<code class="signature">public string <strong>getMaxExpression</strong>(string column)</code>
|
|
<div class="details">
|
|
<p>Returns the highest value of a column</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>column - the column to use</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>generated sql including a MAX aggregate function</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1815</div>
|
|
<h3 id="getMaxIdentifierLength()">getMaxIdentifierLength</h3>
|
|
<code class="signature">public int <strong>getMaxIdentifierLength</strong>()</code>
|
|
<div class="details">
|
|
<p>Maximum length of any given databse identifier, like tables or column names.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 211</div>
|
|
<h3 id="getMd5Expression()">getMd5Expression</h3>
|
|
<code class="signature">public string <strong>getMd5Expression</strong>(mixed column)</code>
|
|
<div class="details">
|
|
<p>Returns the md5 sum of a field.</p><p>Note: Not SQL92, but common functionality</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 186</div>
|
|
<h3 id="getMinExpression()">getMinExpression</h3>
|
|
<code class="signature">public string <strong>getMinExpression</strong>(string column)</code>
|
|
<div class="details">
|
|
<p>Returns the lowest value of a column</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>column - the column to use</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 248</div>
|
|
<h3 id="getModExpression()">getModExpression</h3>
|
|
<code class="signature">public string <strong>getModExpression</strong>(string expression1, string expression2)</code>
|
|
<div class="details">
|
|
<p>Returns the remainder of the division operation
|
|
$expression1 / $expression2.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1785</div>
|
|
<h3 id="getName()">getName</h3>
|
|
<code class="signature">public abstract string <strong>getName</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the name of the platform.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 398</div>
|
|
<h3 id="getNotExpression()">getNotExpression</h3>
|
|
<code class="signature">public string <strong>getNotExpression</strong>(mixed expression)</code>
|
|
<div class="details">
|
|
<p>Returns the SQL for a logical not.</p><p>Example:
|
|
<code>
|
|
$q = new Doctrine_Query();
|
|
$e = $q->expr;
|
|
$q->select('*')->from('table')
|
|
->where($e->eq('id', $e->not('null'));
|
|
</code></p><dl>
|
|
<dt>Returns:</dt>
|
|
<dd>a logical expression</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 345</div>
|
|
<h3 id="getNowExpression()">getNowExpression</h3>
|
|
<code class="signature">public string <strong>getNowExpression</strong>()</code>
|
|
<div class="details">
|
|
<p>Returns the current system date.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 481</div>
|
|
<h3 id="getPiExpression()">getPiExpression</h3>
|
|
<code class="signature">public void <strong>getPiExpression</strong>()</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 139</div>
|
|
<h3 id="getRegexpExpression()">getRegexpExpression</h3>
|
|
<code class="signature">public string <strong>getRegexpExpression</strong>()</code>
|
|
<div class="details">
|
|
<p>Returns the regular expression operator.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 235</div>
|
|
<h3 id="getRoundExpression()">getRoundExpression</h3>
|
|
<code class="signature">public string <strong>getRoundExpression</strong>(mixed column, mixed decimals, string expression1, string expression2)</code>
|
|
<div class="details">
|
|
<p>Rounds a numeric field to the number of decimals specified.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 284</div>
|
|
<h3 id="getRtrimExpression()">getRtrimExpression</h3>
|
|
<code class="signature">public string <strong>getRtrimExpression</strong>(string str)</code>
|
|
<div class="details">
|
|
<p>rtrim
|
|
returns the string $str with proceeding space characters removed</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>str - literal string or column name</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1793</div>
|
|
<h3 id="getSQLResultCasing()">getSQLResultCasing</h3>
|
|
<code class="signature">public string <strong>getSQLResultCasing</strong>(string column)</code>
|
|
<div class="details">
|
|
<p>Gets the character casing of a column in an SQL result set of this platform.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>column - The column name for which to get the correct character casing.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The column name in the character casing used in SQL result sets.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1527</div>
|
|
<h3 id="getSequenceNextValSQL()">getSequenceNextValSQL</h3>
|
|
<code class="signature">public void <strong>getSequenceNextValSQL</strong>(mixed sequenceName)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1405</div>
|
|
<h3 id="getSetCharsetSQL()">getSetCharsetSQL</h3>
|
|
<code class="signature">public string <strong>getSetCharsetSQL</strong>(string charset)</code>
|
|
<div class="details">
|
|
<p>Gets the SQL statement specific for the platform to set the charset.</p><p>This function is MySQL specific and required by
|
|
\Doctrine\DBAL\Connection::setCharset($charset)</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1542</div>
|
|
<h3 id="getSetTransactionIsolationSQL()">getSetTransactionIsolationSQL</h3>
|
|
<code class="signature">public void <strong>getSetTransactionIsolationSQL</strong>(integer level)</code>
|
|
<div class="details">
|
|
<p>Get sql to set the transaction isolation level</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1185</div>
|
|
<h3 id="getShowDatabasesSQL()">getShowDatabasesSQL</h3>
|
|
<code class="signature">public string <strong>getShowDatabasesSQL</strong>()</code>
|
|
<div class="details">
|
|
<p>Get sql query to show a list of database.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 476</div>
|
|
<h3 id="getSinExpression()">getSinExpression</h3>
|
|
<code class="signature">public void <strong>getSinExpression</strong>(mixed value)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1022</div>
|
|
<h3 id="getSmallIntTypeDeclarationSQL()">getSmallIntTypeDeclarationSQL</h3>
|
|
<code class="signature">public abstract string <strong>getSmallIntTypeDeclarationSQL</strong>(array columnDef)</code>
|
|
<div class="details">
|
|
<p>Gets the SQL snippet that declares a 2 byte integer column.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 109</div>
|
|
<h3 id="getSqlCommentEndString()">getSqlCommentEndString</h3>
|
|
<code class="signature">public string <strong>getSqlCommentEndString</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the string portion that ends an SQL comment.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 99</div>
|
|
<h3 id="getSqlCommentStartString()">getSqlCommentStartString</h3>
|
|
<code class="signature">public string <strong>getSqlCommentStartString</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the string portion that starts an SQL comment.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 362</div>
|
|
<h3 id="getSubstringExpression()">getSubstringExpression</h3>
|
|
<code class="signature">public string <strong>getSubstringExpression</strong>(string value, integer from, integer len)</code>
|
|
<div class="details">
|
|
<p>return string to call a function to get a substring inside an SQL statement</p><p>Note: Not SQL92, but common functionality.</p><p>SQLite only supports the 2 parameter variant of this function</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>value - an sql string literal or column name/alias</dd>
|
|
<dd>from - where to start the substring portion</dd>
|
|
<dd>len - the substring portion length</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 197</div>
|
|
<h3 id="getSumExpression()">getSumExpression</h3>
|
|
<code class="signature">public string <strong>getSumExpression</strong>(string column)</code>
|
|
<div class="details">
|
|
<p>Returns the total sum of a column</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>column - the column to use</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1175</div>
|
|
<h3 id="getTemporaryTableSQL()">getTemporaryTableSQL</h3>
|
|
<code class="signature">public string <strong>getTemporaryTableSQL</strong>()</code>
|
|
<div class="details">
|
|
<p>A method to return the required SQL string that fits between CREATE ... TABLE
|
|
to create the table as a temporary table.</p><p>Should be overridden in driver classes to return the correct string for the
|
|
specific database type.</p><p>The default is to return the string "TEMPORARY" - this will result in a
|
|
SQL error for any database that does not support temporary tables, or that
|
|
requires a different SQL command from "CREATE TEMPORARY TABLE".</p><dl>
|
|
<dt>Returns:</dt>
|
|
<dd>The string required to be placed between "CREATE" and "TABLE" to generate a temporary table, if possible.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1748</div>
|
|
<h3 id="getTimeFormatString()">getTimeFormatString</h3>
|
|
<code class="signature">public string <strong>getTimeFormatString</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the format string, as accepted by the date() function, that describes
|
|
the format of a stored time value of this platform.</p><dl>
|
|
<dt>Returns:</dt>
|
|
<dd>The format string.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1578</div>
|
|
<h3 id="getTimeTypeDeclarationSQL()">getTimeTypeDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getTimeTypeDeclarationSQL</strong>(array fieldDeclaration)</code>
|
|
<div class="details">
|
|
<p>Obtain DBMS specific SQL to be used to create time fields in statements
|
|
like CREATE TABLE.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 261</div>
|
|
<h3 id="getTrimExpression()">getTrimExpression</h3>
|
|
<code class="signature">public string <strong>getTrimExpression</strong>(string str, int pos, string char)</code>
|
|
<div class="details">
|
|
<p>Trim a string, leading/trailing/both and with a given char which defaults to space.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd></dd>
|
|
<dd></dd>
|
|
<dd>char - has to be quoted already</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1842</div>
|
|
<h3 id="getTruncateTableSQL()">getTruncateTableSQL</h3>
|
|
<code class="signature">public string <strong>getTruncateTableSQL</strong>(string tableName, bool cascade)</code>
|
|
<div class="details">
|
|
<p>Generate a Truncate Table SQL statement for a given table.</p><p>Cascade is not supported on many platforms but would optionally cascade the truncate by
|
|
following the foreign keys.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1092</div>
|
|
<h3 id="getUniqueConstraintDeclarationSQL()">getUniqueConstraintDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getUniqueConstraintDeclarationSQL</strong>(string name, <a href="../../../doctrine/dbal/schema/index.html">Index</a> index)</code>
|
|
<div class="details">
|
|
<p>Obtain DBMS specific SQL code portion needed to set a unique
|
|
constraint declaration to be used in statements like CREATE TABLE.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>name - name of the unique constraint</dd>
|
|
<dd>index - index definition</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>DBMS specific SQL code portion needed to set a constraint</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1322</div>
|
|
<h3 id="getUniqueFieldDeclarationSQL()">getUniqueFieldDeclarationSQL</h3>
|
|
<code class="signature">public string <strong>getUniqueFieldDeclarationSQL</strong>()</code>
|
|
<div class="details">
|
|
<p>Obtain DBMS specific SQL code portion needed to set the UNIQUE constraint
|
|
of a field declaration to be used in statements like CREATE TABLE.</p><dl>
|
|
<dt>Returns:</dt>
|
|
<dd>DBMS specific SQL code portion needed to set the UNIQUE constraint of a field declaration.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 309</div>
|
|
<h3 id="getUpperExpression()">getUpperExpression</h3>
|
|
<code class="signature">public string <strong>getUpperExpression</strong>(string str)</code>
|
|
<div class="details">
|
|
<p>upper
|
|
Returns the string $str with all characters changed to
|
|
uppercase according to the current character set mapping.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>str - literal string or column name</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 119</div>
|
|
<h3 id="getVarcharMaxLength()">getVarcharMaxLength</h3>
|
|
<code class="signature">public integer <strong>getVarcharMaxLength</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets the maximum length of a varchar field.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1771</div>
|
|
<h3 id="getVarcharTypeDeclarationSQL()">getVarcharTypeDeclarationSQL</h3>
|
|
<code class="signature">public abstract void <strong>getVarcharTypeDeclarationSQL</strong>(array field)</code>
|
|
<div class="details">
|
|
<p>Gets the SQL snippet used to declare a VARCHAR column type.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 129</div>
|
|
<h3 id="getWildcards()">getWildcards</h3>
|
|
<code class="signature">public array <strong>getWildcards</strong>()</code>
|
|
<div class="details">
|
|
<p>Gets all SQL wildcard characters of the platform.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1753</div>
|
|
<h3 id="modifyLimitQuery()">modifyLimitQuery</h3>
|
|
<code class="signature">public void <strong>modifyLimitQuery</strong>(mixed query, mixed limit, mixed offset)</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1370</div>
|
|
<h3 id="prefersIdentityColumns()">prefersIdentityColumns</h3>
|
|
<code class="signature">public boolean <strong>prefersIdentityColumns</strong>()</code>
|
|
<div class="details">
|
|
<p>Whether the platform prefers identity columns (eg. autoincrement) for ID generation.
|
|
Subclasses should override this method to return TRUE if they prefer identity columns.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1359</div>
|
|
<h3 id="prefersSequences()">prefersSequences</h3>
|
|
<code class="signature">public boolean <strong>prefersSequences</strong>()</code>
|
|
<div class="details">
|
|
<p>Whether the platform prefers sequences for ID generation.
|
|
Subclasses should override this method to return TRUE if they prefer sequences.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 796</div>
|
|
<h3 id="quoteIdentifier()">quoteIdentifier</h3>
|
|
<code class="signature">public string <strong>quoteIdentifier</strong>(string str)</code>
|
|
<div class="details">
|
|
<p>Quotes a string so that it can be safely used as a table or column name,
|
|
even if it is a reserved word of the platform.</p><p>NOTE: Just because you CAN use quoted identifiers doesn't mean
|
|
you SHOULD use them. In general, they end up causing way more
|
|
problems than they solve.</p><dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>str - identifier name to be quoted</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>quoted identifier string</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1628</div>
|
|
<h3 id="supportsAlterTable()">supportsAlterTable</h3>
|
|
<code class="signature">public void <strong>supportsAlterTable</strong>()</code>
|
|
<div class="details">
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1668</div>
|
|
<h3 id="supportsForeignKeyConstraints()">supportsForeignKeyConstraints</h3>
|
|
<code class="signature">public boolean <strong>supportsForeignKeyConstraints</strong>()</code>
|
|
<div class="details">
|
|
<p>Does the platform supports foreign key constraints?</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1678</div>
|
|
<h3 id="supportsForeignKeyOnUpdate()">supportsForeignKeyOnUpdate</h3>
|
|
<code class="signature">public bool <strong>supportsForeignKeyOnUpdate</strong>()</code>
|
|
<div class="details">
|
|
<p>Does this platform supports onUpdate in foreign key constraints?</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1707</div>
|
|
<h3 id="supportsGettingAffectedRows()">supportsGettingAffectedRows</h3>
|
|
<code class="signature">public boolean <strong>supportsGettingAffectedRows</strong>()</code>
|
|
<div class="details">
|
|
<p>Whether the platform supports getting the affected rows of a recent
|
|
update/delete type query.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1613</div>
|
|
<h3 id="supportsIdentityColumns()">supportsIdentityColumns</h3>
|
|
<code class="signature">public boolean <strong>supportsIdentityColumns</strong>()</code>
|
|
<div class="details">
|
|
<p>Whether the platform supports identity columns.
|
|
Identity columns are columns that recieve an auto-generated value from the
|
|
database on insert of a row.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1623</div>
|
|
<h3 id="supportsIndexes()">supportsIndexes</h3>
|
|
<code class="signature">public boolean <strong>supportsIndexes</strong>()</code>
|
|
<div class="details">
|
|
<p>Whether the platform supports indexes.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1658</div>
|
|
<h3 id="supportsPrimaryConstraints()">supportsPrimaryConstraints</h3>
|
|
<code class="signature">public boolean <strong>supportsPrimaryConstraints</strong>()</code>
|
|
<div class="details">
|
|
<p>Whether the platform supports primary key constraints.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1648</div>
|
|
<h3 id="supportsSavepoints()">supportsSavepoints</h3>
|
|
<code class="signature">public boolean <strong>supportsSavepoints</strong>()</code>
|
|
<div class="details">
|
|
<p>Whether the platform supports savepoints.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1688</div>
|
|
<h3 id="supportsSchemas()">supportsSchemas</h3>
|
|
<code class="signature">public boolean <strong>supportsSchemas</strong>()</code>
|
|
<div class="details">
|
|
<p>Whether the platform supports database schemas.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1601</div>
|
|
<h3 id="supportsSequences()">supportsSequences</h3>
|
|
<code class="signature">public boolean <strong>supportsSequences</strong>()</code>
|
|
<div class="details">
|
|
<p>Whether the platform supports sequences.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="location">/Doctrine/DBAL/Platforms/AbstractPlatform.php at line 1638</div>
|
|
<h3 id="supportsTransactions()">supportsTransactions</h3>
|
|
<code class="signature">public boolean <strong>supportsTransactions</strong>()</code>
|
|
<div class="details">
|
|
<p>Whether the platform supports transactions.</p></div>
|
|
|
|
<hr>
|
|
|
|
<div class="header">
|
|
<h1>Doctrine</h1>
|
|
<ul>
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="../../../doctrine/dbal/platforms/package-summary.html">Namespace</a></li>
|
|
<li class="active">Class</li>
|
|
<li><a href="../../../doctrine/dbal/platforms/package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="small_links">
|
|
<a href="../../../index.html" target="_top">Frames</a>
|
|
<a href="../../../doctrine/dbal/platforms/abstractplatform.html" target="_top">No frames</a>
|
|
</div>
|
|
<div class="small_links">
|
|
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
|
|
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
|
|
</div>
|
|
<hr>
|
|
|
|
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
|
|
|
|
</body>
|
|
|
|
</html> |