Constructor.

Some platforms need the boolean values to be converted.

The default conversion in this implementation converts to integers (false => 0, true => 1).

Makes any fixes to a name of a schema element (table, sequence, ...) that are required by restrictions of the platform, like a maximum length.

Return the FOREIGN KEY query section dealing with non-standard options as MATCH, INITIALLY DEFERRED, ON UPDATE, ...

Parameters:

foreignKey - foreign key definition

Gets the sql statements for altering an existing table.

The method returns an array of sql statements, since some platforms need several statements.

Returns the average value of a column

Parameters:

column - the column to use

Returns:

generated sql including an AVG aggregate function

Returns SQL that checks if an expression evaluates to a value between two values.

The parameter $expression is checked if it is between $value1 and $value2.

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

Parameters:

expression - the value to compare to

value1 - the lower value to compare with

value2 - the higher value to compare with

Returns:

logical expression

Gets the SQL snippet that declares an 8 byte integer column.

Gets the SQL snippet that declares a boolean column.

Obtain DBMS specific SQL code portion needed to set a CHECK constraint declaration to be used in statements like CREATE TABLE.

Parameters:

definition - check definition

Returns:

DBMS specific SQL code portion needed to set a CHECK constraint

Gets the SQL snippet used to declare a CLOB column type.

Obtain DBMS specific SQL code portion needed to set the CHARACTER SET of a field declaration to be used in statements like CREATE TABLE.

Parameters:

charset - name of the charset

Returns:

DBMS specific SQL code portion needed to set the CHARACTER SET of a field declaration.

Obtain DBMS specific SQL code portion needed to set the COLLATION of a field declaration to be used in statements like CREATE TABLE.

Parameters:

collation - name of the collation

Returns:

DBMS specific SQL code portion needed to set the COLLATION of a field declaration.

Get declaration of a number of fields in bulk

Parameters:

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

Obtain DBMS specific SQL code portion needed to declare a generic type field to be used in statements like CREATE TABLE.

Parameters:

name - name the field to be declared.

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

Returns:

DBMS specific SQL code portion that should be used to declare the column.

Returns a series of strings concatinated

concat() accepts an arbitrary number of parameters. Each parameter must contain an expression

Parameters:

arg1, - $arg2 ... $argN strings that will be concatinated.

Returns the number of rows (without a NULL value) of a column

If a '*' is used instead of a column the number of selected rows is returned.

Parameters:

column - the column to use

Returns:

generated sql including a COUNT aggregate function

Gets the SQL to create a constraint on a table on this platform.

Create a new foreign key

Parameters:

foreignKey - ForeignKey instance

table - name of the table on which the foreign key is to be created

Gets the SQL to create an index on a table on this platform.

Parameters:

table - name of the table on which the index is to be created

Gets the SQL to create a sequence on this platform.

Throws:

DBALException

Gets the SQL statement(s) to create a table with the specified name, columns and constraints on this platform.

Parameters:

table - The name of the table.

Returns:

The sequence of SQL statements.

Gets the SQL specific for the platform to get the current date.

Gets the SQL specific for the platform to get the current time.

Gets the SQL specific for the platform to get the current timestamp

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.

Gets the format string, as accepted by the date() function, that describes the format of a stored date value of this platform.

Returns:

The format string.

Gets the format string, as accepted by the date() function, that describes the format of a stored datetime value of this platform.

Returns:

The format string.

Todo:

We need to get the specific format for each dbms and override this function for each platform

Obtain DBMS specific SQL to be used to create datetime fields in statements like CREATE TABLE

Obtain DBMS specific SQL to be used to create date fields in statements like CREATE TABLE.

Gets the SQL snippet that declares a floating point column of arbitrary precision.

Gets the default transaction isolation level of the platform.

Returns:

The default isolation level.

See Also:

constants.

Obtain DBMS specific SQL code portion needed to set a default value declaration to be used in statements like CREATE TABLE.

Parameters:

field - field definition array

Returns:

DBMS specific SQL code portion needed to set a default value

Get drop constraint sql

Drop index from a table

Drop a Table

Get the insert sql for an empty insert statement

Returns:

$sql

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.

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.

Parameters:

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

Returns:

DBMS specific SQL code portion needed to set the FOREIGN KEY constraint of a field declaration.

returns given referential action in uppercase if valid, otherwise throws an exception

Throws:

if unknown referential action given

Parameters:

action - foreign key referential action

foreign - key referential action in uppercase

Gets the character used for identifier quoting.

Returns the SQL to check if a value is one in a set of given values.

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.

Parameters:

column - the value that should be matched against

values - that will be matched against $column

Returns:

logical expression

Obtain DBMS specific SQL code portion needed to set an index declaration to be used in statements like CREATE TABLE.

Parameters:

name - name of the index

index - index definition

Returns:

