Methods summary
public
|
|
public
string
|
#
getIdentifierQuoteCharacter( )
Gets the character used for identifier quoting.
Gets the character used for identifier quoting.
Returns
string
|
public
integer
|
#
getVarcharMaxLength( )
Gets the maximum length of a varchar field.
Gets the maximum length of a varchar field.
Returns
integer
|
public
array
|
#
getWildcards( )
Gets all SQL wildcard characters of the platform.
Gets all SQL wildcard characters of the platform.
Returns
array
|
public
string
|
#
getRegexpExpression( )
Returns the regular expression operator.
Returns the regular expression operator.
Returns
string
|
public
string
|
#
getAvgExpression( string $column )
Returns the average value of a column
Returns the average value of a column
Parameters
- $column
- the column to use
Returns
string generated sql including an AVG aggregate function
|
public
string
|
#
getCountExpression( string|integer $column )
Returns the number of rows (without a NULL value) of a column
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
string generated sql including a COUNT aggregate function
|
public
string
|
#
getMaxExpression( string $column )
Returns the highest value of a column
Returns the highest value of a column
Parameters
- $column
- the column to use
Returns
string generated sql including a MAX aggregate function
|
public
string
|
#
getMinExpression( string $column )
Returns the lowest value of a column
Returns the lowest value of a column
Parameters
- $column
- the column to use
Returns
string
|
public
string
|
#
getSumExpression( string $column )
Returns the total sum of a column
Returns the total sum of a column
Parameters
- $column
- the column to use
Returns
string
|
public
string
|
#
getMd5Expression( $column )
Returns the md5 sum of a field.
Returns the md5 sum of a field.
Note: Not SQL92, but common functionality
Returns
string
|
public
string
|
#
getLengthExpression( string $column, string $expression2,… )
Returns the length of a text field.
Returns the length of a text field.
Parameters
- $column
- $expression1
- $expression2,…
Returns
string
|
public
string
|
#
getRoundExpression( string $column, string $decimals = 0 )
Rounds a numeric field to the number of decimals specified.
Rounds a numeric field to the number of decimals specified.
Parameters
- $column
- $expression1
- $decimals
- $expression2
Returns
string
|
public
string
|
#
getModExpression( string $expression1, string $expression2 )
Returns the remainder of the division operation
$expression1 / $expression2.
Returns the remainder of the division operation
$expression1 / $expression2.
Parameters
- $expression1
- $expression2
Returns
string
|
public
string
|
#
getTrimExpression( string $str )
trim
returns the string $str with leading and proceeding space characters removed
trim
returns the string $str with leading and proceeding space characters removed
Parameters
- $str
- literal string or column name
Returns
string
|
public
string
|
#
getRtrimExpression( string $str )
rtrim
returns the string $str with proceeding space characters removed
rtrim
returns the string $str with proceeding space characters removed
Parameters
- $str
- literal string or column name
Returns
string
|
public
string
|
#
getLtrimExpression( string $str )
ltrim
returns the string $str with leading space characters removed
ltrim
returns the string $str with leading space characters removed
Parameters
- $str
- literal string or column name
Returns
string
|
public
string
|
#
getUpperExpression( string $str )
upper
Returns the string $str with all characters changed to
uppercase according to the current character set mapping.
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
Returns
string
|
public
string
|
#
getLowerExpression( string $str )
lower
Returns the string $str with all characters changed to
lowercase according to the current character set mapping.
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
Returns
string
|
public
integer
|
#
getLocateExpression( string $str, string $substr )
locate
returns the position of the first occurrence of substring $substr in string $str
locate
returns the position of the first occurrence of substring $substr in string $str
Parameters
- $str
- $substr literal string to find
- $substr
- $str literal string
Returns
integer
|
public
string
|
#
getNowExpression( )
Returns the current system date.
Returns the current system date.
Returns
string
|
public
string
|
#
getSubstringExpression( string $value, integer $from, integer $len = null )
return string to call a function to get a substring inside an SQL statement
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
- $position where to start the substring portion
- $len
- $length the substring portion length
Returns
string SQL substring function with given parameters
|
public
string
|
#
getConcatExpression( )
Returns a series of strings concatinated
Returns a series of strings concatinated
concat() accepts an arbitrary number of parameters. Each parameter
must contain an expression
Returns
string
|
public
string
|
#
getNotExpression( $expression )
Returns the SQL for a logical not.
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
string a logical expression
|
public
string
|
#
getInExpression( string $column, string|array(string) $values )
Returns the SQL to check if a value is one in a set of
given values.
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
string logical expression
|
public
string
|
#
getIsNullExpression( string $expression )
Returns SQL that checks if a expression is null.
Returns SQL that checks if a expression is null.
Parameters
- $expression
- the expression that should be compared to null
Returns
string logical expression
|
public
string
|
#
getIsNotNullExpression( string $expression )
Returns SQL that checks if a expression is not null.
Returns SQL that checks if a expression is not null.
Parameters
- $expression
- the expression that should be compared to null
Returns
string logical expression
|
public
string
|
#
getBetweenExpression( string $expression, string $value1, string $value2 )
Returns SQL that checks if an expression evaluates to a value between
two values.
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
string logical expression
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
array
|
#
getCreateTableSql( string $table, array $columns, array $options = array() )
Gets the SQL statement(s) to create a table with the specified name, columns and constraints
on this platform.
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.
- $columns
- The column definitions for the table.
- $options
- The table constraints.
Returns
array The sequence of SQL statements.
|
public
|
|
public
string
|
#
getCreateSequenceSql( string $sequenceName, integer $start = 1, integer $allocationSize = 1 )
Gets the SQL to create a sequence on this platform.
Gets the SQL to create a sequence on this platform.
Parameters
- $sequenceName
- $start
- $allocationSize
Returns
string
Throws
|
public
string
|
#
getCreateConstraintSql( string $table, string $name, array $definition )
Gets the SQL to create a constraint on a table on this platform.
Gets the SQL to create a constraint on a table on this platform.
Parameters
- $table
- name of the table on which the constraint is to be created
- $name
- name of the constraint to be created
- $definition
associative array that defines properties of the constraint to be created.
Currently, only one property named FIELDS is supported. This property
is also an associative with the names of the constraint fields as array
constraints. Each entry of this array is set to another type of associative
array that specifies properties of the constraint that are specific to
each field.
Example
array(
'fields' => array(
'user_name' => array(),
'last_login' => array()
)
)
Returns
string
|
public
string
|
#
getCreateIndexSql( string $table, string $name, array $definition )
Gets the SQL to create an index on a table on this platform.
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
- $name
- name of the index to be created
- $definition
- associative array that defines properties of the index to be created.
Returns
string
|
public
string
|
#
quoteIdentifier( string $str )
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.
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
string quoted identifier string
|
public
string
|
#
getCreateForeignKeySql( string $table, array $definition )
createForeignKeySql
Parameters
- $table
- name of the table on which the foreign key is to be created
- $definition
- associative array that defines properties of the foreign key to be created.
Returns
string
|
public
string
|
#
getAlterTableSql( string $name, array $changes, boolean $check = false )
Gets the sql for altering an existing table.
(this method is implemented by the drivers)
Gets the sql for altering an existing table.
(this method is implemented by the drivers)
Parameters
- $name
- name of the table that is intended to be changed.
- $changes
- associative array that contains the details of each type *
- $check
indicates whether the function should just check if the DBMS driver
can perform the requested table alterations if the value is true or
actually perform them otherwise.
Returns
string
|
public
string
|
#
getColumnDeclarationListSql( array $fields )
Get declaration of a number of fields in bulk
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
Returns
string
|
public
string
|
#
getColumnDeclarationSql( string $name, array $field )
Obtain DBMS specific SQL code portion needed to declare a generic type
field to be used in statements like CREATE TABLE.
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
Returns
string DBMS specific SQL code portion that should be used to declare the column.
|
public
string
|
#
getDecimalTypeDeclarationSql( array $columnDef )
Gets the SQL snippet that declares a floating point column of arbitrary precision.
Gets the SQL snippet that declares a floating point column of arbitrary precision.
Parameters
Returns
string
|
public
|
|
abstract public
string
|
#
getBooleanTypeDeclarationSql( array $columnDef )
Gets the SQL snippet that declares a boolean column.
Gets the SQL snippet that declares a boolean column.
Parameters
Returns
string
|
abstract public
string
|
#
getIntegerTypeDeclarationSql( array $columnDef )
Gets the SQL snippet that declares a 4 byte integer column.
Gets the SQL snippet that declares a 4 byte integer column.
Parameters
Returns
string
|
abstract public
string
|
#
getBigIntTypeDeclarationSql( array $columnDef )
Gets the SQL snippet that declares an 8 byte integer column.
Gets the SQL snippet that declares an 8 byte integer column.
Parameters
Returns
string
|
abstract public
string
|
#
getSmallIntTypeDeclarationSql( array $columnDef )
Gets the SQL snippet that declares a 2 byte integer column.
Gets the SQL snippet that declares a 2 byte integer column.
Parameters
Returns
string
|
abstract protected
string
|
#
_getCommonIntegerTypeDeclarationSql( array $columnDef )
Gets the SQL snippet that declares common properties of an integer column.
Gets the SQL snippet that declares common properties of an integer column.
Parameters
Returns
string
|
public
string
|
#
getDefaultValueDeclarationSql( array $field )
Obtain DBMS specific SQL code portion needed to set a default value
declaration to be used in statements like CREATE TABLE.
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
string DBMS specific SQL code portion needed to set a default value
|
public
string
|
#
getCheckDeclarationSql( array $definition )
Obtain DBMS specific SQL code portion needed to set a CHECK constraint
declaration to be used in statements like CREATE TABLE.
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
string DBMS specific SQL code portion needed to set a CHECK constraint
|
public
string
|
#
getIndexDeclarationSql( string $name, array $definition )
Obtain DBMS specific SQL code portion needed to set an index
declaration to be used in statements like CREATE TABLE.
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
- $definition
- index definition
Returns
string DBMS specific SQL code portion needed to set an index
|
public
string
|
#
getIndexFieldDeclarationListSql( array $fields )
getIndexFieldDeclarationList
Obtain DBMS specific SQL code portion needed to set an index
declaration to be used in statements like CREATE TABLE.
getIndexFieldDeclarationList
Obtain DBMS specific SQL code portion needed to set an index
declaration to be used in statements like CREATE TABLE.
Returns
string
|
public
string
|
#
getTemporaryTableSql( )
A method to return the required SQL string that fits between CREATE ... TABLE
to create the table as a temporary table.
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
string The string required to be placed between "CREATE" and "TABLE"
to generate a temporary table, if possible.
|
public
unknown
|
#
getShowDatabasesSql( )
Get sql query to show a list of database
Get sql query to show a list of database
Returns
unknown
|
public
string
|
#
getForeignKeyDeclarationSql( array $definition )
getForeignKeyDeclaration
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.
getForeignKeyDeclaration
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
string DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
of a field declaration.
|
public
string
|
#
getAdvancedForeignKeyOptionsSql( array $definition )
Return the FOREIGN KEY query section dealing with non-standard options
as MATCH, INITIALLY DEFERRED, ON UPDATE, ...
Return the FOREIGN KEY query section dealing with non-standard options
as MATCH, INITIALLY DEFERRED, ON UPDATE, ...
Parameters
- $definition
- foreign key definition
Returns
string
|
public
|
#
getForeignKeyReferentialActionSql( string $action )
returns given referential action in uppercase if valid, otherwise throws
an exception
returns given referential action in uppercase if valid, otherwise throws
an exception
Parameters
- $action
- foreign key referential action
Throws
Doctrine_Exception_Exception if unknown referential action given
|
public
string
|
#
getForeignKeyBaseDeclarationSql( array $definition )
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
Returns
string
|
public
string
|
#
getUniqueFieldDeclarationSql( )
Obtain DBMS specific SQL code portion needed to set the UNIQUE constraint
of a field declaration to be used in statements like CREATE TABLE.
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
string DBMS specific SQL code portion needed to set the UNIQUE constraint
of a field declaration.
|
public
string
|
#
getColumnCharsetDeclarationSql( string $charset )
Obtain DBMS specific SQL code portion needed to set the CHARACTER SET
of a field declaration to be used in statements like CREATE TABLE.
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
string DBMS specific SQL code portion needed to set the CHARACTER SET
of a field declaration.
|
public
string
|
#
getColumnCollationDeclarationSql( string $collation )
Obtain DBMS specific SQL code portion needed to set the COLLATION
of a field declaration to be used in statements like CREATE TABLE.
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
string DBMS specific SQL code portion needed to set the COLLATION
of a field declaration.
|
public
string
|
#
getMatchPatternExpression( array $pattern, string $operator = null, string $field = null )
build a pattern matching string
build a pattern matching string
EXPERIMENTAL
WARNING: this function is experimental and may change signature at
any time until labelled as non-experimental
Parameters
- $pattern
- even keys are strings, odd are patterns (% and _)
- $operator
- optional pattern operator (LIKE, ILIKE and maybe others in the future)
- $field
optional field name that is being matched against
(might be required when emulating ILIKE)
Returns
string SQL pattern
|
public
boolean
|
#
prefersIdentityColumns( )
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 identity columns (eg. autoincrement) for ID generation.
Subclasses should override this method to return TRUE if they prefer identity columns.
Returns
boolean
|
public
|
#
writeLimitClause( string $query, mixed $limit = false, mixed $offset = false )
Adds a LIMIT/OFFSET clause to the query.
This default implementation writes the syntax "LIMIT x OFFSET y" to the
query which is supported by MySql, PostgreSql and Sqlite.
Any database platforms that do not support this syntax should override
this implementation and provide their own.
Adds a LIMIT/OFFSET clause to the query.
This default implementation writes the syntax "LIMIT x OFFSET y" to the
query which is supported by MySql, PostgreSql and Sqlite.
Any database platforms that do not support this syntax should override
this implementation and provide their own.
Parameters
- $query
- The SQL string to write to / append to.
- $limit
- $offset
|
public
|
#
convertBooleans( array $item )
Some platforms need the boolean values to be converted.
Default conversion defined here converts to integers.
Some platforms need the boolean values to be converted.
Default conversion defined here converts to integers.
Parameters
|
public
string
|
#
getSetCharsetSql( string $charset )
Gets the SQL statement specific for the platform to set the charset.
Gets the SQL statement specific for the platform to set the charset.
Parameters
Returns
string
|
public
string
|
#
getCurrentDateSql( )
Gets the SQL specific for the platform to get the current date.
Gets the SQL specific for the platform to get the current date.
Returns
string
|
public
string
|
#
getCurrentTimeSql( )
Gets the SQL specific for the platform to get the current time.
Gets the SQL specific for the platform to get the current time.
Returns
string
|
public
string
|
#
getCurrentTimestampSql( )
Gets the SQL specific for the platform to get the current timestamp
Gets the SQL specific for the platform to get the current timestamp
Returns
string
|
protected
|
#
_getTransactionIsolationLevelSql( integer $level )
Get sql for transaction isolation level Connection constant
Get sql for transaction isolation level Connection constant
Parameters
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
#
getSetTransactionIsolationSql( integer $level )
Get sql to set the transaction isolation level
Get sql to set the transaction isolation level
Parameters
|
public
string
|
#
getCharsetFieldDeclaration( string $charset )
Obtain DBMS specific SQL code portion needed to set the CHARACTER SET
of a field declaration to be used in statements like CREATE TABLE.
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
string DBMS specific SQL code portion needed to set the CHARACTER SET
of a field declaration.
|
public
string
|
#
getDateTimeTypeDeclarationSql( array $fieldDeclaration )
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 datetime fields in
statements like CREATE TABLE
Parameters
Returns
string
|
public
string
|
#
getDateTypeDeclarationSql( array $fieldDeclaration )
Obtain DBMS specific SQL to be used to create date fields in statements
like CREATE TABLE.
Obtain DBMS specific SQL to be used to create date fields in statements
like CREATE TABLE.
Parameters
Returns
string
|
public
integer
|
#
getDefaultTransactionIsolationLevel( )
Gets the default transaction isolation level of the platform.
Gets the default transaction isolation level of the platform.
Returns
integer The default isolation level.
See
Doctrine\DBAL\Connection\TRANSACTION_* constants.
|
public
boolean
|
#
supportsSequences( )
Whether the platform supports sequences.
Whether the platform supports sequences.
Returns
boolean
|
public
boolean
|
#
supportsIdentityColumns( )
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 identity columns.
Identity columns are columns that recieve an auto-generated value from the
database on insert of a row.
Returns
boolean
|
public
boolean
|
#
supportsIndexes( )
Whether the platform supports indexes.
Whether the platform supports indexes.
Returns
boolean
|
public
boolean
|
#
supportsTransactions( )
Whether the platform supports transactions.
Whether the platform supports transactions.
Returns
boolean
|
public
boolean
|
#
supportsSavepoints( )
Whether the platform supports savepoints.
Whether the platform supports savepoints.
Returns
boolean
|
public
boolean
|
#
supportsPrimaryConstraints( )
Whether the platform supports primary key constraints.
Whether the platform supports primary key constraints.
Returns
boolean
|
public
boolean
|
#
supportsForeignKeyConstraints( )
Whether the platform supports foreign key constraints.
Whether the platform supports foreign key constraints.
Returns
boolean
|
public
boolean
|
#
supportsSchemas( )
Whether the platform supports database schemas.
Whether the platform supports database schemas.
Returns
boolean
|
public
boolean
|
#
supportsGettingAffectedRows( )
Whether the platform supports getting the affected rows of a recent
update/delete type query.
Whether the platform supports getting the affected rows of a recent
update/delete type query.
Returns
boolean
|
public
|
|
public
string
|
#
getDateTimeFormatString( )
Gets the format string, as accepted by the date() function, that describes
the format of a stored datetime value of this platform.
Gets the format string, as accepted by the date() function, that describes
the format of a stored datetime value of this platform.
Returns
string The format string.
|
public
string
|
#
getDateFormatString( )
Gets the format string, as accepted by the date() function, that describes
the format of a stored date value of this platform.
Gets the format string, as accepted by the date() function, that describes
the format of a stored date value of this platform.
Returns
string The format string.
|
public
string
|
#
getTimeFormatString( )
Gets the format string, as accepted by the date() function, that describes
the format of a stored time value of this platform.
Gets the format string, as accepted by the date() function, that describes
the format of a stored time value of this platform.
Returns
string The format string.
|
public
|
|
abstract public
|
#
getVarcharTypeDeclarationSql( array $field )
Gets the SQL snippet used to declare a VARCHAR column type.
Gets the SQL snippet used to declare a VARCHAR column type.
Parameters
|
abstract public
|
#
getClobTypeDeclarationSql( array $field )
Gets the SQL snippet used to declare a CLOB column type.
Gets the SQL snippet used to declare a CLOB column type.
Parameters
|
abstract public
string
|
#
getName( )
Gets the name of the platform.
Gets the name of the platform.
Returns
string
|
public
string
|
#
getSqlResultCasing( string $column )
Gets the character casing of a column in an SQL result set of this platform.
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
string The column name in the character casing used in SQL result sets.
|
public
string
|
#
fixSchemaElementName( string $schemaElementName )
Makes any fixes to a name of a schema element (table, sequence, ...) that are required
by restrictions of the platform, like a maximum length.
Makes any fixes to a name of a schema element (table, sequence, ...) that are required
by restrictions of the platform, like a maximum length.
Parameters
- $schemaElementName
- $schemaName
Returns
string
|
public
string
|
#
getEmptyIdentityInsertSql( string $tableName, string $identifierColumnName )
Get the insert sql for an empty insert statement
Get the insert sql for an empty insert statement
Parameters
- $tableName
- $identifierColumnName
Returns
string $sql
|