DBMS specific SQL code portion needed to set an index

getIndexFieldDeclarationList Obtain DBMS specific SQL code portion needed to set an index declaration to be used in statements like CREATE TABLE.

Gets the SQL snippet that declares a 4 byte integer column.

Returns SQL that checks if a expression is not null.

Parameters:

expression - the expression that should be compared to null

Returns:

logical expression

Returns SQL that checks if a expression is null.

Parameters:

expression - the expression that should be compared to null

Returns:

logical expression

Returns the length of a text field.

Get the SQL to list all views of a database or user.

returns the position of the first occurrence of substring $substr in string $str

Parameters:

substr - literal string to find

str - literal string

pos - position to start at, beginning of string by default

lower Returns the string $str with all characters changed to lowercase according to the current character set mapping.

Parameters:

str - literal string or column name

ltrim returns the string $str with leading space characters removed

Parameters:

str - literal string or column name

Returns the highest value of a column

Parameters:

column - the column to use

Returns:

generated sql including a MAX aggregate function

Maximum length of any given databse identifier, like tables or column names.

Returns the md5 sum of a field.

Note: Not SQL92, but common functionality

Returns the lowest value of a column

Parameters:

column - the column to use

Returns the remainder of the division operation $expression1 / $expression2.

Gets the name of the platform.

Returns the SQL for a logical not.

Example: $q = new Doctrine_Query(); $e = $q->expr; $q->select('*')->from('table') ->where($e->eq('id', $e->not('null'));

Returns:

a logical expression

Returns the current system date.

Returns the regular expression operator.

Rounds a numeric field to the number of decimals specified.

rtrim returns the string $str with proceeding space characters removed

Parameters:

str - literal string or column name

Gets the character casing of a column in an SQL result set of this platform.

Parameters:

column - The column name for which to get the correct character casing.

Returns:

The column name in the character casing used in SQL result sets.

Gets the SQL statement specific for the platform to set the charset.

This function is MySQL specific and required by \Doctrine\DBAL\Connection::setCharset($charset)

Get sql to set the transaction isolation level

Get sql query to show a list of database.

Gets the SQL snippet that declares a 2 byte integer column.

Gets the string portion that ends an SQL comment.

Gets the string portion that starts an SQL comment.

return string to call a function to get a substring inside an SQL statement

Note: Not SQL92, but common functionality.

SQLite only supports the 2 parameter variant of this function

Parameters:

value - an sql string literal or column name/alias

from - where to start the substring portion

len - the substring portion length

Returns the total sum of a column

Parameters:

column - the column to use

A method to return the required SQL string that fits between CREATE ... TABLE to create the table as a temporary table.

Should be overridden in driver classes to return the correct string for the specific database type.

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".

Returns:

The string required to be placed between "CREATE" and "TABLE" to generate a temporary table, if possible.

Gets the format string, as accepted by the date() function, that describes the format of a stored time value of this platform.

Returns:

The format string.

Obtain DBMS specific SQL to be used to create time fields in statements like CREATE TABLE.

Trim a string, leading/trailing/both and with a given char which defaults to space.

Parameters:

char - has to be quoted already

Generate a Truncate Table SQL statement for a given table.

Cascade is not supported on many platforms but would optionally cascade the truncate by following the foreign keys.

Obtain DBMS specific SQL code portion needed to set a unique constraint declaration to be used in statements like CREATE TABLE.

Parameters:

name - name of the unique constraint

index - index definition

Returns:

DBMS specific SQL code portion needed to set a constraint

Obtain DBMS specific SQL code portion needed to set the UNIQUE constraint of a field declaration to be used in statements like CREATE TABLE.

Returns:

DBMS specific SQL code portion needed to set the UNIQUE constraint of a field declaration.

upper Returns the string $str with all characters changed to uppercase according to the current character set mapping.

Parameters:

str - literal string or column name

Gets the maximum length of a varchar field.

Gets the SQL snippet used to declare a VARCHAR column type.

Gets all SQL wildcard characters of the platform.

Whether the platform prefers identity columns (eg. autoincrement) for ID generation. Subclasses should override this method to return TRUE if they prefer identity columns.

Whether the platform prefers sequences for ID generation. Subclasses should override this method to return TRUE if they prefer sequences.

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.

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.

Parameters:

str - identifier name to be quoted

Returns:

quoted identifier string

Does the platform supports foreign key constraints?

Does this platform supports onUpdate in foreign key constraints?

Whether the platform supports getting the affected rows of a recent update/delete type query.

Whether the platform supports identity columns. Identity columns are columns that recieve an auto-generated value from the database on insert of a row.

Whether the platform supports indexes.

Whether the platform supports primary key constraints.

Whether the platform supports savepoints.

Whether the platform supports database schemas.

Whether the platform supports sequences.

Whether the platform supports transactions.