[N] Doctrine\DBAL\

[C] Configuration Configuration container for the Doctrine DBAL.

Configuration container for the Doctrine DBAL.

[p] $sqlLogger The SQL logger in use. If null, SQL logging is disabled.

The SQL logger in use. If null, SQL logging is disabled. 
protected Doctrine\DBAL\Logging\SQLLogger|null $sqlLogger = null

Type: SQLLogger|​null

[p] $resultCacheImpl The cache driver implementation that is used for query result caching.

deprecated

The cache driver implementation that is used for query result caching. 
protected Cache|null $resultCacheImpl = null

Type: Cache|​null

See
type summary
​Configuration::$resultCache ​

[p] $schemaAssetsFilter The callable to use to filter schema assets.

The callable to use to filter schema assets. 
protected callable|null $schemaAssetsFilter = null

Type: callable|​null

[p] $autoCommit The default auto-commit mode for connections.

The default auto-commit mode for connections. 
protected bool $autoCommit = true

Type: bool

[m] __construct 

public function __construct()

[m] setSQLLogger Sets the SQL logger to use. Defaults to NULL which means SQL logging is disabled.

deprecated

Sets the SQL logger to use. Defaults to NULL which means SQL logging is disabled. 
public function setSQLLogger(?Doctrine\DBAL\Logging\SQLLogger $logger = null)
Parameter
type name summary
​?SQLLogger ​$logger = null ​
See
type summary
​Configuration::setMiddlewares() ​
​Middleware ​

[m] getSQLLogger Gets the SQL logger that is used.

deprecated

Gets the SQL logger that is used. 
public function getSQLLogger(): ?Doctrine\DBAL\Logging\SQLLogger
Return
type summary
​?SQLLogger ​

[m] getResultCache Gets the cache driver implementation that is used for query result caching.

Gets the cache driver implementation that is used for query result caching. 
public function getResultCache(): ?Psr\Cache\CacheItemPoolInterface
Return
type summary
​?CacheItemPoolInterface ​

[m] getResultCacheImpl Gets the cache driver implementation that is used for query result caching.

deprecated

Gets the cache driver implementation that is used for query result caching. 
public function getResultCacheImpl(): ?Doctrine\Common\Cache\Cache
Return
type summary
​?Cache ​
See
type summary
​Configuration::getResultCache() ​

[m] setResultCache Sets the cache driver implementation that is used for query result caching.

Sets the cache driver implementation that is used for query result caching. 
public function setResultCache(Psr\Cache\CacheItemPoolInterface $cache)
Parameter
type name summary
​CacheItemPoolInterface ​$cache ​

[m] setResultCacheImpl Sets the cache driver implementation that is used for query result caching.

deprecated

Sets the cache driver implementation that is used for query result caching. 
public function setResultCacheImpl(Doctrine\Common\Cache\Cache $cacheImpl)
Parameter
type name summary
​Cache ​$cacheImpl ​
See
type summary
​Configuration::setResultCache() ​

[m] setSchemaAssetsFilter Sets the callable to use to filter schema assets.

Sets the callable to use to filter schema assets. 
public function setSchemaAssetsFilter(?callable $callable = null)
Parameter
type name summary
​?callable ​$callable = null ​

[m] getSchemaAssetsFilter Returns the callable to use to filter schema assets.

Returns the callable to use to filter schema assets. 
public function getSchemaAssetsFilter(): ?callable
Return
type summary
​?callable ​

[m] setAutoCommit Sets the default auto-commit mode for connections.

Sets the default auto-commit mode for connections. 
public function setAutoCommit(bool $autoCommit)

If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either the method commit or the method rollback. By default, new connections are in auto-commit mode.

Parameter
type name summary
​bool ​$autoCommit ​True to enable auto-commit mode; false to disable it
See
type summary
​getAutoCommit ​

[m] getAutoCommit Returns the default auto-commit mode for connections.

Returns the default auto-commit mode for connections. 
public function getAutoCommit(): bool
Return
type summary
​bool ​True if auto-commit mode is enabled by default for connections, false otherwise.
See
type summary
​setAutoCommit ​

[m] setMiddlewares 

public function setMiddlewares(array|Doctrine\DBAL\Driver\Middleware[] $middlewares): Doctrine\DBAL\Configuration
Parameter
type name summary
​array|​Middleware[] ​$middlewares ​
Return
type summary
​Configuration ​

[m] getMiddlewares 

public function getMiddlewares(): array|Doctrine\DBAL\Driver\Middleware[]
Return
type summary
​array|​Middleware[] ​

[m] getSchemaManagerFactory 

public function getSchemaManagerFactory(): ?Doctrine\DBAL\Schema\SchemaManagerFactory
Return
type summary
​?SchemaManagerFactory ​

[m] setSchemaManagerFactory 

public function setSchemaManagerFactory(Doctrine\DBAL\Schema\SchemaManagerFactory $schemaManagerFactory): Doctrine\DBAL\Configuration
Parameter
type name summary
​SchemaManagerFactory ​$schemaManagerFactory ​
Return
type summary
​Configuration ​

[m] getDisableTypeComments 

public function getDisableTypeComments(): bool
Return
type summary
​bool ​

[m] setDisableTypeComments 

public function setDisableTypeComments(bool $disableTypeComments): Doctrine\DBAL\Configuration
Parameter
type name summary
​bool ​$disableTypeComments ​
Return
type summary
​Configuration ​

[C] Exception

Hierarchy

Parents
type summary
​Exception ​
Implements
type summary
​Throwable ​
​Stringable ​

[p] $message 

protected string $message = ""

Type: string

Prototype
kind source summary
​inherit ​Exception::$message ​

[p] $code 

protected int $code = 0

Type: int

Prototype
kind source summary
​inherit ​Exception::$code ​

[p] $file 

protected string $file = ""

Type: string

Prototype
kind source summary
​inherit ​Exception::$file ​

[p] $line 

protected int $line = 0

Type: int

Prototype
kind source summary
​inherit ​Exception::$line ​

[M] notSupported 

public static function notSupported(string $method): Doctrine\DBAL\Exception
Parameter
type name summary
​string ​$method ​
Return
type summary
​Exception ​

[M] invalidPlatformType 

public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
Parameter
type name summary
​mixed ​$invalidPlatform ​
Return
type summary
​Exception ​

[M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

Returns a new instance for an invalid specified platform version. 
public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
Parameter
type name summary
​string ​$version ​The invalid platform version given.
​string ​$expectedFormat ​The expected platform version format.
Return
type summary
​Exception ​

[M] driverRequired 

public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
Parameter
type name summary
​
?string|​string|​null		 ​$url = null ​The URL that was provided in the connection parameters (if any).
Return
type summary
​Exception ​

[M] unknownDriver 

public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
Parameter
type name summary
​string ​$unknownDriverName ​
​array|​string[] ​$knownDrivers ​
Return
type summary
​Exception ​

[M] invalidWrapperClass 

public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
Parameter
type name summary
​string ​$wrapperClass ​
Return
type summary
​Exception ​

[M] invalidDriverClass 

public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
Parameter
type name summary
​string ​$driverClass ​
Return
type summary
​Exception ​

[M] noColumnsSpecifiedForTable 

public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
Parameter
type name summary
​string ​$tableName ​
Return
type summary
​Exception ​

[M] typeExists 

public static function typeExists(string $name): Doctrine\DBAL\Exception
Parameter
type name summary
​string ​$name ​
Return
type summary
​Exception ​

[M] unknownColumnType 

public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
Parameter
type name summary
​string ​$name ​
Return
type summary
​Exception ​

[M] typeNotFound 

public static function typeNotFound(string $name): Doctrine\DBAL\Exception
Parameter
type name summary
​string ​$name ​
Return
type summary
​Exception ​

[M] typeNotRegistered 

public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
Parameter
type name summary
​Type ​$type ​
Return
type summary
​Exception ​

[M] typeAlreadyRegistered 

public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
Parameter
type name summary
​Type ​$type ​
Return
type summary
​Exception ​

[m] __construct 

public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
Parameter
type name summary
​string ​$message = "" ​
​int ​$code = 0 ​
​?Throwable ​$previous = null ​
Prototype
kind source summary
​inherit ​Exception::__construct() ​

[m] __wakeup 

public function __wakeup()
Prototype
kind source summary
​inherit ​Exception::__wakeup() ​

[m] getMessage

final

final public function getMessage(): string
Return
type summary
​string ​
Prototype
kind source summary
​inherit ​Exception::getMessage() ​

[m] getCode

final

final public function getCode()
Prototype
kind source summary
​inherit ​Exception::getCode() ​

[m] getFile

final

final public function getFile(): string
Return
type summary
​string ​
Prototype
kind source summary
​inherit ​Exception::getFile() ​

[m] getLine

final

final public function getLine(): int
Return
type summary
​int ​
Prototype
kind source summary
​inherit ​Exception::getLine() ​

[m] getTrace

final

final public function getTrace(): array
Return
type summary
​array ​
Prototype
kind source summary
​inherit ​Exception::getTrace() ​

[m] getPrevious

final

final public function getPrevious(): ?\Throwable
Return
type summary
​?Throwable ​
Prototype
kind source summary
​inherit ​Exception::getPrevious() ​

[m] getTraceAsString

final

final public function getTraceAsString(): string
Return
type summary
​string ​
Prototype
kind source summary
​inherit ​Exception::getTraceAsString() ​

[m] __toString 

public function __toString(): string
Return
type summary
​string ​
Prototype
kind source summary
​inherit ​Exception::__toString() ​

[C] Connection A database abstraction-level connection that implements features like events, transaction isolation levels,

A database abstraction-level connection that implements features like events, transaction isolation levels, configuration, emulated transaction nesting, lazy connecting and more.

[C] PARAM_INT_ARRAY Represents an array of ints to be expanded by Doctrine SQL parsing.

deprecated

Represents an array of ints to be expanded by Doctrine SQL parsing. 
public const int PARAM_INT_ARRAY = 101
See
type summary
​ArrayParameterType::INTEGER ​

[C] PARAM_STR_ARRAY Represents an array of strings to be expanded by Doctrine SQL parsing.

deprecated

Represents an array of strings to be expanded by Doctrine SQL parsing. 
public const int PARAM_STR_ARRAY = 102
See
type summary
​ArrayParameterType::STRING ​

[C] PARAM_ASCII_STR_ARRAY Represents an array of ascii strings to be expanded by Doctrine SQL parsing.

deprecated

Represents an array of ascii strings to be expanded by Doctrine SQL parsing. 
public const int PARAM_ASCII_STR_ARRAY = 117
See
type summary
​ArrayParameterType::ASCII ​

[C] ARRAY_PARAM_OFFSET Offset by which PARAM_* constants are detected as arrays of the param type.

Offset by which PARAM_* constants are detected as arrays of the param type. 
public const int ARRAY_PARAM_OFFSET = 100

[p] $_conn The wrapped driver connection.

The wrapped driver connection. 
protected Doctrine\DBAL\Driver\Connection|null $_conn = null

Type: Connection|​null

[p] $_config 

protected Doctrine\DBAL\Configuration $_config = null

Type: Configuration

[p] $_eventManager

deprecated 

protected Doctrine\Common\EventManager $_eventManager = null

Type: EventManager

[p] $_expr

deprecated 

protected Doctrine\DBAL\Query\Expression\ExpressionBuilder $_expr = null

Type: ExpressionBuilder

See
type summary
​Connection::createExpressionBuilder() ​

[p] $_schemaManager The schema manager.

deprecated

The schema manager. 
protected Doctrine\DBAL\Schema\AbstractSchemaManager|null $_schemaManager = null

Type: AbstractSchemaManager|​null

See
type summary
​Connection::createSchemaManager() ​

[p] $_driver The used DBAL driver.

The used DBAL driver. 
protected Doctrine\DBAL\Driver $_driver = null

Type: Driver

[m] __construct Initializes a new instance of the Connection class.

Initializes a new instance of the Connection class. 
public function __construct(
    array $params,
    Doctrine\DBAL\Driver $driver,
    ?Doctrine\DBAL\Configuration|Doctrine\DBAL\Configuration|null $config = null,
    ?Doctrine\Common\EventManager|Doctrine\Common\EventManager|null $eventManager = null
)
Parameter
type name summary
​
array		 ​$params ​The connection parameters.
​Driver ​$driver ​The driver to use.
​?Configuration|​Configuration|​null ​$config = null ​The configuration, optional.
​?EventManager|​EventManager|​null ​$eventManager = null ​The event manager, optional.
Throws
type summary
​Exception ​

[m] getParams Gets the parameters used during instantiation.

Gets the parameters used during instantiation. 
public function getParams(): array
Return
type summary
​array ​

[m] getDatabase Gets the name of the currently selected database.

Gets the name of the currently selected database. 
public function getDatabase(): string|null
Return
type summary
​string|​null ​The name of the database or NULL if a database is not selected.
Throws
type summary
​Exception ​

[m] getDriver Gets the DBAL driver instance.

Gets the DBAL driver instance. 
public function getDriver(): Doctrine\DBAL\Driver
Return
type summary
​Driver ​

[m] getConfiguration Gets the Configuration used by the Connection.

Gets the Configuration used by the Connection. 
public function getConfiguration(): Doctrine\DBAL\Configuration
Return
type summary
​Configuration ​

[m] getEventManager Gets the EventManager used by the Connection.

deprecated

Gets the EventManager used by the Connection. 
public function getEventManager(): Doctrine\Common\EventManager
Return
type summary
​EventManager ​

[m] getDatabasePlatform Gets the DatabasePlatform for the connection.

Gets the DatabasePlatform for the connection. 
public function getDatabasePlatform(): Doctrine\DBAL\Platforms\AbstractPlatform
Return
type summary
​AbstractPlatform ​
Throws
type summary
​Exception ​

[m] createExpressionBuilder Creates an expression builder for the connection.

Creates an expression builder for the connection. 
public function createExpressionBuilder(): Doctrine\DBAL\Query\Expression\ExpressionBuilder
Return
type summary
​ExpressionBuilder ​

[m] getExpressionBuilder Gets the ExpressionBuilder for the connection.

deprecated

Gets the ExpressionBuilder for the connection. 
public function getExpressionBuilder(): Doctrine\DBAL\Query\Expression\ExpressionBuilder
Return
type summary
​ExpressionBuilder ​
See
type summary
​Connection::createExpressionBuilder() ​

[m] connect Establishes the connection with the database.

Establishes the connection with the database. 
public function connect(): bool
Return
type summary
​bool ​TRUE if the connection was successfully established, FALSE if
Throws
type summary
​Exception ​

[m] isAutoCommit Returns the current auto-commit mode for this connection.

Returns the current auto-commit mode for this connection. 
public function isAutoCommit(): bool
Return
type summary
​bool ​True if auto-commit mode is currently enabled for this connection, false otherwise.
See
type summary
​setAutoCommit ​

[m] setAutoCommit Sets auto-commit mode for this connection.

Sets auto-commit mode for this connection. 
public function setAutoCommit(bool $autoCommit): void

If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either the method commit or the method rollback. By default, new connections are in auto-commit mode.

NOTE: If this method is called during a transaction and the auto-commit mode is changed, the transaction is committed. If this method is called and the auto-commit mode is not changed, the call is a no-op.

Parameter
type name summary
​bool ​$autoCommit ​True to enable auto-commit mode; false to disable it.
Return
type summary
​void ​
See
type summary
​isAutoCommit ​

[m] fetchAssociative Prepares and executes an SQL query and returns the first row of the result

Prepares and executes an SQL query and returns the first row of the result 
public function fetchAssociative(
    string $query,
    array $params = [],
    array $types = []
): array

as an associative array.

Parameter
type name summary
​string ​$query ​SQL query
​array ​$params = [] ​
​array ​$types = [] ​
Return
type summary
​array ​mixed>
Throws
type summary
​Exception ​

[m] fetchNumeric Prepares and executes an SQL query and returns the first row of the result

Prepares and executes an SQL query and returns the first row of the result 
public function fetchNumeric(
    string $query,
    array $params = [],
    array $types = []
): list|false

as a numerically indexed array.

Parameter
type name summary
​string ​$query ​SQL query
​array ​$params = [] ​
​array ​$types = [] ​
Return
type summary
​list|​false ​False is returned if no rows are found.
Throws
type summary
​Exception ​

[m] fetchOne Prepares and executes an SQL query and returns the value of a single column

Prepares and executes an SQL query and returns the value of a single column 
public function fetchOne(
    string $query,
    array $params = [],
    array $types = []
): mixed|false

of the first row of the result.

Parameter
type name summary
​string ​$query ​SQL query
​array ​$params = [] ​
​array ​$types = [] ​
Return
type summary
​mixed|​false ​False is returned if no rows are found.
Throws
type summary
​Exception ​

[m] isConnected Whether an actual connection to the database is established.

Whether an actual connection to the database is established. 
public function isConnected(): bool
Return
type summary
​bool ​

[m] isTransactionActive Checks whether a transaction is currently active.

Checks whether a transaction is currently active. 
public function isTransactionActive(): bool
Return
type summary
​bool ​TRUE if a transaction is currently active, FALSE otherwise.

[m] delete Executes an SQL DELETE statement on a table.

Executes an SQL DELETE statement on a table. 
public function delete(
    string $table,
    array $criteria,
    array $types = []
): int|string

Table expression and columns are not escaped and are not safe for user-input.

Parameter
type name summary
​string ​$table ​Table name
​array ​$criteria ​
​array ​$types = [] ​
Return
type summary
​int|​string ​The number of affected rows.
Throws
type summary
​Exception ​

[m] close Closes the connection.

Closes the connection. 
public function close(): void
Return
type summary
​void ​

[m] setTransactionIsolation Sets the transaction isolation level.

Sets the transaction isolation level. 
public function setTransactionIsolation(Doctrine\DBAL\TransactionIsolationLevel::*() $level): int|string
Parameter
type name summary
​TransactionIsolationLevel::*() ​$level ​The level to set.
Return
type summary
​int|​string ​
Throws
type summary
​Exception ​

[m] getTransactionIsolation Gets the currently active transaction isolation level.

Gets the currently active transaction isolation level. 
public function getTransactionIsolation(): Doctrine\DBAL\TransactionIsolationLevel::*()
Return
type summary
​TransactionIsolationLevel::*() ​The current transaction isolation level.
Throws
type summary
​Exception ​

[m] update Executes an SQL UPDATE statement on a table.

Executes an SQL UPDATE statement on a table. 
public function update(
    string $table,
    array $data,
    array $criteria,
    array $types = []
): int|string

Table expression and columns are not escaped and are not safe for user-input.

Parameter
type name summary
​string ​$table ​Table name
​array ​$data ​
​array ​$criteria ​
​array ​$types = [] ​
Return
type summary
​int|​string ​The number of affected rows.
Throws
type summary
​Exception ​

[m] insert Inserts a table row with specified data.

Inserts a table row with specified data. 
public function insert(
    string $table,
    array $data,
    array $types = []
): int|string

Table expression and columns are not escaped and are not safe for user-input.

Parameter
type name summary
​string ​$table ​Table name
​array ​$data ​
​array ​$types = [] ​
Return
type summary
​int|​string ​The number of affected rows.
Throws
type summary
​Exception ​

[m] quoteIdentifier Quotes a string so it can be safely used as a table or column name, even if

Quotes a string so it can be safely used as a table or column name, even if 
public function quoteIdentifier(string $str): string

it is a reserved name.

Delimiting style depends on the underlying database platform that is being used.

NOTE: Just because you CAN use quoted identifiers does not mean you SHOULD use them. In general, they end up causing way more problems than they solve.

Parameter
type name summary
​string ​$str ​The name to be quoted.
Return
type summary
​string ​The quoted name.

[m] quote The usage of this method is discouraged. Use prepared statements

The usage of this method is discouraged. Use prepared statements 
public function quote(
    mixed $value,
    int|string|Doctrine\DBAL\Types\Type|null $type = Doctrine\DBAL\ParameterType::STRING
): mixed

or Doctrine\DBAL\Platforms\AbstractPlatform::quoteStringLiteral() instead.

Parameter
type name summary
​mixed ​$value ​
​int|​string|​Type|​null ​$type = Doctrine\DBAL\ParameterType::STRING ​
Return
type summary
​mixed ​
See
type summary
​AbstractPlatform::quoteStringLiteral() ​

[m] fetchAllNumeric Prepares and executes an SQL query and returns the result as an array of numeric arrays.

Prepares and executes an SQL query and returns the result as an array of numeric arrays. 
public function fetchAllNumeric(
    string $query,
    array $params = [],
    array $types = []
): array|list
Parameter
type name summary
​string ​$query ​SQL query
​array ​$params = [] ​
​array ​$types = [] ​
Return
type summary
​array|​list ​
Throws
type summary
​Exception ​

[m] fetchAllAssociative Prepares and executes an SQL query and returns the result as an array of associative arrays.

Prepares and executes an SQL query and returns the result as an array of associative arrays. 
public function fetchAllAssociative(
    string $query,
    array $params = [],
    array $types = []
): array|list
Parameter
type name summary
​string ​$query ​SQL query
​array ​$params = [] ​
​array ​$types = [] ​
Return
type summary
​array|​list ​
Throws
type summary
​Exception ​

[m] fetchAllKeyValue Prepares and executes an SQL query and returns the result as an associative array with the keys

Prepares and executes an SQL query and returns the result as an associative array with the keys 
public function fetchAllKeyValue(
    string $query,
    array $params = [],
    array $types = []
): array

mapped to the first column and the values mapped to the second column.

Parameter
type name summary
​string ​$query ​SQL query
​array ​$params = [] ​
​array ​$types = [] ​
Return
type summary
​array ​
Throws
type summary
​Exception ​

[m] fetchAllAssociativeIndexed Prepares and executes an SQL query and returns the result as an associative array with the keys mapped

Prepares and executes an SQL query and returns the result as an associative array with the keys mapped 
public function fetchAllAssociativeIndexed(
    string $query,
    array $params = [],
    array $types = []
): array

to the first column and the values being an associative array representing the rest of the columns and their values.

Parameter
type name summary
​string ​$query ​SQL query
​array ​$params = [] ​
​array ​$types = [] ​
Return
type summary
​array ​
Throws
type summary
​Exception ​

[m] fetchFirstColumn Prepares and executes an SQL query and returns the result as an array of the first column values.

Prepares and executes an SQL query and returns the result as an array of the first column values. 
public function fetchFirstColumn(
    string $query,
    array $params = [],
    array $types = []
): array|list
Parameter
type name summary
​string ​$query ​SQL query
​array ​$params = [] ​
​array ​$types = [] ​
Return
type summary
​array|​list ​
Throws
type summary
​Exception ​

[m] iterateNumeric Prepares and executes an SQL query and returns the result as an iterator over rows represented as numeric arrays.

Prepares and executes an SQL query and returns the result as an iterator over rows represented as numeric arrays. 
public function iterateNumeric(
    string $query,
    array $params = [],
    array $types = []
): \Traversable
Parameter
type name summary
​string ​$query ​SQL query
​array ​$params = [] ​
​array ​$types = [] ​
Return
type summary
​Traversable ​
Throws
type summary
​Exception ​

[m] iterateAssociative Prepares and executes an SQL query and returns the result as an iterator over rows represented

Prepares and executes an SQL query and returns the result as an iterator over rows represented 
public function iterateAssociative(
    string $query,
    array $params = [],
    array $types = []
): \Traversable

as associative arrays.

Parameter
type name summary
​string ​$query ​SQL query
​array ​$params = [] ​
​array ​$types = [] ​
Return
type summary
​Traversable ​
Throws
type summary
​Exception ​

[m] iterateKeyValue Prepares and executes an SQL query and returns the result as an iterator with the keys

Prepares and executes an SQL query and returns the result as an iterator with the keys 
public function iterateKeyValue(
    string $query,
    array $params = [],
    array $types = []
): \Traversable

mapped to the first column and the values mapped to the second column.

Parameter
type name summary
​string ​$query ​SQL query
​array ​$params = [] ​
​array ​$types = [] ​
Return
type summary
​Traversable ​
Throws
type summary
​Exception ​

[m] iterateAssociativeIndexed Prepares and executes an SQL query and returns the result as an iterator with the keys mapped

Prepares and executes an SQL query and returns the result as an iterator with the keys mapped 
public function iterateAssociativeIndexed(
    string $query,
    array $params = [],
    array $types = []
): \Traversable

to the first column and the values being an associative array representing the rest of the columns and their values.

Parameter
type name summary
​string ​$query ​SQL query
​array ​$params = [] ​
​array ​$types = [] ​
Return
type summary
​Traversable ​
Throws
type summary
​Exception ​

[m] iterateColumn Prepares and executes an SQL query and returns the result as an iterator over the first column values.

Prepares and executes an SQL query and returns the result as an iterator over the first column values. 
public function iterateColumn(
    string $query,
    array $params = [],
    array $types = []
): \Traversable
Parameter
type name summary
​string ​$query ​SQL query
​array ​$params = [] ​
​array ​$types = [] ​
Return
type summary
​Traversable ​
Throws
type summary
​Exception ​

[m] prepare Prepares an SQL statement.

Prepares an SQL statement. 
public function prepare(string $sql): Doctrine\DBAL\Statement
Parameter
type name summary
​string ​$sql ​The SQL statement to prepare.
Return
type summary
​Statement ​
Throws
type summary
​Exception ​

[m] executeQuery Executes an, optionally parameterized, SQL query.

Executes an, optionally parameterized, SQL query. 
public function executeQuery(
    string $sql,
    array $params = [],
    $types = [],
    ?Doctrine\DBAL\Cache\QueryCacheProfile $qcp = null
): Doctrine\DBAL\Result

If the query is parametrized, a prepared statement is used. If an SQLLogger is configured, the execution is logged.

Parameter
type name summary
​string ​$sql ​SQL query
​array ​$params = [] ​
​ ​$types = [] ​
​?QueryCacheProfile ​$qcp = null ​
Return
type summary
​Result ​
Throws
type summary
​Exception ​

[m] executeCacheQuery Executes a caching query.

Executes a caching query. 
public function executeCacheQuery(
    string $sql,
    $params,
    $types,
    Doctrine\DBAL\Cache\QueryCacheProfile $qcp
): Doctrine\DBAL\Result
Parameter
type name summary
​string ​$sql ​SQL query
​ ​$params ​
​ ​$types ​
​QueryCacheProfile ​$qcp ​
Return
type summary
​Result ​
Throws
type summary
​CacheException ​
​Exception ​

[m] executeStatement Executes an SQL statement with the given parameters and returns the number of affected rows.

Executes an SQL statement with the given parameters and returns the number of affected rows. 
public function executeStatement(
    string $sql,
    array $params = [],
    array $types = []
): int|string

Could be used for:

DML statements
INSERT, UPDATE, DELETE, etc.
DDL statements
CREATE, DROP, ALTER, etc.
DCL statements
GRANT, REVOKE, etc.
Session control statements
ALTER SESSION, SET, DECLARE, etc.
  • Other statements that don't yield a row set.

    • This method supports PDO binding types as well as DBAL mapping types.

    Parameter
    type name summary
    ​string ​$sql ​SQL statement
    ​array ​$params = [] ​
    ​array ​$types = [] ​
    Return
    type summary
    ​int|​string ​The number of affected rows.
    Throws
    type summary
    ​Exception ​

    [m] getTransactionNestingLevel Returns the current transaction nesting level.

    Returns the current transaction nesting level. 
    public function getTransactionNestingLevel(): int
    Return
    type summary
    ​int ​The nesting level. A value of 0 means there's no active transaction.

    [m] lastInsertId Returns the ID of the last inserted row, or the last value from a sequence object,

    Returns the ID of the last inserted row, or the last value from a sequence object, 
    public function lastInsertId(string|null $name = null): string|int|false

    depending on the underlying driver.

    Note: This method may not return a meaningful or consistent result across different drivers, because the underlying database may not even support the notion of AUTO_INCREMENT/IDENTITY columns or sequences.

    Parameter
    type name summary
    ​string|​null ​$name = null ​Name of the sequence object from which the ID should be returned.
    Return
    type summary
    ​string|​int|​false ​A string representation of the last inserted ID.
    Throws
    type summary
    ​Exception ​

    [m] transactional Executes a function in a transaction.

    Executes a function in a transaction. 
    public function transactional(\Closure|Closure(self):T $func): T

    The function gets passed this Connection instance as an (optional) parameter.

    If an exception occurs during execution of the function or transaction commit, the transaction is rolled back and the exception re-thrown.

    Parameter
    type name summary
    ​Closure|​Closure(self):T ​$func ​The function to execute transactionally.
    Return
    type summary
    ​T ​The value returned by $func
    Throws
    type summary
    ​Throwable ​

    [m] setNestTransactionsWithSavepoints Sets if nested transactions should use savepoints.

    Sets if nested transactions should use savepoints. 
    public function setNestTransactionsWithSavepoints(bool $nestTransactionsWithSavepoints): void
    Parameter
    type name summary
    ​bool ​$nestTransactionsWithSavepoints ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] getNestTransactionsWithSavepoints Gets if nested transactions should use savepoints.

    Gets if nested transactions should use savepoints. 
    public function getNestTransactionsWithSavepoints(): bool
    Return
    type summary
    ​bool ​

    [m] _getNestedTransactionSavePointName Returns the savepoint name to use for nested transactions.

    Returns the savepoint name to use for nested transactions. 
    protected function _getNestedTransactionSavePointName(): string
    Return
    type summary
    ​string ​

    [m] beginTransaction 

    public function beginTransaction(): bool
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​

    [m] commit 

    public function commit(): bool
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​

    [m] rollBack Cancels any database changes done during the current transaction.

    Cancels any database changes done during the current transaction. 
    public function rollBack(): bool
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​

    [m] createSavepoint Creates a new savepoint.

    Creates a new savepoint. 
    public function createSavepoint(string $savepoint): void
    Parameter
    type name summary
    ​string ​$savepoint ​The name of the savepoint to create.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] releaseSavepoint Releases the given savepoint.

    Releases the given savepoint. 
    public function releaseSavepoint(string $savepoint): void
    Parameter
    type name summary
    ​string ​$savepoint ​The name of the savepoint to release.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] rollbackSavepoint Rolls back to the given savepoint.

    Rolls back to the given savepoint. 
    public function rollbackSavepoint(string $savepoint): void
    Parameter
    type name summary
    ​string ​$savepoint ​The name of the savepoint to rollback to.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] getWrappedConnection Gets the wrapped driver connection.

    deprecated

    Gets the wrapped driver connection. 
    public function getWrappedConnection(): Doctrine\DBAL\Driver\Connection
    Return
    type summary
    ​Connection ​
    Throws
    type summary
    ​Exception ​

    [m] getNativeConnection 

    public function getNativeConnection(): resource|object
    Return
    type summary
    ​resource|​object ​

    [m] createSchemaManager Creates a SchemaManager that can be used to inspect or change the

    Creates a SchemaManager that can be used to inspect or change the 
    public function createSchemaManager(): Doctrine\DBAL\Schema\AbstractSchemaManager

    database schema through the connection.

    Return
    type summary
    ​AbstractSchemaManager ​
    Throws
    type summary
    ​Exception ​

    [m] getSchemaManager Gets the SchemaManager that can be used to inspect or change the

    deprecated

    Gets the SchemaManager that can be used to inspect or change the 
    public function getSchemaManager(): Doctrine\DBAL\Schema\AbstractSchemaManager

    database schema through the connection.

    Return
    type summary
    ​AbstractSchemaManager ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​Connection::createSchemaManager() ​

    [m] setRollbackOnly Marks the current transaction so that the only possible

    Marks the current transaction so that the only possible 
    public function setRollbackOnly(): void

    outcome for the transaction to be rolled back.

    Return
    type summary
    ​void ​
    Throws
    type summary
    ​ConnectionException ​If no transaction is active.

    [m] isRollbackOnly Checks whether the current transaction is marked for rollback only.

    Checks whether the current transaction is marked for rollback only. 
    public function isRollbackOnly(): bool
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​ConnectionException ​If no transaction is active.

    [m] convertToDatabaseValue Converts a given value to its database representation according to the conversion

    Converts a given value to its database representation according to the conversion 
    public function convertToDatabaseValue(
    mixed $value,
    string $type
): mixed

    rules of a specific DBAL mapping type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​string ​$type ​The name of the DBAL mapping type.
    Return
    type summary
    ​mixed ​The converted value.
    Throws
    type summary
    ​Exception ​

    [m] convertToPHPValue Converts a given value to its PHP representation according to the conversion

    Converts a given value to its PHP representation according to the conversion 
    public function convertToPHPValue(
    mixed $value,
    string $type
): mixed

    rules of a specific DBAL mapping type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​string ​$type ​The name of the DBAL mapping type.
    Return
    type summary
    ​mixed ​The converted type.
    Throws
    type summary
    ​Exception ​

    [m] createQueryBuilder Creates a new instance of a SQL query builder.

    Creates a new instance of a SQL query builder. 
    public function createQueryBuilder(): Doctrine\DBAL\Query\QueryBuilder
    Return
    type summary
    ​QueryBuilder ​

    [m] convertExceptionDuringQuery

    final

    final public function convertExceptionDuringQuery(
    Doctrine\DBAL\Driver\Exception $e,
    string $sql,
    array $params = [],
    array $types = []
): Doctrine\DBAL\Exception\DriverException
    Parameter
    type name summary
    ​Exception ​$e ​
    ​string ​$sql ​
    ​array ​$params = [] ​
    ​array ​$types = [] ​
    Return
    type summary
    ​DriverException ​

    [m] convertException

    final

    final public function convertException(Doctrine\DBAL\Driver\Exception $e): Doctrine\DBAL\Exception\DriverException
    Parameter
    type name summary
    ​Exception ​$e ​
    Return
    type summary
    ​DriverException ​

    [m] executeUpdate BC layer for a wide-spread use-case of old DBAL APIs

    deprecated

    BC layer for a wide-spread use-case of old DBAL APIs 
    public function executeUpdate(
    string $sql,
    array $params = [],
    array $types = []
): int
    Parameter
    type name summary
    ​string ​$sql ​
    ​array ​$params = [] ​The query parameters
    ​array ​$types = [] ​The parameter types
    Return
    type summary
    ​int ​
    See
    type summary
    ​Connection::executeStatement() ​

    [m] query BC layer for a wide-spread use-case of old DBAL APIs

    deprecated

    BC layer for a wide-spread use-case of old DBAL APIs 
    public function query(string $sql): Doctrine\DBAL\Result
    Parameter
    type name summary
    ​string ​$sql ​
    Return
    type summary
    ​Result ​
    See
    type summary
    ​Connection::executeQuery() ​

    [m] exec BC layer for a wide-spread use-case of old DBAL APIs

    deprecated

    BC layer for a wide-spread use-case of old DBAL APIs 
    public function exec(string $sql): int
    Parameter
    type name summary
    ​string ​$sql ​
    Return
    type summary
    ​int ​
    See
    type summary
    ​Connection::executeStatement() ​

    [C] ParameterType Contains statement parameter types.

    final

    Contains statement parameter types.

    [C] NULL Represents the SQL NULL data type.

    Represents the SQL NULL data type. 
    public const int NULL = 0

    [C] INTEGER Represents the SQL INTEGER data type.

    Represents the SQL INTEGER data type. 
    public const int INTEGER = 1

    [C] STRING Represents the SQL CHAR, VARCHAR, or other string data type.

    Represents the SQL CHAR, VARCHAR, or other string data type. 
    public const int STRING = 2
    See
    type summary
    ​PDO::PARAM_STR ​

    [C] LARGE_OBJECT Represents the SQL large object data type.

    Represents the SQL large object data type. 
    public const int LARGE_OBJECT = 3

    [C] BOOLEAN Represents a boolean data type.

    Represents a boolean data type. 
    public const int BOOLEAN = 5
    See
    type summary
    ​PDO::PARAM_BOOL ​

    [C] BINARY Represents a binary string data type.

    Represents a binary string data type. 
    public const int BINARY = 16

    [C] ASCII Represents an ASCII string data type

    Represents an ASCII string data type 
    public const int ASCII = 17

    [C] Result

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Driver\Result $result,
    Doctrine\DBAL\Connection $connection
)
    Parameter
    type name summary
    ​Result ​$result ​
    ​Connection ​$connection ​
    See
    type summary
    ​Connection ​
    ​Statement ​

    [m] fetchNumeric Returns the next row of the result as a numeric array or FALSE if there are no more rows.

    Returns the next row of the result as a numeric array or FALSE if there are no more rows. 
    public function fetchNumeric(): list|false
    Return
    type summary
    ​list|​false ​
    Throws
    type summary
    ​Exception ​

    [m] fetchAssociative Returns the next row of the result as an associative array or FALSE if there are no more rows.

    Returns the next row of the result as an associative array or FALSE if there are no more rows. 
    public function fetchAssociative(): array|false
    Return
    type summary
    ​array|​false ​
    Throws
    type summary
    ​Exception ​

    [m] fetchOne Returns the first value of the next row of the result or FALSE if there are no more rows.

    Returns the first value of the next row of the result or FALSE if there are no more rows. 
    public function fetchOne(): mixed|false
    Return
    type summary
    ​mixed|​false ​
    Throws
    type summary
    ​Exception ​

    [m] fetchAllNumeric Returns an array containing all of the result rows represented as numeric arrays.

    Returns an array containing all of the result rows represented as numeric arrays. 
    public function fetchAllNumeric(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [m] fetchAllAssociative Returns an array containing all of the result rows represented as associative arrays.

    Returns an array containing all of the result rows represented as associative arrays. 
    public function fetchAllAssociative(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [m] fetchAllKeyValue Returns an array containing the values of the first column of the result.

    Returns an array containing the values of the first column of the result. 
    public function fetchAllKeyValue(): array
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​

    [m] fetchAllAssociativeIndexed Returns an associative array with the keys mapped to the first column and the values being

    Returns an associative array with the keys mapped to the first column and the values being 
    public function fetchAllAssociativeIndexed(): array

    an associative array representing the rest of the columns and their values.

    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​

    [m] fetchFirstColumn 

    public function fetchFirstColumn(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [m] iterateNumeric 

    public function iterateNumeric(): \Traversable
    Return
    type summary
    ​Traversable ​
    Throws
    type summary
    ​Exception ​

    [m] iterateAssociative 

    public function iterateAssociative(): \Traversable
    Return
    type summary
    ​Traversable ​
    Throws
    type summary
    ​Exception ​

    [m] iterateKeyValue 

    public function iterateKeyValue(): \Traversable
    Return
    type summary
    ​Traversable ​mixed>
    Throws
    type summary
    ​Exception ​

    [m] iterateAssociativeIndexed Returns an iterator over the result set with the keys mapped to the first column and the values being

    Returns an iterator over the result set with the keys mapped to the first column and the values being 
    public function iterateAssociativeIndexed(): \Traversable

    an associative array representing the rest of the columns and their values.

    Return
    type summary
    ​Traversable ​
    Throws
    type summary
    ​Exception ​

    [m] iterateColumn 

    public function iterateColumn(): \Traversable
    Return
    type summary
    ​Traversable ​
    Throws
    type summary
    ​Exception ​

    [m] rowCount 

    public function rowCount(): int
    Return
    type summary
    ​int ​
    Throws
    type summary
    ​Exception ​

    [m] columnCount 

    public function columnCount(): int
    Return
    type summary
    ​int ​
    Throws
    type summary
    ​Exception ​

    [m] free 

    public function free()

    [m] fetch BC layer for a wide-spread use-case of old DBAL APIs

    deprecated

    BC layer for a wide-spread use-case of old DBAL APIs 
    public function fetch(int $mode = Doctrine\DBAL\FetchMode::ASSOCIATIVE): mixed
    Parameter
    type name summary
    ​int ​$mode = Doctrine\DBAL\FetchMode::ASSOCIATIVE ​
    Return
    type summary
    ​mixed ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​Result::fetchNumeric() ​
    ​Result::fetchAssociative() ​
    ​Result::fetchOne() ​

    [m] fetchAll BC layer for a wide-spread use-case of old DBAL APIs

    deprecated

    BC layer for a wide-spread use-case of old DBAL APIs 
    public function fetchAll(int $mode = Doctrine\DBAL\FetchMode::ASSOCIATIVE): array|list
    Parameter
    type name summary
    ​int ​$mode = Doctrine\DBAL\FetchMode::ASSOCIATIVE ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​Result::fetchAllNumeric() ​
    ​Result::fetchAllAssociative() ​
    ​Result::fetchFirstColumn() ​

    [C] Statement A database abstraction-level statement that implements support for logging, DBAL mapping types, etc.

    A database abstraction-level statement that implements support for logging, DBAL mapping types, etc.

    [p] $sql The SQL statement.

    The SQL statement. 
    protected string $sql = null

    Type: string

    [p] $params The bound parameters.

    The bound parameters. 
    protected mixed[] $params = []

    Type: mixed[]

    [p] $types The parameter types.

    The parameter types. 
    protected int[]|string[] $types = []

    Type: int[]|​string[]

    [p] $stmt The underlying driver statement.

    The underlying driver statement. 
    protected Doctrine\DBAL\Driver\Statement $stmt = null

    Type: Statement

    [p] $platform The underlying database platform.

    The underlying database platform. 
    protected Doctrine\DBAL\Platforms\AbstractPlatform $platform = null

    Type: AbstractPlatform

    [p] $conn The connection this statement is bound to and executed on.

    The connection this statement is bound to and executed on. 
    protected Doctrine\DBAL\Connection $conn = null

    Type: Connection

    [m] __construct Creates a new <tt>Statement</tt> for the given SQL and <tt>Connection</tt>.

    Creates a new Statement for the given SQL and Connection. 
    public function __construct(
    Doctrine\DBAL\Connection $conn,
    Doctrine\DBAL\Driver\Statement $statement,
    string $sql
)
    Parameter
    type name summary
    ​Connection ​$conn ​The connection for handling statement errors.
    ​Statement ​$statement ​The underlying driver-level statement.
    ​string ​$sql ​The SQL of the statement.
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​Connection ​

    [m] bindValue Binds a parameter value to the statement.

    Binds a parameter value to the statement. 
    public function bindValue(
    string|int $param,
    mixed $value,
    mixed $type = Doctrine\DBAL\ParameterType::STRING
): bool

    The value can optionally be bound with a DBAL mapping type. If bound with a DBAL mapping type, the binding type is derived from the mapping type and the value undergoes the conversion routines of the mapping type before being bound.

    Parameter
    type name summary
    ​string|​int ​$param ​The name or position of the parameter.
    ​mixed ​$value ​The value of the parameter.
    ​mixed ​$type = Doctrine\DBAL\ParameterType::STRING ​Either a PDO binding type or a DBAL mapping type name or instance.
    Return
    type summary
    ​bool ​TRUE on success, FALSE on failure.
    Throws
    type summary
    ​Exception ​

    [m] bindParam Binds a parameter to a value by reference.

    deprecated

    Binds a parameter to a value by reference. 
    public function bindParam(
    string|int $param,
    mixed &$variable,
    int $type = Doctrine\DBAL\ParameterType::STRING,
    int|null $length = null
): bool

    Binding a parameter by reference does not support DBAL mapping types.

    Parameter
    type name summary
    ​string|​int ​$param ​The name or position of the parameter.
    ​mixed ​&$variable ​The reference to the variable to bind.
    ​int ​$type = Doctrine\DBAL\ParameterType::STRING ​The binding type.
    ​int|​null ​$length = null ​Must be specified when using an OUT bind
    Return
    type summary
    ​bool ​TRUE on success, FALSE on failure.
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​Statement::bindValue() ​

    [m] execute Executes the statement with the currently bound parameters.

    deprecated

    Executes the statement with the currently bound parameters. 
    public function execute(mixed[]|null $params = null): Doctrine\DBAL\Result
    Parameter
    type name summary
    ​mixed[]|​null ​$params = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​

    [m] executeQuery Executes the statement with the currently bound parameters and return result.

    Executes the statement with the currently bound parameters and return result. 
    public function executeQuery(array|mixed[] $params = []): Doctrine\DBAL\Result
    Parameter
    type name summary
    ​array|​mixed[] ​$params = [] ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​

    [m] executeStatement Executes the statement with the currently bound parameters and return affected rows.

    Executes the statement with the currently bound parameters and return affected rows. 
    public function executeStatement(array|mixed[] $params = []): int
    Parameter
    type name summary
    ​array|​mixed[] ​$params = [] ​
    Return
    type summary
    ​int ​
    Throws
    type summary
    ​Exception ​

    [m] getWrappedStatement Gets the wrapped driver statement.

    Gets the wrapped driver statement. 
    public function getWrappedStatement(): Doctrine\DBAL\Driver\Statement
    Return
    type summary
    ​Statement ​

    [C] Events Container for all DBAL events.

    finaldeprecated

    Container for all DBAL events.

    This class cannot be instantiated.

    [C] postConnect

    deprecated 

    public const string postConnect = "postConnect"

    [C] onSchemaCreateTable

    deprecated 

    public const string onSchemaCreateTable = "onSchemaCreateTable"

    [C] onSchemaCreateTableColumn

    deprecated 

    public const string onSchemaCreateTableColumn = "onSchemaCreateTableColumn"

    [C] onSchemaDropTable

    deprecated 

    public const string onSchemaDropTable = "onSchemaDropTable"

    [C] onSchemaAlterTable

    deprecated 

    public const string onSchemaAlterTable = "onSchemaAlterTable"

    [C] onSchemaAlterTableAddColumn

    deprecated 

    public const string onSchemaAlterTableAddColumn = "onSchemaAlterTableAddColumn"

    [C] onSchemaAlterTableRemoveColumn

    deprecated 

    public const string onSchemaAlterTableRemoveColumn = "onSchemaAlterTableRemoveColumn"

    [C] onSchemaAlterTableChangeColumn

    deprecated 

    public const string onSchemaAlterTableChangeColumn = "onSchemaAlterTableChangeColumn"

    [C] onSchemaAlterTableRenameColumn

    deprecated 

    public const string onSchemaAlterTableRenameColumn = "onSchemaAlterTableRenameColumn"

    [C] onSchemaColumnDefinition

    deprecated 

    public const string onSchemaColumnDefinition = "onSchemaColumnDefinition"

    [C] onSchemaIndexDefinition

    deprecated 

    public const string onSchemaIndexDefinition = "onSchemaIndexDefinition"

    [C] onTransactionBegin

    deprecated 

    public const string onTransactionBegin = "onTransactionBegin"

    [C] onTransactionCommit

    deprecated 

    public const string onTransactionCommit = "onTransactionCommit"

    [C] onTransactionRollBack

    deprecated 

    public const string onTransactionRollBack = "onTransactionRollBack"

    [C] LockMode Contains all DBAL LockModes.

    Contains all DBAL LockModes.

    [C] NONE 

    public const int NONE = 0

    [C] OPTIMISTIC 

    public const int OPTIMISTIC = 1

    [C] PESSIMISTIC_READ 

    public const int PESSIMISTIC_READ = 2

    [C] PESSIMISTIC_WRITE 

    public const int PESSIMISTIC_WRITE = 4

    [C] TransactionIsolationLevel

    final

    [C] READ_UNCOMMITTED Transaction isolation level READ UNCOMMITTED.

    Transaction isolation level READ UNCOMMITTED. 
    public const int READ_UNCOMMITTED = 1

    [C] READ_COMMITTED Transaction isolation level READ COMMITTED.

    Transaction isolation level READ COMMITTED. 
    public const int READ_COMMITTED = 2

    [C] REPEATABLE_READ Transaction isolation level REPEATABLE READ.

    Transaction isolation level REPEATABLE READ. 
    public const int REPEATABLE_READ = 3

    [C] SERIALIZABLE Transaction isolation level SERIALIZABLE.

    Transaction isolation level SERIALIZABLE. 
    public const int SERIALIZABLE = 4

    [C] Query An SQL query together with its bound parameters.

    final

    An SQL query together with its bound parameters.

    [m] __construct 

    public function __construct(
    string $sql,
    array $params,
    array $types
)
    Parameter
    type name summary
    ​string ​$sql ​
    ​array ​$params ​
    ​array ​$types ​

    [m] getSQL 

    public function getSQL(): string
    Return
    type summary
    ​string ​

    [m] getParams 

    public function getParams(): array
    Return
    type summary
    ​array ​

    [m] getTypes 

    public function getTypes(): array
    Return
    type summary
    ​array ​

    [C] DriverManager Factory for creating Doctrine\DBAL\Connection instances.

    final

    Factory for creating Doctrine\DBAL\Connection instances.

    See
    type summary
    ​Connection ​

    [M] getConnection Creates a connection object based on the specified parameters.

    Creates a connection object based on the specified parameters. 
    public static function getConnection(
    array $params,
    ?Doctrine\DBAL\Configuration|Doctrine\DBAL\Configuration|null $config = null,
    ?Doctrine\Common\EventManager|Doctrine\Common\EventManager|null $eventManager = null
): Doctrine\DBAL\Connection

    This method returns a Doctrine\DBAL\Connection which wraps the underlying driver connection.

    $params must contain at least one of the following.

    Either 'driver' with one of the array keys of Doctrine\DBAL\DriverManager::DRIVER_MAP, OR 'driverClass' that contains the full class name (with namespace) of the driver class to instantiate.

    Other (optional) parameters:

    user (string): The username to use when connecting.

    password (string): The password to use when connecting.

    driverOptions (array): Any additional driver-specific options for the driver. These are just passed through to the driver.

    wrapperClass: You may specify a custom wrapper class through the 'wrapperClass' parameter but this class MUST inherit from Doctrine\DBAL\Connection.

    driverClass: The driver class to use.

    Parameter
    type name summary
    ​
    array    		 ​$params ​
    ​?Configuration|​Configuration|​null ​$config = null ​The configuration to use.
    ​?EventManager|​EventManager|​null ​$eventManager = null ​The event manager to use.
    Return
    type summary
    ​Connection ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​DriverManager::DRIVER_MAP ​

    [M] getAvailableDrivers Returns the list of supported drivers.

    Returns the list of supported drivers. 
    public static function getAvailableDrivers(): array|string[]
    Return
    type summary
    ​array|​string[] ​

    [C] ArrayParameterType

    final

    [C] INTEGER Represents an array of ints to be expanded by Doctrine SQL parsing.

    Represents an array of ints to be expanded by Doctrine SQL parsing. 
    public const int INTEGER = 101

    [C] STRING Represents an array of strings to be expanded by Doctrine SQL parsing.

    Represents an array of strings to be expanded by Doctrine SQL parsing. 
    public const int STRING = 102

    [C] ASCII Represents an array of ascii strings to be expanded by Doctrine SQL parsing.

    Represents an array of ascii strings to be expanded by Doctrine SQL parsing. 
    public const int ASCII = 117

    [C] BINARY Represents an array of ascii strings to be expanded by Doctrine SQL parsing.

    Represents an array of ascii strings to be expanded by Doctrine SQL parsing. 
    public const int BINARY = 116

    [M] toElementParameterType 

    public static function toElementParameterType(int $type): int
    Parameter
    type name summary
    ​int ​$type ​
    Return
    type summary
    ​int ​

    [C] ConnectionException

    Hierarchy

    Parents
    type summary
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Stringable ​
    ​Throwable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] commitFailedRollbackOnly 

    public static function commitFailedRollbackOnly(): Doctrine\DBAL\ConnectionException
    Return
    type summary
    ​ConnectionException ​

    [M] noActiveTransaction 

    public static function noActiveTransaction(): Doctrine\DBAL\ConnectionException
    Return
    type summary
    ​ConnectionException ​

    [M] savepointsNotSupported 

    public static function savepointsNotSupported(): Doctrine\DBAL\ConnectionException
    Return
    type summary
    ​ConnectionException ​

    [M] mayNotAlterNestedTransactionWithSavepointsInTransaction 

    public static function mayNotAlterNestedTransactionWithSavepointsInTransaction(): Doctrine\DBAL\ConnectionException
    Return
    type summary
    ​ConnectionException ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [I] Driver Driver interface.

    abstract

    Driver interface. Interface that all DBAL drivers must implement.

    Hierarchy

    [m] connect Attempts to create a connection with the database.

    abstract

    Attempts to create a connection with the database. 
    abstract public function connect(array $params): Doctrine\DBAL\Driver\Connection
    Parameter
    type name summary
    ​
    array    		 ​$params ​
    Return
    type summary
    ​Connection ​The database connection.
    Throws
    type summary
    ​Exception ​

    [m] getDatabasePlatform Gets the DatabasePlatform instance that provides all the metadata about

    abstract

    Gets the DatabasePlatform instance that provides all the metadata about 
    abstract public function getDatabasePlatform(): Doctrine\DBAL\Platforms\AbstractPlatform

    the platform this driver connects to.

    Return
    type summary
    ​AbstractPlatform ​The database platform.

    [m] getSchemaManager Gets the SchemaManager that can be used to inspect and change the underlying

    abstractdeprecated

    Gets the SchemaManager that can be used to inspect and change the underlying 
    abstract public function getSchemaManager(
    Doctrine\DBAL\Connection $conn,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): Doctrine\DBAL\Schema\AbstractSchemaManager

    database schema of the platform this driver connects to.

    Parameter
    type name summary
    ​Connection ​$conn ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​AbstractSchemaManager ​

    [m] getExceptionConverter Gets the ExceptionConverter that can be used to convert driver-level exceptions into DBAL exceptions.

    abstract

    Gets the ExceptionConverter that can be used to convert driver-level exceptions into DBAL exceptions. 
    abstract public function getExceptionConverter(): Doctrine\DBAL\Driver\API\ExceptionConverter
    Return
    type summary
    ​ExceptionConverter ​

    [I] VersionAwarePlatformDriver Contract for a driver that is able to create platform instances by version.

    abstractdeprecated

    Contract for a driver that is able to create platform instances by version.

    Doctrine uses different platform classes for different vendor versions to support the correct features and SQL syntax of each version. This interface should be implemented by drivers that are capable to do this distinction.

    Hierarchy

    Implements
    type summary
    ​Driver ​Driver interface.

    [m] createDatabasePlatformForVersion Factory method for creating the appropriate platform instance for the given version.

    abstract

    Factory method for creating the appropriate platform instance for the given version. 
    abstract public function createDatabasePlatformForVersion(string $version): Doctrine\DBAL\Platforms\AbstractPlatform
    Parameter
    type name summary
    ​string ​$version ​The platform/server version string to evaluate. This should be given in the notation
    Return
    type summary
    ​AbstractPlatform ​
    Throws
    type summary
    ​Exception ​If the given version string could not be evaluated.

    [m] connect Attempts to create a connection with the database.

    abstract

    Attempts to create a connection with the database. 
    abstract public function connect(array $params): Doctrine\DBAL\Driver\Connection
    Parameter
    type name summary
    ​
    array    		 ​$params ​
    Return
    type summary
    ​Connection ​The database connection.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Driver::connect() ​Attempts to create a connection with the database.

    [m] getDatabasePlatform Gets the DatabasePlatform instance that provides all the metadata about

    abstract

    Gets the DatabasePlatform instance that provides all the metadata about 
    abstract public function getDatabasePlatform(): Doctrine\DBAL\Platforms\AbstractPlatform

    the platform this driver connects to.

    Return
    type summary
    ​AbstractPlatform ​The database platform.
    Prototype
    kind source summary
    ​inherit ​Driver::getDatabasePlatform() ​Gets the DatabasePlatform instance that provides all the metadata about

    [m] getSchemaManager Gets the SchemaManager that can be used to inspect and change the underlying

    abstractdeprecated

    Gets the SchemaManager that can be used to inspect and change the underlying 
    abstract public function getSchemaManager(
    Doctrine\DBAL\Connection $conn,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): Doctrine\DBAL\Schema\AbstractSchemaManager

    database schema of the platform this driver connects to.

    Parameter
    type name summary
    ​Connection ​$conn ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​AbstractSchemaManager ​
    Prototype
    kind source summary
    ​inherit ​Driver::getSchemaManager() ​Gets the SchemaManager that can be used to inspect and change the underlying

    [m] getExceptionConverter Gets the ExceptionConverter that can be used to convert driver-level exceptions into DBAL exceptions.

    abstract

    Gets the ExceptionConverter that can be used to convert driver-level exceptions into DBAL exceptions. 
    abstract public function getExceptionConverter(): Doctrine\DBAL\Driver\API\ExceptionConverter
    Return
    type summary
    ​ExceptionConverter ​
    Prototype
    kind source summary
    ​inherit ​Driver::getExceptionConverter() ​Gets the ExceptionConverter that can be used to convert driver-level exceptions into DBAL exceptions.

    [N] Doctrine\DBAL\Cache\

    [C] ArrayResult

    final

    Implements
    type summary
    ​Result ​Driver-level statement execution result.

    [m] __construct 

    public function __construct(array $data)
    Parameter
    type name summary
    ​array ​$data ​

    [m] fetchNumeric Returns the next row of the result as a numeric array or FALSE if there are no more rows.

    Returns the next row of the result as a numeric array or FALSE if there are no more rows. 
    public function fetchNumeric(): list|false
    Return
    type summary
    ​list|​false ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Result::fetchNumeric() ​Returns the next row of the result as a numeric array or FALSE if there are no more rows.

    [m] fetchAssociative Returns the next row of the result as an associative array or FALSE if there are no more rows.

    Returns the next row of the result as an associative array or FALSE if there are no more rows. 
    public function fetchAssociative(): array|false
    Return
    type summary
    ​array|​false ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Result::fetchAssociative() ​Returns the next row of the result as an associative array or FALSE if there are no more rows.

    [m] fetchOne Returns the first value of the next row of the result or FALSE if there are no more rows.

    Returns the first value of the next row of the result or FALSE if there are no more rows. 
    public function fetchOne(): mixed|false
    Return
    type summary
    ​mixed|​false ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Result::fetchOne() ​Returns the first value of the next row of the result or FALSE if there are no more rows.

    [m] fetchAllNumeric Returns an array containing all of the result rows represented as numeric arrays.

    Returns an array containing all of the result rows represented as numeric arrays. 
    public function fetchAllNumeric(): array
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Result::fetchAllNumeric() ​Returns an array containing all of the result rows represented as numeric arrays.

    [m] fetchAllAssociative Returns an array containing all of the result rows represented as associative arrays.

    Returns an array containing all of the result rows represented as associative arrays. 
    public function fetchAllAssociative(): array
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Result::fetchAllAssociative() ​Returns an array containing all of the result rows represented as associative arrays.

    [m] fetchFirstColumn Returns an array containing the values of the first column of the result.

    Returns an array containing the values of the first column of the result. 
    public function fetchFirstColumn(): array
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Result::fetchFirstColumn() ​Returns an array containing the values of the first column of the result.

    [m] rowCount Returns the number of rows affected by the DELETE, INSERT, or UPDATE statement that produced the result.

    Returns the number of rows affected by the DELETE, INSERT, or UPDATE statement that produced the result. 
    public function rowCount(): int

    If the statement executed a SELECT query or a similar platform-specific SQL (e.g. DESCRIBE, SHOW, etc.), some database drivers may return the number of rows returned by that query. However, this behaviour is not guaranteed for all drivers and should not be relied on in portable applications.

    Return
    type summary
    ​int ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Result::rowCount() ​Returns the number of rows affected by the DELETE, INSERT, or UPDATE statement that produced the result.

    [m] columnCount Returns the number of columns in the result

    Returns the number of columns in the result 
    public function columnCount(): int
    Return
    type summary
    ​int ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Result::columnCount() ​Returns the number of columns in the result

    [m] free Discards the non-fetched portion of the result, enabling the originating statement to be executed again.

    Discards the non-fetched portion of the result, enabling the originating statement to be executed again. 
    public function free()
    Prototype
    kind source summary
    ​implement ​Result::free() ​Discards the non-fetched portion of the result, enabling the originating statement to be executed again.

    [C] CacheException

    Hierarchy

    Parents
    type summary
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Stringable ​
    ​Throwable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] noCacheKey 

    public static function noCacheKey(): Doctrine\DBAL\Cache\CacheException
    Return
    type summary
    ​CacheException ​

    [M] noResultDriverConfigured 

    public static function noResultDriverConfigured(): Doctrine\DBAL\Cache\CacheException
    Return
    type summary
    ​CacheException ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] QueryCacheProfile Query Cache Profile handles the data relevant for query caching.

    Query Cache Profile handles the data relevant for query caching.

    It is a value object, setter methods return NEW instances.

    [m] __construct 

    public function __construct(
    int $lifetime = 0,
    string|null $cacheKey = null,
    ?object|Psr\Cache\CacheItemPoolInterface|Cache|null $resultCache = null
)
    Parameter
    type name summary
    ​int ​$lifetime = 0 ​
    ​string|​null ​$cacheKey = null ​
    ​?object|​CacheItemPoolInterface|​Cache|​null ​$resultCache = null ​

    [m] getResultCache 

    public function getResultCache(): ?Psr\Cache\CacheItemPoolInterface
    Return
    type summary
    ​?CacheItemPoolInterface ​

    [m] getResultCacheDriver

    deprecated 

    public function getResultCacheDriver(): Cache|null
    Return
    type summary
    ​Cache|​null ​
    See
    type summary
    ​QueryCacheProfile::getResultCache() ​

    [m] getLifetime 

    public function getLifetime(): int
    Return
    type summary
    ​int ​

    [m] getCacheKey 

    public function getCacheKey(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​CacheException ​

    [m] generateCacheKeys Generates the real cache key from query, params, types and connection parameters.

    Generates the real cache key from query, params, types and connection parameters. 
    public function generateCacheKeys(
    string $sql,
    $params,
    $types,
    array $connectionParams = []
): array
    Parameter
    type name summary
    ​string ​$sql ​
    ​ ​$params ​
    ​ ​$types ​
    ​array ​$connectionParams = [] ​
    Return
    type summary
    ​array ​string}

    [m] setResultCache 

    public function setResultCache(Psr\Cache\CacheItemPoolInterface $cache): Doctrine\DBAL\Cache\QueryCacheProfile
    Parameter
    type name summary
    ​CacheItemPoolInterface ​$cache ​
    Return
    type summary
    ​QueryCacheProfile ​

    [m] setResultCacheDriver

    deprecated 

    public function setResultCacheDriver(Doctrine\Common\Cache\Cache $cache): Doctrine\DBAL\Cache\QueryCacheProfile
    Parameter
    type name summary
    ​Cache ​$cache ​
    Return
    type summary
    ​QueryCacheProfile ​
    See
    type summary
    ​QueryCacheProfile::setResultCache() ​

    [m] setCacheKey 

    public function setCacheKey(string|null $cacheKey): Doctrine\DBAL\Cache\QueryCacheProfile
    Parameter
    type name summary
    ​string|​null ​$cacheKey ​
    Return
    type summary
    ​QueryCacheProfile ​

    [m] setLifetime 

    public function setLifetime(int $lifetime): Doctrine\DBAL\Cache\QueryCacheProfile
    Parameter
    type name summary
    ​int ​$lifetime ​
    Return
    type summary
    ​QueryCacheProfile ​

    [N] Doctrine\DBAL\Driver\

    [C] FetchUtils

    final

    [M] fetchOne 

    public static function fetchOne(Doctrine\DBAL\Driver\Result $result): mixed|false
    Parameter
    type name summary
    ​Result ​$result ​
    Return
    type summary
    ​mixed|​false ​
    Throws
    type summary
    ​Exception ​

    [M] fetchAllNumeric 

    public static function fetchAllNumeric(Doctrine\DBAL\Driver\Result $result): array|list
    Parameter
    type name summary
    ​Result ​$result ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [M] fetchAllAssociative 

    public static function fetchAllAssociative(Doctrine\DBAL\Driver\Result $result): array|list
    Parameter
    type name summary
    ​Result ​$result ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [M] fetchFirstColumn 

    public static function fetchFirstColumn(Doctrine\DBAL\Driver\Result $result): array|list
    Parameter
    type name summary
    ​Result ​$result ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [C] AbstractException Base implementation of the Doctrine\DBAL\Driver\Exception interface.

    abstract

    Base implementation of the Doctrine\DBAL\Driver\Exception interface.

    See
    type summary
    ​Exception ​

    Hierarchy

    Parents
    type summary
    ​Exception ​
    Implements
    type summary
    ​Stringable ​
    ​Throwable ​
    ​Exception ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [m] __construct 

    public function __construct(
    string $message,
    string|null $sqlState = null,
    int $code = 0,
    ?\Throwable|\Throwable|null $previous = null
)
    Parameter
    type name summary
    ​string ​$message ​The driver error message.
    ​string|​null ​$sqlState = null ​The SQLSTATE the driver is in at the time the error occurred, if any.
    ​int ​$code = 0 ​The driver specific error code if any.
    ​?Throwable|​Throwable|​null ​$previous = null ​The previous throwable used for the exception chaining.
    Prototype
    kind source summary
    ​override ​Exception::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​implement ​Exception::getSQLState() ​Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [I] Middleware

    abstract

    Hierarchy

    [m] wrap

    abstract

    abstract public function wrap(Doctrine\DBAL\Driver $driver): Doctrine\DBAL\Driver
    Parameter
    type name summary
    ​Driver ​$driver ​
    Return
    type summary
    ​Driver ​

    [I] Exception

    abstract

    Hierarchy

    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [m] getSQLState Returns the SQLSTATE the driver was in at the time the error occurred.

    abstract

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    abstract public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​

    [m] getMessage

    abstract

    abstract public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getMessage() ​

    [m] getCode

    abstract

    abstract public function getCode()
    Prototype
    kind source summary
    ​inherit ​Throwable::getCode() ​

    [m] getFile

    abstract

    abstract public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getFile() ​

    [m] getLine

    abstract

    abstract public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getLine() ​

    [m] getTrace

    abstract

    abstract public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getTrace() ​

    [m] getPrevious

    abstract

    abstract public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getPrevious() ​

    [m] getTraceAsString

    abstract

    abstract public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getTraceAsString() ​

    [m] __toString

    abstract

    abstract public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Stringable::__toString() ​

    [I] Result Driver-level statement execution result.

    abstract

    Driver-level statement execution result.

    Hierarchy

    [m] fetchNumeric Returns the next row of the result as a numeric array or FALSE if there are no more rows.

    abstract

    Returns the next row of the result as a numeric array or FALSE if there are no more rows. 
    abstract public function fetchNumeric(): list|false
    Return
    type summary
    ​list|​false ​
    Throws
    type summary
    ​Exception ​

    [m] fetchAssociative Returns the next row of the result as an associative array or FALSE if there are no more rows.

    abstract

    Returns the next row of the result as an associative array or FALSE if there are no more rows. 
    abstract public function fetchAssociative(): array|false
    Return
    type summary
    ​array|​false ​
    Throws
    type summary
    ​Exception ​

    [m] fetchOne Returns the first value of the next row of the result or FALSE if there are no more rows.

    abstract

    Returns the first value of the next row of the result or FALSE if there are no more rows. 
    abstract public function fetchOne(): mixed|false
    Return
    type summary
    ​mixed|​false ​
    Throws
    type summary
    ​Exception ​

    [m] fetchAllNumeric Returns an array containing all of the result rows represented as numeric arrays.

    abstract

    Returns an array containing all of the result rows represented as numeric arrays. 
    abstract public function fetchAllNumeric(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [m] fetchAllAssociative Returns an array containing all of the result rows represented as associative arrays.

    abstract

    Returns an array containing all of the result rows represented as associative arrays. 
    abstract public function fetchAllAssociative(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [m] fetchFirstColumn Returns an array containing the values of the first column of the result.

    abstract

    Returns an array containing the values of the first column of the result. 
    abstract public function fetchFirstColumn(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [m] rowCount Returns the number of rows affected by the DELETE, INSERT, or UPDATE statement that produced the result.

    abstract

    Returns the number of rows affected by the DELETE, INSERT, or UPDATE statement that produced the result. 
    abstract public function rowCount(): int

    If the statement executed a SELECT query or a similar platform-specific SQL (e.g. DESCRIBE, SHOW, etc.), some database drivers may return the number of rows returned by that query. However, this behaviour is not guaranteed for all drivers and should not be relied on in portable applications.

    Return
    type summary
    ​int ​The number of rows.
    Throws
    type summary
    ​Exception ​

    [m] columnCount Returns the number of columns in the result

    abstract

    Returns the number of columns in the result 
    abstract public function columnCount(): int
    Return
    type summary
    ​int ​The number of columns in the result. If the columns cannot be counted,
    Throws
    type summary
    ​Exception ​

    [m] free Discards the non-fetched portion of the result, enabling the originating statement to be executed again.

    abstract

    Discards the non-fetched portion of the result, enabling the originating statement to be executed again. 
    abstract public function free()

    [I] Connection Connection interface.

    abstract

    Connection interface. Driver connections must implement this interface.

    Hierarchy

    [m] prepare Prepares a statement for execution and returns a Statement object.

    abstract

    Prepares a statement for execution and returns a Statement object. 
    abstract public function prepare(string $sql): Doctrine\DBAL\Driver\Statement
    Parameter
    type name summary
    ​string ​$sql ​
    Return
    type summary
    ​Statement ​
    Throws
    type summary
    ​Exception ​

    [m] query Executes an SQL statement, returning a result set as a Statement object.

    abstract

    Executes an SQL statement, returning a result set as a Statement object. 
    abstract public function query(string $sql): Doctrine\DBAL\Driver\Result
    Parameter
    type name summary
    ​string ​$sql ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​

    [m] quote Quotes a string for use in a query.

    abstract

    Quotes a string for use in a query. 
    abstract public function quote(
    mixed $value,
    int $type = Doctrine\DBAL\ParameterType::STRING
): mixed

    The usage of this method is discouraged. Use prepared statements or AbstractPlatform::quoteStringLiteral() instead.

    Parameter
    type name summary
    ​mixed ​$value ​
    ​int ​$type = Doctrine\DBAL\ParameterType::STRING ​
    Return
    type summary
    ​mixed ​
    See
    type summary
    ​AbstractPlatform::quoteStringLiteral() ​

    [m] exec Executes an SQL statement and return the number of affected rows.

    abstract

    Executes an SQL statement and return the number of affected rows. 
    abstract public function exec(string $sql): int
    Parameter
    type name summary
    ​string ​$sql ​
    Return
    type summary
    ​int ​
    Throws
    type summary
    ​Exception ​

    [m] lastInsertId Returns the ID of the last inserted row or sequence value.

    abstract

    Returns the ID of the last inserted row or sequence value. 
    abstract public function lastInsertId(string|null $name = null): string|int|false
    Parameter
    type name summary
    ​string|​null ​$name = null ​
    Return
    type summary
    ​string|​int|​false ​
    Throws
    type summary
    ​Exception ​

    [m] beginTransaction Initiates a transaction.

    abstract

    Initiates a transaction. 
    abstract public function beginTransaction(): bool
    Return
    type summary
    ​bool ​TRUE on success or FALSE on failure.
    Throws
    type summary
    ​Exception ​

    [m] commit Commits a transaction.

    abstract

    Commits a transaction. 
    abstract public function commit(): bool
    Return
    type summary
    ​bool ​TRUE on success or FALSE on failure.
    Throws
    type summary
    ​Exception ​

    [m] rollBack Rolls back the current transaction, as initiated by beginTransaction().

    abstract

    Rolls back the current transaction, as initiated by beginTransaction(). 
    abstract public function rollBack(): bool
    Return
    type summary
    ​bool ​TRUE on success or FALSE on failure.
    Throws
    type summary
    ​Exception ​

    [m] getNativeConnection

    magic

    public function getNativeConnection(): resource|object
    Return
    type summary
    ​resource|​object ​

    [I] ServerInfoAwareConnection Contract for a connection that is able to provide information about the server it is connected to.

    abstractdeprecated

    Contract for a connection that is able to provide information about the server it is connected to.

    See
    type summary
    ​Driver ​

    Hierarchy

    Implements
    type summary
    ​Connection ​Connection interface.

    [m] getServerVersion Returns information about the version of the database server connected to.

    abstract

    Returns information about the version of the database server connected to. 
    abstract public function getServerVersion(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​

    [m] prepare Prepares a statement for execution and returns a Statement object.

    abstract

    Prepares a statement for execution and returns a Statement object. 
    abstract public function prepare(string $sql): Doctrine\DBAL\Driver\Statement
    Parameter
    type name summary
    ​string ​$sql ​
    Return
    type summary
    ​Statement ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Connection::prepare() ​Prepares a statement for execution and returns a Statement object.

    [m] query Executes an SQL statement, returning a result set as a Statement object.

    abstract

    Executes an SQL statement, returning a result set as a Statement object. 
    abstract public function query(string $sql): Doctrine\DBAL\Driver\Result
    Parameter
    type name summary
    ​string ​$sql ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Connection::query() ​Executes an SQL statement, returning a result set as a Statement object.

    [m] quote Quotes a string for use in a query.

    abstract

    Quotes a string for use in a query. 
    abstract public function quote(
    mixed $value,
    int $type = Doctrine\DBAL\ParameterType::STRING
): mixed

    The usage of this method is discouraged. Use prepared statements or AbstractPlatform::quoteStringLiteral() instead.

    Parameter
    type name summary
    ​mixed ​$value ​
    ​int ​$type = Doctrine\DBAL\ParameterType::STRING ​
    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​inherit ​Connection::quote() ​Quotes a string for use in a query.
    See
    type summary
    ​AbstractPlatform::quoteStringLiteral() ​

    [m] exec Executes an SQL statement and return the number of affected rows.

    abstract

    Executes an SQL statement and return the number of affected rows. 
    abstract public function exec(string $sql): int
    Parameter
    type name summary
    ​string ​$sql ​
    Return
    type summary
    ​int ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Connection::exec() ​Executes an SQL statement and return the number of affected rows.

    [m] lastInsertId Returns the ID of the last inserted row or sequence value.

    abstract

    Returns the ID of the last inserted row or sequence value. 
    abstract public function lastInsertId(string|null $name = null): string|int|false
    Parameter
    type name summary
    ​string|​null ​$name = null ​
    Return
    type summary
    ​string|​int|​false ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Connection::lastInsertId() ​Returns the ID of the last inserted row or sequence value.

    [m] beginTransaction Initiates a transaction.

    abstract

    Initiates a transaction. 
    abstract public function beginTransaction(): bool
    Return
    type summary
    ​bool ​TRUE on success or FALSE on failure.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Connection::beginTransaction() ​Initiates a transaction.

    [m] commit Commits a transaction.

    abstract

    Commits a transaction. 
    abstract public function commit(): bool
    Return
    type summary
    ​bool ​TRUE on success or FALSE on failure.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Connection::commit() ​Commits a transaction.

    [m] rollBack Rolls back the current transaction, as initiated by beginTransaction().

    abstract

    Rolls back the current transaction, as initiated by beginTransaction(). 
    abstract public function rollBack(): bool
    Return
    type summary
    ​bool ​TRUE on success or FALSE on failure.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Connection::rollBack() ​Rolls back the current transaction, as initiated by beginTransaction().

    [I] Statement Driver-level statement

    abstract

    Driver-level statement

    Hierarchy

    [m] bindValue Binds a value to a corresponding named (not supported by mysqli driver, see comment below) or positional

    abstract

    Binds a value to a corresponding named (not supported by mysqli driver, see comment below) or positional 
    abstract public function bindValue(
    string|int $param,
    mixed $value,
    int $type = Doctrine\DBAL\ParameterType::STRING
): bool

    placeholder in the SQL statement that was used to prepare the statement.

    As mentioned above, the named parameters are not natively supported by the mysqli driver, use executeQuery(), fetchAll(), fetchArray(), fetchColumn(), fetchAssoc() methods to have the named parameter emulated by doctrine.

    Parameter
    type name summary
    ​string|​int ​$param ​Parameter identifier. For a prepared statement using named placeholders,
    ​mixed ​$value ​The value to bind to the parameter.
    ​int ​$type = Doctrine\DBAL\ParameterType::STRING ​Explicit data type for the parameter using the Doctrine\DBAL\ParameterType
    Return
    type summary
    ​bool ​TRUE on success or FALSE on failure.
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​ParameterType ​

    [m] bindParam Binds a PHP variable to a corresponding named (not supported by mysqli driver, see comment below) or question

    abstractdeprecated

    Binds a PHP variable to a corresponding named (not supported by mysqli driver, see comment below) or question 
    abstract public function bindParam(
    string|int $param,
    mixed &$variable,
    int $type = Doctrine\DBAL\ParameterType::STRING,
    int|null $length = null
): bool

    mark placeholder in the SQL statement that was use to prepare the statement. Unlike Doctrine\DBAL\Driver\Statement::bindValue(), the variable is bound as a reference and will only be evaluated at the time that PDOStatement->execute() is called.

    As mentioned above, the named parameters are not natively supported by the mysqli driver, use executeQuery(), fetchAll(), fetchArray(), fetchColumn(), fetchAssoc() methods to have the named parameter emulated by doctrine.

    Most parameters are input parameters, that is, parameters that are used in a read-only fashion to build up the query. Some drivers support the invocation of stored procedures that return data as output parameters, and some also as input/output parameters that both send in data and are updated to receive it.

    Parameter
    type name summary
    ​string|​int ​$param ​Parameter identifier. For a prepared statement using named placeholders,
    ​mixed ​&$variable ​Name of the PHP variable to bind to the SQL statement parameter.
    ​int ​$type = Doctrine\DBAL\ParameterType::STRING ​Explicit data type for the parameter using the Doctrine\DBAL\ParameterType
    ​int|​null ​$length = null ​You must specify maxlength when using an OUT bind
    Return
    type summary
    ​bool ​TRUE on success or FALSE on failure.
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​Statement::bindValue() ​
    ​Statement::bindValue() ​
    ​ParameterType ​

    [m] execute Executes a prepared statement

    abstract

    Executes a prepared statement 
    abstract public function execute(mixed[]|null $params = null): Doctrine\DBAL\Driver\Result

    If the prepared statement included parameter markers, you must either: call Doctrine\DBAL\Driver\Statement::bindParam() to bind PHP variables to the parameter markers: bound variables pass their value as input and receive the output value, if any, of their associated parameter markers or pass an array of input-only parameter values.

    Parameter
    type name summary
    ​mixed[]|​null ​$params = null ​A numeric array of values with as many elements as there are
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​Statement::bindParam() ​

    [N] Doctrine\DBAL\Driver\API\

    [I] ExceptionConverter

    abstract

    [m] convert Converts a given driver-level exception into a DBAL-level driver exception.

    abstract

    Converts a given driver-level exception into a DBAL-level driver exception. 
    abstract public function convert(
    Doctrine\DBAL\Driver\Exception $exception,
    ?Doctrine\DBAL\Query|Doctrine\DBAL\Query|null $query
): Doctrine\DBAL\Exception\DriverException

    Implementors should use the vendor-specific error code and SQLSTATE of the exception and instantiate the most appropriate specialized Doctrine\DBAL\Exception\DriverException subclass.

    Parameter
    type name summary
    ​Exception ​$exception ​The driver exception to convert.
    ​?Query|​Query|​null ​$query ​The SQL query that triggered the exception, if any.
    Return
    type summary
    ​DriverException ​An instance of Doctrine\DBAL\Exception\DriverException or one of its subclasses.
    See
    type summary
    ​DriverException ​
    ​DriverException ​

    [N] Doctrine\DBAL\Driver\API\SQLite\

    [C] UserDefinedFunctions User-defined SQLite functions.

    final

    User-defined SQLite functions.

    [M] register 

    public static function register(
    callable $callback,
    array $additionalFunctions = []
)
    Parameter
    type name summary
    ​callable ​$callback ​
    ​array ​$additionalFunctions = [] ​

    [M] mod User-defined function that implements MOD().

    User-defined function that implements MOD(). 
    public static function mod(
    int $a,
    int $b
): int
    Parameter
    type name summary
    ​int ​$a ​
    ​int ​$b ​
    Return
    type summary
    ​int ​

    [M] locate User-defined function that implements LOCATE().

    User-defined function that implements LOCATE(). 
    public static function locate(
    string $str,
    string $substr,
    int $offset = 0
): int
    Parameter
    type name summary
    ​string ​$str ​
    ​string ​$substr ​
    ​int ​$offset = 0 ​
    Return
    type summary
    ​int ​

    [N] Doctrine\DBAL\Driver\Exception\

    [C] UnknownParameterType

    final

    Hierarchy

    Parents
    type summary
    ​AbstractException ​Base implementation of the Doctrine\DBAL\Driver\Exception interface.
    ​Exception ​
    Implements
    type summary
    ​Exception ​
    ​Throwable ​
    ​Stringable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(mixed $type): Doctrine\DBAL\Driver\Exception\UnknownParameterType
    Parameter
    type name summary
    ​mixed ​$type ​
    Return
    type summary
    ​UnknownParameterType ​

    [m] __construct 

    public function __construct(
    string $message,
    string|null $sqlState = null,
    int $code = 0,
    ?\Throwable|\Throwable|null $previous = null
)
    Parameter
    type name summary
    ​string ​$message ​The driver error message.
    ​string|​null ​$sqlState = null ​The SQLSTATE the driver is in at the time the error occurred, if any.
    ​int ​$code = 0 ​The driver specific error code if any.
    ​?Throwable|​Throwable|​null ​$previous = null ​The previous throwable used for the exception chaining.
    Prototype
    kind source summary
    ​inherit ​AbstractException::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractException::getSQLState() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [N] Doctrine\DBAL\Driver\Middleware\

    [C] AbstractConnectionMiddleware

    abstract

    Hierarchy

    Implements
    type summary
    ​ServerInfoAwareConnection ​Contract for a connection that is able to provide information about the server it is connected to.
    ​Connection ​Connection interface.

    [m] __construct 

    public function __construct(Doctrine\DBAL\Driver\Connection $wrappedConnection)
    Parameter
    type name summary
    ​Connection ​$wrappedConnection ​

    [m] prepare Prepares a statement for execution and returns a Statement object.

    Prepares a statement for execution and returns a Statement object. 
    public function prepare(string $sql): Doctrine\DBAL\Driver\Statement
    Parameter
    type name summary
    ​string ​$sql ​
    Return
    type summary
    ​Statement ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Connection::prepare() ​Prepares a statement for execution and returns a Statement object.

    [m] query Executes an SQL statement, returning a result set as a Statement object.

    Executes an SQL statement, returning a result set as a Statement object. 
    public function query(string $sql): Doctrine\DBAL\Driver\Result
    Parameter
    type name summary
    ​string ​$sql ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Connection::query() ​Executes an SQL statement, returning a result set as a Statement object.

    [m] quote <tag_inheritdoc data-type='' data-description=''>Quotes a string for use in a query.

    Quotes a string for use in a query. 
    public function quote(
    mixed $value,
    int $type = Doctrine\DBAL\ParameterType::STRING
): mixed

    The usage of this method is discouraged. Use prepared statements or AbstractPlatform::quoteStringLiteral() instead.

    Parameter
    type name summary
    ​mixed ​$value ​
    ​int ​$type = Doctrine\DBAL\ParameterType::STRING ​
    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​implement ​Connection::quote() ​Quotes a string for use in a query.
    See
    type summary
    ​AbstractPlatform::quoteStringLiteral() ​

    [m] exec Executes an SQL statement and return the number of affected rows.

    Executes an SQL statement and return the number of affected rows. 
    public function exec(string $sql): int
    Parameter
    type name summary
    ​string ​$sql ​
    Return
    type summary
    ​int ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Connection::exec() ​Executes an SQL statement and return the number of affected rows.

    [m] lastInsertId Returns the ID of the last inserted row or sequence value.

    Returns the ID of the last inserted row or sequence value. 
    public function lastInsertId(string|null $name = null): string|int|false
    Parameter
    type name summary
    ​string|​null ​$name = null ​
    Return
    type summary
    ​string|​int|​false ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Connection::lastInsertId() ​Returns the ID of the last inserted row or sequence value.

    [m] beginTransaction Initiates a transaction.

    Initiates a transaction. 
    public function beginTransaction(): bool
    Return
    type summary
    ​bool ​TRUE on success or FALSE on failure.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Connection::beginTransaction() ​Initiates a transaction.

    [m] commit Commits a transaction.

    Commits a transaction. 
    public function commit(): bool
    Return
    type summary
    ​bool ​TRUE on success or FALSE on failure.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Connection::commit() ​Commits a transaction.

    [m] rollBack Rolls back the current transaction, as initiated by beginTransaction().

    Rolls back the current transaction, as initiated by beginTransaction(). 
    public function rollBack(): bool
    Return
    type summary
    ​bool ​TRUE on success or FALSE on failure.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Connection::rollBack() ​Rolls back the current transaction, as initiated by beginTransaction().

    [m] getServerVersion Returns information about the version of the database server connected to.

    Returns information about the version of the database server connected to. 
    public function getServerVersion(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​ServerInfoAwareConnection::getServerVersion() ​Returns information about the version of the database server connected to.

    [m] getNativeConnection 

    public function getNativeConnection(): resource|object
    Return
    type summary
    ​resource|​object ​

    [C] AbstractDriverMiddleware

    abstract

    Hierarchy

    Implements
    type summary
    ​VersionAwarePlatformDriver ​Contract for a driver that is able to create platform instances by version.
    ​Driver ​Driver interface.

    [m] __construct 

    public function __construct(Doctrine\DBAL\Driver $wrappedDriver)
    Parameter
    type name summary
    ​Driver ​$wrappedDriver ​

    [m] connect Attempts to create a connection with the database.

    Attempts to create a connection with the database. 
    public function connect(array $params): Doctrine\DBAL\Driver\Connection
    Parameter
    type name summary
    ​
    array    		 ​$params ​
    Return
    type summary
    ​Connection ​The database connection.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Driver::connect() ​Attempts to create a connection with the database.

    [m] getDatabasePlatform <tag_inheritdoc data-type='' data-description=''>Gets the DatabasePlatform instance that provides all the metadata about

    Gets the DatabasePlatform instance that provides all the metadata about 
    public function getDatabasePlatform(): Doctrine\DBAL\Platforms\AbstractPlatform

    the platform this driver connects to.

    Return
    type summary
    ​AbstractPlatform ​The database platform.
    Prototype
    kind source summary
    ​implement ​Driver::getDatabasePlatform() ​Gets the DatabasePlatform instance that provides all the metadata about

    [m] getSchemaManager <tag_inheritdoc data-type='' data-description=''>Gets the SchemaManager that can be used to inspect and change the underlying

    deprecated

    Gets the SchemaManager that can be used to inspect and change the underlying 
    public function getSchemaManager(
    Doctrine\DBAL\Connection $conn,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): Doctrine\DBAL\Schema\AbstractSchemaManager

    database schema of the platform this driver connects to.

    Parameter
    type name summary
    ​Connection ​$conn ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​AbstractSchemaManager ​
    Prototype
    kind source summary
    ​implement ​Driver::getSchemaManager() ​Gets the SchemaManager that can be used to inspect and change the underlying

    [m] getExceptionConverter Gets the ExceptionConverter that can be used to convert driver-level exceptions into DBAL exceptions.

    Gets the ExceptionConverter that can be used to convert driver-level exceptions into DBAL exceptions. 
    public function getExceptionConverter(): Doctrine\DBAL\Driver\API\ExceptionConverter
    Return
    type summary
    ​ExceptionConverter ​
    Prototype
    kind source summary
    ​implement ​Driver::getExceptionConverter() ​Gets the ExceptionConverter that can be used to convert driver-level exceptions into DBAL exceptions.

    [m] createDatabasePlatformForVersion Factory method for creating the appropriate platform instance for the given version.

    Factory method for creating the appropriate platform instance for the given version. 
    public function createDatabasePlatformForVersion(string $version): Doctrine\DBAL\Platforms\AbstractPlatform
    Parameter
    type name summary
    ​string ​$version ​The platform/server version string to evaluate. This should be given in the notation
    Return
    type summary
    ​AbstractPlatform ​
    Throws
    type summary
    ​Exception ​If the given version string could not be evaluated.
    Prototype
    kind source summary
    ​implement ​VersionAwarePlatformDriver::createDatabasePlatformForVersion() ​Factory method for creating the appropriate platform instance for the given version.

    [C] AbstractStatementMiddleware

    abstract

    Hierarchy

    Implements
    type summary
    ​Statement ​Driver-level statement

    [m] __construct 

    public function __construct(Doctrine\DBAL\Driver\Statement $wrappedStatement)
    Parameter
    type name summary
    ​Statement ​$wrappedStatement ​

    [m] bindValue <tag_inheritdoc data-type='' data-description=''>Binds a value to a corresponding named (not supported by mysqli driver, see comment below) or positional

    Binds a value to a corresponding named (not supported by mysqli driver, see comment below) or positional 
    public function bindValue(
    string|int $param,
    mixed $value,
    int $type = Doctrine\DBAL\ParameterType::STRING
): bool

    placeholder in the SQL statement that was used to prepare the statement.

    As mentioned above, the named parameters are not natively supported by the mysqli driver, use executeQuery(), fetchAll(), fetchArray(), fetchColumn(), fetchAssoc() methods to have the named parameter emulated by doctrine.

    Parameter
    type name summary
    ​string|​int ​$param ​Parameter identifier. For a prepared statement using named placeholders,
    ​mixed ​$value ​The value to bind to the parameter.
    ​int ​$type = Doctrine\DBAL\ParameterType::STRING ​Explicit data type for the parameter using the Doctrine\DBAL\ParameterType
    Return
    type summary
    ​bool ​TRUE on success or FALSE on failure.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Statement::bindValue() ​Binds a value to a corresponding named (not supported by mysqli driver, see comment below) or positional
    See
    type summary
    ​ParameterType ​

    [m] bindParam <tag_inheritdoc data-type='' data-description=''>Binds a PHP variable to a corresponding named (not supported by mysqli driver, see comment below) or question

    deprecated

    Binds a PHP variable to a corresponding named (not supported by mysqli driver, see comment below) or question 
    public function bindParam(
    string|int $param,
    mixed &$variable,
    int $type = Doctrine\DBAL\ParameterType::STRING,
    int|null $length = null
): bool

    mark placeholder in the SQL statement that was use to prepare the statement. Unlike Doctrine\DBAL\Driver\Statement::bindValue(), the variable is bound as a reference and will only be evaluated at the time that PDOStatement->execute() is called.

    As mentioned above, the named parameters are not natively supported by the mysqli driver, use executeQuery(), fetchAll(), fetchArray(), fetchColumn(), fetchAssoc() methods to have the named parameter emulated by doctrine.

    Most parameters are input parameters, that is, parameters that are used in a read-only fashion to build up the query. Some drivers support the invocation of stored procedures that return data as output parameters, and some also as input/output parameters that both send in data and are updated to receive it.

    Parameter
    type name summary
    ​string|​int ​$param ​Parameter identifier. For a prepared statement using named placeholders,
    ​mixed ​&$variable ​Name of the PHP variable to bind to the SQL statement parameter.
    ​int ​$type = Doctrine\DBAL\ParameterType::STRING ​Explicit data type for the parameter using the Doctrine\DBAL\ParameterType
    ​int|​null ​$length = null ​You must specify maxlength when using an OUT bind
    Return
    type summary
    ​bool ​TRUE on success or FALSE on failure.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Statement::bindParam() ​Binds a PHP variable to a corresponding named (not supported by mysqli driver, see comment below) or question
    See
    type summary
    ​AbstractStatementMiddleware::bindValue() ​
    ​Statement::bindValue() ​
    ​Statement::bindValue() ​
    ​ParameterType ​

    [m] execute <tag_inheritdoc data-type='' data-description=''>Executes a prepared statement

    Executes a prepared statement 
    public function execute(mixed[]|null $params = null): Doctrine\DBAL\Driver\Result

    If the prepared statement included parameter markers, you must either: call Doctrine\DBAL\Driver\Statement::bindParam() to bind PHP variables to the parameter markers: bound variables pass their value as input and receive the output value, if any, of their associated parameter markers or pass an array of input-only parameter values.

    Parameter
    type name summary
    ​mixed[]|​null ​$params = null ​A numeric array of values with as many elements as there are
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Statement::execute() ​Executes a prepared statement
    See
    type summary
    ​Statement::bindParam() ​

    [N] Doctrine\DBAL\Driver\Mysqli\

    [C] Statement

    final

    Implements
    type summary
    ​Statement ​Driver-level statement

    [m] __construct 

    public function __construct(\mysqli_stmt $stmt)
    Parameter
    type name summary
    ​mysqli_stmt ​$stmt ​

    [m] __destruct 

    public function __destruct()

    [m] bindParam

    deprecated 

    public function bindParam(
    string|int $param,
    mixed &$variable,
    int $type = Doctrine\DBAL\ParameterType::STRING,
    int|null $length = null
): bool
    Parameter
    type name summary
    ​string|​int ​$param ​Parameter identifier. For a prepared statement using named placeholders,
    ​mixed ​&$variable ​Name of the PHP variable to bind to the SQL statement parameter.
    ​int ​$type = Doctrine\DBAL\ParameterType::STRING ​Explicit data type for the parameter using the Doctrine\DBAL\ParameterType
    ​int|​null ​$length = null ​You must specify maxlength when using an OUT bind
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Statement::bindParam() ​Binds a PHP variable to a corresponding named (not supported by mysqli driver, see comment below) or question
    See
    type summary
    ​Statement::bindValue() ​
    ​Statement::bindValue() ​
    ​Statement::bindValue() ​
    ​ParameterType ​

    [m] bindValue <tag_inheritdoc data-type='' data-description=''>Binds a value to a corresponding named (not supported by mysqli driver, see comment below) or positional

    Binds a value to a corresponding named (not supported by mysqli driver, see comment below) or positional 
    public function bindValue(
    string|int $param,
    mixed $value,
    int $type = Doctrine\DBAL\ParameterType::STRING
): bool

    placeholder in the SQL statement that was used to prepare the statement.

    As mentioned above, the named parameters are not natively supported by the mysqli driver, use executeQuery(), fetchAll(), fetchArray(), fetchColumn(), fetchAssoc() methods to have the named parameter emulated by doctrine.

    Parameter
    type name summary
    ​string|​int ​$param ​Parameter identifier. For a prepared statement using named placeholders,
    ​mixed ​$value ​The value to bind to the parameter.
    ​int ​$type = Doctrine\DBAL\ParameterType::STRING ​Explicit data type for the parameter using the Doctrine\DBAL\ParameterType
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Statement::bindValue() ​Binds a value to a corresponding named (not supported by mysqli driver, see comment below) or positional
    See
    type summary
    ​ParameterType ​

    [m] execute <tag_inheritdoc data-type='' data-description=''>Executes a prepared statement

    Executes a prepared statement 
    public function execute(mixed[]|null $params = null): Doctrine\DBAL\Driver\Result

    If the prepared statement included parameter markers, you must either: call Doctrine\DBAL\Driver\Statement::bindParam() to bind PHP variables to the parameter markers: bound variables pass their value as input and receive the output value, if any, of their associated parameter markers or pass an array of input-only parameter values.

    Parameter
    type name summary
    ​mixed[]|​null ​$params = null ​A numeric array of values with as many elements as there are
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​Statement::execute() ​Executes a prepared statement
    See
    type summary
    ​Statement::bindParam() ​

    [N] Doctrine\DBAL\Driver\Mysqli\Exception\

    [C] StatementError

    final

    Hierarchy

    Parents
    type summary
    ​AbstractException ​Base implementation of the Doctrine\DBAL\Driver\Exception interface.
    ​Exception ​
    Implements
    type summary
    ​Exception ​
    ​Throwable ​
    ​Stringable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(\mysqli_stmt $statement): Doctrine\DBAL\Driver\Mysqli\Exception\StatementError
    Parameter
    type name summary
    ​mysqli_stmt ​$statement ​
    Return
    type summary
    ​StatementError ​

    [M] upcast 

    public static function upcast(\mysqli_sql_exception $exception): Doctrine\DBAL\Driver\Mysqli\Exception\StatementError
    Parameter
    type name summary
    ​mysqli_sql_exception ​$exception ​
    Return
    type summary
    ​StatementError ​

    [m] __construct 

    public function __construct(
    string $message,
    string|null $sqlState = null,
    int $code = 0,
    ?\Throwable|\Throwable|null $previous = null
)
    Parameter
    type name summary
    ​string ​$message ​The driver error message.
    ​string|​null ​$sqlState = null ​The SQLSTATE the driver is in at the time the error occurred, if any.
    ​int ​$code = 0 ​The driver specific error code if any.
    ​?Throwable|​Throwable|​null ​$previous = null ​The previous throwable used for the exception chaining.
    Prototype
    kind source summary
    ​inherit ​AbstractException::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractException::getSQLState() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] FailedReadingStreamOffset

    final

    Hierarchy

    Parents
    type summary
    ​AbstractException ​Base implementation of the Doctrine\DBAL\Driver\Exception interface.
    ​Exception ​
    Implements
    type summary
    ​Exception ​
    ​Throwable ​
    ​Stringable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(int $parameter): Doctrine\DBAL\Driver\Mysqli\Exception\FailedReadingStreamOffset
    Parameter
    type name summary
    ​int ​$parameter ​
    Return
    type summary
    ​FailedReadingStreamOffset ​

    [m] __construct 

    public function __construct(
    string $message,
    string|null $sqlState = null,
    int $code = 0,
    ?\Throwable|\Throwable|null $previous = null
)
    Parameter
    type name summary
    ​string ​$message ​The driver error message.
    ​string|​null ​$sqlState = null ​The SQLSTATE the driver is in at the time the error occurred, if any.
    ​int ​$code = 0 ​The driver specific error code if any.
    ​?Throwable|​Throwable|​null ​$previous = null ​The previous throwable used for the exception chaining.
    Prototype
    kind source summary
    ​inherit ​AbstractException::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractException::getSQLState() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] NonStreamResourceUsedAsLargeObject

    final

    Hierarchy

    Parents
    type summary
    ​AbstractException ​Base implementation of the Doctrine\DBAL\Driver\Exception interface.
    ​Exception ​
    Implements
    type summary
    ​Exception ​
    ​Throwable ​
    ​Stringable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(int $parameter): Doctrine\DBAL\Driver\Mysqli\Exception\NonStreamResourceUsedAsLargeObject
    Parameter
    type name summary
    ​int ​$parameter ​
    Return
    type summary
    ​NonStreamResourceUsedAsLargeObject ​

    [m] __construct 

    public function __construct(
    string $message,
    string|null $sqlState = null,
    int $code = 0,
    ?\Throwable|\Throwable|null $previous = null
)
    Parameter
    type name summary
    ​string ​$message ​The driver error message.
    ​string|​null ​$sqlState = null ​The SQLSTATE the driver is in at the time the error occurred, if any.
    ​int ​$code = 0 ​The driver specific error code if any.
    ​?Throwable|​Throwable|​null ​$previous = null ​The previous throwable used for the exception chaining.
    Prototype
    kind source summary
    ​inherit ​AbstractException::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractException::getSQLState() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [N] Doctrine\DBAL\Event\

    [C] TransactionBeginEventArgs

    deprecated

    Hierarchy

    Parents
    type summary
    ​TransactionEventArgs ​
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(Doctrine\DBAL\Connection $connection)
    Parameter
    type name summary
    ​Connection ​$connection ​
    Prototype
    kind source summary
    ​inherit ​TransactionEventArgs::__construct() ​

    [m] getConnection 

    public function getConnection(): Doctrine\DBAL\Connection
    Return
    type summary
    ​Connection ​
    Prototype
    kind source summary
    ​inherit ​TransactionEventArgs::getConnection() ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] TransactionEventArgs

    abstractdeprecated

    Hierarchy

    Parents
    type summary
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(Doctrine\DBAL\Connection $connection)
    Parameter
    type name summary
    ​Connection ​$connection ​

    [m] getConnection 

    public function getConnection(): Doctrine\DBAL\Connection
    Return
    type summary
    ​Connection ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] TransactionCommitEventArgs

    deprecated

    Hierarchy

    Parents
    type summary
    ​TransactionEventArgs ​
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(Doctrine\DBAL\Connection $connection)
    Parameter
    type name summary
    ​Connection ​$connection ​
    Prototype
    kind source summary
    ​inherit ​TransactionEventArgs::__construct() ​

    [m] getConnection 

    public function getConnection(): Doctrine\DBAL\Connection
    Return
    type summary
    ​Connection ​
    Prototype
    kind source summary
    ​inherit ​TransactionEventArgs::getConnection() ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] TransactionRollBackEventArgs

    deprecated

    Hierarchy

    Parents
    type summary
    ​TransactionEventArgs ​
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(Doctrine\DBAL\Connection $connection)
    Parameter
    type name summary
    ​Connection ​$connection ​
    Prototype
    kind source summary
    ​inherit ​TransactionEventArgs::__construct() ​

    [m] getConnection 

    public function getConnection(): Doctrine\DBAL\Connection
    Return
    type summary
    ​Connection ​
    Prototype
    kind source summary
    ​inherit ​TransactionEventArgs::getConnection() ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] SchemaColumnDefinitionEventArgs Event Arguments used when the portable column definition is generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    deprecated

    Event Arguments used when the portable column definition is generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    See
    type summary
    ​AbstractPlatform ​

    Hierarchy

    Parents
    type summary
    ​SchemaEventArgs ​Base class for schema related events.
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(
    array|mixed[] $tableColumn,
    string $table,
    string $database,
    Doctrine\DBAL\Connection $connection
)
    Parameter
    type name summary
    ​array|​mixed[] ​$tableColumn ​
    ​string ​$table ​
    ​string ​$database ​
    ​Connection ​$connection ​

    [m] setColumn Allows to clear the column which means the column will be excluded from

    Allows to clear the column which means the column will be excluded from 
    public function setColumn(?Doctrine\DBAL\Schema\Column $column = null): Doctrine\DBAL\Event\SchemaColumnDefinitionEventArgs

    tables column list.

    Parameter
    type name summary
    ​?Column ​$column = null ​
    Return
    type summary
    ​SchemaColumnDefinitionEventArgs ​

    [m] getColumn 

    public function getColumn(): Doctrine\DBAL\Schema\Column|null
    Return
    type summary
    ​Column|​null ​

    [m] getTableColumn 

    public function getTableColumn(): mixed[]
    Return
    type summary
    ​mixed[] ​

    [m] getTable 

    public function getTable(): string
    Return
    type summary
    ​string ​

    [m] getDatabase 

    public function getDatabase(): string
    Return
    type summary
    ​string ​

    [m] getConnection 

    public function getConnection(): Doctrine\DBAL\Connection
    Return
    type summary
    ​Connection ​

    [m] preventDefault 

    public function preventDefault(): Doctrine\DBAL\Event\SchemaEventArgs
    Return
    type summary
    ​SchemaEventArgs ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::preventDefault() ​

    [m] isDefaultPrevented 

    public function isDefaultPrevented(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::isDefaultPrevented() ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] SchemaEventArgs Base class for schema related events.

    deprecated

    Base class for schema related events.

    Hierarchy

    Parents
    type summary
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] preventDefault 

    public function preventDefault(): Doctrine\DBAL\Event\SchemaEventArgs
    Return
    type summary
    ​SchemaEventArgs ​

    [m] isDefaultPrevented 

    public function isDefaultPrevented(): bool
    Return
    type summary
    ​bool ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] SchemaIndexDefinitionEventArgs Event Arguments used when the portable index definition is generated inside AbstractSchemaManager.

    deprecated

    Event Arguments used when the portable index definition is generated inside AbstractSchemaManager.

    See
    type summary
    ​AbstractSchemaManager ​

    Hierarchy

    Parents
    type summary
    ​SchemaEventArgs ​Base class for schema related events.
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(
    array|mixed[] $tableIndex,
    string $table,
    Doctrine\DBAL\Connection $connection
)
    Parameter
    type name summary
    ​array|​mixed[] ​$tableIndex ​
    ​string ​$table ​
    ​Connection ​$connection ​

    [m] setIndex Allows to clear the index which means the index will be excluded from tables index list.

    Allows to clear the index which means the index will be excluded from tables index list. 
    public function setIndex(?Doctrine\DBAL\Schema\Index $index = null): Doctrine\DBAL\Event\SchemaIndexDefinitionEventArgs
    Parameter
    type name summary
    ​?Index ​$index = null ​
    Return
    type summary
    ​SchemaIndexDefinitionEventArgs ​

    [m] getIndex 

    public function getIndex(): Doctrine\DBAL\Schema\Index|null
    Return
    type summary
    ​Index|​null ​

    [m] getTableIndex 

    public function getTableIndex(): mixed[]
    Return
    type summary
    ​mixed[] ​

    [m] getTable 

    public function getTable(): string
    Return
    type summary
    ​string ​

    [m] getConnection 

    public function getConnection(): Doctrine\DBAL\Connection
    Return
    type summary
    ​Connection ​

    [m] preventDefault 

    public function preventDefault(): Doctrine\DBAL\Event\SchemaEventArgs
    Return
    type summary
    ​SchemaEventArgs ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::preventDefault() ​

    [m] isDefaultPrevented 

    public function isDefaultPrevented(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::isDefaultPrevented() ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] SchemaAlterTableAddColumnEventArgs Event Arguments used when SQL queries for adding table columns are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    deprecated

    Event Arguments used when SQL queries for adding table columns are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    See
    type summary
    ​AbstractPlatform ​

    Hierarchy

    Parents
    type summary
    ​SchemaEventArgs ​Base class for schema related events.
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $tableDiff,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
)
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$tableDiff ​
    ​AbstractPlatform ​$platform ​

    [m] getColumn 

    public function getColumn(): Doctrine\DBAL\Schema\Column
    Return
    type summary
    ​Column ​

    [m] getTableDiff 

    public function getTableDiff(): Doctrine\DBAL\Schema\TableDiff
    Return
    type summary
    ​TableDiff ​

    [m] getPlatform 

    public function getPlatform(): Doctrine\DBAL\Platforms\AbstractPlatform
    Return
    type summary
    ​AbstractPlatform ​

    [m] addSql Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead.

    Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. 
    public function addSql(string|string[] $sql): Doctrine\DBAL\Event\SchemaAlterTableAddColumnEventArgs
    Parameter
    type name summary
    ​string|​string[] ​$sql ​
    Return
    type summary
    ​SchemaAlterTableAddColumnEventArgs ​

    [m] getSql 

    public function getSql(): string[]
    Return
    type summary
    ​string[] ​

    [m] preventDefault 

    public function preventDefault(): Doctrine\DBAL\Event\SchemaEventArgs
    Return
    type summary
    ​SchemaEventArgs ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::preventDefault() ​

    [m] isDefaultPrevented 

    public function isDefaultPrevented(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::isDefaultPrevented() ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] SchemaAlterTableChangeColumnEventArgs Event Arguments used when SQL queries for changing table columns are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    deprecated

    Event Arguments used when SQL queries for changing table columns are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    See
    type summary
    ​AbstractPlatform ​

    Hierarchy

    Parents
    type summary
    ​SchemaEventArgs ​Base class for schema related events.
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Schema\ColumnDiff $columnDiff,
    Doctrine\DBAL\Schema\TableDiff $tableDiff,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
)
    Parameter
    type name summary
    ​ColumnDiff ​$columnDiff ​
    ​TableDiff ​$tableDiff ​
    ​AbstractPlatform ​$platform ​

    [m] getColumnDiff 

    public function getColumnDiff(): Doctrine\DBAL\Schema\ColumnDiff
    Return
    type summary
    ​ColumnDiff ​

    [m] getTableDiff 

    public function getTableDiff(): Doctrine\DBAL\Schema\TableDiff
    Return
    type summary
    ​TableDiff ​

    [m] getPlatform 

    public function getPlatform(): Doctrine\DBAL\Platforms\AbstractPlatform
    Return
    type summary
    ​AbstractPlatform ​

    [m] addSql Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead.

    Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. 
    public function addSql(string|string[] $sql): Doctrine\DBAL\Event\SchemaAlterTableChangeColumnEventArgs
    Parameter
    type name summary
    ​string|​string[] ​$sql ​
    Return
    type summary
    ​SchemaAlterTableChangeColumnEventArgs ​

    [m] getSql 

    public function getSql(): string[]
    Return
    type summary
    ​string[] ​

    [m] preventDefault 

    public function preventDefault(): Doctrine\DBAL\Event\SchemaEventArgs
    Return
    type summary
    ​SchemaEventArgs ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::preventDefault() ​

    [m] isDefaultPrevented 

    public function isDefaultPrevented(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::isDefaultPrevented() ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] SchemaAlterTableEventArgs Event Arguments used when SQL queries for creating tables are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    deprecated

    Event Arguments used when SQL queries for creating tables are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    See
    type summary
    ​AbstractPlatform ​

    Hierarchy

    Parents
    type summary
    ​SchemaEventArgs ​Base class for schema related events.
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Schema\TableDiff $tableDiff,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
)
    Parameter
    type name summary
    ​TableDiff ​$tableDiff ​
    ​AbstractPlatform ​$platform ​

    [m] getTableDiff 

    public function getTableDiff(): Doctrine\DBAL\Schema\TableDiff
    Return
    type summary
    ​TableDiff ​

    [m] getPlatform 

    public function getPlatform(): Doctrine\DBAL\Platforms\AbstractPlatform
    Return
    type summary
    ​AbstractPlatform ​

    [m] addSql Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead.

    Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. 
    public function addSql(string|string[] $sql): Doctrine\DBAL\Event\SchemaAlterTableEventArgs
    Parameter
    type name summary
    ​string|​string[] ​$sql ​
    Return
    type summary
    ​SchemaAlterTableEventArgs ​

    [m] getSql 

    public function getSql(): string[]
    Return
    type summary
    ​string[] ​

    [m] preventDefault 

    public function preventDefault(): Doctrine\DBAL\Event\SchemaEventArgs
    Return
    type summary
    ​SchemaEventArgs ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::preventDefault() ​

    [m] isDefaultPrevented 

    public function isDefaultPrevented(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::isDefaultPrevented() ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] SchemaAlterTableRemoveColumnEventArgs Event Arguments used when SQL queries for removing table columns are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    deprecated

    Event Arguments used when SQL queries for removing table columns are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    See
    type summary
    ​AbstractPlatform ​

    Hierarchy

    Parents
    type summary
    ​SchemaEventArgs ​Base class for schema related events.
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $tableDiff,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
)
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$tableDiff ​
    ​AbstractPlatform ​$platform ​

    [m] getColumn 

    public function getColumn(): Doctrine\DBAL\Schema\Column
    Return
    type summary
    ​Column ​

    [m] getTableDiff 

    public function getTableDiff(): Doctrine\DBAL\Schema\TableDiff
    Return
    type summary
    ​TableDiff ​

    [m] getPlatform 

    public function getPlatform(): Doctrine\DBAL\Platforms\AbstractPlatform
    Return
    type summary
    ​AbstractPlatform ​

    [m] addSql Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead.

    Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. 
    public function addSql(string|string[] $sql): Doctrine\DBAL\Event\SchemaAlterTableRemoveColumnEventArgs
    Parameter
    type name summary
    ​string|​string[] ​$sql ​
    Return
    type summary
    ​SchemaAlterTableRemoveColumnEventArgs ​

    [m] getSql 

    public function getSql(): string[]
    Return
    type summary
    ​string[] ​

    [m] preventDefault 

    public function preventDefault(): Doctrine\DBAL\Event\SchemaEventArgs
    Return
    type summary
    ​SchemaEventArgs ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::preventDefault() ​

    [m] isDefaultPrevented 

    public function isDefaultPrevented(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::isDefaultPrevented() ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] SchemaAlterTableRenameColumnEventArgs Event Arguments used when SQL queries for renaming table columns are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    deprecated

    Event Arguments used when SQL queries for renaming table columns are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    See
    type summary
    ​AbstractPlatform ​

    Hierarchy

    Parents
    type summary
    ​SchemaEventArgs ​Base class for schema related events.
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(
    string $oldColumnName,
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $tableDiff,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
)
    Parameter
    type name summary
    ​string ​$oldColumnName ​
    ​Column ​$column ​
    ​TableDiff ​$tableDiff ​
    ​AbstractPlatform ​$platform ​

    [m] getOldColumnName 

    public function getOldColumnName(): string
    Return
    type summary
    ​string ​

    [m] getColumn 

    public function getColumn(): Doctrine\DBAL\Schema\Column
    Return
    type summary
    ​Column ​

    [m] getTableDiff 

    public function getTableDiff(): Doctrine\DBAL\Schema\TableDiff
    Return
    type summary
    ​TableDiff ​

    [m] getPlatform 

    public function getPlatform(): Doctrine\DBAL\Platforms\AbstractPlatform
    Return
    type summary
    ​AbstractPlatform ​

    [m] addSql Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead.

    Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. 
    public function addSql(string|string[] $sql): Doctrine\DBAL\Event\SchemaAlterTableRenameColumnEventArgs
    Parameter
    type name summary
    ​string|​string[] ​$sql ​
    Return
    type summary
    ​SchemaAlterTableRenameColumnEventArgs ​

    [m] getSql 

    public function getSql(): string[]
    Return
    type summary
    ​string[] ​

    [m] preventDefault 

    public function preventDefault(): Doctrine\DBAL\Event\SchemaEventArgs
    Return
    type summary
    ​SchemaEventArgs ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::preventDefault() ​

    [m] isDefaultPrevented 

    public function isDefaultPrevented(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::isDefaultPrevented() ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] SchemaCreateTableColumnEventArgs Event Arguments used when SQL queries for creating table columns are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    deprecated

    Event Arguments used when SQL queries for creating table columns are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    See
    type summary
    ​AbstractPlatform ​

    Hierarchy

    Parents
    type summary
    ​SchemaEventArgs ​Base class for schema related events.
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\Table $table,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
)
    Parameter
    type name summary
    ​Column ​$column ​
    ​Table ​$table ​
    ​AbstractPlatform ​$platform ​

    [m] getColumn 

    public function getColumn(): Doctrine\DBAL\Schema\Column
    Return
    type summary
    ​Column ​

    [m] getTable 

    public function getTable(): Doctrine\DBAL\Schema\Table
    Return
    type summary
    ​Table ​

    [m] getPlatform 

    public function getPlatform(): Doctrine\DBAL\Platforms\AbstractPlatform
    Return
    type summary
    ​AbstractPlatform ​

    [m] addSql Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead.

    Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. 
    public function addSql(string|string[] $sql): Doctrine\DBAL\Event\SchemaCreateTableColumnEventArgs
    Parameter
    type name summary
    ​string|​string[] ​$sql ​
    Return
    type summary
    ​SchemaCreateTableColumnEventArgs ​

    [m] getSql 

    public function getSql(): string[]
    Return
    type summary
    ​string[] ​

    [m] preventDefault 

    public function preventDefault(): Doctrine\DBAL\Event\SchemaEventArgs
    Return
    type summary
    ​SchemaEventArgs ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::preventDefault() ​

    [m] isDefaultPrevented 

    public function isDefaultPrevented(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::isDefaultPrevented() ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] SchemaCreateTableEventArgs Event Arguments used when SQL queries for creating tables are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    deprecated

    Event Arguments used when SQL queries for creating tables are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    See
    type summary
    ​AbstractPlatform ​

    Hierarchy

    Parents
    type summary
    ​SchemaEventArgs ​Base class for schema related events.
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Schema\Table $table,
    array|mixed[][] $columns,
    array|mixed[] $options,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
)
    Parameter
    type name summary
    ​Table ​$table ​
    ​array|​mixed[][] ​$columns ​
    ​array|​mixed[] ​$options ​
    ​AbstractPlatform ​$platform ​

    [m] getTable 

    public function getTable(): Doctrine\DBAL\Schema\Table
    Return
    type summary
    ​Table ​

    [m] getColumns 

    public function getColumns(): mixed[][]
    Return
    type summary
    ​mixed[][] ​

    [m] getOptions 

    public function getOptions(): mixed[]
    Return
    type summary
    ​mixed[] ​

    [m] getPlatform 

    public function getPlatform(): Doctrine\DBAL\Platforms\AbstractPlatform
    Return
    type summary
    ​AbstractPlatform ​

    [m] addSql Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead.

    Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. 
    public function addSql(string|string[] $sql): Doctrine\DBAL\Event\SchemaCreateTableEventArgs
    Parameter
    type name summary
    ​string|​string[] ​$sql ​
    Return
    type summary
    ​SchemaCreateTableEventArgs ​

    [m] getSql 

    public function getSql(): string[]
    Return
    type summary
    ​string[] ​

    [m] preventDefault 

    public function preventDefault(): Doctrine\DBAL\Event\SchemaEventArgs
    Return
    type summary
    ​SchemaEventArgs ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::preventDefault() ​

    [m] isDefaultPrevented 

    public function isDefaultPrevented(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::isDefaultPrevented() ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [C] SchemaDropTableEventArgs Event Arguments used when the SQL query for dropping tables are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    deprecated

    Event Arguments used when the SQL query for dropping tables are generated inside Doctrine\DBAL\Platforms\AbstractPlatform.

    See
    type summary
    ​AbstractPlatform ​

    Hierarchy

    Parents
    type summary
    ​SchemaEventArgs ​Base class for schema related events.
    ​EventArgs ​EventArgs is the base class for classes containing event data.

    [m] __construct 

    public function __construct(
    string|Doctrine\DBAL\Schema\Table $table,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
)
    Parameter
    type name summary
    ​string|​Table ​$table ​
    ​AbstractPlatform ​$platform ​

    [m] getTable 

    public function getTable(): string|Doctrine\DBAL\Schema\Table
    Return
    type summary
    ​string|​Table ​

    [m] getPlatform 

    public function getPlatform(): Doctrine\DBAL\Platforms\AbstractPlatform
    Return
    type summary
    ​AbstractPlatform ​

    [m] setSql 

    public function setSql(string $sql): Doctrine\DBAL\Event\SchemaDropTableEventArgs
    Parameter
    type name summary
    ​string ​$sql ​
    Return
    type summary
    ​SchemaDropTableEventArgs ​

    [m] getSql 

    public function getSql(): string|null
    Return
    type summary
    ​string|​null ​

    [m] preventDefault 

    public function preventDefault(): Doctrine\DBAL\Event\SchemaEventArgs
    Return
    type summary
    ​SchemaEventArgs ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::preventDefault() ​

    [m] isDefaultPrevented 

    public function isDefaultPrevented(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​SchemaEventArgs::isDefaultPrevented() ​

    [M] getEmptyInstance Gets the single, empty and immutable EventArgs instance.

    Gets the single, empty and immutable EventArgs instance. 
    public static function getEmptyInstance(): Doctrine\Common\EventArgs

    This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');

    The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).

    Return
    type summary
    ​EventArgs ​
    Prototype
    kind source summary
    ​inherit ​EventArgs::getEmptyInstance() ​Gets the single, empty and immutable EventArgs instance.
    See
    type summary
    ​EventManager::dispatchEvent() ​

    [N] Doctrine\DBAL\Exception\

    [C] DriverException Base class for all errors detected in the driver.

    Base class for all errors detected in the driver.

    Hierarchy

    Parents
    type summary
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​
    ​Exception ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Driver\Exception $driverException,
    ?Doctrine\DBAL\Query|Doctrine\DBAL\Query|null $query
)
    Parameter
    type name summary
    ​Exception ​$driverException ​The DBAL driver exception to chain.
    ​?Query|​Query|​null ​$query ​The SQL query that triggered the exception, if any.
    Prototype
    kind source summary
    ​override ​Exception::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​implement ​Exception::getSQLState() ​Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] getQuery 

    public function getQuery(): ?Doctrine\DBAL\Query
    Return
    type summary
    ​?Query ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] ConnectionLost

    final

    Hierarchy

    Parents
    type summary
    ​ConnectionException ​Base class for all connection related errors detected in the driver.
    ​DriverException ​Base class for all errors detected in the driver.
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​
    ​Exception ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Driver\Exception $driverException,
    ?Doctrine\DBAL\Query|Doctrine\DBAL\Query|null $query
)
    Parameter
    type name summary
    ​Exception ​$driverException ​The DBAL driver exception to chain.
    ​?Query|​Query|​null ​$query ​The SQL query that triggered the exception, if any.
    Prototype
    kind source summary
    ​inherit ​DriverException::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getSQLState() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] getQuery 

    public function getQuery(): ?Doctrine\DBAL\Query
    Return
    type summary
    ​?Query ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getQuery() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] ConnectionException Base class for all connection related errors detected in the driver.

    Base class for all connection related errors detected in the driver.

    Hierarchy

    Parents
    type summary
    ​DriverException ​Base class for all errors detected in the driver.
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Exception ​
    ​Stringable ​
    ​Throwable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Driver\Exception $driverException,
    ?Doctrine\DBAL\Query|Doctrine\DBAL\Query|null $query
)
    Parameter
    type name summary
    ​Exception ​$driverException ​The DBAL driver exception to chain.
    ​?Query|​Query|​null ​$query ​The SQL query that triggered the exception, if any.
    Prototype
    kind source summary
    ​inherit ​DriverException::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getSQLState() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] getQuery 

    public function getQuery(): ?Doctrine\DBAL\Query
    Return
    type summary
    ​?Query ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getQuery() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] DeadlockException Exception for a deadlock error of a transaction detected in the driver.

    Exception for a deadlock error of a transaction detected in the driver.

    Hierarchy

    Parents
    type summary
    ​ServerException ​Base class for all server related errors detected in the driver.
    ​DriverException ​Base class for all errors detected in the driver.
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Exception ​
    ​Stringable ​
    ​Throwable ​
    ​RetryableException ​Marker interface for all exceptions where retrying the transaction makes sense.

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Driver\Exception $driverException,
    ?Doctrine\DBAL\Query|Doctrine\DBAL\Query|null $query
)
    Parameter
    type name summary
    ​Exception ​$driverException ​The DBAL driver exception to chain.
    ​?Query|​Query|​null ​$query ​The SQL query that triggered the exception, if any.
    Prototype
    kind source summary
    ​inherit ​DriverException::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getSQLState() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] getQuery 

    public function getQuery(): ?Doctrine\DBAL\Query
    Return
    type summary
    ​?Query ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getQuery() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] ServerException Base class for all server related errors detected in the driver.

    Base class for all server related errors detected in the driver.

    Hierarchy

    Parents
    type summary
    ​DriverException ​Base class for all errors detected in the driver.
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Exception ​
    ​Stringable ​
    ​Throwable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Driver\Exception $driverException,
    ?Doctrine\DBAL\Query|Doctrine\DBAL\Query|null $query
)
    Parameter
    type name summary
    ​Exception ​$driverException ​The DBAL driver exception to chain.
    ​?Query|​Query|​null ​$query ​The SQL query that triggered the exception, if any.
    Prototype
    kind source summary
    ​inherit ​DriverException::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getSQLState() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] getQuery 

    public function getQuery(): ?Doctrine\DBAL\Query
    Return
    type summary
    ​?Query ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getQuery() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] ForeignKeyConstraintViolationException Exception for a foreign key constraint violation detected in the driver.

    Exception for a foreign key constraint violation detected in the driver.

    Hierarchy

    Parents
    type summary
    ​ConstraintViolationException ​Base class for all constraint violation related errors detected in the driver.
    ​ServerException ​Base class for all server related errors detected in the driver.
    ​DriverException ​Base class for all errors detected in the driver.
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Exception ​
    ​Stringable ​
    ​Throwable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Driver\Exception $driverException,
    ?Doctrine\DBAL\Query|Doctrine\DBAL\Query|null $query
)
    Parameter
    type name summary
    ​Exception ​$driverException ​The DBAL driver exception to chain.
    ​?Query|​Query|​null ​$query ​The SQL query that triggered the exception, if any.
    Prototype
    kind source summary
    ​inherit ​DriverException::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getSQLState() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] getQuery 

    public function getQuery(): ?Doctrine\DBAL\Query
    Return
    type summary
    ​?Query ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getQuery() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] ConstraintViolationException Base class for all constraint violation related errors detected in the driver.

    Base class for all constraint violation related errors detected in the driver.

    Hierarchy

    Parents
    type summary
    ​ServerException ​Base class for all server related errors detected in the driver.
    ​DriverException ​Base class for all errors detected in the driver.
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​
    ​Exception ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Driver\Exception $driverException,
    ?Doctrine\DBAL\Query|Doctrine\DBAL\Query|null $query
)
    Parameter
    type name summary
    ​Exception ​$driverException ​The DBAL driver exception to chain.
    ​?Query|​Query|​null ​$query ​The SQL query that triggered the exception, if any.
    Prototype
    kind source summary
    ​inherit ​DriverException::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getSQLState() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] getQuery 

    public function getQuery(): ?Doctrine\DBAL\Query
    Return
    type summary
    ​?Query ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getQuery() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] InvalidArgumentException Exception to be thrown when invalid arguments are passed to any DBAL API

    Exception to be thrown when invalid arguments are passed to any DBAL API

    Hierarchy

    Parents
    type summary
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Stringable ​
    ​Throwable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] fromEmptyCriteria 

    public static function fromEmptyCriteria(): Doctrine\DBAL\Exception\InvalidArgumentException
    Return
    type summary
    ​InvalidArgumentException ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] TransactionRolledBack

    Hierarchy

    Parents
    type summary
    ​DriverException ​Base class for all errors detected in the driver.
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Exception ​
    ​Stringable ​
    ​Throwable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Driver\Exception $driverException,
    ?Doctrine\DBAL\Query|Doctrine\DBAL\Query|null $query
)
    Parameter
    type name summary
    ​Exception ​$driverException ​The DBAL driver exception to chain.
    ​?Query|​Query|​null ​$query ​The SQL query that triggered the exception, if any.
    Prototype
    kind source summary
    ​inherit ​DriverException::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getSQLState() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] getQuery 

    public function getQuery(): ?Doctrine\DBAL\Query
    Return
    type summary
    ​?Query ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getQuery() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] UniqueConstraintViolationException Exception for a unique constraint violation detected in the driver.

    Exception for a unique constraint violation detected in the driver.

    Hierarchy

    Parents
    type summary
    ​ConstraintViolationException ​Base class for all constraint violation related errors detected in the driver.
    ​ServerException ​Base class for all server related errors detected in the driver.
    ​DriverException ​Base class for all errors detected in the driver.
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Exception ​
    ​Stringable ​
    ​Throwable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Driver\Exception $driverException,
    ?Doctrine\DBAL\Query|Doctrine\DBAL\Query|null $query
)
    Parameter
    type name summary
    ​Exception ​$driverException ​The DBAL driver exception to chain.
    ​?Query|​Query|​null ​$query ​The SQL query that triggered the exception, if any.
    Prototype
    kind source summary
    ​inherit ​DriverException::__construct() ​

    [m] getSQLState <tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    Returns the SQLSTATE the driver was in at the time the error occurred. 
    public function getSQLState(): string|null

    Returns null if the driver does not provide a SQLSTATE for the error occurred.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getSQLState() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQLSTATE the driver was in at the time the error occurred.

    [m] getQuery 

    public function getQuery(): ?Doctrine\DBAL\Query
    Return
    type summary
    ​?Query ​
    Prototype
    kind source summary
    ​inherit ​DriverException::getQuery() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] NoKeyValue

    final

    Hierarchy

    Parents
    type summary
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Stringable ​
    ​Throwable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] fromColumnCount 

    public static function fromColumnCount(int $columnCount): Doctrine\DBAL\Exception\NoKeyValue
    Parameter
    type name summary
    ​int ​$columnCount ​
    Return
    type summary
    ​NoKeyValue ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] DatabaseRequired

    Hierarchy

    Parents
    type summary
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Stringable ​
    ​Throwable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(string $methodName): Doctrine\DBAL\Exception\DatabaseRequired
    Parameter
    type name summary
    ​string ​$methodName ​
    Return
    type summary
    ​DatabaseRequired ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] InvalidLockMode

    Hierarchy

    Parents
    type summary
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Stringable ​
    ​Throwable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] fromLockMode 

    public static function fromLockMode(int $lockMode): Doctrine\DBAL\Exception\InvalidLockMode
    Parameter
    type name summary
    ​int ​$lockMode ​
    Return
    type summary
    ​InvalidLockMode ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] MalformedDsnException

    Hierarchy

    Parents
    type summary
    ​InvalidArgumentException ​
    ​LogicException ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(): Doctrine\DBAL\Exception\MalformedDsnException
    Return
    type summary
    ​MalformedDsnException ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [I] RetryableException Marker interface for all exceptions where retrying the transaction makes sense.

    abstract

    Marker interface for all exceptions where retrying the transaction makes sense.

    Hierarchy

    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [m] getMessage

    abstract

    abstract public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getMessage() ​

    [m] getCode

    abstract

    abstract public function getCode()
    Prototype
    kind source summary
    ​inherit ​Throwable::getCode() ​

    [m] getFile

    abstract

    abstract public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getFile() ​

    [m] getLine

    abstract

    abstract public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getLine() ​

    [m] getTrace

    abstract

    abstract public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getTrace() ​

    [m] getPrevious

    abstract

    abstract public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getPrevious() ​

    [m] getTraceAsString

    abstract

    abstract public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getTraceAsString() ​

    [m] __toString

    abstract

    abstract public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Stringable::__toString() ​

    [N] Doctrine\DBAL\Logging\

    [C] Middleware

    final

    Implements
    type summary
    ​Middleware ​

    [m] __construct 

    public function __construct(Psr\Log\LoggerInterface $logger)
    Parameter
    type name summary
    ​LoggerInterface ​$logger ​

    [m] wrap 

    public function wrap(Doctrine\DBAL\Driver $driver): Doctrine\DBAL\Driver
    Parameter
    type name summary
    ​Driver ​$driver ​
    Return
    type summary
    ​Driver ​
    Prototype
    kind source summary
    ​implement ​Middleware::wrap() ​

    [I] SQLLogger Interface for SQL loggers.

    abstractdeprecated

    Interface for SQL loggers.

    See
    type summary
    ​Middleware ​

    [m] startQuery Logs a SQL statement somewhere.

    abstract

    Logs a SQL statement somewhere. 
    abstract public function startQuery(
    string $sql,
    ?array $params = null,
    ?array $types = null
): void
    Parameter
    type name summary
    ​string ​$sql ​SQL statement
    ​?array ​$params = null ​
    ​?array ​$types = null ​
    Return
    type summary
    ​void ​

    [m] stopQuery Marks the last started query as stopped. This can be used for timing of queries.

    abstract

    Marks the last started query as stopped. This can be used for timing of queries. 
    abstract public function stopQuery(): void
    Return
    type summary
    ​void ​

    [N] Doctrine\DBAL\Platforms\

    [C] AbstractPlatform Base class for all DatabasePlatforms. The DatabasePlatforms are the central

    abstract

    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.

    Hierarchy

    [C] CREATE_INDEXES 

    public const int CREATE_INDEXES = 1

    [C] CREATE_FOREIGNKEYS 

    public const int CREATE_FOREIGNKEYS = 2

    [p] $doctrineTypeMapping 

    protected string[]|null $doctrineTypeMapping = null

    Type: string[]|​null

    [p] $doctrineTypeComments Contains a list of all columns that should generate parseable column comments for type-detection

    deprecated

    Contains a list of all columns that should generate parseable column comments for type-detection 
    protected string[]|null $doctrineTypeComments = null

    in reverse engineering scenarios.

    Type: string[]|​null

    [p] $_eventManager

    deprecated 

    protected Doctrine\Common\EventManager|null $_eventManager = null

    Type: EventManager|​null

    [p] $_keywords Holds the KeywordList instance for the current platform.

    Holds the KeywordList instance for the current platform. 
    protected Doctrine\DBAL\Platforms\Keywords\KeywordList|null $_keywords = null

    Type: KeywordList|​null

    [m] setDisableTypeComments

    final

    final public function setDisableTypeComments(bool $value)
    Parameter
    type name summary
    ​bool ​$value ​

    [m] setEventManager Sets the EventManager used by the Platform.

    deprecated

    Sets the EventManager used by the Platform. 
    public function setEventManager(Doctrine\Common\EventManager $eventManager): void
    Parameter
    type name summary
    ​EventManager ​$eventManager ​
    Return
    type summary
    ​void ​

    [m] getEventManager Gets the EventManager used by the Platform.

    deprecated

    Gets the EventManager used by the Platform. 
    public function getEventManager(): Doctrine\Common\EventManager|null
    Return
    type summary
    ​EventManager|​null ​

    [m] getBooleanTypeDeclarationSQL Returns the SQL snippet that declares a boolean column.

    abstract

    Returns the SQL snippet that declares a boolean column. 
    abstract public function getBooleanTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getIntegerTypeDeclarationSQL Returns the SQL snippet that declares a 4 byte integer column.

    abstract

    Returns the SQL snippet that declares a 4 byte integer column. 
    abstract public function getIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getBigIntTypeDeclarationSQL Returns the SQL snippet that declares an 8 byte integer column.

    abstract

    Returns the SQL snippet that declares an 8 byte integer column. 
    abstract public function getBigIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getSmallIntTypeDeclarationSQL Returns the SQL snippet that declares a 2 byte integer column.

    abstract

    Returns the SQL snippet that declares a 2 byte integer column. 
    abstract public function getSmallIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] _getCommonIntegerTypeDeclarationSQL Returns the SQL snippet that declares common properties of an integer column.

    abstract

    Returns the SQL snippet that declares common properties of an integer column. 
    abstract protected function _getCommonIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] initializeDoctrineTypeMappings Lazy load Doctrine Type Mappings.

    abstract

    Lazy load Doctrine Type Mappings. 
    abstract protected function initializeDoctrineTypeMappings(): void
    Return
    type summary
    ​void ​

    [m] getAsciiStringTypeDeclarationSQL Returns the SQL snippet used to declare a column that can

    Returns the SQL snippet used to declare a column that can 
    public function getAsciiStringTypeDeclarationSQL(array|mixed[] $column): string

    store characters in the ASCII character set

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getVarcharTypeDeclarationSQL Returns the SQL snippet used to declare a VARCHAR column type.

    deprecated

    Returns the SQL snippet used to declare a VARCHAR column type. 
    public function getVarcharTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getStringTypeDeclarationSQL Returns the SQL snippet used to declare a string column type.

    Returns the SQL snippet used to declare a string column type. 
    public function getStringTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getBinaryTypeDeclarationSQL Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    public function getBinaryTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition.
    Return
    type summary
    ​string ​

    [m] getGuidTypeDeclarationSQL Returns the SQL snippet to declare a GUID/UUID column.

    Returns the SQL snippet to declare a GUID/UUID column. 
    public function getGuidTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CHAR(36) and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getJsonTypeDeclarationSQL Returns the SQL snippet to declare a JSON column.

    Returns the SQL snippet to declare a JSON column. 
    public function getJsonTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CLOB and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getVarcharTypeDeclarationSQLSnippet 

    protected function getVarcharTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​
    ​bool ​$fixed ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getBinaryTypeDeclarationSQLSnippet Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    protected function getBinaryTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​The length of the column.
    ​bool ​$fixed ​Whether the column length is fixed.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getClobTypeDeclarationSQL Returns the SQL snippet used to declare a CLOB column type.

    abstract

    Returns the SQL snippet used to declare a CLOB column type. 
    abstract public function getClobTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getBlobTypeDeclarationSQL Returns the SQL Snippet used to declare a BLOB column type.

    abstract

    Returns the SQL Snippet used to declare a BLOB column type. 
    abstract public function getBlobTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getName Gets the name of the platform.

    abstractdeprecated

    Gets the name of the platform. 
    abstract public function getName(): string
    Return
    type summary
    ​string ​

    [m] registerDoctrineTypeMapping Registers a doctrine type to be used in conjunction with a column type of this platform.

    Registers a doctrine type to be used in conjunction with a column type of this platform. 
    public function registerDoctrineTypeMapping(
    string $dbType,
    string $doctrineType
): void
    Parameter
    type name summary
    ​string ​$dbType ​
    ​string ​$doctrineType ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​If the type is not found.

    [m] getDoctrineTypeMapping Gets the Doctrine type that is mapped for the given database column type.

    Gets the Doctrine type that is mapped for the given database column type. 
    public function getDoctrineTypeMapping(string $dbType): string
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​

    [m] hasDoctrineTypeMappingFor Checks if a database type is currently supported by this platform.

    Checks if a database type is currently supported by this platform. 
    public function hasDoctrineTypeMappingFor(string $dbType): bool
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​bool ​

    [m] initializeCommentedDoctrineTypes Initializes the Doctrine Type comments instance variable for in_array() checks.

    deprecated

    Initializes the Doctrine Type comments instance variable for in_array() checks. 
    protected function initializeCommentedDoctrineTypes(): void
    Return
    type summary
    ​void ​

    [m] isCommentedDoctrineType Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    deprecated

    Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type? 
    public function isCommentedDoctrineType(Doctrine\DBAL\Types\Type $doctrineType): bool
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​bool ​

    [m] markDoctrineTypeCommented Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements. 
    public function markDoctrineTypeCommented(string|Doctrine\DBAL\Types\Type $doctrineType): void
    Parameter
    type name summary
    ​string|​Type ​$doctrineType ​
    Return
    type summary
    ​void ​

    [m] getDoctrineTypeComment Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    deprecated

    Gets the comment to append to a column comment that helps parsing this type in reverse engineering. 
    public function getDoctrineTypeComment(Doctrine\DBAL\Types\Type $doctrineType): string
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​string ​

    [m] getColumnComment Gets the comment of a passed column modified by potential doctrine type comment hints.

    deprecated

    Gets the comment of a passed column modified by potential doctrine type comment hints. 
    protected function getColumnComment(Doctrine\DBAL\Schema\Column $column): string|null
    Parameter
    type name summary
    ​Column ​$column ​
    Return
    type summary
    ​string|​null ​

    [m] getIdentifierQuoteCharacter Gets the character used for identifier quoting.

    deprecated

    Gets the character used for identifier quoting. 
    public function getIdentifierQuoteCharacter(): string
    Return
    type summary
    ​string ​
    See
    type summary
    ​AbstractPlatform::quoteIdentifier() ​

    [m] getSqlCommentStartString Gets the string portion that starts an SQL comment.

    deprecated

    Gets the string portion that starts an SQL comment. 
    public function getSqlCommentStartString(): string
    Return
    type summary
    ​string ​

    [m] getSqlCommentEndString Gets the string portion that ends an SQL comment.

    deprecated

    Gets the string portion that ends an SQL comment. 
    public function getSqlCommentEndString(): string
    Return
    type summary
    ​string ​

    [m] getCharMaxLength Gets the maximum length of a char column.

    deprecated

    Gets the maximum length of a char column. 
    public function getCharMaxLength(): int
    Return
    type summary
    ​int ​

    [m] getVarcharMaxLength Gets the maximum length of a varchar column.

    deprecated

    Gets the maximum length of a varchar column. 
    public function getVarcharMaxLength(): int
    Return
    type summary
    ​int ​

    [m] getVarcharDefaultLength Gets the default length of a varchar column.

    deprecated

    Gets the default length of a varchar column. 
    public function getVarcharDefaultLength(): int
    Return
    type summary
    ​int ​

    [m] getBinaryMaxLength Gets the maximum length of a binary column.

    deprecated

    Gets the maximum length of a binary column. 
    public function getBinaryMaxLength(): int
    Return
    type summary
    ​int ​

    [m] getBinaryDefaultLength Gets the default length of a binary column.

    deprecated

    Gets the default length of a binary column. 
    public function getBinaryDefaultLength(): int
    Return
    type summary
    ​int ​

    [m] getWildcards Gets all SQL wildcard characters of the platform.

    deprecated

    Gets all SQL wildcard characters of the platform. 
    public function getWildcards(): string[]
    Return
    type summary
    ​string[] ​
    See
    type summary
    ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] getRegexpExpression Returns the regular expression operator.

    Returns the regular expression operator. 
    public function getRegexpExpression(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getAvgExpression Returns the SQL snippet to get the average value of a column.

    deprecated

    Returns the SQL snippet to get the average value of a column. 
    public function getAvgExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an AVG aggregate function.

    [m] getCountExpression Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    deprecated

    Returns the SQL snippet to get the number of rows (without a NULL value) of a column. 
    public function getCountExpression(string|int $column): string

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

    Parameter
    type name summary
    ​string|​int ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a COUNT aggregate function.

    [m] getMaxExpression Returns the SQL snippet to get the highest value of a column.

    deprecated

    Returns the SQL snippet to get the highest value of a column. 
    public function getMaxExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MAX aggregate function.

    [m] getMinExpression Returns the SQL snippet to get the lowest value of a column.

    deprecated

    Returns the SQL snippet to get the lowest value of a column. 
    public function getMinExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MIN aggregate function.

    [m] getSumExpression Returns the SQL snippet to get the total sum of a column.

    deprecated

    Returns the SQL snippet to get the total sum of a column. 
    public function getSumExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a SUM aggregate function.

    [m] getMd5Expression Returns the SQL snippet to get the md5 sum of a column.

    deprecated

    Returns the SQL snippet to get the md5 sum of a column. 
    public function getMd5Expression(string $column): string

    Note: Not SQL92, but common functionality.

    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​

    [m] getLengthExpression Returns the SQL snippet to get the length of a text column in characters.

    Returns the SQL snippet to get the length of a text column in characters. 
    public function getLengthExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​

    [m] getSqrtExpression Returns the SQL snippet to get the squared value of a column.

    deprecated

    Returns the SQL snippet to get the squared value of a column. 
    public function getSqrtExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an SQRT aggregate function.

    [m] getRoundExpression Returns the SQL snippet to round a numeric column to the number of decimals specified.

    deprecated

    Returns the SQL snippet to round a numeric column to the number of decimals specified. 
    public function getRoundExpression(
    string $column,
    string|int $decimals = 0
): string
    Parameter
    type name summary
    ​string ​$column ​
    ​string|​int ​$decimals = 0 ​
    Return
    type summary
    ​string ​

    [m] getModExpression Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2. 
    public function getModExpression(
    string $expression1,
    string $expression2
): string
    Parameter
    type name summary
    ​string ​$expression1 ​
    ​string ​$expression2 ​
    Return
    type summary
    ​string ​

    [m] getTrimExpression Returns the SQL snippet to trim a string.

    Returns the SQL snippet to trim a string. 
    public function getTrimExpression(
    string $str,
    int $mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED,
    string|bool $char = false
): string
    Parameter
    type name summary
    ​string ​$str ​The expression to apply the trim to.
    ​int ​$mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED ​The position of the trim (leading/trailing/both).
    ​string|​bool ​$char = false ​The char to trim, has to be quoted already. Defaults to space.
    Return
    type summary
    ​string ​

    [m] getRtrimExpression Returns the SQL snippet to trim trailing space characters from the expression.

    deprecated

    Returns the SQL snippet to trim trailing space characters from the expression. 
    public function getRtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​

    [m] getLtrimExpression Returns the SQL snippet to trim leading space characters from the expression.

    deprecated

    Returns the SQL snippet to trim leading space characters from the expression. 
    public function getLtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​

    [m] getUpperExpression Returns the SQL snippet to change all characters from the expression to uppercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to uppercase, 
    public function getUpperExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​

    [m] getLowerExpression Returns the SQL snippet to change all characters from the expression to lowercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to lowercase, 
    public function getLowerExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​

    [m] getLocateExpression Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str. 
    public function getLocateExpression(
    string $str,
    string $substr,
    string|int|false $startPos = false
): string
    Parameter
    type name summary
    ​string ​$str ​Literal string.
    ​string ​$substr ​Literal string to find.
    ​string|​int|​false ​$startPos = false ​Position to start at, beginning of string by default.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getNowExpression Returns the SQL snippet to get the current system date.

    deprecated

    Returns the SQL snippet to get the current system date. 
    public function getNowExpression(): string
    Return
    type summary
    ​string ​

    [m] getSubstringExpression Returns a SQL snippet to get a substring inside an SQL statement.

    Returns a SQL snippet to get a substring inside an SQL statement. 
    public function getSubstringExpression(
    string $string,
    string|int $start,
    string|int|null $length = null
): string

    Note: Not SQL92, but common functionality.

    SQLite only supports the 2 parameter variant of this function.

    Parameter
    type name summary
    ​string ​$string ​An sql string literal or column name/alias.
    ​string|​int ​$start ​Where to start the substring portion.
    ​string|​int|​null ​$length = null ​The substring portion length.
    Return
    type summary
    ​string ​

    [m] getConcatExpression Returns a SQL snippet to concatenate the given expressions.

    Returns a SQL snippet to concatenate the given expressions. 
    public function getConcatExpression(): string

    Accepts an arbitrary number of string parameters. Each parameter must contain an expression.

    Return
    type summary
    ​string ​

    [m] getNotExpression Returns the SQL for a logical not.

    deprecated

    Returns the SQL for a logical not. 
    public function getNotExpression(string $expression): string

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

    Parameter
    type name summary
    ​string ​$expression ​
    Return
    type summary
    ​string ​The logical expression.

    [m] getIsNullExpression Returns the SQL that checks if an expression is null.

    deprecated

    Returns the SQL that checks if an expression is null. 
    public function getIsNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.

    [m] getIsNotNullExpression Returns the SQL that checks if an expression is not null.

    deprecated

    Returns the SQL that checks if an expression is not null. 
    public function getIsNotNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.

    [m] getBetweenExpression Returns the SQL that checks if an expression evaluates to a value between two values.

    deprecated

    Returns the SQL that checks if an expression evaluates to a value between two values. 
    public function getBetweenExpression(
    string $expression,
    string $value1,
    string $value2
): string

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

    Parameter
    type name summary
    ​string ​$expression ​The value to compare to.
    ​string ​$value1 ​The lower value to compare with.
    ​string ​$value2 ​The higher value to compare with.
    Return
    type summary
    ​string ​The logical expression.

    [m] getAcosExpression Returns the SQL to get the arccosine of a value.

    deprecated

    Returns the SQL to get the arccosine of a value. 
    public function getAcosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​

    [m] getSinExpression Returns the SQL to get the sine of a value.

    deprecated

    Returns the SQL to get the sine of a value. 
    public function getSinExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​

    [m] getPiExpression Returns the SQL to get the PI value.

    deprecated

    Returns the SQL to get the PI value. 
    public function getPiExpression(): string
    Return
    type summary
    ​string ​

    [m] getCosExpression Returns the SQL to get the cosine of a value.

    deprecated

    Returns the SQL to get the cosine of a value. 
    public function getCosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​

    [m] getDateDiffExpression Returns the SQL to calculate the difference in days between the two passed dates.

    Returns the SQL to calculate the difference in days between the two passed dates. 
    public function getDateDiffExpression(
    string $date1,
    string $date2
): string

    Computes diff = date1 - date2.

    Parameter
    type name summary
    ​string ​$date1 ​
    ​string ​$date2 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateAddSecondsExpression Returns the SQL to add the number of given seconds to a date.

    Returns the SQL to add the number of given seconds to a date. 
    public function getDateAddSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateSubSecondsExpression Returns the SQL to subtract the number of given seconds from a date.

    Returns the SQL to subtract the number of given seconds from a date. 
    public function getDateSubSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateAddMinutesExpression Returns the SQL to add the number of given minutes to a date.

    Returns the SQL to add the number of given minutes to a date. 
    public function getDateAddMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateSubMinutesExpression Returns the SQL to subtract the number of given minutes from a date.

    Returns the SQL to subtract the number of given minutes from a date. 
    public function getDateSubMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateAddHourExpression Returns the SQL to add the number of given hours to a date.

    Returns the SQL to add the number of given hours to a date. 
    public function getDateAddHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateSubHourExpression Returns the SQL to subtract the number of given hours to a date.

    Returns the SQL to subtract the number of given hours to a date. 
    public function getDateSubHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateAddDaysExpression Returns the SQL to add the number of given days to a date.

    Returns the SQL to add the number of given days to a date. 
    public function getDateAddDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateSubDaysExpression Returns the SQL to subtract the number of given days to a date.

    Returns the SQL to subtract the number of given days to a date. 
    public function getDateSubDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateAddWeeksExpression Returns the SQL to add the number of given weeks to a date.

    Returns the SQL to add the number of given weeks to a date. 
    public function getDateAddWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateSubWeeksExpression Returns the SQL to subtract the number of given weeks from a date.

    Returns the SQL to subtract the number of given weeks from a date. 
    public function getDateSubWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateAddMonthExpression Returns the SQL to add the number of given months to a date.

    Returns the SQL to add the number of given months to a date. 
    public function getDateAddMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateSubMonthExpression Returns the SQL to subtract the number of given months to a date.

    Returns the SQL to subtract the number of given months to a date. 
    public function getDateSubMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateAddQuartersExpression Returns the SQL to add the number of given quarters to a date.

    Returns the SQL to add the number of given quarters to a date. 
    public function getDateAddQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateSubQuartersExpression Returns the SQL to subtract the number of given quarters from a date.

    Returns the SQL to subtract the number of given quarters from a date. 
    public function getDateSubQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateAddYearsExpression Returns the SQL to add the number of given years to a date.

    Returns the SQL to add the number of given years to a date. 
    public function getDateAddYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateSubYearsExpression Returns the SQL to subtract the number of given years from a date.

    Returns the SQL to subtract the number of given years from a date. 
    public function getDateSubYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateArithmeticIntervalExpression Returns the SQL for a date arithmetic expression.

    Returns the SQL for a date arithmetic expression. 
    protected function getDateArithmeticIntervalExpression(
    string $date,
    string $operator,
    int|string $interval,
    string $unit
): string
    Parameter
    type name summary
    ​string ​$date ​The column or literal representing a date
    ​string ​$operator ​The arithmetic operator (+ or -).
    ​int|​string ​$interval ​The interval that shall be calculated into the date.
    ​string ​$unit ​The unit of the interval that shall be calculated into the date.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] multiplyInterval Generates the SQL expression which represents the given date interval multiplied by a number

    Generates the SQL expression which represents the given date interval multiplied by a number 
    protected function multiplyInterval(
    string $interval,
    int $multiplier
): string
    Parameter
    type name summary
    ​string ​$interval ​SQL expression describing the interval value
    ​int ​$multiplier ​Interval multiplier
    Return
    type summary
    ​string ​

    [m] getBitAndComparisonExpression Returns the SQL bit AND comparison expression.

    Returns the SQL bit AND comparison expression. 
    public function getBitAndComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​

    [m] getBitOrComparisonExpression Returns the SQL bit OR comparison expression.

    Returns the SQL bit OR comparison expression. 
    public function getBitOrComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​

    [m] getCurrentDatabaseExpression Returns the SQL expression which represents the currently selected database.

    abstract

    Returns the SQL expression which represents the currently selected database. 
    abstract public function getCurrentDatabaseExpression(): string
    Return
    type summary
    ​string ​

    [m] getForUpdateSQL Returns the FOR UPDATE expression.

    deprecated

    Returns the FOR UPDATE expression. 
    public function getForUpdateSQL(): string
    Return
    type summary
    ​string ​

    [m] appendLockHint Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    Honors that some SQL vendors such as MsSql use table hints for locking instead of the 
    public function appendLockHint(
    string $fromClause,
    int $lockMode
): string

    ANSI SQL FOR UPDATE specification.

    Parameter
    type name summary
    ​string ​$fromClause ​The FROM clause to append the hint for the given lock mode to
    ​int ​$lockMode ​One of the Doctrine\DBAL\LockMode::* constants
    Return
    type summary
    ​string ​

    [m] getReadLockSQL Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock. 
    public function getReadLockSQL(): string

    This defaults to the ANSI SQL "FOR UPDATE", which is an exclusive lock (Write). Some database vendors allow to lighten this constraint up to be a real read lock.

    Return
    type summary
    ​string ​

    [m] getWriteLockSQL Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows. 
    public function getWriteLockSQL(): string

    The semantics of this lock mode should equal the SELECT .. FOR UPDATE of the ANSI SQL standard.

    Return
    type summary
    ​string ​

    [m] getDropTableSQL Returns the SQL snippet to drop an existing table.

    Returns the SQL snippet to drop an existing table. 
    public function getDropTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​

    [m] getDropTemporaryTableSQL Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction. 
    public function getDropTemporaryTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​

    [m] getDropIndexSQL Returns the SQL to drop an index from a table.

    Returns the SQL to drop an index from a table. 
    public function getDropIndexSQL(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string|null $table = null
): string
    Parameter
    type name summary
    ​Index|​string ​$index ​
    ​Table|​string|​null ​$table = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​

    [m] getDropConstraintSQL Returns the SQL to drop a constraint.

    Returns the SQL to drop a constraint. 
    public function getDropConstraintSQL(
    Doctrine\DBAL\Schema\Constraint|string $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint|​string ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    See
    type summary
    ​AbstractPlatform ​

    [m] getDropForeignKeySQL Returns the SQL to drop a foreign key.

    Returns the SQL to drop a foreign key. 
    public function getDropForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​

    [m] getDropUniqueConstraintSQL Returns the SQL to drop a unique constraint.

    Returns the SQL to drop a unique constraint. 
    public function getDropUniqueConstraintSQL(
    string $name,
    string $tableName
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​

    [m] getCreateTableSQL Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    Returns the SQL statement(s) to create a table with the specified name, columns and constraints 
    public function getCreateTableSQL(
    Doctrine\DBAL\Schema\Table $table,
    int $createFlags = self::CREATE_INDEXES
): list

    on this platform.

    Parameter
    type name summary
    ​Table ​$table ​
    ​int ​$createFlags = self::CREATE_INDEXES ​
    Return
    type summary
    ​list ​The list of SQL statements.
    Throws
    type summary
    ​Exception ​
    ​InvalidArgumentException ​

    [m] createSelectSQLBuilder 

    public function createSelectSQLBuilder(): Doctrine\DBAL\SQL\Builder\SelectSQLBuilder
    Return
    type summary
    ​SelectSQLBuilder ​

    [m] getCreateTableWithoutForeignKeysSQL

    final

    final protected function getCreateTableWithoutForeignKeysSQL(Doctrine\DBAL\Schema\Table $table): array|list
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [m] getCreateTablesSQL 

    public function getCreateTablesSQL(array|Doctrine\DBAL\Schema\Table[] $tables): array|list
    Parameter
    type name summary
    ​array|​Table[] ​$tables ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [m] getDropTablesSQL 

    public function getDropTablesSQL(array|list $tables): array|list
    Parameter
    type name summary
    ​array|​list ​$tables ​
    Return
    type summary
    ​array|​list ​

    [m] getCommentOnTableSQL 

    protected function getCommentOnTableSQL(
    string $tableName,
    ?string $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​?string ​$comment ​
    Return
    type summary
    ​string ​

    [m] getCommentOnColumnSQL 

    public function getCommentOnColumnSQL(
    string $tableName,
    string $columnName,
    string|null $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    ​string|​null ​$comment ​
    Return
    type summary
    ​string ​

    [m] getInlineColumnCommentSQL Returns the SQL to create inline comment on a column.

    Returns the SQL to create inline comment on a column. 
    public function getInlineColumnCommentSQL(string $comment): string
    Parameter
    type name summary
    ​string ​$comment ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] _getCreateTableSQL Returns the SQL used to create a table.

    Returns the SQL used to create a table. 
    protected function _getCreateTableSQL(
    string $name,
    array|mixed[][] $columns,
    array|mixed[] $options = []
): string[]
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​mixed[][] ​$columns ​
    ​array|​mixed[] ​$options = [] ​
    Return
    type summary
    ​string[] ​

    [m] getCreateTemporaryTableSnippetSQL 

    public function getCreateTemporaryTableSnippetSQL(): string
    Return
    type summary
    ​string ​

    [m] getAlterSchemaSQL Generates SQL statements that can be used to apply the diff.

    Generates SQL statements that can be used to apply the diff. 
    public function getAlterSchemaSQL(Doctrine\DBAL\Schema\SchemaDiff $diff): array|list
    Parameter
    type name summary
    ​SchemaDiff ​$diff ​
    Return
    type summary
    ​array|​list ​

    [m] getCreateSequenceSQL Returns the SQL to create a sequence on this platform.

    Returns the SQL to create a sequence on this platform. 
    public function getCreateSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getAlterSequenceSQL Returns the SQL to change a sequence on this platform.

    Returns the SQL to change a sequence on this platform. 
    public function getAlterSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDropSequenceSQL Returns the SQL snippet to drop an existing sequence.

    Returns the SQL snippet to drop an existing sequence. 
    public function getDropSequenceSQL(Doctrine\DBAL\Schema\Sequence|string $sequence): string
    Parameter
    type name summary
    ​Sequence|​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getCreateConstraintSQL Returns the SQL to create a constraint on a table on this platform.

    deprecated

    Returns the SQL to create a constraint on a table on this platform. 
    public function getCreateConstraintSQL(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    See
    type summary
    ​AbstractPlatform::getCreateIndexSQL() ​
    ​AbstractPlatform::getCreateForeignKeySQL() ​

    [m] getCreateIndexSQL Returns the SQL to create an index on a table on this platform.

    Returns the SQL to create an index on a table on this platform. 
    public function getCreateIndexSQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​

    [m] getPartialIndexSQL Adds condition for partial index.

    Adds condition for partial index. 
    protected function getPartialIndexSQL(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​

    [m] getCreateIndexSQLFlags Adds additional flags for index generation.

    Adds additional flags for index generation. 
    protected function getCreateIndexSQLFlags(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​

    [m] getCreatePrimaryKeySQL Returns the SQL to create an unnamed primary key constraint.

    Returns the SQL to create an unnamed primary key constraint. 
    public function getCreatePrimaryKeySQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​

    [m] getCreateSchemaSQL Returns the SQL to create a named schema.

    Returns the SQL to create a named schema. 
    public function getCreateSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getCreateUniqueConstraintSQL Returns the SQL to create a unique constraint on a table on this platform.

    Returns the SQL to create a unique constraint on a table on this platform. 
    public function getCreateUniqueConstraintSQL(
    Doctrine\DBAL\Schema\UniqueConstraint $constraint,
    string $tableName
): string
    Parameter
    type name summary
    ​UniqueConstraint ​$constraint ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​

    [m] getDropSchemaSQL Returns the SQL snippet to drop a schema.

    Returns the SQL snippet to drop a schema. 
    public function getDropSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] quoteIdentifier Quotes a string so that it can be safely used as a table or column name,

    Quotes a string so that it can be safely used as a table or column name, 
    public function quoteIdentifier(string $str): string

    even if it is a reserved word of the platform. This also detects identifier chains separated by dot and quotes them independently.

    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.

    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.

    [m] quoteSingleIdentifier Quotes a single identifier (no dot chain separation).

    Quotes a single identifier (no dot chain separation). 
    public function quoteSingleIdentifier(string $str): string
    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.

    [m] getCreateForeignKeySQL Returns the SQL to create a new foreign key.

    Returns the SQL to create a new foreign key. 
    public function getCreateForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key constraint.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​string ​

    [m] getAlterTableSQL Gets the SQL statements for altering an existing table.

    Gets the SQL statements for altering an existing table. 
    public function getAlterTableSQL(Doctrine\DBAL\Schema\TableDiff $diff): list

    This method returns an array of SQL statements, since some platforms need several statements.

    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getRenameTableSQL 

    public function getRenameTableSQL(
    string $oldName,
    string $newName
): array|list
    Parameter
    type name summary
    ​string ​$oldName ​
    ​string ​$newName ​
    Return
    type summary
    ​array|​list ​

    [m] onSchemaAlterTableAddColumn 

    protected function onSchemaAlterTableAddColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    mixed[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​mixed[] ​&$columnSql ​
    Return
    type summary
    ​bool ​

    [m] onSchemaAlterTableRemoveColumn 

    protected function onSchemaAlterTableRemoveColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​

    [m] onSchemaAlterTableChangeColumn 

    protected function onSchemaAlterTableChangeColumn(
    Doctrine\DBAL\Schema\ColumnDiff $columnDiff,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​ColumnDiff ​$columnDiff ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​

    [m] onSchemaAlterTableRenameColumn 

    protected function onSchemaAlterTableRenameColumn(
    string $oldColumnName,
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​string ​$oldColumnName ​
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​

    [m] onSchemaAlterTable 

    protected function onSchemaAlterTable(
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$sql
): bool
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    ​string[] ​&$sql ​
    Return
    type summary
    ​bool ​

    [m] getPreAlterTableIndexForeignKeySQL 

    protected function getPreAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​

    [m] getPostAlterTableIndexForeignKeySQL 

    protected function getPostAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​

    [m] getRenameIndexSQL Returns the SQL for renaming an index on a table.

    Returns the SQL for renaming an index on a table. 
    protected function getRenameIndexSQL(
    string $oldIndexName,
    Doctrine\DBAL\Schema\Index $index,
    string $tableName
): string[]
    Parameter
    type name summary
    ​string ​$oldIndexName ​The name of the index to rename from.
    ​Index ​$index ​The definition of the index to rename to.
    ​string ​$tableName ​The table to rename the given index on.
    Return
    type summary
    ​string[] ​The sequence of SQL statements for renaming the given index.

    [m] getColumnDeclarationListSQL Gets declaration of a number of columns in bulk.

    Gets declaration of a number of columns in bulk. 
    public function getColumnDeclarationListSQL(array|mixed[][] $columns): string
    Parameter
    type name summary
    ​array|​mixed[][] ​$columns ​A multidimensional associative array.
    Return
    type summary
    ​string ​

    [m] getColumnDeclarationSQL Obtains DBMS specific SQL code portion needed to declare a generic type

    Obtains DBMS specific SQL code portion needed to declare a generic type 
    public function getColumnDeclarationSQL(
    string $name,
    array|mixed[] $column
): string

    column to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name the column to be declared.
    ​array|​mixed[] ​$column ​An associative array with the name of the properties
    Return
    type summary
    ​string ​DBMS specific SQL code portion that should be used to declare the column.
    Throws
    type summary
    ​Exception ​

    [m] getDecimalTypeDeclarationSQL Returns the SQL snippet that declares a floating point column of arbitrary precision.

    Returns the SQL snippet that declares a floating point column of arbitrary precision. 
    public function getDecimalTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getDefaultValueDeclarationSQL Obtains DBMS specific SQL code portion needed to set a default value

    Obtains DBMS specific SQL code portion needed to set a default value 
    public function getDefaultValueDeclarationSQL(mixed[] $column): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​mixed[] ​$column ​The column definition array.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a default value.

    [m] getCheckDeclarationSQL Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    Obtains DBMS specific SQL code portion needed to set a CHECK constraint 
    public function getCheckDeclarationSQL(array|string[]|mixed[][] $definition): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​string[]|​mixed[][] ​$definition ​The check definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a CHECK constraint.

    [m] getUniqueConstraintDeclarationSQL Obtains DBMS specific SQL code portion needed to set a unique

    Obtains DBMS specific SQL code portion needed to set a unique 
    public function getUniqueConstraintDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\UniqueConstraint $constraint
): string

    constraint declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the unique constraint.
    ​UniqueConstraint ​$constraint ​The unique constraint definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a constraint.
    Throws
    type summary
    ​InvalidArgumentException ​

    [m] getIndexDeclarationSQL Obtains DBMS specific SQL code portion needed to set an index

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\Index $index
): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the index.
    ​Index ​$index ​The index definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set an index.
    Throws
    type summary
    ​InvalidArgumentException ​

    [m] getCustomTypeDeclarationSQL Obtains SQL code portion needed to create a custom column,

    deprecated

    Obtains SQL code portion needed to create a custom column, 
    public function getCustomTypeDeclarationSQL(array|mixed[] $column): string

    e.g. when a column has the "columnDefinition" keyword. Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getIndexFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexFieldDeclarationListSQL(Doctrine\DBAL\Schema\Index $index): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​

    [m] getColumnsFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getColumnsFieldDeclarationListSQL(array|mixed[] $columns): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$columns ​
    Return
    type summary
    ​string ​

    [m] getTemporaryTableSQL Returns the required SQL string that fits between CREATE ... TABLE

    deprecated

    Returns the required SQL string that fits between CREATE ... TABLE 
    public function getTemporaryTableSQL(): string

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

    Return
    type summary
    ​string ​The string required to be placed between "CREATE" and "TABLE"

    [m] getTemporaryTableName Some vendors require temporary table names to be qualified specially.

    Some vendors require temporary table names to be qualified specially. 
    public function getTemporaryTableName(string $tableName): string
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​string ​

    [m] getForeignKeyDeclarationSQL Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getAdvancedForeignKeyOptionsSQL Returns the FOREIGN KEY query section dealing with non-standard options

    Returns the FOREIGN KEY query section dealing with non-standard options 
    public function getAdvancedForeignKeyOptionsSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    as MATCH, INITIALLY DEFERRED, ON UPDATE, ...

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key definition.
    Return
    type summary
    ​string ​

    [m] getForeignKeyReferentialActionSQL Returns the given referential action in uppercase if valid, otherwise throws an exception.

    Returns the given referential action in uppercase if valid, otherwise throws an exception. 
    public function getForeignKeyReferentialActionSQL(string $action): string
    Parameter
    type name summary
    ​string ​$action ​The foreign key referential action.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​If unknown referential action given.

    [m] getForeignKeyBaseDeclarationSQL Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyBaseDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​

    [m] getUniqueFieldDeclarationSQL Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    deprecated

    Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint 
    public function getUniqueFieldDeclarationSQL(): string

    of a column declaration to be used in statements like CREATE TABLE.

    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the UNIQUE constraint

    [m] getColumnCharsetDeclarationSQL Obtains DBMS specific SQL code portion needed to set the CHARACTER SET

    Obtains DBMS specific SQL code portion needed to set the CHARACTER SET 
    public function getColumnCharsetDeclarationSQL(string $charset): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$charset ​The name of the charset.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the CHARACTER SET

    [m] getColumnCollationDeclarationSQL Obtains DBMS specific SQL code portion needed to set the COLLATION

    Obtains DBMS specific SQL code portion needed to set the COLLATION 
    public function getColumnCollationDeclarationSQL(string $collation): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$collation ​The name of the collation.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the COLLATION

    [m] prefersIdentityColumns Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    deprecated

    Whether the platform prefers identity columns (eg. autoincrement) for ID generation. 
    public function prefersIdentityColumns(): bool

    Subclasses should override this method to return TRUE if they prefer identity columns.

    Return
    type summary
    ​bool ​

    [m] convertBooleans Some platforms need the boolean values to be converted.

    Some platforms need the boolean values to be converted. 
    public function convertBooleans(mixed $item): mixed

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

    Note: if the input is not a boolean the original input might be returned.

    There are two contexts when converting booleans: Literals and Prepared Statements. This method should handle the literal case

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.

    [m] convertFromBoolean Some platforms have boolean literals that needs to be correctly converted

    Some platforms have boolean literals that needs to be correctly converted 
    public function convertFromBoolean(T $item): (T

    The default conversion tries to convert value into bool "(bool)$item"

    Parameter
    type name summary
    ​T ​$item ​
    Return
    type summary
    ​(T ​is null ? null : bool)

    [m] convertBooleansToDatabaseValue This method should handle the prepared statements case. When there is no

    This method should handle the prepared statements case. When there is no 
    public function convertBooleansToDatabaseValue(mixed $item): mixed

    distinction, it's OK to use the same method.

    Note: if the input is not a boolean the original input might be returned.

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.

    [m] getCurrentDateSQL Returns the SQL specific for the platform to get the current date.

    Returns the SQL specific for the platform to get the current date. 
    public function getCurrentDateSQL(): string
    Return
    type summary
    ​string ​

    [m] getCurrentTimeSQL Returns the SQL specific for the platform to get the current time.

    Returns the SQL specific for the platform to get the current time. 
    public function getCurrentTimeSQL(): string
    Return
    type summary
    ​string ​

    [m] getCurrentTimestampSQL Returns the SQL specific for the platform to get the current timestamp

    Returns the SQL specific for the platform to get the current timestamp 
    public function getCurrentTimestampSQL(): string
    Return
    type summary
    ​string ​

    [m] _getTransactionIsolationLevelSQL Returns the SQL for a given transaction isolation level Connection constant.

    Returns the SQL for a given transaction isolation level Connection constant. 
    protected function _getTransactionIsolationLevelSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​

    [m] getListDatabasesSQL 

    public function getListDatabasesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    See
    type summary
    ​AbstractSchemaManager ​

    [m] getListNamespacesSQL Returns the SQL statement for retrieving the namespaces defined in the database.

    deprecated

    Returns the SQL statement for retrieving the namespaces defined in the database. 
    public function getListNamespacesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] getListSequencesSQL 

    public function getListSequencesSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    See
    type summary
    ​AbstractSchemaManager ​

    [m] getListTableConstraintsSQL

    deprecated 

    public function getListTableConstraintsSQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getListTableColumnsSQL

    deprecated 

    public function getListTableColumnsSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getListTablesSQL

    deprecated 

    public function getListTablesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getListUsersSQL

    deprecated 

    public function getListUsersSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getListViewsSQL Returns the SQL to list all views of a database or user.

    Returns the SQL to list all views of a database or user. 
    public function getListViewsSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    See
    type summary
    ​AbstractSchemaManager ​

    [m] getListTableIndexesSQL

    deprecated 

    public function getListTableIndexesSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getListTableForeignKeysSQL

    deprecated 

    public function getListTableForeignKeysSQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getCreateViewSQL 

    public function getCreateViewSQL(
    string $name,
    string $sql
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$sql ​
    Return
    type summary
    ​string ​

    [m] getDropViewSQL 

    public function getDropViewSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​

    [m] getSequenceNextValSQL 

    public function getSequenceNextValSQL(string $sequence): string
    Parameter
    type name summary
    ​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getCreateDatabaseSQL Returns the SQL to create a new database.

    Returns the SQL to create a new database. 
    public function getCreateDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDropDatabaseSQL Returns the SQL snippet to drop an existing database.

    Returns the SQL snippet to drop an existing database. 
    public function getDropDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be dropped.
    Return
    type summary
    ​string ​

    [m] getSetTransactionIsolationSQL Returns the SQL to set the transaction isolation level.

    Returns the SQL to set the transaction isolation level. 
    public function getSetTransactionIsolationSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateTimeTypeDeclarationSQL Obtains DBMS specific SQL to be used to create datetime columns in

    Obtains DBMS specific SQL to be used to create datetime columns in 
    public function getDateTimeTypeDeclarationSQL(array|mixed[] $column): string

    statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getDateTimeTzTypeDeclarationSQL Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    Obtains DBMS specific SQL to be used to create datetime with timezone offset columns. 
    public function getDateTimeTzTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getDateTypeDeclarationSQL Obtains DBMS specific SQL to be used to create date columns in statements

    Obtains DBMS specific SQL to be used to create date columns in statements 
    public function getDateTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getTimeTypeDeclarationSQL Obtains DBMS specific SQL to be used to create time columns in statements

    Obtains DBMS specific SQL to be used to create time columns in statements 
    public function getTimeTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] getFloatDeclarationSQL 

    public function getFloatDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​

    [m] getDefaultTransactionIsolationLevel Gets the default transaction isolation level of the platform.

    Gets the default transaction isolation level of the platform. 
    public function getDefaultTransactionIsolationLevel(): Doctrine\DBAL\TransactionIsolationLevel::*()
    Return
    type summary
    ​TransactionIsolationLevel::*() ​The default isolation level.
    See
    type summary
    ​TransactionIsolationLevel ​

    [m] supportsSequences Whether the platform supports sequences.

    Whether the platform supports sequences. 
    public function supportsSequences(): bool
    Return
    type summary
    ​bool ​

    [m] supportsIdentityColumns Whether the platform supports identity columns.

    Whether the platform supports identity columns. 
    public function supportsIdentityColumns(): bool

    Identity columns are columns that receive an auto-generated value from the database on insert of a row.

    Return
    type summary
    ​bool ​

    [m] usesSequenceEmulatedIdentityColumns Whether the platform emulates identity columns through sequences.

    deprecated

    Whether the platform emulates identity columns through sequences. 
    public function usesSequenceEmulatedIdentityColumns(): bool

    Some platforms that do not support identity columns natively but support sequences can emulate identity columns by using sequences.

    Return
    type summary
    ​bool ​

    [m] getIdentitySequenceName Returns the name of the sequence for a particular identity column in a particular table.

    deprecated

    Returns the name of the sequence for a particular identity column in a particular table. 
    public function getIdentitySequenceName(
    string $tableName,
    string $columnName
): string
    Parameter
    type name summary
    ​string ​$tableName ​The name of the table to return the sequence name for.
    ​string ​$columnName ​The name of the identity column in the table to return the sequence name for.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    See
    type summary
    ​usesSequenceEmulatedIdentityColumns ​

    [m] supportsIndexes Whether the platform supports indexes.

    deprecated

    Whether the platform supports indexes. 
    public function supportsIndexes(): bool
    Return
    type summary
    ​bool ​

    [m] supportsPartialIndexes Whether the platform supports partial indexes.

    Whether the platform supports partial indexes. 
    public function supportsPartialIndexes(): bool
    Return
    type summary
    ​bool ​

    [m] supportsColumnLengthIndexes Whether the platform supports indexes with column length definitions.

    Whether the platform supports indexes with column length definitions. 
    public function supportsColumnLengthIndexes(): bool
    Return
    type summary
    ​bool ​

    [m] supportsAlterTable Whether the platform supports altering tables.

    deprecated

    Whether the platform supports altering tables. 
    public function supportsAlterTable(): bool
    Return
    type summary
    ​bool ​

    [m] supportsTransactions Whether the platform supports transactions.

    deprecated

    Whether the platform supports transactions. 
    public function supportsTransactions(): bool
    Return
    type summary
    ​bool ​

    [m] supportsSavepoints Whether the platform supports savepoints.

    Whether the platform supports savepoints. 
    public function supportsSavepoints(): bool
    Return
    type summary
    ​bool ​

    [m] supportsReleaseSavepoints Whether the platform supports releasing savepoints.

    Whether the platform supports releasing savepoints. 
    public function supportsReleaseSavepoints(): bool
    Return
    type summary
    ​bool ​

    [m] supportsPrimaryConstraints Whether the platform supports primary key constraints.

    deprecated

    Whether the platform supports primary key constraints. 
    public function supportsPrimaryConstraints(): bool
    Return
    type summary
    ​bool ​

    [m] supportsForeignKeyConstraints Whether the platform supports foreign key constraints.

    deprecated

    Whether the platform supports foreign key constraints. 
    public function supportsForeignKeyConstraints(): bool
    Return
    type summary
    ​bool ​

    [m] supportsSchemas Whether the platform supports database schemas.

    Whether the platform supports database schemas. 
    public function supportsSchemas(): bool
    Return
    type summary
    ​bool ​

    [m] canEmulateSchemas Whether this platform can emulate schemas.

    deprecated

    Whether this platform can emulate schemas. 
    public function canEmulateSchemas(): bool
    Return
    type summary
    ​bool ​
    See
    type summary
    ​AbstractManager::introspectSchema() ​

    [m] getDefaultSchemaName Returns the default schema name.

    deprecated

    Returns the default schema name. 
    public function getDefaultSchemaName(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.

    [m] supportsCreateDropDatabase Whether this platform supports create database.

    deprecated

    Whether this platform supports create database. 
    public function supportsCreateDropDatabase(): bool

    Some databases don't allow to create and drop databases at all or only with certain tools.

    Return
    type summary
    ​bool ​

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

    deprecated

    Whether the platform supports getting the affected rows of a recent update/delete type query. 
    public function supportsGettingAffectedRows(): bool
    Return
    type summary
    ​bool ​

    [m] supportsInlineColumnComments Whether this platform support to add inline column comments as postfix.

    Whether this platform support to add inline column comments as postfix. 
    public function supportsInlineColumnComments(): bool
    Return
    type summary
    ​bool ​

    [m] supportsCommentOnStatement Whether this platform support the proprietary syntax "COMMENT ON asset".

    Whether this platform support the proprietary syntax "COMMENT ON asset". 
    public function supportsCommentOnStatement(): bool
    Return
    type summary
    ​bool ​

    [m] hasNativeGuidType Does this platform have native guid type.

    deprecated

    Does this platform have native guid type. 
    public function hasNativeGuidType(): bool
    Return
    type summary
    ​bool ​

    [m] hasNativeJsonType Does this platform have native JSON type.

    deprecated

    Does this platform have native JSON type. 
    public function hasNativeJsonType(): bool
    Return
    type summary
    ​bool ​

    [m] supportsViews Whether this platform supports views.

    deprecated

    Whether this platform supports views. 
    public function supportsViews(): bool
    Return
    type summary
    ​bool ​

    [m] supportsColumnCollation Does this platform support column collation?

    Does this platform support column collation? 
    public function supportsColumnCollation(): bool
    Return
    type summary
    ​bool ​

    [m] getDateTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeFormatString(): string

    the format of a stored datetime value of this platform.

    Return
    type summary
    ​string ​The format string.

    [m] getDateTimeTzFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeTzFormatString(): string

    the format of a stored datetime with timezone value of this platform.

    Return
    type summary
    ​string ​The format string.

    [m] getDateFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateFormatString(): string

    the format of a stored date value of this platform.

    Return
    type summary
    ​string ​The format string.

    [m] getTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getTimeFormatString(): string

    the format of a stored time value of this platform.

    Return
    type summary
    ​string ​The format string.

    [m] modifyLimitQuery Adds an driver-specific LIMIT clause to the query.

    final

    Adds an driver-specific LIMIT clause to the query. 
    final public function modifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset = 0
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset = 0 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​

    [m] doModifyLimitQuery Adds an platform-specific LIMIT clause to the query.

    Adds an platform-specific LIMIT clause to the query. 
    protected function doModifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset ​
    Return
    type summary
    ​string ​

    [m] supportsLimitOffset Whether the database platform support offsets in modify limit clauses.

    deprecated

    Whether the database platform support offsets in modify limit clauses. 
    public function supportsLimitOffset(): bool
    Return
    type summary
    ​bool ​

    [m] getMaxIdentifierLength Maximum length of any given database identifier, like tables or column names.

    Maximum length of any given database identifier, like tables or column names. 
    public function getMaxIdentifierLength(): int
    Return
    type summary
    ​int ​

    [m] getEmptyIdentityInsertSQL Returns the insert SQL for an empty insert statement.

    Returns the insert SQL for an empty insert statement. 
    public function getEmptyIdentityInsertSQL(
    string $quotedTableName,
    string $quotedIdentifierColumnName
): string
    Parameter
    type name summary
    ​string ​$quotedTableName ​
    ​string ​$quotedIdentifierColumnName ​
    Return
    type summary
    ​string ​

    [m] getTruncateTableSQL Generates a Truncate Table SQL statement for a given table.

    Generates a Truncate Table SQL statement for a given table. 
    public function getTruncateTableSQL(
    string $tableName,
    bool $cascade = false
): string

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

    Parameter
    type name summary
    ​string ​$tableName ​
    ​bool ​$cascade = false ​
    Return
    type summary
    ​string ​

    [m] getDummySelectSQL This is for test reasons, many vendors have special requirements for dummy statements.

    This is for test reasons, many vendors have special requirements for dummy statements. 
    public function getDummySelectSQL(): string
    Return
    type summary
    ​string ​

    [m] createSavePoint Returns the SQL to create a new savepoint.

    Returns the SQL to create a new savepoint. 
    public function createSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​

    [m] releaseSavePoint Returns the SQL to release a savepoint.

    Returns the SQL to release a savepoint. 
    public function releaseSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​

    [m] rollbackSavePoint Returns the SQL to rollback a savepoint.

    Returns the SQL to rollback a savepoint. 
    public function rollbackSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​

    [m] getReservedKeywordsList Returns the keyword list instance of this platform.

    final

    Returns the keyword list instance of this platform. 
    final public function getReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList
    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​If no keyword list is specified.

    [m] createReservedKeywordsList Creates an instance of the reserved keyword list of this platform.

    Creates an instance of the reserved keyword list of this platform. 
    protected function createReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList

    This method will become @abstract in DBAL 4.0.0.

    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​

    [m] getReservedKeywordsClass Returns the class name of the reserved keywords list.

    deprecated

    Returns the class name of the reserved keywords list. 
    protected function getReservedKeywordsClass(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    See
    type summary
    ​AbstractPlatform::createReservedKeywordsList() ​

    [m] quoteStringLiteral Quotes a literal string.

    Quotes a literal string. 
    public function quoteStringLiteral(string $str): string

    This method is NOT meant to fix SQL injections! It is only meant to escape this platform's string literal quote character inside the given literal string.

    Parameter
    type name summary
    ​string ​$str ​The literal string to be quoted.
    Return
    type summary
    ​string ​The quoted literal string.

    [m] getStringLiteralQuoteCharacter Gets the character used for string literal quoting.

    deprecated

    Gets the character used for string literal quoting. 
    public function getStringLiteralQuoteCharacter(): string
    Return
    type summary
    ​string ​
    See
    type summary
    ​AbstractPlatform::quoteStringLiteral() ​

    [m] escapeStringForLike Escapes metacharacters in a string intended to be used with a LIKE

    final

    Escapes metacharacters in a string intended to be used with a LIKE 
    final public function escapeStringForLike(
    string $inputString,
    string $escapeChar
): string

    operator.

    Parameter
    type name summary
    ​string ​$inputString ​a literal, unquoted string
    ​string ​$escapeChar ​should be reused by the caller in the LIKE
    Return
    type summary
    ​string ​

    [m] createSQLParser 

    public function createSQLParser(): Doctrine\DBAL\SQL\Parser
    Return
    type summary
    ​Parser ​

    [m] getLikeWildcardCharacters 

    protected function getLikeWildcardCharacters(): string
    Return
    type summary
    ​string ​

    [m] columnsEqual Compares the definitions of the given columns in the context of this platform.

    Compares the definitions of the given columns in the context of this platform. 
    public function columnsEqual(
    Doctrine\DBAL\Schema\Column $column1,
    Doctrine\DBAL\Schema\Column $column2
): bool
    Parameter
    type name summary
    ​Column ​$column1 ​
    ​Column ​$column2 ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​

    [m] createSchemaManager Creates the schema manager that can be used to inspect and change the underlying

    Creates the schema manager that can be used to inspect and change the underlying 
    public function createSchemaManager(Doctrine\DBAL\Connection $connection): Doctrine\DBAL\Schema\AbstractSchemaManager

    database schema according to the dialect of the platform.

    Parameter
    type name summary
    ​Connection ​$connection ​
    Return
    type summary
    ​AbstractSchemaManager ​
    Throws
    type summary
    ​Exception ​

    [C] MySQLPlatform Provides the behavior, features and SQL dialect of the Oracle MySQL database platform

    Provides the behavior, features and SQL dialect of the Oracle MySQL database platform of the oldest supported version.

    Hierarchy

    Parents
    type summary
    ​AbstractMySQLPlatform ​Provides the base implementation for the lowest versions of supported MySQL-like database platforms.
    ​AbstractPlatform ​Base class for all DatabasePlatforms. The DatabasePlatforms are the central

    [C] LENGTH_LIMIT_TINYTEXT 

    public const int LENGTH_LIMIT_TINYTEXT = 255
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_TINYTEXT ​

    [C] LENGTH_LIMIT_TEXT 

    public const int LENGTH_LIMIT_TEXT = 65535
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_TEXT ​

    [C] LENGTH_LIMIT_MEDIUMTEXT 

    public const int LENGTH_LIMIT_MEDIUMTEXT = 16777215
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_MEDIUMTEXT ​

    [C] LENGTH_LIMIT_TINYBLOB 

    public const int LENGTH_LIMIT_TINYBLOB = 255
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_TINYBLOB ​

    [C] LENGTH_LIMIT_BLOB 

    public const int LENGTH_LIMIT_BLOB = 65535
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_BLOB ​

    [C] LENGTH_LIMIT_MEDIUMBLOB 

    public const int LENGTH_LIMIT_MEDIUMBLOB = 16777215
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_MEDIUMBLOB ​

    [C] CREATE_INDEXES 

    public const int CREATE_INDEXES = 1
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_INDEXES ​

    [C] CREATE_FOREIGNKEYS 

    public const int CREATE_FOREIGNKEYS = 2
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_FOREIGNKEYS ​

    [p] $doctrineTypeMapping 

    protected string[]|null $doctrineTypeMapping = null

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeMapping ​

    [p] $doctrineTypeComments Contains a list of all columns that should generate parseable column comments for type-detection

    deprecated

    Contains a list of all columns that should generate parseable column comments for type-detection 
    protected string[]|null $doctrineTypeComments = null

    in reverse engineering scenarios.

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeComments ​Contains a list of all columns that should generate parseable column comments for type-detection

    [p] $_eventManager

    deprecated 

    protected Doctrine\Common\EventManager|null $_eventManager = null

    Type: EventManager|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_eventManager ​

    [p] $_keywords Holds the KeywordList instance for the current platform.

    Holds the KeywordList instance for the current platform. 
    protected Doctrine\DBAL\Platforms\Keywords\KeywordList|null $_keywords = null

    Type: KeywordList|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_keywords ​Holds the KeywordList instance for the current platform.

    [m] doModifyLimitQuery Adds an platform-specific LIMIT clause to the query.

    Adds an platform-specific LIMIT clause to the query. 
    protected function doModifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::doModifyLimitQuery() ​Adds an platform-specific LIMIT clause to the query.

    [m] getIdentifierQuoteCharacter Gets the character used for identifier quoting.

    deprecated

    Gets the character used for identifier quoting. 
    public function getIdentifierQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getIdentifierQuoteCharacter() ​Gets the character used for identifier quoting.
    See
    type summary
    ​AbstractMySQLPlatform::quoteIdentifier() ​
    ​AbstractPlatform::quoteIdentifier() ​

    [m] getRegexpExpression Returns the regular expression operator.

    Returns the regular expression operator. 
    public function getRegexpExpression(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getRegexpExpression() ​Returns the regular expression operator.

    [m] getLocateExpression Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str. 
    public function getLocateExpression(
    string $str,
    string $substr,
    string|int|false $startPos = false
): string
    Parameter
    type name summary
    ​string ​$str ​Literal string.
    ​string ​$substr ​Literal string to find.
    ​string|​int|​false ​$startPos = false ​Position to start at, beginning of string by default.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getLocateExpression() ​Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    [m] getConcatExpression <tag_inheritdoc data-type='' data-description=''>Returns a SQL snippet to concatenate the given expressions.

    Returns a SQL snippet to concatenate the given expressions. 
    public function getConcatExpression(): string

    Accepts an arbitrary number of string parameters. Each parameter must contain an expression.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getConcatExpression() ​<tag_inheritdoc data-type='' data-description=''>Returns a SQL snippet to concatenate the given expressions.

    [m] getDateArithmeticIntervalExpression Returns the SQL for a date arithmetic expression.

    Returns the SQL for a date arithmetic expression. 
    protected function getDateArithmeticIntervalExpression(
    string $date,
    string $operator,
    int|string $interval,
    string $unit
): string
    Parameter
    type name summary
    ​string ​$date ​The column or literal representing a date
    ​string ​$operator ​The arithmetic operator (+ or -).
    ​int|​string ​$interval ​The interval that shall be calculated into the date.
    ​string ​$unit ​The unit of the interval that shall be calculated into the date.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDateArithmeticIntervalExpression() ​Returns the SQL for a date arithmetic expression.

    [m] getDateDiffExpression <tag_inheritdoc data-type='' data-description=''>Returns the SQL to calculate the difference in days between the two passed dates.

    Returns the SQL to calculate the difference in days between the two passed dates. 
    public function getDateDiffExpression(
    string $date1,
    string $date2
): string

    Computes diff = date1 - date2.

    Parameter
    type name summary
    ​string ​$date1 ​
    ​string ​$date2 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDateDiffExpression() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQL to calculate the difference in days between the two passed dates.

    [m] getCurrentDatabaseExpression Returns the SQL expression which represents the currently selected database.

    Returns the SQL expression which represents the currently selected database. 
    public function getCurrentDatabaseExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getCurrentDatabaseExpression() ​Returns the SQL expression which represents the currently selected database.

    [m] getLengthExpression Returns the SQL snippet to get the length of a text column in characters.

    Returns the SQL snippet to get the length of a text column in characters. 
    public function getLengthExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getLengthExpression() ​Returns the SQL snippet to get the length of a text column in characters.

    [m] getListDatabasesSQL 

    public function getListDatabasesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListDatabasesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getListTableConstraintsSQL

    deprecated 

    public function getListTableConstraintsSQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableConstraintsSQL() ​

    [m] getListTableIndexesSQL

    deprecated 

    public function getListTableIndexesSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableIndexesSQL() ​

    [m] getListViewsSQL Returns the SQL to list all views of a database or user.

    Returns the SQL to list all views of a database or user. 
    public function getListViewsSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListViewsSQL() ​Returns the SQL to list all views of a database or user.
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getListTableForeignKeysSQL

    deprecated 

    public function getListTableForeignKeysSQL(
    string $table,
    string|null $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableForeignKeysSQL() ​

    [m] getVarcharTypeDeclarationSQLSnippet 

    protected function getVarcharTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​
    ​bool ​$fixed ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getVarcharTypeDeclarationSQLSnippet() ​

    [m] getBinaryTypeDeclarationSQLSnippet Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    protected function getBinaryTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​The length of the column.
    ​bool ​$fixed ​Whether the column length is fixed.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBinaryTypeDeclarationSQLSnippet() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getClobTypeDeclarationSQL Gets the SQL snippet used to declare a CLOB column type.

    Gets the SQL snippet used to declare a CLOB column type. 
    public function getClobTypeDeclarationSQL(array|mixed[] $column): string
    TINYTEXT   : 2 ^  8 - 1 = 255
TEXT       : 2 ^ 16 - 1 = 65535
MEDIUMTEXT : 2 ^ 24 - 1 = 16777215
LONGTEXT   : 2 ^ 32 - 1 = 4294967295

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

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getClobTypeDeclarationSQL() ​Gets the SQL snippet used to declare a CLOB column type.

    [m] getDateTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create datetime columns in

    Obtains DBMS specific SQL to be used to create datetime columns in 
    public function getDateTimeTypeDeclarationSQL(array|mixed[] $column): string

    statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDateTimeTypeDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create datetime columns in

    [m] getDateTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create date columns in statements

    Obtains DBMS specific SQL to be used to create date columns in statements 
    public function getDateTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDateTypeDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create date columns in statements

    [m] getTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create time columns in statements

    Obtains DBMS specific SQL to be used to create time columns in statements 
    public function getTimeTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getTimeTypeDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create time columns in statements

    [m] getBooleanTypeDeclarationSQL Returns the SQL snippet that declares a boolean column.

    Returns the SQL snippet that declares a boolean column. 
    public function getBooleanTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBooleanTypeDeclarationSQL() ​Returns the SQL snippet that declares a boolean column.

    [m] prefersIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    deprecated

    Whether the platform prefers identity columns (eg. autoincrement) for ID generation. 
    public function prefersIdentityColumns(): bool

    Subclasses should override this method to return TRUE if they prefer identity columns.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::prefersIdentityColumns() ​<tag_inheritdoc data-type='' data-description=''>Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    [m] supportsIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform supports identity columns.

    Whether the platform supports identity columns. 
    public function supportsIdentityColumns(): bool

    Identity columns are columns that receive an auto-generated value from the database on insert of a row.

    MySQL supports this through AUTO_INCREMENT columns.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::supportsIdentityColumns() ​<tag_inheritdoc data-type='' data-description=''>Whether the platform supports identity columns.

    [m] supportsInlineColumnComments Whether this platform support to add inline column comments as postfix.

    Whether this platform support to add inline column comments as postfix. 
    public function supportsInlineColumnComments(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::supportsInlineColumnComments() ​Whether this platform support to add inline column comments as postfix.
    See
    type summary
    ​AbstractPlatform ​

    [m] supportsColumnCollation Does this platform support column collation?

    Does this platform support column collation? 
    public function supportsColumnCollation(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::supportsColumnCollation() ​Does this platform support column collation?
    See
    type summary
    ​AbstractPlatform ​

    [m] getListTablesSQL

    deprecated 

    public function getListTablesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTablesSQL() ​

    [m] getListTableColumnsSQL

    deprecated 

    public function getListTableColumnsSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableColumnsSQL() ​

    [m] getColumnTypeSQLSnippets

    deprecated 

    public function getColumnTypeSQLSnippets(string $tableAlias = "c"): array
    Parameter
    type name summary
    ​string ​$tableAlias = "c" ​
    Return
    type summary
    ​array ​string}
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getColumnTypeSQLSnippets() ​
    See
    type summary
    ​AbstractMySQLPlatform::getColumnTypeSQLSnippet() ​

    [m] getColumnTypeSQLSnippet The SQL snippet required to elucidate a column type

    The SQL snippet required to elucidate a column type 
    public function getColumnTypeSQLSnippet(
    string $tableAlias = "c",
    ?string $databaseName = null
): string

    Returns a column type SELECT snippet string

    Parameter
    type name summary
    ​string ​$tableAlias = "c" ​
    ​?string ​$databaseName = null ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getColumnTypeSQLSnippet() ​The SQL snippet required to elucidate a column type

    [m] getListTableMetadataSQL

    deprecated 

    public function getListTableMetadataSQL(
    string $table,
    ?string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​?string ​$database = null ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableMetadataSQL() ​

    [m] getCreateTablesSQL 

    public function getCreateTablesSQL(array|Doctrine\DBAL\Schema\Table[] $tables): array
    Parameter
    type name summary
    ​array|​Table[] ​$tables ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getCreateTablesSQL() ​

    [m] _getCreateTableSQL Returns the SQL used to create a table.

    Returns the SQL used to create a table. 
    protected function _getCreateTableSQL(
    string $name,
    array|mixed[][] $columns,
    array|mixed[] $options = []
): string[]
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​mixed[][] ​$columns ​
    ​array|​mixed[] ​$options = [] ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::_getCreateTableSQL() ​Returns the SQL used to create a table.

    [m] createSelectSQLBuilder 

    public function createSelectSQLBuilder(): Doctrine\DBAL\SQL\Builder\SelectSQLBuilder
    Return
    type summary
    ​SelectSQLBuilder ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::createSelectSQLBuilder() ​

    [m] getDefaultValueDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set a default value

    Obtains DBMS specific SQL code portion needed to set a default value 
    public function getDefaultValueDeclarationSQL(mixed[] $column): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​mixed[] ​$column ​The column definition array.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a default value.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDefaultValueDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set a default value
    See
    type summary
    ​AbstractPlatform ​

    [m] getAlterTableSQL <tag_inheritdoc data-type='' data-description=''>Gets the SQL statements for altering an existing table.

    Gets the SQL statements for altering an existing table. 
    public function getAlterTableSQL(Doctrine\DBAL\Schema\TableDiff $diff): list

    This method returns an array of SQL statements, since some platforms need several statements.

    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getAlterTableSQL() ​<tag_inheritdoc data-type='' data-description=''>Gets the SQL statements for altering an existing table.

    [m] getPreAlterTableIndexForeignKeySQL 

    protected function getPreAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getPreAlterTableIndexForeignKeySQL() ​

    [m] getPreAlterTableRenameIndexForeignKeySQL 

    protected function getPreAlterTableRenameIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​The table diff to gather the SQL for.
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getPreAlterTableRenameIndexForeignKeySQL() ​

    [m] getPostAlterTableIndexForeignKeySQL 

    protected function getPostAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getPostAlterTableIndexForeignKeySQL() ​

    [m] getPostAlterTableRenameIndexForeignKeySQL 

    protected function getPostAlterTableRenameIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​The table diff to gather the SQL for.
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getPostAlterTableRenameIndexForeignKeySQL() ​

    [m] getCreateIndexSQLFlags Adds additional flags for index generation.

    Adds additional flags for index generation. 
    protected function getCreateIndexSQLFlags(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getCreateIndexSQLFlags() ​Adds additional flags for index generation.

    [m] getIntegerTypeDeclarationSQL Returns the SQL snippet that declares a 4 byte integer column.

    Returns the SQL snippet that declares a 4 byte integer column. 
    public function getIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares a 4 byte integer column.

    [m] getBigIntTypeDeclarationSQL Returns the SQL snippet that declares an 8 byte integer column.

    Returns the SQL snippet that declares an 8 byte integer column. 
    public function getBigIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBigIntTypeDeclarationSQL() ​Returns the SQL snippet that declares an 8 byte integer column.

    [m] getSmallIntTypeDeclarationSQL Returns the SQL snippet that declares a 2 byte integer column.

    Returns the SQL snippet that declares a 2 byte integer column. 
    public function getSmallIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getSmallIntTypeDeclarationSQL() ​Returns the SQL snippet that declares a 2 byte integer column.

    [m] getFloatDeclarationSQL 

    public function getFloatDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getFloatDeclarationSQL() ​

    [m] getDecimalTypeDeclarationSQL Returns the SQL snippet that declares a floating point column of arbitrary precision.

    Returns the SQL snippet that declares a floating point column of arbitrary precision. 
    public function getDecimalTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDecimalTypeDeclarationSQL() ​Returns the SQL snippet that declares a floating point column of arbitrary precision.

    [m] _getCommonIntegerTypeDeclarationSQL Returns the SQL snippet that declares common properties of an integer column.

    Returns the SQL snippet that declares common properties of an integer column. 
    protected function _getCommonIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::_getCommonIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares common properties of an integer column.

    [m] getColumnCharsetDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set the CHARACTER SET

    Obtains DBMS specific SQL code portion needed to set the CHARACTER SET 
    public function getColumnCharsetDeclarationSQL(string $charset): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$charset ​The name of the charset.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the CHARACTER SET
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getColumnCharsetDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set the CHARACTER SET
    See
    type summary
    ​AbstractPlatform ​

    [m] getAdvancedForeignKeyOptionsSQL <tag_inheritdoc data-type='' data-description=''>Returns the FOREIGN KEY query section dealing with non-standard options

    Returns the FOREIGN KEY query section dealing with non-standard options 
    public function getAdvancedForeignKeyOptionsSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    as MATCH, INITIALLY DEFERRED, ON UPDATE, ...

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getAdvancedForeignKeyOptionsSQL() ​<tag_inheritdoc data-type='' data-description=''>Returns the FOREIGN KEY query section dealing with non-standard options
    See
    type summary
    ​AbstractPlatform ​

    [m] getDropIndexSQL Returns the SQL to drop an index from a table.

    Returns the SQL to drop an index from a table. 
    public function getDropIndexSQL(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string|null $table = null
): string
    Parameter
    type name summary
    ​Index|​string ​$index ​
    ​Table|​string|​null ​$table = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDropIndexSQL() ​Returns the SQL to drop an index from a table.

    [m] getDropPrimaryKeySQL 

    protected function getDropPrimaryKeySQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDropPrimaryKeySQL() ​

    [m] getDropUniqueConstraintSQL The ALTER TABLE ... DROP CONSTRAINT syntax is only available as of MySQL 8.0.19.

    The ALTER TABLE ... DROP CONSTRAINT syntax is only available as of MySQL 8.0.19. 
    public function getDropUniqueConstraintSQL(
    string $name,
    string $tableName
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDropUniqueConstraintSQL() ​The ALTER TABLE ... DROP CONSTRAINT syntax is only available as of MySQL 8.0.19.

    [m] getSetTransactionIsolationSQL Returns the SQL to set the transaction isolation level.

    Returns the SQL to set the transaction isolation level. 
    public function getSetTransactionIsolationSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getSetTransactionIsolationSQL() ​Returns the SQL to set the transaction isolation level.

    [m] getName Gets the name of the platform.

    deprecated

    Gets the name of the platform. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getName() ​Gets the name of the platform.

    [m] getReadLockSQL <tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock. 
    public function getReadLockSQL(): string

    This defaults to the ANSI SQL "FOR UPDATE", which is an exclusive lock (Write). Some database vendors allow to lighten this constraint up to be a real read lock.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getReadLockSQL() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    [m] initializeDoctrineTypeMappings Lazy load Doctrine Type Mappings.

    Lazy load Doctrine Type Mappings. 
    protected function initializeDoctrineTypeMappings(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::initializeDoctrineTypeMappings() ​Lazy load Doctrine Type Mappings.

    [m] getVarcharMaxLength Gets the maximum length of a varchar column.

    deprecated

    Gets the maximum length of a varchar column. 
    public function getVarcharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getVarcharMaxLength() ​Gets the maximum length of a varchar column.

    [m] getBinaryMaxLength Gets the maximum length of a binary column.

    deprecated

    Gets the maximum length of a binary column. 
    public function getBinaryMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBinaryMaxLength() ​Gets the maximum length of a binary column.

    [m] getReservedKeywordsClass Returns the class name of the reserved keywords list.

    deprecated

    Returns the class name of the reserved keywords list. 
    protected function getReservedKeywordsClass(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getReservedKeywordsClass() ​Returns the class name of the reserved keywords list.
    See
    type summary
    ​AbstractMySQLPlatform::createReservedKeywordsList() ​
    ​AbstractPlatform::createReservedKeywordsList() ​

    [m] getDropTemporaryTableSQL Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction. 
    public function getDropTemporaryTableSQL(Doctrine\DBAL\Schema\Table|string $table): string

    MySQL commits a transaction implicitly when DROP TABLE is executed, however not if DROP TEMPORARY TABLE is executed.

    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDropTemporaryTableSQL() ​Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    [m] getBlobTypeDeclarationSQL Gets the SQL Snippet used to declare a BLOB column type.

    Gets the SQL Snippet used to declare a BLOB column type. 
    public function getBlobTypeDeclarationSQL(array|mixed[] $column): string
    TINYBLOB   : 2 ^  8 - 1 = 255
BLOB       : 2 ^ 16 - 1 = 65535
MEDIUMBLOB : 2 ^ 24 - 1 = 16777215
LONGBLOB   : 2 ^ 32 - 1 = 4294967295

    Returns the SQL Snippet used to declare a BLOB column type.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBlobTypeDeclarationSQL() ​Gets the SQL Snippet used to declare a BLOB column type.

    [m] quoteStringLiteral <tag_inheritdoc data-type='' data-description=''>Quotes a literal string.

    Quotes a literal string. 
    public function quoteStringLiteral(string $str): string

    This method is NOT meant to fix SQL injections! It is only meant to escape this platform's string literal quote character inside the given literal string.

    Parameter
    type name summary
    ​string ​$str ​The literal string to be quoted.
    Return
    type summary
    ​string ​The quoted literal string.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::quoteStringLiteral() ​<tag_inheritdoc data-type='' data-description=''>Quotes a literal string.

    [m] getDefaultTransactionIsolationLevel Gets the default transaction isolation level of the platform.

    Gets the default transaction isolation level of the platform. 
    public function getDefaultTransactionIsolationLevel(): Doctrine\DBAL\TransactionIsolationLevel::*()
    Return
    type summary
    ​TransactionIsolationLevel::*() ​The default isolation level.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDefaultTransactionIsolationLevel() ​Gets the default transaction isolation level of the platform.
    See
    type summary
    ​TransactionIsolationLevel ​

    [m] supportsColumnLengthIndexes Whether the platform supports indexes with column length definitions.

    Whether the platform supports indexes with column length definitions. 
    public function supportsColumnLengthIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::supportsColumnLengthIndexes() ​Whether the platform supports indexes with column length definitions.

    [m] getDatabaseNameSQL

    deprecated 

    protected function getDatabaseNameSQL(?string $databaseName): string
    Parameter
    type name summary
    ​?string ​$databaseName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDatabaseNameSQL() ​

    [m] createSchemaManager Creates the schema manager that can be used to inspect and change the underlying

    Creates the schema manager that can be used to inspect and change the underlying 
    public function createSchemaManager(Doctrine\DBAL\Connection $connection): Doctrine\DBAL\Schema\MySQLSchemaManager

    database schema according to the dialect of the platform.

    Parameter
    type name summary
    ​Connection ​$connection ​
    Return
    type summary
    ​MySQLSchemaManager ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::createSchemaManager() ​Creates the schema manager that can be used to inspect and change the underlying

    [m] fetchTableOptionsByTable 

    public function fetchTableOptionsByTable(bool $includeTableName): string
    Parameter
    type name summary
    ​bool ​$includeTableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::fetchTableOptionsByTable() ​

    [m] setDisableTypeComments

    final

    final public function setDisableTypeComments(bool $value)
    Parameter
    type name summary
    ​bool ​$value ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setDisableTypeComments() ​

    [m] setEventManager Sets the EventManager used by the Platform.

    deprecated

    Sets the EventManager used by the Platform. 
    public function setEventManager(Doctrine\Common\EventManager $eventManager): void
    Parameter
    type name summary
    ​EventManager ​$eventManager ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setEventManager() ​Sets the EventManager used by the Platform.

    [m] getEventManager Gets the EventManager used by the Platform.

    deprecated

    Gets the EventManager used by the Platform. 
    public function getEventManager(): Doctrine\Common\EventManager|null
    Return
    type summary
    ​EventManager|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEventManager() ​Gets the EventManager used by the Platform.

    [m] getAsciiStringTypeDeclarationSQL Returns the SQL snippet used to declare a column that can

    Returns the SQL snippet used to declare a column that can 
    public function getAsciiStringTypeDeclarationSQL(array|mixed[] $column): string

    store characters in the ASCII character set

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAsciiStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a column that can

    [m] getVarcharTypeDeclarationSQL Returns the SQL snippet used to declare a VARCHAR column type.

    deprecated

    Returns the SQL snippet used to declare a VARCHAR column type. 
    public function getVarcharTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharTypeDeclarationSQL() ​Returns the SQL snippet used to declare a VARCHAR column type.

    [m] getStringTypeDeclarationSQL Returns the SQL snippet used to declare a string column type.

    Returns the SQL snippet used to declare a string column type. 
    public function getStringTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a string column type.

    [m] getBinaryTypeDeclarationSQL Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    public function getBinaryTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryTypeDeclarationSQL() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getGuidTypeDeclarationSQL Returns the SQL snippet to declare a GUID/UUID column.

    Returns the SQL snippet to declare a GUID/UUID column. 
    public function getGuidTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CHAR(36) and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getGuidTypeDeclarationSQL() ​Returns the SQL snippet to declare a GUID/UUID column.

    [m] getJsonTypeDeclarationSQL Returns the SQL snippet to declare a JSON column.

    Returns the SQL snippet to declare a JSON column. 
    public function getJsonTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CLOB and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getJsonTypeDeclarationSQL() ​Returns the SQL snippet to declare a JSON column.

    [m] registerDoctrineTypeMapping Registers a doctrine type to be used in conjunction with a column type of this platform.

    Registers a doctrine type to be used in conjunction with a column type of this platform. 
    public function registerDoctrineTypeMapping(
    string $dbType,
    string $doctrineType
): void
    Parameter
    type name summary
    ​string ​$dbType ​
    ​string ​$doctrineType ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​If the type is not found.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::registerDoctrineTypeMapping() ​Registers a doctrine type to be used in conjunction with a column type of this platform.

    [m] getDoctrineTypeMapping Gets the Doctrine type that is mapped for the given database column type.

    Gets the Doctrine type that is mapped for the given database column type. 
    public function getDoctrineTypeMapping(string $dbType): string
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeMapping() ​Gets the Doctrine type that is mapped for the given database column type.

    [m] hasDoctrineTypeMappingFor Checks if a database type is currently supported by this platform.

    Checks if a database type is currently supported by this platform. 
    public function hasDoctrineTypeMappingFor(string $dbType): bool
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasDoctrineTypeMappingFor() ​Checks if a database type is currently supported by this platform.

    [m] initializeCommentedDoctrineTypes Initializes the Doctrine Type comments instance variable for in_array() checks.

    deprecated

    Initializes the Doctrine Type comments instance variable for in_array() checks. 
    protected function initializeCommentedDoctrineTypes(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::initializeCommentedDoctrineTypes() ​Initializes the Doctrine Type comments instance variable for in_array() checks.

    [m] isCommentedDoctrineType Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    deprecated

    Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type? 
    public function isCommentedDoctrineType(Doctrine\DBAL\Types\Type $doctrineType): bool
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::isCommentedDoctrineType() ​Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    [m] markDoctrineTypeCommented Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements. 
    public function markDoctrineTypeCommented(string|Doctrine\DBAL\Types\Type $doctrineType): void
    Parameter
    type name summary
    ​string|​Type ​$doctrineType ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::markDoctrineTypeCommented() ​Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    [m] getDoctrineTypeComment Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    deprecated

    Gets the comment to append to a column comment that helps parsing this type in reverse engineering. 
    public function getDoctrineTypeComment(Doctrine\DBAL\Types\Type $doctrineType): string
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeComment() ​Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    [m] getColumnComment Gets the comment of a passed column modified by potential doctrine type comment hints.

    deprecated

    Gets the comment of a passed column modified by potential doctrine type comment hints. 
    protected function getColumnComment(Doctrine\DBAL\Schema\Column $column): string|null
    Parameter
    type name summary
    ​Column ​$column ​
    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnComment() ​Gets the comment of a passed column modified by potential doctrine type comment hints.

    [m] getSqlCommentStartString Gets the string portion that starts an SQL comment.

    deprecated

    Gets the string portion that starts an SQL comment. 
    public function getSqlCommentStartString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentStartString() ​Gets the string portion that starts an SQL comment.

    [m] getSqlCommentEndString Gets the string portion that ends an SQL comment.

    deprecated

    Gets the string portion that ends an SQL comment. 
    public function getSqlCommentEndString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentEndString() ​Gets the string portion that ends an SQL comment.

    [m] getCharMaxLength Gets the maximum length of a char column.

    deprecated

    Gets the maximum length of a char column. 
    public function getCharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCharMaxLength() ​Gets the maximum length of a char column.

    [m] getVarcharDefaultLength Gets the default length of a varchar column.

    deprecated

    Gets the default length of a varchar column. 
    public function getVarcharDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharDefaultLength() ​Gets the default length of a varchar column.

    [m] getBinaryDefaultLength Gets the default length of a binary column.

    deprecated

    Gets the default length of a binary column. 
    public function getBinaryDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryDefaultLength() ​Gets the default length of a binary column.

    [m] getWildcards Gets all SQL wildcard characters of the platform.

    deprecated

    Gets all SQL wildcard characters of the platform. 
    public function getWildcards(): string[]
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWildcards() ​Gets all SQL wildcard characters of the platform.
    See
    type summary
    ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] getAvgExpression Returns the SQL snippet to get the average value of a column.

    deprecated

    Returns the SQL snippet to get the average value of a column. 
    public function getAvgExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an AVG aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAvgExpression() ​Returns the SQL snippet to get the average value of a column.

    [m] getCountExpression Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    deprecated

    Returns the SQL snippet to get the number of rows (without a NULL value) of a column. 
    public function getCountExpression(string|int $column): string

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

    Parameter
    type name summary
    ​string|​int ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a COUNT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCountExpression() ​Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    [m] getMaxExpression Returns the SQL snippet to get the highest value of a column.

    deprecated

    Returns the SQL snippet to get the highest value of a column. 
    public function getMaxExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MAX aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxExpression() ​Returns the SQL snippet to get the highest value of a column.

    [m] getMinExpression Returns the SQL snippet to get the lowest value of a column.

    deprecated

    Returns the SQL snippet to get the lowest value of a column. 
    public function getMinExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MIN aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMinExpression() ​Returns the SQL snippet to get the lowest value of a column.

    [m] getSumExpression Returns the SQL snippet to get the total sum of a column.

    deprecated

    Returns the SQL snippet to get the total sum of a column. 
    public function getSumExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a SUM aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSumExpression() ​Returns the SQL snippet to get the total sum of a column.

    [m] getMd5Expression Returns the SQL snippet to get the md5 sum of a column.

    deprecated

    Returns the SQL snippet to get the md5 sum of a column. 
    public function getMd5Expression(string $column): string

    Note: Not SQL92, but common functionality.

    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMd5Expression() ​Returns the SQL snippet to get the md5 sum of a column.

    [m] getSqrtExpression Returns the SQL snippet to get the squared value of a column.

    deprecated

    Returns the SQL snippet to get the squared value of a column. 
    public function getSqrtExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an SQRT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqrtExpression() ​Returns the SQL snippet to get the squared value of a column.

    [m] getRoundExpression Returns the SQL snippet to round a numeric column to the number of decimals specified.

    deprecated

    Returns the SQL snippet to round a numeric column to the number of decimals specified. 
    public function getRoundExpression(
    string $column,
    string|int $decimals = 0
): string
    Parameter
    type name summary
    ​string ​$column ​
    ​string|​int ​$decimals = 0 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRoundExpression() ​Returns the SQL snippet to round a numeric column to the number of decimals specified.

    [m] getModExpression Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2. 
    public function getModExpression(
    string $expression1,
    string $expression2
): string
    Parameter
    type name summary
    ​string ​$expression1 ​
    ​string ​$expression2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getModExpression() ​Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    [m] getTrimExpression Returns the SQL snippet to trim a string.

    Returns the SQL snippet to trim a string. 
    public function getTrimExpression(
    string $str,
    int $mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED,
    string|bool $char = false
): string
    Parameter
    type name summary
    ​string ​$str ​The expression to apply the trim to.
    ​int ​$mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED ​The position of the trim (leading/trailing/both).
    ​string|​bool ​$char = false ​The char to trim, has to be quoted already. Defaults to space.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTrimExpression() ​Returns the SQL snippet to trim a string.

    [m] getRtrimExpression Returns the SQL snippet to trim trailing space characters from the expression.

    deprecated

    Returns the SQL snippet to trim trailing space characters from the expression. 
    public function getRtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRtrimExpression() ​Returns the SQL snippet to trim trailing space characters from the expression.

    [m] getLtrimExpression Returns the SQL snippet to trim leading space characters from the expression.

    deprecated

    Returns the SQL snippet to trim leading space characters from the expression. 
    public function getLtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLtrimExpression() ​Returns the SQL snippet to trim leading space characters from the expression.

    [m] getUpperExpression Returns the SQL snippet to change all characters from the expression to uppercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to uppercase, 
    public function getUpperExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUpperExpression() ​Returns the SQL snippet to change all characters from the expression to uppercase,

    [m] getLowerExpression Returns the SQL snippet to change all characters from the expression to lowercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to lowercase, 
    public function getLowerExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLowerExpression() ​Returns the SQL snippet to change all characters from the expression to lowercase,

    [m] getNowExpression Returns the SQL snippet to get the current system date.

    deprecated

    Returns the SQL snippet to get the current system date. 
    public function getNowExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getNowExpression() ​Returns the SQL snippet to get the current system date.

    [m] getSubstringExpression Returns a SQL snippet to get a substring inside an SQL statement.

    Returns a SQL snippet to get a substring inside an SQL statement. 
    public function getSubstringExpression(
    string $string,
    string|int $start,
    string|int|null $length = null
): string

    Note: Not SQL92, but common functionality.

    SQLite only supports the 2 parameter variant of this function.

    Parameter
    type name summary
    ​string ​$string ​An sql string literal or column name/alias.
    ​string|​int ​$start ​Where to start the substring portion.
    ​string|​int|​null ​$length = null ​The substring portion length.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSubstringExpression() ​Returns a SQL snippet to get a substring inside an SQL statement.

    [m] getNotExpression Returns the SQL for a logical not.

    deprecated

    Returns the SQL for a logical not. 
    public function getNotExpression(string $expression): string

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

    Parameter
    type name summary
    ​string ​$expression ​
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getNotExpression() ​Returns the SQL for a logical not.

    [m] getIsNullExpression Returns the SQL that checks if an expression is null.

    deprecated

    Returns the SQL that checks if an expression is null. 
    public function getIsNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNullExpression() ​Returns the SQL that checks if an expression is null.

    [m] getIsNotNullExpression Returns the SQL that checks if an expression is not null.

    deprecated

    Returns the SQL that checks if an expression is not null. 
    public function getIsNotNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNotNullExpression() ​Returns the SQL that checks if an expression is not null.

    [m] getBetweenExpression Returns the SQL that checks if an expression evaluates to a value between two values.

    deprecated

    Returns the SQL that checks if an expression evaluates to a value between two values. 
    public function getBetweenExpression(
    string $expression,
    string $value1,
    string $value2
): string

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

    Parameter
    type name summary
    ​string ​$expression ​The value to compare to.
    ​string ​$value1 ​The lower value to compare with.
    ​string ​$value2 ​The higher value to compare with.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBetweenExpression() ​Returns the SQL that checks if an expression evaluates to a value between two values.

    [m] getAcosExpression Returns the SQL to get the arccosine of a value.

    deprecated

    Returns the SQL to get the arccosine of a value. 
    public function getAcosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAcosExpression() ​Returns the SQL to get the arccosine of a value.

    [m] getSinExpression Returns the SQL to get the sine of a value.

    deprecated

    Returns the SQL to get the sine of a value. 
    public function getSinExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSinExpression() ​Returns the SQL to get the sine of a value.

    [m] getPiExpression Returns the SQL to get the PI value.

    deprecated

    Returns the SQL to get the PI value. 
    public function getPiExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPiExpression() ​Returns the SQL to get the PI value.

    [m] getCosExpression Returns the SQL to get the cosine of a value.

    deprecated

    Returns the SQL to get the cosine of a value. 
    public function getCosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCosExpression() ​Returns the SQL to get the cosine of a value.

    [m] getDateAddSecondsExpression Returns the SQL to add the number of given seconds to a date.

    Returns the SQL to add the number of given seconds to a date. 
    public function getDateAddSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddSecondsExpression() ​Returns the SQL to add the number of given seconds to a date.

    [m] getDateSubSecondsExpression Returns the SQL to subtract the number of given seconds from a date.

    Returns the SQL to subtract the number of given seconds from a date. 
    public function getDateSubSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubSecondsExpression() ​Returns the SQL to subtract the number of given seconds from a date.

    [m] getDateAddMinutesExpression Returns the SQL to add the number of given minutes to a date.

    Returns the SQL to add the number of given minutes to a date. 
    public function getDateAddMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMinutesExpression() ​Returns the SQL to add the number of given minutes to a date.

    [m] getDateSubMinutesExpression Returns the SQL to subtract the number of given minutes from a date.

    Returns the SQL to subtract the number of given minutes from a date. 
    public function getDateSubMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMinutesExpression() ​Returns the SQL to subtract the number of given minutes from a date.

    [m] getDateAddHourExpression Returns the SQL to add the number of given hours to a date.

    Returns the SQL to add the number of given hours to a date. 
    public function getDateAddHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddHourExpression() ​Returns the SQL to add the number of given hours to a date.

    [m] getDateSubHourExpression Returns the SQL to subtract the number of given hours to a date.

    Returns the SQL to subtract the number of given hours to a date. 
    public function getDateSubHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubHourExpression() ​Returns the SQL to subtract the number of given hours to a date.

    [m] getDateAddDaysExpression Returns the SQL to add the number of given days to a date.

    Returns the SQL to add the number of given days to a date. 
    public function getDateAddDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddDaysExpression() ​Returns the SQL to add the number of given days to a date.

    [m] getDateSubDaysExpression Returns the SQL to subtract the number of given days to a date.

    Returns the SQL to subtract the number of given days to a date. 
    public function getDateSubDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubDaysExpression() ​Returns the SQL to subtract the number of given days to a date.

    [m] getDateAddWeeksExpression Returns the SQL to add the number of given weeks to a date.

    Returns the SQL to add the number of given weeks to a date. 
    public function getDateAddWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddWeeksExpression() ​Returns the SQL to add the number of given weeks to a date.

    [m] getDateSubWeeksExpression Returns the SQL to subtract the number of given weeks from a date.

    Returns the SQL to subtract the number of given weeks from a date. 
    public function getDateSubWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubWeeksExpression() ​Returns the SQL to subtract the number of given weeks from a date.

    [m] getDateAddMonthExpression Returns the SQL to add the number of given months to a date.

    Returns the SQL to add the number of given months to a date. 
    public function getDateAddMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMonthExpression() ​Returns the SQL to add the number of given months to a date.

    [m] getDateSubMonthExpression Returns the SQL to subtract the number of given months to a date.

    Returns the SQL to subtract the number of given months to a date. 
    public function getDateSubMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMonthExpression() ​Returns the SQL to subtract the number of given months to a date.

    [m] getDateAddQuartersExpression Returns the SQL to add the number of given quarters to a date.

    Returns the SQL to add the number of given quarters to a date. 
    public function getDateAddQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddQuartersExpression() ​Returns the SQL to add the number of given quarters to a date.

    [m] getDateSubQuartersExpression Returns the SQL to subtract the number of given quarters from a date.

    Returns the SQL to subtract the number of given quarters from a date. 
    public function getDateSubQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubQuartersExpression() ​Returns the SQL to subtract the number of given quarters from a date.

    [m] getDateAddYearsExpression Returns the SQL to add the number of given years to a date.

    Returns the SQL to add the number of given years to a date. 
    public function getDateAddYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddYearsExpression() ​Returns the SQL to add the number of given years to a date.

    [m] getDateSubYearsExpression Returns the SQL to subtract the number of given years from a date.

    Returns the SQL to subtract the number of given years from a date. 
    public function getDateSubYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubYearsExpression() ​Returns the SQL to subtract the number of given years from a date.

    [m] multiplyInterval Generates the SQL expression which represents the given date interval multiplied by a number

    Generates the SQL expression which represents the given date interval multiplied by a number 
    protected function multiplyInterval(
    string $interval,
    int $multiplier
): string
    Parameter
    type name summary
    ​string ​$interval ​SQL expression describing the interval value
    ​int ​$multiplier ​Interval multiplier
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::multiplyInterval() ​Generates the SQL expression which represents the given date interval multiplied by a number

    [m] getBitAndComparisonExpression Returns the SQL bit AND comparison expression.

    Returns the SQL bit AND comparison expression. 
    public function getBitAndComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitAndComparisonExpression() ​Returns the SQL bit AND comparison expression.

    [m] getBitOrComparisonExpression Returns the SQL bit OR comparison expression.

    Returns the SQL bit OR comparison expression. 
    public function getBitOrComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitOrComparisonExpression() ​Returns the SQL bit OR comparison expression.

    [m] getForUpdateSQL Returns the FOR UPDATE expression.

    deprecated

    Returns the FOR UPDATE expression. 
    public function getForUpdateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForUpdateSQL() ​Returns the FOR UPDATE expression.

    [m] appendLockHint Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    Honors that some SQL vendors such as MsSql use table hints for locking instead of the 
    public function appendLockHint(
    string $fromClause,
    int $lockMode
): string

    ANSI SQL FOR UPDATE specification.

    Parameter
    type name summary
    ​string ​$fromClause ​The FROM clause to append the hint for the given lock mode to
    ​int ​$lockMode ​One of the Doctrine\DBAL\LockMode::* constants
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::appendLockHint() ​Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    [m] getWriteLockSQL Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows. 
    public function getWriteLockSQL(): string

    The semantics of this lock mode should equal the SELECT .. FOR UPDATE of the ANSI SQL standard.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWriteLockSQL() ​Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    [m] getDropTableSQL Returns the SQL snippet to drop an existing table.

    Returns the SQL snippet to drop an existing table. 
    public function getDropTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTableSQL() ​Returns the SQL snippet to drop an existing table.

    [m] getDropConstraintSQL Returns the SQL to drop a constraint.

    Returns the SQL to drop a constraint. 
    public function getDropConstraintSQL(
    Doctrine\DBAL\Schema\Constraint|string $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint|​string ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropConstraintSQL() ​Returns the SQL to drop a constraint.
    See
    type summary
    ​AbstractPlatform ​

    [m] getDropForeignKeySQL Returns the SQL to drop a foreign key.

    Returns the SQL to drop a foreign key. 
    public function getDropForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropForeignKeySQL() ​Returns the SQL to drop a foreign key.

    [m] getCreateTableSQL Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    Returns the SQL statement(s) to create a table with the specified name, columns and constraints 
    public function getCreateTableSQL(
    Doctrine\DBAL\Schema\Table $table,
    int $createFlags = self::CREATE_INDEXES
): list

    on this platform.

    Parameter
    type name summary
    ​Table ​$table ​
    ​int ​$createFlags = self::CREATE_INDEXES ​
    Return
    type summary
    ​list ​The list of SQL statements.
    Throws
    type summary
    ​Exception ​
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableSQL() ​Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    [m] getCreateTableWithoutForeignKeysSQL

    final

    final protected function getCreateTableWithoutForeignKeysSQL(Doctrine\DBAL\Schema\Table $table): array|list
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableWithoutForeignKeysSQL() ​

    [m] getDropTablesSQL 

    public function getDropTablesSQL(array|list $tables): array|list
    Parameter
    type name summary
    ​array|​list ​$tables ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTablesSQL() ​

    [m] getCommentOnTableSQL 

    protected function getCommentOnTableSQL(
    string $tableName,
    ?string $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​?string ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnTableSQL() ​

    [m] getCommentOnColumnSQL 

    public function getCommentOnColumnSQL(
    string $tableName,
    string $columnName,
    string|null $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    ​string|​null ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnColumnSQL() ​

    [m] getInlineColumnCommentSQL Returns the SQL to create inline comment on a column.

    Returns the SQL to create inline comment on a column. 
    public function getInlineColumnCommentSQL(string $comment): string
    Parameter
    type name summary
    ​string ​$comment ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getInlineColumnCommentSQL() ​Returns the SQL to create inline comment on a column.

    [m] getCreateTemporaryTableSnippetSQL 

    public function getCreateTemporaryTableSnippetSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTemporaryTableSnippetSQL() ​

    [m] getAlterSchemaSQL Generates SQL statements that can be used to apply the diff.

    Generates SQL statements that can be used to apply the diff. 
    public function getAlterSchemaSQL(Doctrine\DBAL\Schema\SchemaDiff $diff): array|list
    Parameter
    type name summary
    ​SchemaDiff ​$diff ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAlterSchemaSQL() ​Generates SQL statements that can be used to apply the diff.

    [m] getCreateSequenceSQL Returns the SQL to create a sequence on this platform.

    Returns the SQL to create a sequence on this platform. 
    public function getCreateSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateSequenceSQL() ​Returns the SQL to create a sequence on this platform.

    [m] getAlterSequenceSQL Returns the SQL to change a sequence on this platform.

    Returns the SQL to change a sequence on this platform. 
    public function getAlterSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAlterSequenceSQL() ​Returns the SQL to change a sequence on this platform.

    [m] getDropSequenceSQL Returns the SQL snippet to drop an existing sequence.

    Returns the SQL snippet to drop an existing sequence. 
    public function getDropSequenceSQL(Doctrine\DBAL\Schema\Sequence|string $sequence): string
    Parameter
    type name summary
    ​Sequence|​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSequenceSQL() ​Returns the SQL snippet to drop an existing sequence.

    [m] getCreateConstraintSQL Returns the SQL to create a constraint on a table on this platform.

    deprecated

    Returns the SQL to create a constraint on a table on this platform. 
    public function getCreateConstraintSQL(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateConstraintSQL() ​Returns the SQL to create a constraint on a table on this platform.
    See
    type summary
    ​AbstractPlatform::getCreateIndexSQL() ​
    ​AbstractPlatform::getCreateForeignKeySQL() ​

    [m] getCreateIndexSQL Returns the SQL to create an index on a table on this platform.

    Returns the SQL to create an index on a table on this platform. 
    public function getCreateIndexSQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateIndexSQL() ​Returns the SQL to create an index on a table on this platform.

    [m] getPartialIndexSQL Adds condition for partial index.

    Adds condition for partial index. 
    protected function getPartialIndexSQL(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPartialIndexSQL() ​Adds condition for partial index.

    [m] getCreatePrimaryKeySQL Returns the SQL to create an unnamed primary key constraint.

    Returns the SQL to create an unnamed primary key constraint. 
    public function getCreatePrimaryKeySQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreatePrimaryKeySQL() ​Returns the SQL to create an unnamed primary key constraint.

    [m] getCreateSchemaSQL Returns the SQL to create a named schema.

    Returns the SQL to create a named schema. 
    public function getCreateSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateSchemaSQL() ​Returns the SQL to create a named schema.

    [m] getCreateUniqueConstraintSQL Returns the SQL to create a unique constraint on a table on this platform.

    Returns the SQL to create a unique constraint on a table on this platform. 
    public function getCreateUniqueConstraintSQL(
    Doctrine\DBAL\Schema\UniqueConstraint $constraint,
    string $tableName
): string
    Parameter
    type name summary
    ​UniqueConstraint ​$constraint ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateUniqueConstraintSQL() ​Returns the SQL to create a unique constraint on a table on this platform.

    [m] getDropSchemaSQL Returns the SQL snippet to drop a schema.

    Returns the SQL snippet to drop a schema. 
    public function getDropSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSchemaSQL() ​Returns the SQL snippet to drop a schema.

    [m] quoteIdentifier Quotes a string so that it can be safely used as a table or column name,

    Quotes a string so that it can be safely used as a table or column name, 
    public function quoteIdentifier(string $str): string

    even if it is a reserved word of the platform. This also detects identifier chains separated by dot and quotes them independently.

    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.

    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteIdentifier() ​Quotes a string so that it can be safely used as a table or column name,

    [m] quoteSingleIdentifier Quotes a single identifier (no dot chain separation).

    Quotes a single identifier (no dot chain separation). 
    public function quoteSingleIdentifier(string $str): string
    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteSingleIdentifier() ​Quotes a single identifier (no dot chain separation).

    [m] getCreateForeignKeySQL Returns the SQL to create a new foreign key.

    Returns the SQL to create a new foreign key. 
    public function getCreateForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key constraint.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateForeignKeySQL() ​Returns the SQL to create a new foreign key.

    [m] getRenameTableSQL 

    public function getRenameTableSQL(
    string $oldName,
    string $newName
): array|list
    Parameter
    type name summary
    ​string ​$oldName ​
    ​string ​$newName ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRenameTableSQL() ​

    [m] onSchemaAlterTableAddColumn 

    protected function onSchemaAlterTableAddColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    mixed[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​mixed[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableAddColumn() ​

    [m] onSchemaAlterTableRemoveColumn 

    protected function onSchemaAlterTableRemoveColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRemoveColumn() ​

    [m] onSchemaAlterTableChangeColumn 

    protected function onSchemaAlterTableChangeColumn(
    Doctrine\DBAL\Schema\ColumnDiff $columnDiff,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​ColumnDiff ​$columnDiff ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableChangeColumn() ​

    [m] onSchemaAlterTableRenameColumn 

    protected function onSchemaAlterTableRenameColumn(
    string $oldColumnName,
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​string ​$oldColumnName ​
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRenameColumn() ​

    [m] onSchemaAlterTable 

    protected function onSchemaAlterTable(
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$sql
): bool
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    ​string[] ​&$sql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTable() ​

    [m] getRenameIndexSQL Returns the SQL for renaming an index on a table.

    Returns the SQL for renaming an index on a table. 
    protected function getRenameIndexSQL(
    string $oldIndexName,
    Doctrine\DBAL\Schema\Index $index,
    string $tableName
): string[]
    Parameter
    type name summary
    ​string ​$oldIndexName ​The name of the index to rename from.
    ​Index ​$index ​The definition of the index to rename to.
    ​string ​$tableName ​The table to rename the given index on.
    Return
    type summary
    ​string[] ​The sequence of SQL statements for renaming the given index.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRenameIndexSQL() ​Returns the SQL for renaming an index on a table.

    [m] getColumnDeclarationListSQL Gets declaration of a number of columns in bulk.

    Gets declaration of a number of columns in bulk. 
    public function getColumnDeclarationListSQL(array|mixed[][] $columns): string
    Parameter
    type name summary
    ​array|​mixed[][] ​$columns ​A multidimensional associative array.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationListSQL() ​Gets declaration of a number of columns in bulk.

    [m] getColumnDeclarationSQL Obtains DBMS specific SQL code portion needed to declare a generic type

    Obtains DBMS specific SQL code portion needed to declare a generic type 
    public function getColumnDeclarationSQL(
    string $name,
    array|mixed[] $column
): string

    column to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name the column to be declared.
    ​array|​mixed[] ​$column ​An associative array with the name of the properties
    Return
    type summary
    ​string ​DBMS specific SQL code portion that should be used to declare the column.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to declare a generic type

    [m] getCheckDeclarationSQL Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    Obtains DBMS specific SQL code portion needed to set a CHECK constraint 
    public function getCheckDeclarationSQL(array|string[]|mixed[][] $definition): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​string[]|​mixed[][] ​$definition ​The check definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a CHECK constraint.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCheckDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    [m] getUniqueConstraintDeclarationSQL Obtains DBMS specific SQL code portion needed to set a unique

    Obtains DBMS specific SQL code portion needed to set a unique 
    public function getUniqueConstraintDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\UniqueConstraint $constraint
): string

    constraint declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the unique constraint.
    ​UniqueConstraint ​$constraint ​The unique constraint definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a constraint.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueConstraintDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a unique

    [m] getIndexDeclarationSQL Obtains DBMS specific SQL code portion needed to set an index

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\Index $index
): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the index.
    ​Index ​$index ​The index definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set an index.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getCustomTypeDeclarationSQL Obtains SQL code portion needed to create a custom column,

    deprecated

    Obtains SQL code portion needed to create a custom column, 
    public function getCustomTypeDeclarationSQL(array|mixed[] $column): string

    e.g. when a column has the "columnDefinition" keyword. Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCustomTypeDeclarationSQL() ​Obtains SQL code portion needed to create a custom column,

    [m] getIndexFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexFieldDeclarationListSQL(Doctrine\DBAL\Schema\Index $index): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getColumnsFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getColumnsFieldDeclarationListSQL(array|mixed[] $columns): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$columns ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnsFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getTemporaryTableSQL Returns the required SQL string that fits between CREATE ... TABLE

    deprecated

    Returns the required SQL string that fits between CREATE ... TABLE 
    public function getTemporaryTableSQL(): string

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

    Return
    type summary
    ​string ​The string required to be placed between "CREATE" and "TABLE"
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableSQL() ​Returns the required SQL string that fits between CREATE ... TABLE

    [m] getTemporaryTableName Some vendors require temporary table names to be qualified specially.

    Some vendors require temporary table names to be qualified specially. 
    public function getTemporaryTableName(string $tableName): string
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableName() ​Some vendors require temporary table names to be qualified specially.

    [m] getForeignKeyDeclarationSQL Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyDeclarationSQL() ​Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getForeignKeyReferentialActionSQL Returns the given referential action in uppercase if valid, otherwise throws an exception.

    Returns the given referential action in uppercase if valid, otherwise throws an exception. 
    public function getForeignKeyReferentialActionSQL(string $action): string
    Parameter
    type name summary
    ​string ​$action ​The foreign key referential action.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​If unknown referential action given.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyReferentialActionSQL() ​Returns the given referential action in uppercase if valid, otherwise throws an exception.

    [m] getForeignKeyBaseDeclarationSQL Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyBaseDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyBaseDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getUniqueFieldDeclarationSQL Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    deprecated

    Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint 
    public function getUniqueFieldDeclarationSQL(): string

    of a column declaration to be used in statements like CREATE TABLE.

    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the UNIQUE constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueFieldDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    [m] getColumnCollationDeclarationSQL Obtains DBMS specific SQL code portion needed to set the COLLATION

    Obtains DBMS specific SQL code portion needed to set the COLLATION 
    public function getColumnCollationDeclarationSQL(string $collation): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$collation ​The name of the collation.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the COLLATION
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnCollationDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the COLLATION

    [m] convertBooleans Some platforms need the boolean values to be converted.

    Some platforms need the boolean values to be converted. 
    public function convertBooleans(mixed $item): mixed

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

    Note: if the input is not a boolean the original input might be returned.

    There are two contexts when converting booleans: Literals and Prepared Statements. This method should handle the literal case

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertBooleans() ​Some platforms need the boolean values to be converted.

    [m] convertFromBoolean Some platforms have boolean literals that needs to be correctly converted

    Some platforms have boolean literals that needs to be correctly converted 
    public function convertFromBoolean(T $item): (T

    The default conversion tries to convert value into bool "(bool)$item"

    Parameter
    type name summary
    ​T ​$item ​
    Return
    type summary
    ​(T ​is null ? null : bool)
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertFromBoolean() ​Some platforms have boolean literals that needs to be correctly converted

    [m] convertBooleansToDatabaseValue This method should handle the prepared statements case. When there is no

    This method should handle the prepared statements case. When there is no 
    public function convertBooleansToDatabaseValue(mixed $item): mixed

    distinction, it's OK to use the same method.

    Note: if the input is not a boolean the original input might be returned.

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertBooleansToDatabaseValue() ​This method should handle the prepared statements case. When there is no

    [m] getCurrentDateSQL Returns the SQL specific for the platform to get the current date.

    Returns the SQL specific for the platform to get the current date. 
    public function getCurrentDateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentDateSQL() ​Returns the SQL specific for the platform to get the current date.

    [m] getCurrentTimeSQL Returns the SQL specific for the platform to get the current time.

    Returns the SQL specific for the platform to get the current time. 
    public function getCurrentTimeSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimeSQL() ​Returns the SQL specific for the platform to get the current time.

    [m] getCurrentTimestampSQL Returns the SQL specific for the platform to get the current timestamp

    Returns the SQL specific for the platform to get the current timestamp 
    public function getCurrentTimestampSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimestampSQL() ​Returns the SQL specific for the platform to get the current timestamp

    [m] _getTransactionIsolationLevelSQL Returns the SQL for a given transaction isolation level Connection constant.

    Returns the SQL for a given transaction isolation level Connection constant. 
    protected function _getTransactionIsolationLevelSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::_getTransactionIsolationLevelSQL() ​Returns the SQL for a given transaction isolation level Connection constant.

    [m] getListNamespacesSQL Returns the SQL statement for retrieving the namespaces defined in the database.

    deprecated

    Returns the SQL statement for retrieving the namespaces defined in the database. 
    public function getListNamespacesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListNamespacesSQL() ​Returns the SQL statement for retrieving the namespaces defined in the database.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] getListSequencesSQL 

    public function getListSequencesSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListSequencesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​

    [m] getListUsersSQL

    deprecated 

    public function getListUsersSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListUsersSQL() ​

    [m] getCreateViewSQL 

    public function getCreateViewSQL(
    string $name,
    string $sql
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$sql ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateViewSQL() ​

    [m] getDropViewSQL 

    public function getDropViewSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropViewSQL() ​

    [m] getSequenceNextValSQL 

    public function getSequenceNextValSQL(string $sequence): string
    Parameter
    type name summary
    ​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSequenceNextValSQL() ​

    [m] getCreateDatabaseSQL Returns the SQL to create a new database.

    Returns the SQL to create a new database. 
    public function getCreateDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateDatabaseSQL() ​Returns the SQL to create a new database.

    [m] getDropDatabaseSQL Returns the SQL snippet to drop an existing database.

    Returns the SQL snippet to drop an existing database. 
    public function getDropDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be dropped.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropDatabaseSQL() ​Returns the SQL snippet to drop an existing database.

    [m] getDateTimeTzTypeDeclarationSQL Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    Obtains DBMS specific SQL to be used to create datetime with timezone offset columns. 
    public function getDateTimeTzTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeTzTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    [m] supportsSequences Whether the platform supports sequences.

    Whether the platform supports sequences. 
    public function supportsSequences(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSequences() ​Whether the platform supports sequences.

    [m] usesSequenceEmulatedIdentityColumns Whether the platform emulates identity columns through sequences.

    deprecated

    Whether the platform emulates identity columns through sequences. 
    public function usesSequenceEmulatedIdentityColumns(): bool

    Some platforms that do not support identity columns natively but support sequences can emulate identity columns by using sequences.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::usesSequenceEmulatedIdentityColumns() ​Whether the platform emulates identity columns through sequences.

    [m] getIdentitySequenceName Returns the name of the sequence for a particular identity column in a particular table.

    deprecated

    Returns the name of the sequence for a particular identity column in a particular table. 
    public function getIdentitySequenceName(
    string $tableName,
    string $columnName
): string
    Parameter
    type name summary
    ​string ​$tableName ​The name of the table to return the sequence name for.
    ​string ​$columnName ​The name of the identity column in the table to return the sequence name for.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIdentitySequenceName() ​Returns the name of the sequence for a particular identity column in a particular table.
    See
    type summary
    ​usesSequenceEmulatedIdentityColumns ​

    [m] supportsIndexes Whether the platform supports indexes.

    deprecated

    Whether the platform supports indexes. 
    public function supportsIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsIndexes() ​Whether the platform supports indexes.

    [m] supportsPartialIndexes Whether the platform supports partial indexes.

    Whether the platform supports partial indexes. 
    public function supportsPartialIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPartialIndexes() ​Whether the platform supports partial indexes.

    [m] supportsAlterTable Whether the platform supports altering tables.

    deprecated

    Whether the platform supports altering tables. 
    public function supportsAlterTable(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsAlterTable() ​Whether the platform supports altering tables.

    [m] supportsTransactions Whether the platform supports transactions.

    deprecated

    Whether the platform supports transactions. 
    public function supportsTransactions(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsTransactions() ​Whether the platform supports transactions.

    [m] supportsSavepoints Whether the platform supports savepoints.

    Whether the platform supports savepoints. 
    public function supportsSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSavepoints() ​Whether the platform supports savepoints.

    [m] supportsReleaseSavepoints Whether the platform supports releasing savepoints.

    Whether the platform supports releasing savepoints. 
    public function supportsReleaseSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsReleaseSavepoints() ​Whether the platform supports releasing savepoints.

    [m] supportsPrimaryConstraints Whether the platform supports primary key constraints.

    deprecated

    Whether the platform supports primary key constraints. 
    public function supportsPrimaryConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPrimaryConstraints() ​Whether the platform supports primary key constraints.

    [m] supportsForeignKeyConstraints Whether the platform supports foreign key constraints.

    deprecated

    Whether the platform supports foreign key constraints. 
    public function supportsForeignKeyConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsForeignKeyConstraints() ​Whether the platform supports foreign key constraints.

    [m] supportsSchemas Whether the platform supports database schemas.

    Whether the platform supports database schemas. 
    public function supportsSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSchemas() ​Whether the platform supports database schemas.

    [m] canEmulateSchemas Whether this platform can emulate schemas.

    deprecated

    Whether this platform can emulate schemas. 
    public function canEmulateSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::canEmulateSchemas() ​Whether this platform can emulate schemas.
    See
    type summary
    ​AbstractManager::introspectSchema() ​

    [m] getDefaultSchemaName Returns the default schema name.

    deprecated

    Returns the default schema name. 
    public function getDefaultSchemaName(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDefaultSchemaName() ​Returns the default schema name.

    [m] supportsCreateDropDatabase Whether this platform supports create database.

    deprecated

    Whether this platform supports create database. 
    public function supportsCreateDropDatabase(): bool

    Some databases don't allow to create and drop databases at all or only with certain tools.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsCreateDropDatabase() ​Whether this platform supports create database.

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

    deprecated

    Whether the platform supports getting the affected rows of a recent update/delete type query. 
    public function supportsGettingAffectedRows(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsGettingAffectedRows() ​Whether the platform supports getting the affected rows of a recent update/delete type query.

    [m] supportsCommentOnStatement Whether this platform support the proprietary syntax "COMMENT ON asset".

    Whether this platform support the proprietary syntax "COMMENT ON asset". 
    public function supportsCommentOnStatement(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsCommentOnStatement() ​Whether this platform support the proprietary syntax "COMMENT ON asset".

    [m] hasNativeGuidType Does this platform have native guid type.

    deprecated

    Does this platform have native guid type. 
    public function hasNativeGuidType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasNativeGuidType() ​Does this platform have native guid type.

    [m] hasNativeJsonType Does this platform have native JSON type.

    deprecated

    Does this platform have native JSON type. 
    public function hasNativeJsonType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasNativeJsonType() ​Does this platform have native JSON type.

    [m] supportsViews Whether this platform supports views.

    deprecated

    Whether this platform supports views. 
    public function supportsViews(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsViews() ​Whether this platform supports views.

    [m] getDateTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeFormatString(): string

    the format of a stored datetime value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateTimeTzFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeTzFormatString(): string

    the format of a stored datetime with timezone value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeTzFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateFormatString(): string

    the format of a stored date value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getTimeFormatString(): string

    the format of a stored time value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] modifyLimitQuery Adds an driver-specific LIMIT clause to the query.

    final

    Adds an driver-specific LIMIT clause to the query. 
    final public function modifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset = 0
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset = 0 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::modifyLimitQuery() ​Adds an driver-specific LIMIT clause to the query.

    [m] supportsLimitOffset Whether the database platform support offsets in modify limit clauses.

    deprecated

    Whether the database platform support offsets in modify limit clauses. 
    public function supportsLimitOffset(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsLimitOffset() ​Whether the database platform support offsets in modify limit clauses.

    [m] getMaxIdentifierLength Maximum length of any given database identifier, like tables or column names.

    Maximum length of any given database identifier, like tables or column names. 
    public function getMaxIdentifierLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxIdentifierLength() ​Maximum length of any given database identifier, like tables or column names.

    [m] getEmptyIdentityInsertSQL Returns the insert SQL for an empty insert statement.

    Returns the insert SQL for an empty insert statement. 
    public function getEmptyIdentityInsertSQL(
    string $quotedTableName,
    string $quotedIdentifierColumnName
): string
    Parameter
    type name summary
    ​string ​$quotedTableName ​
    ​string ​$quotedIdentifierColumnName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEmptyIdentityInsertSQL() ​Returns the insert SQL for an empty insert statement.

    [m] getTruncateTableSQL Generates a Truncate Table SQL statement for a given table.

    Generates a Truncate Table SQL statement for a given table. 
    public function getTruncateTableSQL(
    string $tableName,
    bool $cascade = false
): string

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

    Parameter
    type name summary
    ​string ​$tableName ​
    ​bool ​$cascade = false ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTruncateTableSQL() ​Generates a Truncate Table SQL statement for a given table.

    [m] getDummySelectSQL This is for test reasons, many vendors have special requirements for dummy statements.

    This is for test reasons, many vendors have special requirements for dummy statements. 
    public function getDummySelectSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDummySelectSQL() ​This is for test reasons, many vendors have special requirements for dummy statements.

    [m] createSavePoint Returns the SQL to create a new savepoint.

    Returns the SQL to create a new savepoint. 
    public function createSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSavePoint() ​Returns the SQL to create a new savepoint.

    [m] releaseSavePoint Returns the SQL to release a savepoint.

    Returns the SQL to release a savepoint. 
    public function releaseSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::releaseSavePoint() ​Returns the SQL to release a savepoint.

    [m] rollbackSavePoint Returns the SQL to rollback a savepoint.

    Returns the SQL to rollback a savepoint. 
    public function rollbackSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::rollbackSavePoint() ​Returns the SQL to rollback a savepoint.

    [m] getReservedKeywordsList Returns the keyword list instance of this platform.

    final

    Returns the keyword list instance of this platform. 
    final public function getReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList
    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​If no keyword list is specified.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getReservedKeywordsList() ​Returns the keyword list instance of this platform.

    [m] createReservedKeywordsList Creates an instance of the reserved keyword list of this platform.

    Creates an instance of the reserved keyword list of this platform. 
    protected function createReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList

    This method will become @abstract in DBAL 4.0.0.

    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createReservedKeywordsList() ​Creates an instance of the reserved keyword list of this platform.

    [m] getStringLiteralQuoteCharacter Gets the character used for string literal quoting.

    deprecated

    Gets the character used for string literal quoting. 
    public function getStringLiteralQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringLiteralQuoteCharacter() ​Gets the character used for string literal quoting.
    See
    type summary
    ​AbstractPlatform::quoteStringLiteral() ​

    [m] escapeStringForLike Escapes metacharacters in a string intended to be used with a LIKE

    final

    Escapes metacharacters in a string intended to be used with a LIKE 
    final public function escapeStringForLike(
    string $inputString,
    string $escapeChar
): string

    operator.

    Parameter
    type name summary
    ​string ​$inputString ​a literal, unquoted string
    ​string ​$escapeChar ​should be reused by the caller in the LIKE
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::escapeStringForLike() ​Escapes metacharacters in a string intended to be used with a LIKE

    [m] createSQLParser 

    public function createSQLParser(): Doctrine\DBAL\SQL\Parser
    Return
    type summary
    ​Parser ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSQLParser() ​

    [m] getLikeWildcardCharacters 

    protected function getLikeWildcardCharacters(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] columnsEqual Compares the definitions of the given columns in the context of this platform.

    Compares the definitions of the given columns in the context of this platform. 
    public function columnsEqual(
    Doctrine\DBAL\Schema\Column $column1,
    Doctrine\DBAL\Schema\Column $column2
): bool
    Parameter
    type name summary
    ​Column ​$column1 ​
    ​Column ​$column2 ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::columnsEqual() ​Compares the definitions of the given columns in the context of this platform.

    [C] AbstractMySQLPlatform Provides the base implementation for the lowest versions of supported MySQL-like database platforms.

    abstract

    Provides the base implementation for the lowest versions of supported MySQL-like database platforms.

    Hierarchy

    Parents
    type summary
    ​AbstractPlatform ​Base class for all DatabasePlatforms. The DatabasePlatforms are the central

    [C] LENGTH_LIMIT_TINYTEXT 

    public const int LENGTH_LIMIT_TINYTEXT = 255

    [C] LENGTH_LIMIT_TEXT 

    public const int LENGTH_LIMIT_TEXT = 65535

    [C] LENGTH_LIMIT_MEDIUMTEXT 

    public const int LENGTH_LIMIT_MEDIUMTEXT = 16777215

    [C] LENGTH_LIMIT_TINYBLOB 

    public const int LENGTH_LIMIT_TINYBLOB = 255

    [C] LENGTH_LIMIT_BLOB 

    public const int LENGTH_LIMIT_BLOB = 65535

    [C] LENGTH_LIMIT_MEDIUMBLOB 

    public const int LENGTH_LIMIT_MEDIUMBLOB = 16777215

    [C] CREATE_INDEXES 

    public const int CREATE_INDEXES = 1
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_INDEXES ​

    [C] CREATE_FOREIGNKEYS 

    public const int CREATE_FOREIGNKEYS = 2
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_FOREIGNKEYS ​

    [p] $doctrineTypeMapping 

    protected string[]|null $doctrineTypeMapping = null

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeMapping ​

    [p] $doctrineTypeComments Contains a list of all columns that should generate parseable column comments for type-detection

    deprecated

    Contains a list of all columns that should generate parseable column comments for type-detection 
    protected string[]|null $doctrineTypeComments = null

    in reverse engineering scenarios.

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeComments ​Contains a list of all columns that should generate parseable column comments for type-detection

    [p] $_eventManager

    deprecated 

    protected Doctrine\Common\EventManager|null $_eventManager = null

    Type: EventManager|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_eventManager ​

    [p] $_keywords Holds the KeywordList instance for the current platform.

    Holds the KeywordList instance for the current platform. 
    protected Doctrine\DBAL\Platforms\Keywords\KeywordList|null $_keywords = null

    Type: KeywordList|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_keywords ​Holds the KeywordList instance for the current platform.

    [m] doModifyLimitQuery Adds an platform-specific LIMIT clause to the query.

    Adds an platform-specific LIMIT clause to the query. 
    protected function doModifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::doModifyLimitQuery() ​Adds an platform-specific LIMIT clause to the query.

    [m] getIdentifierQuoteCharacter Gets the character used for identifier quoting.

    deprecated

    Gets the character used for identifier quoting. 
    public function getIdentifierQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getIdentifierQuoteCharacter() ​Gets the character used for identifier quoting.
    See
    type summary
    ​AbstractMySQLPlatform::quoteIdentifier() ​
    ​AbstractPlatform::quoteIdentifier() ​

    [m] getRegexpExpression Returns the regular expression operator.

    Returns the regular expression operator. 
    public function getRegexpExpression(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getRegexpExpression() ​Returns the regular expression operator.

    [m] getLocateExpression Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str. 
    public function getLocateExpression(
    string $str,
    string $substr,
    string|int|false $startPos = false
): string
    Parameter
    type name summary
    ​string ​$str ​Literal string.
    ​string ​$substr ​Literal string to find.
    ​string|​int|​false ​$startPos = false ​Position to start at, beginning of string by default.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getLocateExpression() ​Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    [m] getConcatExpression <tag_inheritdoc data-type='' data-description=''>Returns a SQL snippet to concatenate the given expressions.

    Returns a SQL snippet to concatenate the given expressions. 
    public function getConcatExpression(): string

    Accepts an arbitrary number of string parameters. Each parameter must contain an expression.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getConcatExpression() ​Returns a SQL snippet to concatenate the given expressions.

    [m] getDateArithmeticIntervalExpression Returns the SQL for a date arithmetic expression.

    Returns the SQL for a date arithmetic expression. 
    protected function getDateArithmeticIntervalExpression(
    string $date,
    string $operator,
    int|string $interval,
    string $unit
): string
    Parameter
    type name summary
    ​string ​$date ​The column or literal representing a date
    ​string ​$operator ​The arithmetic operator (+ or -).
    ​int|​string ​$interval ​The interval that shall be calculated into the date.
    ​string ​$unit ​The unit of the interval that shall be calculated into the date.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateArithmeticIntervalExpression() ​Returns the SQL for a date arithmetic expression.

    [m] getDateDiffExpression <tag_inheritdoc data-type='' data-description=''>Returns the SQL to calculate the difference in days between the two passed dates.

    Returns the SQL to calculate the difference in days between the two passed dates. 
    public function getDateDiffExpression(
    string $date1,
    string $date2
): string

    Computes diff = date1 - date2.

    Parameter
    type name summary
    ​string ​$date1 ​
    ​string ​$date2 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateDiffExpression() ​Returns the SQL to calculate the difference in days between the two passed dates.

    [m] getCurrentDatabaseExpression Returns the SQL expression which represents the currently selected database.

    Returns the SQL expression which represents the currently selected database. 
    public function getCurrentDatabaseExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCurrentDatabaseExpression() ​Returns the SQL expression which represents the currently selected database.

    [m] getLengthExpression Returns the SQL snippet to get the length of a text column in characters.

    Returns the SQL snippet to get the length of a text column in characters. 
    public function getLengthExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getLengthExpression() ​Returns the SQL snippet to get the length of a text column in characters.

    [m] getListDatabasesSQL 

    public function getListDatabasesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListDatabasesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getListTableConstraintsSQL

    deprecated 

    public function getListTableConstraintsSQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableConstraintsSQL() ​

    [m] getListTableIndexesSQL

    deprecated 

    public function getListTableIndexesSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableIndexesSQL() ​

    [m] getListViewsSQL Returns the SQL to list all views of a database or user.

    Returns the SQL to list all views of a database or user. 
    public function getListViewsSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListViewsSQL() ​Returns the SQL to list all views of a database or user.
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getListTableForeignKeysSQL

    deprecated 

    public function getListTableForeignKeysSQL(
    string $table,
    string|null $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableForeignKeysSQL() ​

    [m] getVarcharTypeDeclarationSQLSnippet 

    protected function getVarcharTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​
    ​bool ​$fixed ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getVarcharTypeDeclarationSQLSnippet() ​

    [m] getBinaryTypeDeclarationSQLSnippet Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    protected function getBinaryTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​The length of the column.
    ​bool ​$fixed ​Whether the column length is fixed.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBinaryTypeDeclarationSQLSnippet() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getClobTypeDeclarationSQL Gets the SQL snippet used to declare a CLOB column type.

    Gets the SQL snippet used to declare a CLOB column type. 
    public function getClobTypeDeclarationSQL(array|mixed[] $column): string
    TINYTEXT   : 2 ^  8 - 1 = 255
TEXT       : 2 ^ 16 - 1 = 65535
MEDIUMTEXT : 2 ^ 24 - 1 = 16777215
LONGTEXT   : 2 ^ 32 - 1 = 4294967295

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

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getClobTypeDeclarationSQL() ​Returns the SQL snippet used to declare a CLOB column type.

    [m] getDateTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create datetime columns in

    Obtains DBMS specific SQL to be used to create datetime columns in 
    public function getDateTimeTypeDeclarationSQL(array|mixed[] $column): string

    statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTimeTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create datetime columns in

    [m] getDateTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create date columns in statements

    Obtains DBMS specific SQL to be used to create date columns in statements 
    public function getDateTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create date columns in statements

    [m] getTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create time columns in statements

    Obtains DBMS specific SQL to be used to create time columns in statements 
    public function getTimeTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTimeTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create time columns in statements

    [m] getBooleanTypeDeclarationSQL Returns the SQL snippet that declares a boolean column.

    Returns the SQL snippet that declares a boolean column. 
    public function getBooleanTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBooleanTypeDeclarationSQL() ​Returns the SQL snippet that declares a boolean column.

    [m] prefersIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    deprecated

    Whether the platform prefers identity columns (eg. autoincrement) for ID generation. 
    public function prefersIdentityColumns(): bool

    Subclasses should override this method to return TRUE if they prefer identity columns.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::prefersIdentityColumns() ​Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    [m] supportsIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform supports identity columns.

    Whether the platform supports identity columns. 
    public function supportsIdentityColumns(): bool

    Identity columns are columns that receive an auto-generated value from the database on insert of a row.

    MySQL supports this through AUTO_INCREMENT columns.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsIdentityColumns() ​Whether the platform supports identity columns.

    [m] supportsInlineColumnComments Whether this platform support to add inline column comments as postfix.

    Whether this platform support to add inline column comments as postfix. 
    public function supportsInlineColumnComments(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsInlineColumnComments() ​Whether this platform support to add inline column comments as postfix.
    See
    type summary
    ​AbstractPlatform ​

    [m] supportsColumnCollation Does this platform support column collation?

    Does this platform support column collation? 
    public function supportsColumnCollation(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsColumnCollation() ​Does this platform support column collation?
    See
    type summary
    ​AbstractPlatform ​

    [m] getListTablesSQL

    deprecated 

    public function getListTablesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTablesSQL() ​

    [m] getListTableColumnsSQL

    deprecated 

    public function getListTableColumnsSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableColumnsSQL() ​

    [m] getColumnTypeSQLSnippets

    deprecated 

    public function getColumnTypeSQLSnippets(string $tableAlias = "c"): array
    Parameter
    type name summary
    ​string ​$tableAlias = "c" ​
    Return
    type summary
    ​array ​string}
    See
    type summary
    ​AbstractMySQLPlatform::getColumnTypeSQLSnippet() ​

    [m] getColumnTypeSQLSnippet The SQL snippet required to elucidate a column type

    The SQL snippet required to elucidate a column type 
    public function getColumnTypeSQLSnippet(
    string $tableAlias = "c",
    ?string $databaseName = null
): string

    Returns a column type SELECT snippet string

    Parameter
    type name summary
    ​string ​$tableAlias = "c" ​
    ​?string ​$databaseName = null ​
    Return
    type summary
    ​string ​

    [m] getListTableMetadataSQL

    deprecated 

    public function getListTableMetadataSQL(
    string $table,
    ?string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​?string ​$database = null ​
    Return
    type summary
    ​string ​

    [m] getCreateTablesSQL 

    public function getCreateTablesSQL(array|Doctrine\DBAL\Schema\Table[] $tables): array
    Parameter
    type name summary
    ​array|​Table[] ​$tables ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateTablesSQL() ​

    [m] _getCreateTableSQL Returns the SQL used to create a table.

    Returns the SQL used to create a table. 
    protected function _getCreateTableSQL(
    string $name,
    array|mixed[][] $columns,
    array|mixed[] $options = []
): string[]
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​mixed[][] ​$columns ​
    ​array|​mixed[] ​$options = [] ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::_getCreateTableSQL() ​Returns the SQL used to create a table.

    [m] createSelectSQLBuilder 

    public function createSelectSQLBuilder(): Doctrine\DBAL\SQL\Builder\SelectSQLBuilder
    Return
    type summary
    ​SelectSQLBuilder ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::createSelectSQLBuilder() ​

    [m] getDefaultValueDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set a default value

    Obtains DBMS specific SQL code portion needed to set a default value 
    public function getDefaultValueDeclarationSQL(mixed[] $column): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​mixed[] ​$column ​The column definition array.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a default value.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDefaultValueDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a default value
    See
    type summary
    ​AbstractPlatform ​

    [m] getAlterTableSQL <tag_inheritdoc data-type='' data-description=''>Gets the SQL statements for altering an existing table.

    Gets the SQL statements for altering an existing table. 
    public function getAlterTableSQL(Doctrine\DBAL\Schema\TableDiff $diff): list

    This method returns an array of SQL statements, since some platforms need several statements.

    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getAlterTableSQL() ​Gets the SQL statements for altering an existing table.

    [m] getPreAlterTableIndexForeignKeySQL 

    protected function getPreAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getPreAlterTableIndexForeignKeySQL() ​

    [m] getPreAlterTableRenameIndexForeignKeySQL 

    protected function getPreAlterTableRenameIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​The table diff to gather the SQL for.
    Return
    type summary
    ​string[] ​

    [m] getPostAlterTableIndexForeignKeySQL 

    protected function getPostAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getPostAlterTableIndexForeignKeySQL() ​

    [m] getPostAlterTableRenameIndexForeignKeySQL 

    protected function getPostAlterTableRenameIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​The table diff to gather the SQL for.
    Return
    type summary
    ​string[] ​

    [m] getCreateIndexSQLFlags Adds additional flags for index generation.

    Adds additional flags for index generation. 
    protected function getCreateIndexSQLFlags(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateIndexSQLFlags() ​Adds additional flags for index generation.

    [m] getIntegerTypeDeclarationSQL Returns the SQL snippet that declares a 4 byte integer column.

    Returns the SQL snippet that declares a 4 byte integer column. 
    public function getIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares a 4 byte integer column.

    [m] getBigIntTypeDeclarationSQL Returns the SQL snippet that declares an 8 byte integer column.

    Returns the SQL snippet that declares an 8 byte integer column. 
    public function getBigIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBigIntTypeDeclarationSQL() ​Returns the SQL snippet that declares an 8 byte integer column.

    [m] getSmallIntTypeDeclarationSQL Returns the SQL snippet that declares a 2 byte integer column.

    Returns the SQL snippet that declares a 2 byte integer column. 
    public function getSmallIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSmallIntTypeDeclarationSQL() ​Returns the SQL snippet that declares a 2 byte integer column.

    [m] getFloatDeclarationSQL 

    public function getFloatDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getFloatDeclarationSQL() ​

    [m] getDecimalTypeDeclarationSQL Returns the SQL snippet that declares a floating point column of arbitrary precision.

    Returns the SQL snippet that declares a floating point column of arbitrary precision. 
    public function getDecimalTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDecimalTypeDeclarationSQL() ​Returns the SQL snippet that declares a floating point column of arbitrary precision.

    [m] _getCommonIntegerTypeDeclarationSQL Returns the SQL snippet that declares common properties of an integer column.

    Returns the SQL snippet that declares common properties of an integer column. 
    protected function _getCommonIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::_getCommonIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares common properties of an integer column.

    [m] getColumnCharsetDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set the CHARACTER SET

    Obtains DBMS specific SQL code portion needed to set the CHARACTER SET 
    public function getColumnCharsetDeclarationSQL(string $charset): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$charset ​The name of the charset.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the CHARACTER SET
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getColumnCharsetDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the CHARACTER SET
    See
    type summary
    ​AbstractPlatform ​

    [m] getAdvancedForeignKeyOptionsSQL <tag_inheritdoc data-type='' data-description=''>Returns the FOREIGN KEY query section dealing with non-standard options

    Returns the FOREIGN KEY query section dealing with non-standard options 
    public function getAdvancedForeignKeyOptionsSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    as MATCH, INITIALLY DEFERRED, ON UPDATE, ...

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getAdvancedForeignKeyOptionsSQL() ​Returns the FOREIGN KEY query section dealing with non-standard options
    See
    type summary
    ​AbstractPlatform ​

    [m] getDropIndexSQL Returns the SQL to drop an index from a table.

    Returns the SQL to drop an index from a table. 
    public function getDropIndexSQL(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string|null $table = null
): string
    Parameter
    type name summary
    ​Index|​string ​$index ​
    ​Table|​string|​null ​$table = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDropIndexSQL() ​Returns the SQL to drop an index from a table.

    [m] getDropPrimaryKeySQL 

    protected function getDropPrimaryKeySQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​

    [m] getDropUniqueConstraintSQL The ALTER TABLE ... DROP CONSTRAINT syntax is only available as of MySQL 8.0.19.

    The ALTER TABLE ... DROP CONSTRAINT syntax is only available as of MySQL 8.0.19. 
    public function getDropUniqueConstraintSQL(
    string $name,
    string $tableName
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDropUniqueConstraintSQL() ​Returns the SQL to drop a unique constraint.

    [m] getSetTransactionIsolationSQL Returns the SQL to set the transaction isolation level.

    Returns the SQL to set the transaction isolation level. 
    public function getSetTransactionIsolationSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSetTransactionIsolationSQL() ​Returns the SQL to set the transaction isolation level.

    [m] getName Gets the name of the platform.

    deprecated

    Gets the name of the platform. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getName() ​Gets the name of the platform.

    [m] getReadLockSQL <tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock. 
    public function getReadLockSQL(): string

    This defaults to the ANSI SQL "FOR UPDATE", which is an exclusive lock (Write). Some database vendors allow to lighten this constraint up to be a real read lock.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getReadLockSQL() ​Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    [m] initializeDoctrineTypeMappings Lazy load Doctrine Type Mappings.

    Lazy load Doctrine Type Mappings. 
    protected function initializeDoctrineTypeMappings(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::initializeDoctrineTypeMappings() ​Lazy load Doctrine Type Mappings.

    [m] getVarcharMaxLength Gets the maximum length of a varchar column.

    deprecated

    Gets the maximum length of a varchar column. 
    public function getVarcharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getVarcharMaxLength() ​Gets the maximum length of a varchar column.

    [m] getBinaryMaxLength Gets the maximum length of a binary column.

    deprecated

    Gets the maximum length of a binary column. 
    public function getBinaryMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBinaryMaxLength() ​Gets the maximum length of a binary column.

    [m] getReservedKeywordsClass Returns the class name of the reserved keywords list.

    deprecated

    Returns the class name of the reserved keywords list. 
    protected function getReservedKeywordsClass(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getReservedKeywordsClass() ​Returns the class name of the reserved keywords list.
    See
    type summary
    ​AbstractMySQLPlatform::createReservedKeywordsList() ​
    ​AbstractPlatform::createReservedKeywordsList() ​

    [m] getDropTemporaryTableSQL Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction. 
    public function getDropTemporaryTableSQL(Doctrine\DBAL\Schema\Table|string $table): string

    MySQL commits a transaction implicitly when DROP TABLE is executed, however not if DROP TEMPORARY TABLE is executed.

    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDropTemporaryTableSQL() ​Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    [m] getBlobTypeDeclarationSQL Gets the SQL Snippet used to declare a BLOB column type.

    Gets the SQL Snippet used to declare a BLOB column type. 
    public function getBlobTypeDeclarationSQL(array|mixed[] $column): string
    TINYBLOB   : 2 ^  8 - 1 = 255
BLOB       : 2 ^ 16 - 1 = 65535
MEDIUMBLOB : 2 ^ 24 - 1 = 16777215
LONGBLOB   : 2 ^ 32 - 1 = 4294967295

    Returns the SQL Snippet used to declare a BLOB column type.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBlobTypeDeclarationSQL() ​Returns the SQL Snippet used to declare a BLOB column type.

    [m] quoteStringLiteral <tag_inheritdoc data-type='' data-description=''>Quotes a literal string.

    Quotes a literal string. 
    public function quoteStringLiteral(string $str): string

    This method is NOT meant to fix SQL injections! It is only meant to escape this platform's string literal quote character inside the given literal string.

    Parameter
    type name summary
    ​string ​$str ​The literal string to be quoted.
    Return
    type summary
    ​string ​The quoted literal string.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::quoteStringLiteral() ​Quotes a literal string.

    [m] getDefaultTransactionIsolationLevel Gets the default transaction isolation level of the platform.

    Gets the default transaction isolation level of the platform. 
    public function getDefaultTransactionIsolationLevel(): Doctrine\DBAL\TransactionIsolationLevel::*()
    Return
    type summary
    ​TransactionIsolationLevel::*() ​The default isolation level.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDefaultTransactionIsolationLevel() ​Gets the default transaction isolation level of the platform.
    See
    type summary
    ​TransactionIsolationLevel ​

    [m] supportsColumnLengthIndexes Whether the platform supports indexes with column length definitions.

    Whether the platform supports indexes with column length definitions. 
    public function supportsColumnLengthIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsColumnLengthIndexes() ​Whether the platform supports indexes with column length definitions.

    [m] getDatabaseNameSQL

    deprecated 

    protected function getDatabaseNameSQL(?string $databaseName): string
    Parameter
    type name summary
    ​?string ​$databaseName ​
    Return
    type summary
    ​string ​

    [m] createSchemaManager Creates the schema manager that can be used to inspect and change the underlying

    Creates the schema manager that can be used to inspect and change the underlying 
    public function createSchemaManager(Doctrine\DBAL\Connection $connection): Doctrine\DBAL\Schema\MySQLSchemaManager

    database schema according to the dialect of the platform.

    Parameter
    type name summary
    ​Connection ​$connection ​
    Return
    type summary
    ​MySQLSchemaManager ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::createSchemaManager() ​Creates the schema manager that can be used to inspect and change the underlying

    [m] fetchTableOptionsByTable 

    public function fetchTableOptionsByTable(bool $includeTableName): string
    Parameter
    type name summary
    ​bool ​$includeTableName ​
    Return
    type summary
    ​string ​

    [m] setDisableTypeComments

    final

    final public function setDisableTypeComments(bool $value)
    Parameter
    type name summary
    ​bool ​$value ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setDisableTypeComments() ​

    [m] setEventManager Sets the EventManager used by the Platform.

    deprecated

    Sets the EventManager used by the Platform. 
    public function setEventManager(Doctrine\Common\EventManager $eventManager): void
    Parameter
    type name summary
    ​EventManager ​$eventManager ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setEventManager() ​Sets the EventManager used by the Platform.

    [m] getEventManager Gets the EventManager used by the Platform.

    deprecated

    Gets the EventManager used by the Platform. 
    public function getEventManager(): Doctrine\Common\EventManager|null
    Return
    type summary
    ​EventManager|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEventManager() ​Gets the EventManager used by the Platform.

    [m] getAsciiStringTypeDeclarationSQL Returns the SQL snippet used to declare a column that can

    Returns the SQL snippet used to declare a column that can 
    public function getAsciiStringTypeDeclarationSQL(array|mixed[] $column): string

    store characters in the ASCII character set

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAsciiStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a column that can

    [m] getVarcharTypeDeclarationSQL Returns the SQL snippet used to declare a VARCHAR column type.

    deprecated

    Returns the SQL snippet used to declare a VARCHAR column type. 
    public function getVarcharTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharTypeDeclarationSQL() ​Returns the SQL snippet used to declare a VARCHAR column type.

    [m] getStringTypeDeclarationSQL Returns the SQL snippet used to declare a string column type.

    Returns the SQL snippet used to declare a string column type. 
    public function getStringTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a string column type.

    [m] getBinaryTypeDeclarationSQL Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    public function getBinaryTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryTypeDeclarationSQL() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getGuidTypeDeclarationSQL Returns the SQL snippet to declare a GUID/UUID column.

    Returns the SQL snippet to declare a GUID/UUID column. 
    public function getGuidTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CHAR(36) and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getGuidTypeDeclarationSQL() ​Returns the SQL snippet to declare a GUID/UUID column.

    [m] getJsonTypeDeclarationSQL Returns the SQL snippet to declare a JSON column.

    Returns the SQL snippet to declare a JSON column. 
    public function getJsonTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CLOB and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getJsonTypeDeclarationSQL() ​Returns the SQL snippet to declare a JSON column.

    [m] registerDoctrineTypeMapping Registers a doctrine type to be used in conjunction with a column type of this platform.

    Registers a doctrine type to be used in conjunction with a column type of this platform. 
    public function registerDoctrineTypeMapping(
    string $dbType,
    string $doctrineType
): void
    Parameter
    type name summary
    ​string ​$dbType ​
    ​string ​$doctrineType ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​If the type is not found.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::registerDoctrineTypeMapping() ​Registers a doctrine type to be used in conjunction with a column type of this platform.

    [m] getDoctrineTypeMapping Gets the Doctrine type that is mapped for the given database column type.

    Gets the Doctrine type that is mapped for the given database column type. 
    public function getDoctrineTypeMapping(string $dbType): string
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeMapping() ​Gets the Doctrine type that is mapped for the given database column type.

    [m] hasDoctrineTypeMappingFor Checks if a database type is currently supported by this platform.

    Checks if a database type is currently supported by this platform. 
    public function hasDoctrineTypeMappingFor(string $dbType): bool
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasDoctrineTypeMappingFor() ​Checks if a database type is currently supported by this platform.

    [m] initializeCommentedDoctrineTypes Initializes the Doctrine Type comments instance variable for in_array() checks.

    deprecated

    Initializes the Doctrine Type comments instance variable for in_array() checks. 
    protected function initializeCommentedDoctrineTypes(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::initializeCommentedDoctrineTypes() ​Initializes the Doctrine Type comments instance variable for in_array() checks.

    [m] isCommentedDoctrineType Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    deprecated

    Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type? 
    public function isCommentedDoctrineType(Doctrine\DBAL\Types\Type $doctrineType): bool
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::isCommentedDoctrineType() ​Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    [m] markDoctrineTypeCommented Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements. 
    public function markDoctrineTypeCommented(string|Doctrine\DBAL\Types\Type $doctrineType): void
    Parameter
    type name summary
    ​string|​Type ​$doctrineType ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::markDoctrineTypeCommented() ​Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    [m] getDoctrineTypeComment Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    deprecated

    Gets the comment to append to a column comment that helps parsing this type in reverse engineering. 
    public function getDoctrineTypeComment(Doctrine\DBAL\Types\Type $doctrineType): string
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeComment() ​Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    [m] getColumnComment Gets the comment of a passed column modified by potential doctrine type comment hints.

    deprecated

    Gets the comment of a passed column modified by potential doctrine type comment hints. 
    protected function getColumnComment(Doctrine\DBAL\Schema\Column $column): string|null
    Parameter
    type name summary
    ​Column ​$column ​
    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnComment() ​Gets the comment of a passed column modified by potential doctrine type comment hints.

    [m] getSqlCommentStartString Gets the string portion that starts an SQL comment.

    deprecated

    Gets the string portion that starts an SQL comment. 
    public function getSqlCommentStartString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentStartString() ​Gets the string portion that starts an SQL comment.

    [m] getSqlCommentEndString Gets the string portion that ends an SQL comment.

    deprecated

    Gets the string portion that ends an SQL comment. 
    public function getSqlCommentEndString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentEndString() ​Gets the string portion that ends an SQL comment.

    [m] getCharMaxLength Gets the maximum length of a char column.

    deprecated

    Gets the maximum length of a char column. 
    public function getCharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCharMaxLength() ​Gets the maximum length of a char column.

    [m] getVarcharDefaultLength Gets the default length of a varchar column.

    deprecated

    Gets the default length of a varchar column. 
    public function getVarcharDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharDefaultLength() ​Gets the default length of a varchar column.

    [m] getBinaryDefaultLength Gets the default length of a binary column.

    deprecated

    Gets the default length of a binary column. 
    public function getBinaryDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryDefaultLength() ​Gets the default length of a binary column.

    [m] getWildcards Gets all SQL wildcard characters of the platform.

    deprecated

    Gets all SQL wildcard characters of the platform. 
    public function getWildcards(): string[]
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWildcards() ​Gets all SQL wildcard characters of the platform.
    See
    type summary
    ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] getAvgExpression Returns the SQL snippet to get the average value of a column.

    deprecated

    Returns the SQL snippet to get the average value of a column. 
    public function getAvgExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an AVG aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAvgExpression() ​Returns the SQL snippet to get the average value of a column.

    [m] getCountExpression Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    deprecated

    Returns the SQL snippet to get the number of rows (without a NULL value) of a column. 
    public function getCountExpression(string|int $column): string

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

    Parameter
    type name summary
    ​string|​int ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a COUNT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCountExpression() ​Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    [m] getMaxExpression Returns the SQL snippet to get the highest value of a column.

    deprecated

    Returns the SQL snippet to get the highest value of a column. 
    public function getMaxExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MAX aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxExpression() ​Returns the SQL snippet to get the highest value of a column.

    [m] getMinExpression Returns the SQL snippet to get the lowest value of a column.

    deprecated

    Returns the SQL snippet to get the lowest value of a column. 
    public function getMinExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MIN aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMinExpression() ​Returns the SQL snippet to get the lowest value of a column.

    [m] getSumExpression Returns the SQL snippet to get the total sum of a column.

    deprecated

    Returns the SQL snippet to get the total sum of a column. 
    public function getSumExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a SUM aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSumExpression() ​Returns the SQL snippet to get the total sum of a column.

    [m] getMd5Expression Returns the SQL snippet to get the md5 sum of a column.

    deprecated

    Returns the SQL snippet to get the md5 sum of a column. 
    public function getMd5Expression(string $column): string

    Note: Not SQL92, but common functionality.

    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMd5Expression() ​Returns the SQL snippet to get the md5 sum of a column.

    [m] getSqrtExpression Returns the SQL snippet to get the squared value of a column.

    deprecated

    Returns the SQL snippet to get the squared value of a column. 
    public function getSqrtExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an SQRT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqrtExpression() ​Returns the SQL snippet to get the squared value of a column.

    [m] getRoundExpression Returns the SQL snippet to round a numeric column to the number of decimals specified.

    deprecated

    Returns the SQL snippet to round a numeric column to the number of decimals specified. 
    public function getRoundExpression(
    string $column,
    string|int $decimals = 0
): string
    Parameter
    type name summary
    ​string ​$column ​
    ​string|​int ​$decimals = 0 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRoundExpression() ​Returns the SQL snippet to round a numeric column to the number of decimals specified.

    [m] getModExpression Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2. 
    public function getModExpression(
    string $expression1,
    string $expression2
): string
    Parameter
    type name summary
    ​string ​$expression1 ​
    ​string ​$expression2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getModExpression() ​Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    [m] getTrimExpression Returns the SQL snippet to trim a string.

    Returns the SQL snippet to trim a string. 
    public function getTrimExpression(
    string $str,
    int $mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED,
    string|bool $char = false
): string
    Parameter
    type name summary
    ​string ​$str ​The expression to apply the trim to.
    ​int ​$mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED ​The position of the trim (leading/trailing/both).
    ​string|​bool ​$char = false ​The char to trim, has to be quoted already. Defaults to space.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTrimExpression() ​Returns the SQL snippet to trim a string.

    [m] getRtrimExpression Returns the SQL snippet to trim trailing space characters from the expression.

    deprecated

    Returns the SQL snippet to trim trailing space characters from the expression. 
    public function getRtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRtrimExpression() ​Returns the SQL snippet to trim trailing space characters from the expression.

    [m] getLtrimExpression Returns the SQL snippet to trim leading space characters from the expression.

    deprecated

    Returns the SQL snippet to trim leading space characters from the expression. 
    public function getLtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLtrimExpression() ​Returns the SQL snippet to trim leading space characters from the expression.

    [m] getUpperExpression Returns the SQL snippet to change all characters from the expression to uppercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to uppercase, 
    public function getUpperExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUpperExpression() ​Returns the SQL snippet to change all characters from the expression to uppercase,

    [m] getLowerExpression Returns the SQL snippet to change all characters from the expression to lowercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to lowercase, 
    public function getLowerExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLowerExpression() ​Returns the SQL snippet to change all characters from the expression to lowercase,

    [m] getNowExpression Returns the SQL snippet to get the current system date.

    deprecated

    Returns the SQL snippet to get the current system date. 
    public function getNowExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getNowExpression() ​Returns the SQL snippet to get the current system date.

    [m] getSubstringExpression Returns a SQL snippet to get a substring inside an SQL statement.

    Returns a SQL snippet to get a substring inside an SQL statement. 
    public function getSubstringExpression(
    string $string,
    string|int $start,
    string|int|null $length = null
): string

    Note: Not SQL92, but common functionality.

    SQLite only supports the 2 parameter variant of this function.

    Parameter
    type name summary
    ​string ​$string ​An sql string literal or column name/alias.
    ​string|​int ​$start ​Where to start the substring portion.
    ​string|​int|​null ​$length = null ​The substring portion length.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSubstringExpression() ​Returns a SQL snippet to get a substring inside an SQL statement.

    [m] getNotExpression Returns the SQL for a logical not.

    deprecated

    Returns the SQL for a logical not. 
    public function getNotExpression(string $expression): string

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

    Parameter
    type name summary
    ​string ​$expression ​
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getNotExpression() ​Returns the SQL for a logical not.

    [m] getIsNullExpression Returns the SQL that checks if an expression is null.

    deprecated

    Returns the SQL that checks if an expression is null. 
    public function getIsNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNullExpression() ​Returns the SQL that checks if an expression is null.

    [m] getIsNotNullExpression Returns the SQL that checks if an expression is not null.

    deprecated

    Returns the SQL that checks if an expression is not null. 
    public function getIsNotNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNotNullExpression() ​Returns the SQL that checks if an expression is not null.

    [m] getBetweenExpression Returns the SQL that checks if an expression evaluates to a value between two values.

    deprecated

    Returns the SQL that checks if an expression evaluates to a value between two values. 
    public function getBetweenExpression(
    string $expression,
    string $value1,
    string $value2
): string

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

    Parameter
    type name summary
    ​string ​$expression ​The value to compare to.
    ​string ​$value1 ​The lower value to compare with.
    ​string ​$value2 ​The higher value to compare with.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBetweenExpression() ​Returns the SQL that checks if an expression evaluates to a value between two values.

    [m] getAcosExpression Returns the SQL to get the arccosine of a value.

    deprecated

    Returns the SQL to get the arccosine of a value. 
    public function getAcosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAcosExpression() ​Returns the SQL to get the arccosine of a value.

    [m] getSinExpression Returns the SQL to get the sine of a value.

    deprecated

    Returns the SQL to get the sine of a value. 
    public function getSinExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSinExpression() ​Returns the SQL to get the sine of a value.

    [m] getPiExpression Returns the SQL to get the PI value.

    deprecated

    Returns the SQL to get the PI value. 
    public function getPiExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPiExpression() ​Returns the SQL to get the PI value.

    [m] getCosExpression Returns the SQL to get the cosine of a value.

    deprecated

    Returns the SQL to get the cosine of a value. 
    public function getCosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCosExpression() ​Returns the SQL to get the cosine of a value.

    [m] getDateAddSecondsExpression Returns the SQL to add the number of given seconds to a date.

    Returns the SQL to add the number of given seconds to a date. 
    public function getDateAddSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddSecondsExpression() ​Returns the SQL to add the number of given seconds to a date.

    [m] getDateSubSecondsExpression Returns the SQL to subtract the number of given seconds from a date.

    Returns the SQL to subtract the number of given seconds from a date. 
    public function getDateSubSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubSecondsExpression() ​Returns the SQL to subtract the number of given seconds from a date.

    [m] getDateAddMinutesExpression Returns the SQL to add the number of given minutes to a date.

    Returns the SQL to add the number of given minutes to a date. 
    public function getDateAddMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMinutesExpression() ​Returns the SQL to add the number of given minutes to a date.

    [m] getDateSubMinutesExpression Returns the SQL to subtract the number of given minutes from a date.

    Returns the SQL to subtract the number of given minutes from a date. 
    public function getDateSubMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMinutesExpression() ​Returns the SQL to subtract the number of given minutes from a date.

    [m] getDateAddHourExpression Returns the SQL to add the number of given hours to a date.

    Returns the SQL to add the number of given hours to a date. 
    public function getDateAddHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddHourExpression() ​Returns the SQL to add the number of given hours to a date.

    [m] getDateSubHourExpression Returns the SQL to subtract the number of given hours to a date.

    Returns the SQL to subtract the number of given hours to a date. 
    public function getDateSubHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubHourExpression() ​Returns the SQL to subtract the number of given hours to a date.

    [m] getDateAddDaysExpression Returns the SQL to add the number of given days to a date.

    Returns the SQL to add the number of given days to a date. 
    public function getDateAddDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddDaysExpression() ​Returns the SQL to add the number of given days to a date.

    [m] getDateSubDaysExpression Returns the SQL to subtract the number of given days to a date.

    Returns the SQL to subtract the number of given days to a date. 
    public function getDateSubDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubDaysExpression() ​Returns the SQL to subtract the number of given days to a date.

    [m] getDateAddWeeksExpression Returns the SQL to add the number of given weeks to a date.

    Returns the SQL to add the number of given weeks to a date. 
    public function getDateAddWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddWeeksExpression() ​Returns the SQL to add the number of given weeks to a date.

    [m] getDateSubWeeksExpression Returns the SQL to subtract the number of given weeks from a date.

    Returns the SQL to subtract the number of given weeks from a date. 
    public function getDateSubWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubWeeksExpression() ​Returns the SQL to subtract the number of given weeks from a date.

    [m] getDateAddMonthExpression Returns the SQL to add the number of given months to a date.

    Returns the SQL to add the number of given months to a date. 
    public function getDateAddMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMonthExpression() ​Returns the SQL to add the number of given months to a date.

    [m] getDateSubMonthExpression Returns the SQL to subtract the number of given months to a date.

    Returns the SQL to subtract the number of given months to a date. 
    public function getDateSubMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMonthExpression() ​Returns the SQL to subtract the number of given months to a date.

    [m] getDateAddQuartersExpression Returns the SQL to add the number of given quarters to a date.

    Returns the SQL to add the number of given quarters to a date. 
    public function getDateAddQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddQuartersExpression() ​Returns the SQL to add the number of given quarters to a date.

    [m] getDateSubQuartersExpression Returns the SQL to subtract the number of given quarters from a date.

    Returns the SQL to subtract the number of given quarters from a date. 
    public function getDateSubQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubQuartersExpression() ​Returns the SQL to subtract the number of given quarters from a date.

    [m] getDateAddYearsExpression Returns the SQL to add the number of given years to a date.

    Returns the SQL to add the number of given years to a date. 
    public function getDateAddYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddYearsExpression() ​Returns the SQL to add the number of given years to a date.

    [m] getDateSubYearsExpression Returns the SQL to subtract the number of given years from a date.

    Returns the SQL to subtract the number of given years from a date. 
    public function getDateSubYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubYearsExpression() ​Returns the SQL to subtract the number of given years from a date.

    [m] multiplyInterval Generates the SQL expression which represents the given date interval multiplied by a number

    Generates the SQL expression which represents the given date interval multiplied by a number 
    protected function multiplyInterval(
    string $interval,
    int $multiplier
): string
    Parameter
    type name summary
    ​string ​$interval ​SQL expression describing the interval value
    ​int ​$multiplier ​Interval multiplier
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::multiplyInterval() ​Generates the SQL expression which represents the given date interval multiplied by a number

    [m] getBitAndComparisonExpression Returns the SQL bit AND comparison expression.

    Returns the SQL bit AND comparison expression. 
    public function getBitAndComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitAndComparisonExpression() ​Returns the SQL bit AND comparison expression.

    [m] getBitOrComparisonExpression Returns the SQL bit OR comparison expression.

    Returns the SQL bit OR comparison expression. 
    public function getBitOrComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitOrComparisonExpression() ​Returns the SQL bit OR comparison expression.

    [m] getForUpdateSQL Returns the FOR UPDATE expression.

    deprecated

    Returns the FOR UPDATE expression. 
    public function getForUpdateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForUpdateSQL() ​Returns the FOR UPDATE expression.

    [m] appendLockHint Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    Honors that some SQL vendors such as MsSql use table hints for locking instead of the 
    public function appendLockHint(
    string $fromClause,
    int $lockMode
): string

    ANSI SQL FOR UPDATE specification.

    Parameter
    type name summary
    ​string ​$fromClause ​The FROM clause to append the hint for the given lock mode to
    ​int ​$lockMode ​One of the Doctrine\DBAL\LockMode::* constants
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::appendLockHint() ​Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    [m] getWriteLockSQL Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows. 
    public function getWriteLockSQL(): string

    The semantics of this lock mode should equal the SELECT .. FOR UPDATE of the ANSI SQL standard.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWriteLockSQL() ​Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    [m] getDropTableSQL Returns the SQL snippet to drop an existing table.

    Returns the SQL snippet to drop an existing table. 
    public function getDropTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTableSQL() ​Returns the SQL snippet to drop an existing table.

    [m] getDropConstraintSQL Returns the SQL to drop a constraint.

    Returns the SQL to drop a constraint. 
    public function getDropConstraintSQL(
    Doctrine\DBAL\Schema\Constraint|string $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint|​string ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropConstraintSQL() ​Returns the SQL to drop a constraint.
    See
    type summary
    ​AbstractPlatform ​

    [m] getDropForeignKeySQL Returns the SQL to drop a foreign key.

    Returns the SQL to drop a foreign key. 
    public function getDropForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropForeignKeySQL() ​Returns the SQL to drop a foreign key.

    [m] getCreateTableSQL Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    Returns the SQL statement(s) to create a table with the specified name, columns and constraints 
    public function getCreateTableSQL(
    Doctrine\DBAL\Schema\Table $table,
    int $createFlags = self::CREATE_INDEXES
): list

    on this platform.

    Parameter
    type name summary
    ​Table ​$table ​
    ​int ​$createFlags = self::CREATE_INDEXES ​
    Return
    type summary
    ​list ​The list of SQL statements.
    Throws
    type summary
    ​Exception ​
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableSQL() ​Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    [m] getCreateTableWithoutForeignKeysSQL

    final

    final protected function getCreateTableWithoutForeignKeysSQL(Doctrine\DBAL\Schema\Table $table): array|list
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableWithoutForeignKeysSQL() ​

    [m] getDropTablesSQL 

    public function getDropTablesSQL(array|list $tables): array|list
    Parameter
    type name summary
    ​array|​list ​$tables ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTablesSQL() ​

    [m] getCommentOnTableSQL 

    protected function getCommentOnTableSQL(
    string $tableName,
    ?string $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​?string ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnTableSQL() ​

    [m] getCommentOnColumnSQL 

    public function getCommentOnColumnSQL(
    string $tableName,
    string $columnName,
    string|null $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    ​string|​null ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnColumnSQL() ​

    [m] getInlineColumnCommentSQL Returns the SQL to create inline comment on a column.

    Returns the SQL to create inline comment on a column. 
    public function getInlineColumnCommentSQL(string $comment): string
    Parameter
    type name summary
    ​string ​$comment ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getInlineColumnCommentSQL() ​Returns the SQL to create inline comment on a column.

    [m] getCreateTemporaryTableSnippetSQL 

    public function getCreateTemporaryTableSnippetSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTemporaryTableSnippetSQL() ​

    [m] getAlterSchemaSQL Generates SQL statements that can be used to apply the diff.

    Generates SQL statements that can be used to apply the diff. 
    public function getAlterSchemaSQL(Doctrine\DBAL\Schema\SchemaDiff $diff): array|list
    Parameter
    type name summary
    ​SchemaDiff ​$diff ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAlterSchemaSQL() ​Generates SQL statements that can be used to apply the diff.

    [m] getCreateSequenceSQL Returns the SQL to create a sequence on this platform.

    Returns the SQL to create a sequence on this platform. 
    public function getCreateSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateSequenceSQL() ​Returns the SQL to create a sequence on this platform.

    [m] getAlterSequenceSQL Returns the SQL to change a sequence on this platform.

    Returns the SQL to change a sequence on this platform. 
    public function getAlterSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAlterSequenceSQL() ​Returns the SQL to change a sequence on this platform.

    [m] getDropSequenceSQL Returns the SQL snippet to drop an existing sequence.

    Returns the SQL snippet to drop an existing sequence. 
    public function getDropSequenceSQL(Doctrine\DBAL\Schema\Sequence|string $sequence): string
    Parameter
    type name summary
    ​Sequence|​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSequenceSQL() ​Returns the SQL snippet to drop an existing sequence.

    [m] getCreateConstraintSQL Returns the SQL to create a constraint on a table on this platform.

    deprecated

    Returns the SQL to create a constraint on a table on this platform. 
    public function getCreateConstraintSQL(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateConstraintSQL() ​Returns the SQL to create a constraint on a table on this platform.
    See
    type summary
    ​AbstractPlatform::getCreateIndexSQL() ​
    ​AbstractPlatform::getCreateForeignKeySQL() ​

    [m] getCreateIndexSQL Returns the SQL to create an index on a table on this platform.

    Returns the SQL to create an index on a table on this platform. 
    public function getCreateIndexSQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateIndexSQL() ​Returns the SQL to create an index on a table on this platform.

    [m] getPartialIndexSQL Adds condition for partial index.

    Adds condition for partial index. 
    protected function getPartialIndexSQL(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPartialIndexSQL() ​Adds condition for partial index.

    [m] getCreatePrimaryKeySQL Returns the SQL to create an unnamed primary key constraint.

    Returns the SQL to create an unnamed primary key constraint. 
    public function getCreatePrimaryKeySQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreatePrimaryKeySQL() ​Returns the SQL to create an unnamed primary key constraint.

    [m] getCreateSchemaSQL Returns the SQL to create a named schema.

    Returns the SQL to create a named schema. 
    public function getCreateSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateSchemaSQL() ​Returns the SQL to create a named schema.

    [m] getCreateUniqueConstraintSQL Returns the SQL to create a unique constraint on a table on this platform.

    Returns the SQL to create a unique constraint on a table on this platform. 
    public function getCreateUniqueConstraintSQL(
    Doctrine\DBAL\Schema\UniqueConstraint $constraint,
    string $tableName
): string
    Parameter
    type name summary
    ​UniqueConstraint ​$constraint ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateUniqueConstraintSQL() ​Returns the SQL to create a unique constraint on a table on this platform.

    [m] getDropSchemaSQL Returns the SQL snippet to drop a schema.

    Returns the SQL snippet to drop a schema. 
    public function getDropSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSchemaSQL() ​Returns the SQL snippet to drop a schema.

    [m] quoteIdentifier Quotes a string so that it can be safely used as a table or column name,

    Quotes a string so that it can be safely used as a table or column name, 
    public function quoteIdentifier(string $str): string

    even if it is a reserved word of the platform. This also detects identifier chains separated by dot and quotes them independently.

    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.

    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteIdentifier() ​Quotes a string so that it can be safely used as a table or column name,

    [m] quoteSingleIdentifier Quotes a single identifier (no dot chain separation).

    Quotes a single identifier (no dot chain separation). 
    public function quoteSingleIdentifier(string $str): string
    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteSingleIdentifier() ​Quotes a single identifier (no dot chain separation).

    [m] getCreateForeignKeySQL Returns the SQL to create a new foreign key.

    Returns the SQL to create a new foreign key. 
    public function getCreateForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key constraint.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateForeignKeySQL() ​Returns the SQL to create a new foreign key.

    [m] getRenameTableSQL 

    public function getRenameTableSQL(
    string $oldName,
    string $newName
): array|list
    Parameter
    type name summary
    ​string ​$oldName ​
    ​string ​$newName ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRenameTableSQL() ​

    [m] onSchemaAlterTableAddColumn 

    protected function onSchemaAlterTableAddColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    mixed[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​mixed[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableAddColumn() ​

    [m] onSchemaAlterTableRemoveColumn 

    protected function onSchemaAlterTableRemoveColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRemoveColumn() ​

    [m] onSchemaAlterTableChangeColumn 

    protected function onSchemaAlterTableChangeColumn(
    Doctrine\DBAL\Schema\ColumnDiff $columnDiff,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​ColumnDiff ​$columnDiff ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableChangeColumn() ​

    [m] onSchemaAlterTableRenameColumn 

    protected function onSchemaAlterTableRenameColumn(
    string $oldColumnName,
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​string ​$oldColumnName ​
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRenameColumn() ​

    [m] onSchemaAlterTable 

    protected function onSchemaAlterTable(
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$sql
): bool
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    ​string[] ​&$sql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTable() ​

    [m] getRenameIndexSQL Returns the SQL for renaming an index on a table.

    Returns the SQL for renaming an index on a table. 
    protected function getRenameIndexSQL(
    string $oldIndexName,
    Doctrine\DBAL\Schema\Index $index,
    string $tableName
): string[]
    Parameter
    type name summary
    ​string ​$oldIndexName ​The name of the index to rename from.
    ​Index ​$index ​The definition of the index to rename to.
    ​string ​$tableName ​The table to rename the given index on.
    Return
    type summary
    ​string[] ​The sequence of SQL statements for renaming the given index.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRenameIndexSQL() ​Returns the SQL for renaming an index on a table.

    [m] getColumnDeclarationListSQL Gets declaration of a number of columns in bulk.

    Gets declaration of a number of columns in bulk. 
    public function getColumnDeclarationListSQL(array|mixed[][] $columns): string
    Parameter
    type name summary
    ​array|​mixed[][] ​$columns ​A multidimensional associative array.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationListSQL() ​Gets declaration of a number of columns in bulk.

    [m] getColumnDeclarationSQL Obtains DBMS specific SQL code portion needed to declare a generic type

    Obtains DBMS specific SQL code portion needed to declare a generic type 
    public function getColumnDeclarationSQL(
    string $name,
    array|mixed[] $column
): string

    column to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name the column to be declared.
    ​array|​mixed[] ​$column ​An associative array with the name of the properties
    Return
    type summary
    ​string ​DBMS specific SQL code portion that should be used to declare the column.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to declare a generic type

    [m] getCheckDeclarationSQL Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    Obtains DBMS specific SQL code portion needed to set a CHECK constraint 
    public function getCheckDeclarationSQL(array|string[]|mixed[][] $definition): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​string[]|​mixed[][] ​$definition ​The check definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a CHECK constraint.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCheckDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    [m] getUniqueConstraintDeclarationSQL Obtains DBMS specific SQL code portion needed to set a unique

    Obtains DBMS specific SQL code portion needed to set a unique 
    public function getUniqueConstraintDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\UniqueConstraint $constraint
): string

    constraint declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the unique constraint.
    ​UniqueConstraint ​$constraint ​The unique constraint definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a constraint.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueConstraintDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a unique

    [m] getIndexDeclarationSQL Obtains DBMS specific SQL code portion needed to set an index

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\Index $index
): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the index.
    ​Index ​$index ​The index definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set an index.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getCustomTypeDeclarationSQL Obtains SQL code portion needed to create a custom column,

    deprecated

    Obtains SQL code portion needed to create a custom column, 
    public function getCustomTypeDeclarationSQL(array|mixed[] $column): string

    e.g. when a column has the "columnDefinition" keyword. Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCustomTypeDeclarationSQL() ​Obtains SQL code portion needed to create a custom column,

    [m] getIndexFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexFieldDeclarationListSQL(Doctrine\DBAL\Schema\Index $index): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getColumnsFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getColumnsFieldDeclarationListSQL(array|mixed[] $columns): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$columns ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnsFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getTemporaryTableSQL Returns the required SQL string that fits between CREATE ... TABLE

    deprecated

    Returns the required SQL string that fits between CREATE ... TABLE 
    public function getTemporaryTableSQL(): string

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

    Return
    type summary
    ​string ​The string required to be placed between "CREATE" and "TABLE"
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableSQL() ​Returns the required SQL string that fits between CREATE ... TABLE

    [m] getTemporaryTableName Some vendors require temporary table names to be qualified specially.

    Some vendors require temporary table names to be qualified specially. 
    public function getTemporaryTableName(string $tableName): string
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableName() ​Some vendors require temporary table names to be qualified specially.

    [m] getForeignKeyDeclarationSQL Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyDeclarationSQL() ​Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getForeignKeyReferentialActionSQL Returns the given referential action in uppercase if valid, otherwise throws an exception.

    Returns the given referential action in uppercase if valid, otherwise throws an exception. 
    public function getForeignKeyReferentialActionSQL(string $action): string
    Parameter
    type name summary
    ​string ​$action ​The foreign key referential action.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​If unknown referential action given.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyReferentialActionSQL() ​Returns the given referential action in uppercase if valid, otherwise throws an exception.

    [m] getForeignKeyBaseDeclarationSQL Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyBaseDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyBaseDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getUniqueFieldDeclarationSQL Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    deprecated

    Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint 
    public function getUniqueFieldDeclarationSQL(): string

    of a column declaration to be used in statements like CREATE TABLE.

    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the UNIQUE constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueFieldDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    [m] getColumnCollationDeclarationSQL Obtains DBMS specific SQL code portion needed to set the COLLATION

    Obtains DBMS specific SQL code portion needed to set the COLLATION 
    public function getColumnCollationDeclarationSQL(string $collation): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$collation ​The name of the collation.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the COLLATION
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnCollationDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the COLLATION

    [m] convertBooleans Some platforms need the boolean values to be converted.

    Some platforms need the boolean values to be converted. 
    public function convertBooleans(mixed $item): mixed

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

    Note: if the input is not a boolean the original input might be returned.

    There are two contexts when converting booleans: Literals and Prepared Statements. This method should handle the literal case

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertBooleans() ​Some platforms need the boolean values to be converted.

    [m] convertFromBoolean Some platforms have boolean literals that needs to be correctly converted

    Some platforms have boolean literals that needs to be correctly converted 
    public function convertFromBoolean(T $item): (T

    The default conversion tries to convert value into bool "(bool)$item"

    Parameter
    type name summary
    ​T ​$item ​
    Return
    type summary
    ​(T ​is null ? null : bool)
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertFromBoolean() ​Some platforms have boolean literals that needs to be correctly converted

    [m] convertBooleansToDatabaseValue This method should handle the prepared statements case. When there is no

    This method should handle the prepared statements case. When there is no 
    public function convertBooleansToDatabaseValue(mixed $item): mixed

    distinction, it's OK to use the same method.

    Note: if the input is not a boolean the original input might be returned.

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertBooleansToDatabaseValue() ​This method should handle the prepared statements case. When there is no

    [m] getCurrentDateSQL Returns the SQL specific for the platform to get the current date.

    Returns the SQL specific for the platform to get the current date. 
    public function getCurrentDateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentDateSQL() ​Returns the SQL specific for the platform to get the current date.

    [m] getCurrentTimeSQL Returns the SQL specific for the platform to get the current time.

    Returns the SQL specific for the platform to get the current time. 
    public function getCurrentTimeSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimeSQL() ​Returns the SQL specific for the platform to get the current time.

    [m] getCurrentTimestampSQL Returns the SQL specific for the platform to get the current timestamp

    Returns the SQL specific for the platform to get the current timestamp 
    public function getCurrentTimestampSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimestampSQL() ​Returns the SQL specific for the platform to get the current timestamp

    [m] _getTransactionIsolationLevelSQL Returns the SQL for a given transaction isolation level Connection constant.

    Returns the SQL for a given transaction isolation level Connection constant. 
    protected function _getTransactionIsolationLevelSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::_getTransactionIsolationLevelSQL() ​Returns the SQL for a given transaction isolation level Connection constant.

    [m] getListNamespacesSQL Returns the SQL statement for retrieving the namespaces defined in the database.

    deprecated

    Returns the SQL statement for retrieving the namespaces defined in the database. 
    public function getListNamespacesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListNamespacesSQL() ​Returns the SQL statement for retrieving the namespaces defined in the database.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] getListSequencesSQL 

    public function getListSequencesSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListSequencesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​

    [m] getListUsersSQL

    deprecated 

    public function getListUsersSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListUsersSQL() ​

    [m] getCreateViewSQL 

    public function getCreateViewSQL(
    string $name,
    string $sql
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$sql ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateViewSQL() ​

    [m] getDropViewSQL 

    public function getDropViewSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropViewSQL() ​

    [m] getSequenceNextValSQL 

    public function getSequenceNextValSQL(string $sequence): string
    Parameter
    type name summary
    ​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSequenceNextValSQL() ​

    [m] getCreateDatabaseSQL Returns the SQL to create a new database.

    Returns the SQL to create a new database. 
    public function getCreateDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateDatabaseSQL() ​Returns the SQL to create a new database.

    [m] getDropDatabaseSQL Returns the SQL snippet to drop an existing database.

    Returns the SQL snippet to drop an existing database. 
    public function getDropDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be dropped.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropDatabaseSQL() ​Returns the SQL snippet to drop an existing database.

    [m] getDateTimeTzTypeDeclarationSQL Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    Obtains DBMS specific SQL to be used to create datetime with timezone offset columns. 
    public function getDateTimeTzTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeTzTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    [m] supportsSequences Whether the platform supports sequences.

    Whether the platform supports sequences. 
    public function supportsSequences(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSequences() ​Whether the platform supports sequences.

    [m] usesSequenceEmulatedIdentityColumns Whether the platform emulates identity columns through sequences.

    deprecated

    Whether the platform emulates identity columns through sequences. 
    public function usesSequenceEmulatedIdentityColumns(): bool

    Some platforms that do not support identity columns natively but support sequences can emulate identity columns by using sequences.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::usesSequenceEmulatedIdentityColumns() ​Whether the platform emulates identity columns through sequences.

    [m] getIdentitySequenceName Returns the name of the sequence for a particular identity column in a particular table.

    deprecated

    Returns the name of the sequence for a particular identity column in a particular table. 
    public function getIdentitySequenceName(
    string $tableName,
    string $columnName
): string
    Parameter
    type name summary
    ​string ​$tableName ​The name of the table to return the sequence name for.
    ​string ​$columnName ​The name of the identity column in the table to return the sequence name for.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIdentitySequenceName() ​Returns the name of the sequence for a particular identity column in a particular table.
    See
    type summary
    ​usesSequenceEmulatedIdentityColumns ​

    [m] supportsIndexes Whether the platform supports indexes.

    deprecated

    Whether the platform supports indexes. 
    public function supportsIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsIndexes() ​Whether the platform supports indexes.

    [m] supportsPartialIndexes Whether the platform supports partial indexes.

    Whether the platform supports partial indexes. 
    public function supportsPartialIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPartialIndexes() ​Whether the platform supports partial indexes.

    [m] supportsAlterTable Whether the platform supports altering tables.

    deprecated

    Whether the platform supports altering tables. 
    public function supportsAlterTable(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsAlterTable() ​Whether the platform supports altering tables.

    [m] supportsTransactions Whether the platform supports transactions.

    deprecated

    Whether the platform supports transactions. 
    public function supportsTransactions(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsTransactions() ​Whether the platform supports transactions.

    [m] supportsSavepoints Whether the platform supports savepoints.

    Whether the platform supports savepoints. 
    public function supportsSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSavepoints() ​Whether the platform supports savepoints.

    [m] supportsReleaseSavepoints Whether the platform supports releasing savepoints.

    Whether the platform supports releasing savepoints. 
    public function supportsReleaseSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsReleaseSavepoints() ​Whether the platform supports releasing savepoints.

    [m] supportsPrimaryConstraints Whether the platform supports primary key constraints.

    deprecated

    Whether the platform supports primary key constraints. 
    public function supportsPrimaryConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPrimaryConstraints() ​Whether the platform supports primary key constraints.

    [m] supportsForeignKeyConstraints Whether the platform supports foreign key constraints.

    deprecated

    Whether the platform supports foreign key constraints. 
    public function supportsForeignKeyConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsForeignKeyConstraints() ​Whether the platform supports foreign key constraints.

    [m] supportsSchemas Whether the platform supports database schemas.

    Whether the platform supports database schemas. 
    public function supportsSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSchemas() ​Whether the platform supports database schemas.

    [m] canEmulateSchemas Whether this platform can emulate schemas.

    deprecated

    Whether this platform can emulate schemas. 
    public function canEmulateSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::canEmulateSchemas() ​Whether this platform can emulate schemas.
    See
    type summary
    ​AbstractManager::introspectSchema() ​

    [m] getDefaultSchemaName Returns the default schema name.

    deprecated

    Returns the default schema name. 
    public function getDefaultSchemaName(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDefaultSchemaName() ​Returns the default schema name.

    [m] supportsCreateDropDatabase Whether this platform supports create database.

    deprecated

    Whether this platform supports create database. 
    public function supportsCreateDropDatabase(): bool

    Some databases don't allow to create and drop databases at all or only with certain tools.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsCreateDropDatabase() ​Whether this platform supports create database.

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

    deprecated

    Whether the platform supports getting the affected rows of a recent update/delete type query. 
    public function supportsGettingAffectedRows(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsGettingAffectedRows() ​Whether the platform supports getting the affected rows of a recent update/delete type query.

    [m] supportsCommentOnStatement Whether this platform support the proprietary syntax "COMMENT ON asset".

    Whether this platform support the proprietary syntax "COMMENT ON asset". 
    public function supportsCommentOnStatement(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsCommentOnStatement() ​Whether this platform support the proprietary syntax "COMMENT ON asset".

    [m] hasNativeGuidType Does this platform have native guid type.

    deprecated

    Does this platform have native guid type. 
    public function hasNativeGuidType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasNativeGuidType() ​Does this platform have native guid type.

    [m] hasNativeJsonType Does this platform have native JSON type.

    deprecated

    Does this platform have native JSON type. 
    public function hasNativeJsonType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasNativeJsonType() ​Does this platform have native JSON type.

    [m] supportsViews Whether this platform supports views.

    deprecated

    Whether this platform supports views. 
    public function supportsViews(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsViews() ​Whether this platform supports views.

    [m] getDateTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeFormatString(): string

    the format of a stored datetime value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateTimeTzFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeTzFormatString(): string

    the format of a stored datetime with timezone value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeTzFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateFormatString(): string

    the format of a stored date value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getTimeFormatString(): string

    the format of a stored time value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] modifyLimitQuery Adds an driver-specific LIMIT clause to the query.

    final

    Adds an driver-specific LIMIT clause to the query. 
    final public function modifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset = 0
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset = 0 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::modifyLimitQuery() ​Adds an driver-specific LIMIT clause to the query.

    [m] supportsLimitOffset Whether the database platform support offsets in modify limit clauses.

    deprecated

    Whether the database platform support offsets in modify limit clauses. 
    public function supportsLimitOffset(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsLimitOffset() ​Whether the database platform support offsets in modify limit clauses.

    [m] getMaxIdentifierLength Maximum length of any given database identifier, like tables or column names.

    Maximum length of any given database identifier, like tables or column names. 
    public function getMaxIdentifierLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxIdentifierLength() ​Maximum length of any given database identifier, like tables or column names.

    [m] getEmptyIdentityInsertSQL Returns the insert SQL for an empty insert statement.

    Returns the insert SQL for an empty insert statement. 
    public function getEmptyIdentityInsertSQL(
    string $quotedTableName,
    string $quotedIdentifierColumnName
): string
    Parameter
    type name summary
    ​string ​$quotedTableName ​
    ​string ​$quotedIdentifierColumnName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEmptyIdentityInsertSQL() ​Returns the insert SQL for an empty insert statement.

    [m] getTruncateTableSQL Generates a Truncate Table SQL statement for a given table.

    Generates a Truncate Table SQL statement for a given table. 
    public function getTruncateTableSQL(
    string $tableName,
    bool $cascade = false
): string

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

    Parameter
    type name summary
    ​string ​$tableName ​
    ​bool ​$cascade = false ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTruncateTableSQL() ​Generates a Truncate Table SQL statement for a given table.

    [m] getDummySelectSQL This is for test reasons, many vendors have special requirements for dummy statements.

    This is for test reasons, many vendors have special requirements for dummy statements. 
    public function getDummySelectSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDummySelectSQL() ​This is for test reasons, many vendors have special requirements for dummy statements.

    [m] createSavePoint Returns the SQL to create a new savepoint.

    Returns the SQL to create a new savepoint. 
    public function createSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSavePoint() ​Returns the SQL to create a new savepoint.

    [m] releaseSavePoint Returns the SQL to release a savepoint.

    Returns the SQL to release a savepoint. 
    public function releaseSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::releaseSavePoint() ​Returns the SQL to release a savepoint.

    [m] rollbackSavePoint Returns the SQL to rollback a savepoint.

    Returns the SQL to rollback a savepoint. 
    public function rollbackSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::rollbackSavePoint() ​Returns the SQL to rollback a savepoint.

    [m] getReservedKeywordsList Returns the keyword list instance of this platform.

    final

    Returns the keyword list instance of this platform. 
    final public function getReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList
    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​If no keyword list is specified.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getReservedKeywordsList() ​Returns the keyword list instance of this platform.

    [m] createReservedKeywordsList Creates an instance of the reserved keyword list of this platform.

    Creates an instance of the reserved keyword list of this platform. 
    protected function createReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList

    This method will become @abstract in DBAL 4.0.0.

    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createReservedKeywordsList() ​Creates an instance of the reserved keyword list of this platform.

    [m] getStringLiteralQuoteCharacter Gets the character used for string literal quoting.

    deprecated

    Gets the character used for string literal quoting. 
    public function getStringLiteralQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringLiteralQuoteCharacter() ​Gets the character used for string literal quoting.
    See
    type summary
    ​AbstractPlatform::quoteStringLiteral() ​

    [m] escapeStringForLike Escapes metacharacters in a string intended to be used with a LIKE

    final

    Escapes metacharacters in a string intended to be used with a LIKE 
    final public function escapeStringForLike(
    string $inputString,
    string $escapeChar
): string

    operator.

    Parameter
    type name summary
    ​string ​$inputString ​a literal, unquoted string
    ​string ​$escapeChar ​should be reused by the caller in the LIKE
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::escapeStringForLike() ​Escapes metacharacters in a string intended to be used with a LIKE

    [m] createSQLParser 

    public function createSQLParser(): Doctrine\DBAL\SQL\Parser
    Return
    type summary
    ​Parser ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSQLParser() ​

    [m] getLikeWildcardCharacters 

    protected function getLikeWildcardCharacters(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] columnsEqual Compares the definitions of the given columns in the context of this platform.

    Compares the definitions of the given columns in the context of this platform. 
    public function columnsEqual(
    Doctrine\DBAL\Schema\Column $column1,
    Doctrine\DBAL\Schema\Column $column2
): bool
    Parameter
    type name summary
    ​Column ​$column1 ​
    ​Column ​$column2 ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::columnsEqual() ​Compares the definitions of the given columns in the context of this platform.

    [C] OraclePlatform OraclePlatform.

    OraclePlatform.

    Hierarchy

    Parents
    type summary
    ​AbstractPlatform ​Base class for all DatabasePlatforms. The DatabasePlatforms are the central

    [C] CREATE_INDEXES 

    public const int CREATE_INDEXES = 1
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_INDEXES ​

    [C] CREATE_FOREIGNKEYS 

    public const int CREATE_FOREIGNKEYS = 2
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_FOREIGNKEYS ​

    [p] $doctrineTypeMapping 

    protected string[]|null $doctrineTypeMapping = null

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeMapping ​

    [p] $doctrineTypeComments Contains a list of all columns that should generate parseable column comments for type-detection

    deprecated

    Contains a list of all columns that should generate parseable column comments for type-detection 
    protected string[]|null $doctrineTypeComments = null

    in reverse engineering scenarios.

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeComments ​Contains a list of all columns that should generate parseable column comments for type-detection

    [p] $_eventManager

    deprecated 

    protected Doctrine\Common\EventManager|null $_eventManager = null

    Type: EventManager|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_eventManager ​

    [p] $_keywords Holds the KeywordList instance for the current platform.

    Holds the KeywordList instance for the current platform. 
    protected Doctrine\DBAL\Platforms\Keywords\KeywordList|null $_keywords = null

    Type: KeywordList|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_keywords ​Holds the KeywordList instance for the current platform.

    [M] assertValidIdentifier Assertion for Oracle identifiers.

    deprecated

    Assertion for Oracle identifiers. 
    public static function assertValidIdentifier(string $identifier): void
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] getSubstringExpression <tag_inheritdoc data-type='' data-description=''>Returns a SQL snippet to get a substring inside an SQL statement.

    Returns a SQL snippet to get a substring inside an SQL statement. 
    public function getSubstringExpression(
    string $string,
    string|int $start,
    string|int|null $length = null
): string

    Note: Not SQL92, but common functionality.

    SQLite only supports the 2 parameter variant of this function.

    Parameter
    type name summary
    ​string ​$string ​An sql string literal or column name/alias.
    ​string|​int ​$start ​Where to start the substring portion.
    ​string|​int|​null ​$length = null ​The substring portion length.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSubstringExpression() ​Returns a SQL snippet to get a substring inside an SQL statement.

    [m] getNowExpression

    deprecated 

    public function getNowExpression(string $type = "timestamp"): string
    Parameter
    type name summary
    ​string ​$type = "timestamp" ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getNowExpression() ​Returns the SQL snippet to get the current system date.

    [m] getLocateExpression Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str. 
    public function getLocateExpression(
    string $str,
    string $substr,
    string|int|false $startPos = false
): string
    Parameter
    type name summary
    ​string ​$str ​Literal string.
    ​string ​$substr ​Literal string to find.
    ​string|​int|​false ​$startPos = false ​Position to start at, beginning of string by default.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getLocateExpression() ​Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    [m] getDateArithmeticIntervalExpression Returns the SQL for a date arithmetic expression.

    Returns the SQL for a date arithmetic expression. 
    protected function getDateArithmeticIntervalExpression(
    string $date,
    string $operator,
    int|string $interval,
    string $unit
): string
    Parameter
    type name summary
    ​string ​$date ​The column or literal representing a date
    ​string ​$operator ​The arithmetic operator (+ or -).
    ​int|​string ​$interval ​The interval that shall be calculated into the date.
    ​string ​$unit ​The unit of the interval that shall be calculated into the date.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateArithmeticIntervalExpression() ​Returns the SQL for a date arithmetic expression.

    [m] getDateDiffExpression <tag_inheritdoc data-type='' data-description=''>Returns the SQL to calculate the difference in days between the two passed dates.

    Returns the SQL to calculate the difference in days between the two passed dates. 
    public function getDateDiffExpression(
    string $date1,
    string $date2
): string

    Computes diff = date1 - date2.

    Parameter
    type name summary
    ​string ​$date1 ​
    ​string ​$date2 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateDiffExpression() ​Returns the SQL to calculate the difference in days between the two passed dates.

    [m] getBitAndComparisonExpression Returns the SQL bit AND comparison expression.

    Returns the SQL bit AND comparison expression. 
    public function getBitAndComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBitAndComparisonExpression() ​Returns the SQL bit AND comparison expression.

    [m] getCurrentDatabaseExpression Returns the SQL expression which represents the currently selected database.

    Returns the SQL expression which represents the currently selected database. 
    public function getCurrentDatabaseExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCurrentDatabaseExpression() ​Returns the SQL expression which represents the currently selected database.

    [m] getBitOrComparisonExpression Returns the SQL bit OR comparison expression.

    Returns the SQL bit OR comparison expression. 
    public function getBitOrComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBitOrComparisonExpression() ​Returns the SQL bit OR comparison expression.

    [m] getCreatePrimaryKeySQL Returns the SQL to create an unnamed primary key constraint.

    Returns the SQL to create an unnamed primary key constraint. 
    public function getCreatePrimaryKeySQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreatePrimaryKeySQL() ​Returns the SQL to create an unnamed primary key constraint.

    [m] getCreateSequenceSQL Returns the SQL to create a sequence on this platform.

    Returns the SQL to create a sequence on this platform. 
    public function getCreateSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string

    Need to specifiy minvalue, since start with is hidden in the system and MINVALUE <= START WITH. Therefore we can use MINVALUE to be able to get a hint what START WITH was for later introspection in Doctrine\DBAL\Platforms\OraclePlatform::listSequences()

    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateSequenceSQL() ​Returns the SQL to create a sequence on this platform.
    See
    type summary
    ​OraclePlatform::listSequences() ​

    [m] getAlterSequenceSQL Returns the SQL to change a sequence on this platform.

    Returns the SQL to change a sequence on this platform. 
    public function getAlterSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getAlterSequenceSQL() ​Returns the SQL to change a sequence on this platform.

    [m] getSequenceNextValSQL 

    public function getSequenceNextValSQL(string $sequence): string
    Parameter
    type name summary
    ​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSequenceNextValSQL() ​

    [m] getSetTransactionIsolationSQL Returns the SQL to set the transaction isolation level.

    Returns the SQL to set the transaction isolation level. 
    public function getSetTransactionIsolationSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSetTransactionIsolationSQL() ​Returns the SQL to set the transaction isolation level.

    [m] _getTransactionIsolationLevelSQL Returns the SQL for a given transaction isolation level Connection constant.

    Returns the SQL for a given transaction isolation level Connection constant. 
    protected function _getTransactionIsolationLevelSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::_getTransactionIsolationLevelSQL() ​Returns the SQL for a given transaction isolation level Connection constant.

    [m] getBooleanTypeDeclarationSQL Returns the SQL snippet that declares a boolean column.

    Returns the SQL snippet that declares a boolean column. 
    public function getBooleanTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBooleanTypeDeclarationSQL() ​Returns the SQL snippet that declares a boolean column.

    [m] getIntegerTypeDeclarationSQL Returns the SQL snippet that declares a 4 byte integer column.

    Returns the SQL snippet that declares a 4 byte integer column. 
    public function getIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares a 4 byte integer column.

    [m] getBigIntTypeDeclarationSQL Returns the SQL snippet that declares an 8 byte integer column.

    Returns the SQL snippet that declares an 8 byte integer column. 
    public function getBigIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBigIntTypeDeclarationSQL() ​Returns the SQL snippet that declares an 8 byte integer column.

    [m] getSmallIntTypeDeclarationSQL Returns the SQL snippet that declares a 2 byte integer column.

    Returns the SQL snippet that declares a 2 byte integer column. 
    public function getSmallIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSmallIntTypeDeclarationSQL() ​Returns the SQL snippet that declares a 2 byte integer column.

    [m] getDateTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create datetime columns in

    Obtains DBMS specific SQL to be used to create datetime columns in 
    public function getDateTimeTypeDeclarationSQL(array|mixed[] $column): string

    statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTimeTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create datetime columns in

    [m] getDateTimeTzTypeDeclarationSQL Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    Obtains DBMS specific SQL to be used to create datetime with timezone offset columns. 
    public function getDateTimeTzTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTimeTzTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    [m] getDateTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create date columns in statements

    Obtains DBMS specific SQL to be used to create date columns in statements 
    public function getDateTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create date columns in statements

    [m] getTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create time columns in statements

    Obtains DBMS specific SQL to be used to create time columns in statements 
    public function getTimeTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTimeTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create time columns in statements

    [m] _getCommonIntegerTypeDeclarationSQL Returns the SQL snippet that declares common properties of an integer column.

    Returns the SQL snippet that declares common properties of an integer column. 
    protected function _getCommonIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::_getCommonIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares common properties of an integer column.

    [m] getVarcharTypeDeclarationSQLSnippet 

    protected function getVarcharTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​
    ​bool ​$fixed ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getVarcharTypeDeclarationSQLSnippet() ​

    [m] getBinaryTypeDeclarationSQLSnippet Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    protected function getBinaryTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​The length of the column.
    ​bool ​$fixed ​Whether the column length is fixed.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBinaryTypeDeclarationSQLSnippet() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getBinaryMaxLength Gets the maximum length of a binary column.

    deprecated

    Gets the maximum length of a binary column. 
    public function getBinaryMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBinaryMaxLength() ​Gets the maximum length of a binary column.

    [m] getClobTypeDeclarationSQL Returns the SQL snippet used to declare a CLOB column type.

    Returns the SQL snippet used to declare a CLOB column type. 
    public function getClobTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getClobTypeDeclarationSQL() ​Returns the SQL snippet used to declare a CLOB column type.

    [m] getListDatabasesSQL 

    public function getListDatabasesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListDatabasesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getListSequencesSQL 

    public function getListSequencesSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListSequencesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] _getCreateTableSQL Returns the SQL used to create a table.

    Returns the SQL used to create a table. 
    protected function _getCreateTableSQL(
    string $name,
    array|mixed[][] $columns,
    array|mixed[] $options = []
): string[]
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​mixed[][] ​$columns ​
    ​array|​mixed[] ​$options = [] ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::_getCreateTableSQL() ​Returns the SQL used to create a table.

    [m] getListTableIndexesSQL

    deprecated 

    public function getListTableIndexesSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableIndexesSQL() ​

    [m] getListTablesSQL

    deprecated 

    public function getListTablesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTablesSQL() ​

    [m] getListViewsSQL Returns the SQL to list all views of a database or user.

    Returns the SQL to list all views of a database or user. 
    public function getListViewsSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListViewsSQL() ​Returns the SQL to list all views of a database or user.
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getCreateAutoincrementSql 

    public function getCreateAutoincrementSql(
    string $name,
    string $table,
    int $start = 1
): string[]
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$table ​
    ​int ​$start = 1 ​
    Return
    type summary
    ​string[] ​

    [m] getDropAutoincrementSql 

    public function getDropAutoincrementSql(string $table): string[]
    Parameter
    type name summary
    ​string ​$table ​The table name to drop the autoincrement for.
    Return
    type summary
    ​string[] ​

    [m] getListTableForeignKeysSQL

    deprecated 

    public function getListTableForeignKeysSQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableForeignKeysSQL() ​

    [m] getListTableConstraintsSQL

    deprecated 

    public function getListTableConstraintsSQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableConstraintsSQL() ​

    [m] getListTableColumnsSQL

    deprecated 

    public function getListTableColumnsSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableColumnsSQL() ​

    [m] getDropForeignKeySQL Returns the SQL to drop a foreign key.

    Returns the SQL to drop a foreign key. 
    public function getDropForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDropForeignKeySQL() ​Returns the SQL to drop a foreign key.

    [m] getAdvancedForeignKeyOptionsSQL <tag_inheritdoc data-type='' data-description=''>Returns the FOREIGN KEY query section dealing with non-standard options

    Returns the FOREIGN KEY query section dealing with non-standard options 
    public function getAdvancedForeignKeyOptionsSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    as MATCH, INITIALLY DEFERRED, ON UPDATE, ...

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getAdvancedForeignKeyOptionsSQL() ​Returns the FOREIGN KEY query section dealing with non-standard options
    See
    type summary
    ​AbstractPlatform ​

    [m] getForeignKeyReferentialActionSQL Returns the given referential action in uppercase if valid, otherwise throws an exception.

    Returns the given referential action in uppercase if valid, otherwise throws an exception. 
    public function getForeignKeyReferentialActionSQL(string $action): string
    Parameter
    type name summary
    ​string ​$action ​The foreign key referential action.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​If unknown referential action given.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getForeignKeyReferentialActionSQL() ​Returns the given referential action in uppercase if valid, otherwise throws an exception.
    See
    type summary
    ​AbstractPlatform ​

    [m] getCreateDatabaseSQL Returns the SQL to create a new database.

    Returns the SQL to create a new database. 
    public function getCreateDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateDatabaseSQL() ​Returns the SQL to create a new database.

    [m] getDropDatabaseSQL Returns the SQL snippet to drop an existing database.

    Returns the SQL snippet to drop an existing database. 
    public function getDropDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be dropped.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDropDatabaseSQL() ​Returns the SQL snippet to drop an existing database.

    [m] getAlterTableSQL <tag_inheritdoc data-type='' data-description=''>Gets the SQL statements for altering an existing table.

    Gets the SQL statements for altering an existing table. 
    public function getAlterTableSQL(Doctrine\DBAL\Schema\TableDiff $diff): list

    This method returns an array of SQL statements, since some platforms need several statements.

    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getAlterTableSQL() ​Gets the SQL statements for altering an existing table.

    [m] getColumnDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to declare a generic type

    Obtains DBMS specific SQL code portion needed to declare a generic type 
    public function getColumnDeclarationSQL(
    string $name,
    array|mixed[] $column
): string

    column to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name the column to be declared.
    ​array|​mixed[] ​$column ​An associative array with the name of the properties
    Return
    type summary
    ​string ​DBMS specific SQL code portion that should be used to declare the column.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getColumnDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to declare a generic type
    See
    type summary
    ​AbstractPlatform ​

    [m] getRenameIndexSQL Returns the SQL for renaming an index on a table.

    Returns the SQL for renaming an index on a table. 
    protected function getRenameIndexSQL(
    string $oldIndexName,
    Doctrine\DBAL\Schema\Index $index,
    string $tableName
): string[]
    Parameter
    type name summary
    ​string ​$oldIndexName ​The name of the index to rename from.
    ​Index ​$index ​The definition of the index to rename to.
    ​string ​$tableName ​The table to rename the given index on.
    Return
    type summary
    ​string[] ​The sequence of SQL statements for renaming the given index.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getRenameIndexSQL() ​Returns the SQL for renaming an index on a table.

    [m] usesSequenceEmulatedIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform emulates identity columns through sequences.

    deprecated

    Whether the platform emulates identity columns through sequences. 
    public function usesSequenceEmulatedIdentityColumns(): bool

    Some platforms that do not support identity columns natively but support sequences can emulate identity columns by using sequences.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::usesSequenceEmulatedIdentityColumns() ​Whether the platform emulates identity columns through sequences.

    [m] getIdentitySequenceName Returns the name of the sequence for a particular identity column in a particular table.

    Returns the name of the sequence for a particular identity column in a particular table. 
    public function getIdentitySequenceName(
    string $tableName,
    string $columnName
): string
    Parameter
    type name summary
    ​string ​$tableName ​The name of the table to return the sequence name for.
    ​string ​$columnName ​The name of the identity column in the table to return the sequence name for.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getIdentitySequenceName() ​Returns the name of the sequence for a particular identity column in a particular table.
    See
    type summary
    ​usesSequenceEmulatedIdentityColumns ​

    [m] supportsCommentOnStatement Whether this platform support the proprietary syntax "COMMENT ON asset".

    Whether this platform support the proprietary syntax "COMMENT ON asset". 
    public function supportsCommentOnStatement(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsCommentOnStatement() ​Whether this platform support the proprietary syntax "COMMENT ON asset".
    See
    type summary
    ​AbstractPlatform ​

    [m] getName Gets the name of the platform.

    deprecated

    Gets the name of the platform. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getName() ​Gets the name of the platform.

    [m] doModifyLimitQuery Adds an platform-specific LIMIT clause to the query.

    Adds an platform-specific LIMIT clause to the query. 
    protected function doModifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::doModifyLimitQuery() ​Adds an platform-specific LIMIT clause to the query.

    [m] getCreateTemporaryTableSnippetSQL 

    public function getCreateTemporaryTableSnippetSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateTemporaryTableSnippetSQL() ​

    [m] getDateTimeTzFormatString <tag_inheritdoc data-type='' data-description=''>Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeTzFormatString(): string

    the format of a stored datetime with timezone value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTimeTzFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateFormatString <tag_inheritdoc data-type='' data-description=''>Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateFormatString(): string

    the format of a stored date value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getTimeFormatString <tag_inheritdoc data-type='' data-description=''>Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getTimeFormatString(): string

    the format of a stored time value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getMaxIdentifierLength Maximum length of any given database identifier, like tables or column names.

    Maximum length of any given database identifier, like tables or column names. 
    public function getMaxIdentifierLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getMaxIdentifierLength() ​Maximum length of any given database identifier, like tables or column names.

    [m] supportsSequences Whether the platform supports sequences.

    Whether the platform supports sequences. 
    public function supportsSequences(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsSequences() ​Whether the platform supports sequences.

    [m] supportsReleaseSavepoints Whether the platform supports releasing savepoints.

    Whether the platform supports releasing savepoints. 
    public function supportsReleaseSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsReleaseSavepoints() ​Whether the platform supports releasing savepoints.

    [m] getTruncateTableSQL <tag_inheritdoc data-type='' data-description=''>Generates a Truncate Table SQL statement for a given table.

    Generates a Truncate Table SQL statement for a given table. 
    public function getTruncateTableSQL(
    string $tableName,
    bool $cascade = false
): string

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

    Parameter
    type name summary
    ​string ​$tableName ​
    ​bool ​$cascade = false ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTruncateTableSQL() ​Generates a Truncate Table SQL statement for a given table.

    [m] getDummySelectSQL This is for test reasons, many vendors have special requirements for dummy statements.

    This is for test reasons, many vendors have special requirements for dummy statements. 
    public function getDummySelectSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDummySelectSQL() ​This is for test reasons, many vendors have special requirements for dummy statements.

    [m] initializeDoctrineTypeMappings Lazy load Doctrine Type Mappings.

    Lazy load Doctrine Type Mappings. 
    protected function initializeDoctrineTypeMappings(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::initializeDoctrineTypeMappings() ​Lazy load Doctrine Type Mappings.

    [m] releaseSavePoint Returns the SQL to release a savepoint.

    Returns the SQL to release a savepoint. 
    public function releaseSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::releaseSavePoint() ​Returns the SQL to release a savepoint.

    [m] getReservedKeywordsClass Returns the class name of the reserved keywords list.

    deprecated

    Returns the class name of the reserved keywords list. 
    protected function getReservedKeywordsClass(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getReservedKeywordsClass() ​Returns the class name of the reserved keywords list.
    See
    type summary
    ​OraclePlatform::createReservedKeywordsList() ​
    ​AbstractPlatform::createReservedKeywordsList() ​

    [m] getBlobTypeDeclarationSQL Returns the SQL Snippet used to declare a BLOB column type.

    Returns the SQL Snippet used to declare a BLOB column type. 
    public function getBlobTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBlobTypeDeclarationSQL() ​Returns the SQL Snippet used to declare a BLOB column type.

    [m] getListTableCommentsSQL

    deprecated 

    public function getListTableCommentsSQL(
    string $table,
    ?string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​?string ​$database = null ​
    Return
    type summary
    ​string ​

    [m] createSchemaManager Creates the schema manager that can be used to inspect and change the underlying

    Creates the schema manager that can be used to inspect and change the underlying 
    public function createSchemaManager(Doctrine\DBAL\Connection $connection): Doctrine\DBAL\Schema\OracleSchemaManager

    database schema according to the dialect of the platform.

    Parameter
    type name summary
    ​Connection ​$connection ​
    Return
    type summary
    ​OracleSchemaManager ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::createSchemaManager() ​Creates the schema manager that can be used to inspect and change the underlying

    [m] setDisableTypeComments

    final

    final public function setDisableTypeComments(bool $value)
    Parameter
    type name summary
    ​bool ​$value ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setDisableTypeComments() ​

    [m] setEventManager Sets the EventManager used by the Platform.

    deprecated

    Sets the EventManager used by the Platform. 
    public function setEventManager(Doctrine\Common\EventManager $eventManager): void
    Parameter
    type name summary
    ​EventManager ​$eventManager ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setEventManager() ​Sets the EventManager used by the Platform.

    [m] getEventManager Gets the EventManager used by the Platform.

    deprecated

    Gets the EventManager used by the Platform. 
    public function getEventManager(): Doctrine\Common\EventManager|null
    Return
    type summary
    ​EventManager|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEventManager() ​Gets the EventManager used by the Platform.

    [m] getAsciiStringTypeDeclarationSQL Returns the SQL snippet used to declare a column that can

    Returns the SQL snippet used to declare a column that can 
    public function getAsciiStringTypeDeclarationSQL(array|mixed[] $column): string

    store characters in the ASCII character set

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAsciiStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a column that can

    [m] getVarcharTypeDeclarationSQL Returns the SQL snippet used to declare a VARCHAR column type.

    deprecated

    Returns the SQL snippet used to declare a VARCHAR column type. 
    public function getVarcharTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharTypeDeclarationSQL() ​Returns the SQL snippet used to declare a VARCHAR column type.

    [m] getStringTypeDeclarationSQL Returns the SQL snippet used to declare a string column type.

    Returns the SQL snippet used to declare a string column type. 
    public function getStringTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a string column type.

    [m] getBinaryTypeDeclarationSQL Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    public function getBinaryTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryTypeDeclarationSQL() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getGuidTypeDeclarationSQL Returns the SQL snippet to declare a GUID/UUID column.

    Returns the SQL snippet to declare a GUID/UUID column. 
    public function getGuidTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CHAR(36) and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getGuidTypeDeclarationSQL() ​Returns the SQL snippet to declare a GUID/UUID column.

    [m] getJsonTypeDeclarationSQL Returns the SQL snippet to declare a JSON column.

    Returns the SQL snippet to declare a JSON column. 
    public function getJsonTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CLOB and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getJsonTypeDeclarationSQL() ​Returns the SQL snippet to declare a JSON column.

    [m] registerDoctrineTypeMapping Registers a doctrine type to be used in conjunction with a column type of this platform.

    Registers a doctrine type to be used in conjunction with a column type of this platform. 
    public function registerDoctrineTypeMapping(
    string $dbType,
    string $doctrineType
): void
    Parameter
    type name summary
    ​string ​$dbType ​
    ​string ​$doctrineType ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​If the type is not found.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::registerDoctrineTypeMapping() ​Registers a doctrine type to be used in conjunction with a column type of this platform.

    [m] getDoctrineTypeMapping Gets the Doctrine type that is mapped for the given database column type.

    Gets the Doctrine type that is mapped for the given database column type. 
    public function getDoctrineTypeMapping(string $dbType): string
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeMapping() ​Gets the Doctrine type that is mapped for the given database column type.

    [m] hasDoctrineTypeMappingFor Checks if a database type is currently supported by this platform.

    Checks if a database type is currently supported by this platform. 
    public function hasDoctrineTypeMappingFor(string $dbType): bool
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasDoctrineTypeMappingFor() ​Checks if a database type is currently supported by this platform.

    [m] initializeCommentedDoctrineTypes Initializes the Doctrine Type comments instance variable for in_array() checks.

    deprecated

    Initializes the Doctrine Type comments instance variable for in_array() checks. 
    protected function initializeCommentedDoctrineTypes(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::initializeCommentedDoctrineTypes() ​Initializes the Doctrine Type comments instance variable for in_array() checks.

    [m] isCommentedDoctrineType Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    deprecated

    Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type? 
    public function isCommentedDoctrineType(Doctrine\DBAL\Types\Type $doctrineType): bool
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::isCommentedDoctrineType() ​Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    [m] markDoctrineTypeCommented Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements. 
    public function markDoctrineTypeCommented(string|Doctrine\DBAL\Types\Type $doctrineType): void
    Parameter
    type name summary
    ​string|​Type ​$doctrineType ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::markDoctrineTypeCommented() ​Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    [m] getDoctrineTypeComment Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    deprecated

    Gets the comment to append to a column comment that helps parsing this type in reverse engineering. 
    public function getDoctrineTypeComment(Doctrine\DBAL\Types\Type $doctrineType): string
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeComment() ​Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    [m] getColumnComment Gets the comment of a passed column modified by potential doctrine type comment hints.

    deprecated

    Gets the comment of a passed column modified by potential doctrine type comment hints. 
    protected function getColumnComment(Doctrine\DBAL\Schema\Column $column): string|null
    Parameter
    type name summary
    ​Column ​$column ​
    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnComment() ​Gets the comment of a passed column modified by potential doctrine type comment hints.

    [m] getIdentifierQuoteCharacter Gets the character used for identifier quoting.

    deprecated

    Gets the character used for identifier quoting. 
    public function getIdentifierQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIdentifierQuoteCharacter() ​Gets the character used for identifier quoting.
    See
    type summary
    ​AbstractPlatform::quoteIdentifier() ​

    [m] getSqlCommentStartString Gets the string portion that starts an SQL comment.

    deprecated

    Gets the string portion that starts an SQL comment. 
    public function getSqlCommentStartString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentStartString() ​Gets the string portion that starts an SQL comment.

    [m] getSqlCommentEndString Gets the string portion that ends an SQL comment.

    deprecated

    Gets the string portion that ends an SQL comment. 
    public function getSqlCommentEndString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentEndString() ​Gets the string portion that ends an SQL comment.

    [m] getCharMaxLength Gets the maximum length of a char column.

    deprecated

    Gets the maximum length of a char column. 
    public function getCharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCharMaxLength() ​Gets the maximum length of a char column.

    [m] getVarcharMaxLength Gets the maximum length of a varchar column.

    deprecated

    Gets the maximum length of a varchar column. 
    public function getVarcharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharMaxLength() ​Gets the maximum length of a varchar column.

    [m] getVarcharDefaultLength Gets the default length of a varchar column.

    deprecated

    Gets the default length of a varchar column. 
    public function getVarcharDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharDefaultLength() ​Gets the default length of a varchar column.

    [m] getBinaryDefaultLength Gets the default length of a binary column.

    deprecated

    Gets the default length of a binary column. 
    public function getBinaryDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryDefaultLength() ​Gets the default length of a binary column.

    [m] getWildcards Gets all SQL wildcard characters of the platform.

    deprecated

    Gets all SQL wildcard characters of the platform. 
    public function getWildcards(): string[]
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWildcards() ​Gets all SQL wildcard characters of the platform.
    See
    type summary
    ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] getRegexpExpression Returns the regular expression operator.

    Returns the regular expression operator. 
    public function getRegexpExpression(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRegexpExpression() ​Returns the regular expression operator.

    [m] getAvgExpression Returns the SQL snippet to get the average value of a column.

    deprecated

    Returns the SQL snippet to get the average value of a column. 
    public function getAvgExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an AVG aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAvgExpression() ​Returns the SQL snippet to get the average value of a column.

    [m] getCountExpression Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    deprecated

    Returns the SQL snippet to get the number of rows (without a NULL value) of a column. 
    public function getCountExpression(string|int $column): string

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

    Parameter
    type name summary
    ​string|​int ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a COUNT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCountExpression() ​Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    [m] getMaxExpression Returns the SQL snippet to get the highest value of a column.

    deprecated

    Returns the SQL snippet to get the highest value of a column. 
    public function getMaxExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MAX aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxExpression() ​Returns the SQL snippet to get the highest value of a column.

    [m] getMinExpression Returns the SQL snippet to get the lowest value of a column.

    deprecated

    Returns the SQL snippet to get the lowest value of a column. 
    public function getMinExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MIN aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMinExpression() ​Returns the SQL snippet to get the lowest value of a column.

    [m] getSumExpression Returns the SQL snippet to get the total sum of a column.

    deprecated

    Returns the SQL snippet to get the total sum of a column. 
    public function getSumExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a SUM aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSumExpression() ​Returns the SQL snippet to get the total sum of a column.

    [m] getMd5Expression Returns the SQL snippet to get the md5 sum of a column.

    deprecated

    Returns the SQL snippet to get the md5 sum of a column. 
    public function getMd5Expression(string $column): string

    Note: Not SQL92, but common functionality.

    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMd5Expression() ​Returns the SQL snippet to get the md5 sum of a column.

    [m] getLengthExpression Returns the SQL snippet to get the length of a text column in characters.

    Returns the SQL snippet to get the length of a text column in characters. 
    public function getLengthExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLengthExpression() ​Returns the SQL snippet to get the length of a text column in characters.

    [m] getSqrtExpression Returns the SQL snippet to get the squared value of a column.

    deprecated

    Returns the SQL snippet to get the squared value of a column. 
    public function getSqrtExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an SQRT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqrtExpression() ​Returns the SQL snippet to get the squared value of a column.

    [m] getRoundExpression Returns the SQL snippet to round a numeric column to the number of decimals specified.

    deprecated

    Returns the SQL snippet to round a numeric column to the number of decimals specified. 
    public function getRoundExpression(
    string $column,
    string|int $decimals = 0
): string
    Parameter
    type name summary
    ​string ​$column ​
    ​string|​int ​$decimals = 0 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRoundExpression() ​Returns the SQL snippet to round a numeric column to the number of decimals specified.

    [m] getModExpression Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2. 
    public function getModExpression(
    string $expression1,
    string $expression2
): string
    Parameter
    type name summary
    ​string ​$expression1 ​
    ​string ​$expression2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getModExpression() ​Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    [m] getTrimExpression Returns the SQL snippet to trim a string.

    Returns the SQL snippet to trim a string. 
    public function getTrimExpression(
    string $str,
    int $mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED,
    string|bool $char = false
): string
    Parameter
    type name summary
    ​string ​$str ​The expression to apply the trim to.
    ​int ​$mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED ​The position of the trim (leading/trailing/both).
    ​string|​bool ​$char = false ​The char to trim, has to be quoted already. Defaults to space.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTrimExpression() ​Returns the SQL snippet to trim a string.

    [m] getRtrimExpression Returns the SQL snippet to trim trailing space characters from the expression.

    deprecated

    Returns the SQL snippet to trim trailing space characters from the expression. 
    public function getRtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRtrimExpression() ​Returns the SQL snippet to trim trailing space characters from the expression.

    [m] getLtrimExpression Returns the SQL snippet to trim leading space characters from the expression.

    deprecated

    Returns the SQL snippet to trim leading space characters from the expression. 
    public function getLtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLtrimExpression() ​Returns the SQL snippet to trim leading space characters from the expression.

    [m] getUpperExpression Returns the SQL snippet to change all characters from the expression to uppercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to uppercase, 
    public function getUpperExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUpperExpression() ​Returns the SQL snippet to change all characters from the expression to uppercase,

    [m] getLowerExpression Returns the SQL snippet to change all characters from the expression to lowercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to lowercase, 
    public function getLowerExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLowerExpression() ​Returns the SQL snippet to change all characters from the expression to lowercase,

    [m] getConcatExpression Returns a SQL snippet to concatenate the given expressions.

    Returns a SQL snippet to concatenate the given expressions. 
    public function getConcatExpression(): string

    Accepts an arbitrary number of string parameters. Each parameter must contain an expression.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getConcatExpression() ​Returns a SQL snippet to concatenate the given expressions.

    [m] getNotExpression Returns the SQL for a logical not.

    deprecated

    Returns the SQL for a logical not. 
    public function getNotExpression(string $expression): string

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

    Parameter
    type name summary
    ​string ​$expression ​
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getNotExpression() ​Returns the SQL for a logical not.

    [m] getIsNullExpression Returns the SQL that checks if an expression is null.

    deprecated

    Returns the SQL that checks if an expression is null. 
    public function getIsNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNullExpression() ​Returns the SQL that checks if an expression is null.

    [m] getIsNotNullExpression Returns the SQL that checks if an expression is not null.

    deprecated

    Returns the SQL that checks if an expression is not null. 
    public function getIsNotNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNotNullExpression() ​Returns the SQL that checks if an expression is not null.

    [m] getBetweenExpression Returns the SQL that checks if an expression evaluates to a value between two values.

    deprecated

    Returns the SQL that checks if an expression evaluates to a value between two values. 
    public function getBetweenExpression(
    string $expression,
    string $value1,
    string $value2
): string

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

    Parameter
    type name summary
    ​string ​$expression ​The value to compare to.
    ​string ​$value1 ​The lower value to compare with.
    ​string ​$value2 ​The higher value to compare with.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBetweenExpression() ​Returns the SQL that checks if an expression evaluates to a value between two values.

    [m] getAcosExpression Returns the SQL to get the arccosine of a value.

    deprecated

    Returns the SQL to get the arccosine of a value. 
    public function getAcosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAcosExpression() ​Returns the SQL to get the arccosine of a value.

    [m] getSinExpression Returns the SQL to get the sine of a value.

    deprecated

    Returns the SQL to get the sine of a value. 
    public function getSinExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSinExpression() ​Returns the SQL to get the sine of a value.

    [m] getPiExpression Returns the SQL to get the PI value.

    deprecated

    Returns the SQL to get the PI value. 
    public function getPiExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPiExpression() ​Returns the SQL to get the PI value.

    [m] getCosExpression Returns the SQL to get the cosine of a value.

    deprecated

    Returns the SQL to get the cosine of a value. 
    public function getCosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCosExpression() ​Returns the SQL to get the cosine of a value.

    [m] getDateAddSecondsExpression Returns the SQL to add the number of given seconds to a date.

    Returns the SQL to add the number of given seconds to a date. 
    public function getDateAddSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddSecondsExpression() ​Returns the SQL to add the number of given seconds to a date.

    [m] getDateSubSecondsExpression Returns the SQL to subtract the number of given seconds from a date.

    Returns the SQL to subtract the number of given seconds from a date. 
    public function getDateSubSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubSecondsExpression() ​Returns the SQL to subtract the number of given seconds from a date.

    [m] getDateAddMinutesExpression Returns the SQL to add the number of given minutes to a date.

    Returns the SQL to add the number of given minutes to a date. 
    public function getDateAddMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMinutesExpression() ​Returns the SQL to add the number of given minutes to a date.

    [m] getDateSubMinutesExpression Returns the SQL to subtract the number of given minutes from a date.

    Returns the SQL to subtract the number of given minutes from a date. 
    public function getDateSubMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMinutesExpression() ​Returns the SQL to subtract the number of given minutes from a date.

    [m] getDateAddHourExpression Returns the SQL to add the number of given hours to a date.

    Returns the SQL to add the number of given hours to a date. 
    public function getDateAddHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddHourExpression() ​Returns the SQL to add the number of given hours to a date.

    [m] getDateSubHourExpression Returns the SQL to subtract the number of given hours to a date.

    Returns the SQL to subtract the number of given hours to a date. 
    public function getDateSubHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubHourExpression() ​Returns the SQL to subtract the number of given hours to a date.

    [m] getDateAddDaysExpression Returns the SQL to add the number of given days to a date.

    Returns the SQL to add the number of given days to a date. 
    public function getDateAddDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddDaysExpression() ​Returns the SQL to add the number of given days to a date.

    [m] getDateSubDaysExpression Returns the SQL to subtract the number of given days to a date.

    Returns the SQL to subtract the number of given days to a date. 
    public function getDateSubDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubDaysExpression() ​Returns the SQL to subtract the number of given days to a date.

    [m] getDateAddWeeksExpression Returns the SQL to add the number of given weeks to a date.

    Returns the SQL to add the number of given weeks to a date. 
    public function getDateAddWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddWeeksExpression() ​Returns the SQL to add the number of given weeks to a date.

    [m] getDateSubWeeksExpression Returns the SQL to subtract the number of given weeks from a date.

    Returns the SQL to subtract the number of given weeks from a date. 
    public function getDateSubWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubWeeksExpression() ​Returns the SQL to subtract the number of given weeks from a date.

    [m] getDateAddMonthExpression Returns the SQL to add the number of given months to a date.

    Returns the SQL to add the number of given months to a date. 
    public function getDateAddMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMonthExpression() ​Returns the SQL to add the number of given months to a date.

    [m] getDateSubMonthExpression Returns the SQL to subtract the number of given months to a date.

    Returns the SQL to subtract the number of given months to a date. 
    public function getDateSubMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMonthExpression() ​Returns the SQL to subtract the number of given months to a date.

    [m] getDateAddQuartersExpression Returns the SQL to add the number of given quarters to a date.

    Returns the SQL to add the number of given quarters to a date. 
    public function getDateAddQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddQuartersExpression() ​Returns the SQL to add the number of given quarters to a date.

    [m] getDateSubQuartersExpression Returns the SQL to subtract the number of given quarters from a date.

    Returns the SQL to subtract the number of given quarters from a date. 
    public function getDateSubQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubQuartersExpression() ​Returns the SQL to subtract the number of given quarters from a date.

    [m] getDateAddYearsExpression Returns the SQL to add the number of given years to a date.

    Returns the SQL to add the number of given years to a date. 
    public function getDateAddYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddYearsExpression() ​Returns the SQL to add the number of given years to a date.

    [m] getDateSubYearsExpression Returns the SQL to subtract the number of given years from a date.

    Returns the SQL to subtract the number of given years from a date. 
    public function getDateSubYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubYearsExpression() ​Returns the SQL to subtract the number of given years from a date.

    [m] multiplyInterval Generates the SQL expression which represents the given date interval multiplied by a number

    Generates the SQL expression which represents the given date interval multiplied by a number 
    protected function multiplyInterval(
    string $interval,
    int $multiplier
): string
    Parameter
    type name summary
    ​string ​$interval ​SQL expression describing the interval value
    ​int ​$multiplier ​Interval multiplier
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::multiplyInterval() ​Generates the SQL expression which represents the given date interval multiplied by a number

    [m] getForUpdateSQL Returns the FOR UPDATE expression.

    deprecated

    Returns the FOR UPDATE expression. 
    public function getForUpdateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForUpdateSQL() ​Returns the FOR UPDATE expression.

    [m] appendLockHint Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    Honors that some SQL vendors such as MsSql use table hints for locking instead of the 
    public function appendLockHint(
    string $fromClause,
    int $lockMode
): string

    ANSI SQL FOR UPDATE specification.

    Parameter
    type name summary
    ​string ​$fromClause ​The FROM clause to append the hint for the given lock mode to
    ​int ​$lockMode ​One of the Doctrine\DBAL\LockMode::* constants
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::appendLockHint() ​Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    [m] getReadLockSQL Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock. 
    public function getReadLockSQL(): string

    This defaults to the ANSI SQL "FOR UPDATE", which is an exclusive lock (Write). Some database vendors allow to lighten this constraint up to be a real read lock.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getReadLockSQL() ​Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    [m] getWriteLockSQL Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows. 
    public function getWriteLockSQL(): string

    The semantics of this lock mode should equal the SELECT .. FOR UPDATE of the ANSI SQL standard.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWriteLockSQL() ​Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    [m] getDropTableSQL Returns the SQL snippet to drop an existing table.

    Returns the SQL snippet to drop an existing table. 
    public function getDropTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTableSQL() ​Returns the SQL snippet to drop an existing table.

    [m] getDropTemporaryTableSQL Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction. 
    public function getDropTemporaryTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTemporaryTableSQL() ​Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    [m] getDropIndexSQL Returns the SQL to drop an index from a table.

    Returns the SQL to drop an index from a table. 
    public function getDropIndexSQL(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string|null $table = null
): string
    Parameter
    type name summary
    ​Index|​string ​$index ​
    ​Table|​string|​null ​$table = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropIndexSQL() ​Returns the SQL to drop an index from a table.

    [m] getDropConstraintSQL Returns the SQL to drop a constraint.

    Returns the SQL to drop a constraint. 
    public function getDropConstraintSQL(
    Doctrine\DBAL\Schema\Constraint|string $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint|​string ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropConstraintSQL() ​Returns the SQL to drop a constraint.
    See
    type summary
    ​AbstractPlatform ​

    [m] getDropUniqueConstraintSQL Returns the SQL to drop a unique constraint.

    Returns the SQL to drop a unique constraint. 
    public function getDropUniqueConstraintSQL(
    string $name,
    string $tableName
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropUniqueConstraintSQL() ​Returns the SQL to drop a unique constraint.

    [m] getCreateTableSQL Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    Returns the SQL statement(s) to create a table with the specified name, columns and constraints 
    public function getCreateTableSQL(
    Doctrine\DBAL\Schema\Table $table,
    int $createFlags = self::CREATE_INDEXES
): list

    on this platform.

    Parameter
    type name summary
    ​Table ​$table ​
    ​int ​$createFlags = self::CREATE_INDEXES ​
    Return
    type summary
    ​list ​The list of SQL statements.
    Throws
    type summary
    ​Exception ​
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableSQL() ​Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    [m] createSelectSQLBuilder 

    public function createSelectSQLBuilder(): Doctrine\DBAL\SQL\Builder\SelectSQLBuilder
    Return
    type summary
    ​SelectSQLBuilder ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSelectSQLBuilder() ​

    [m] getCreateTableWithoutForeignKeysSQL

    final

    final protected function getCreateTableWithoutForeignKeysSQL(Doctrine\DBAL\Schema\Table $table): array|list
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableWithoutForeignKeysSQL() ​

    [m] getCreateTablesSQL 

    public function getCreateTablesSQL(array|Doctrine\DBAL\Schema\Table[] $tables): array|list
    Parameter
    type name summary
    ​array|​Table[] ​$tables ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTablesSQL() ​

    [m] getDropTablesSQL 

    public function getDropTablesSQL(array|list $tables): array|list
    Parameter
    type name summary
    ​array|​list ​$tables ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTablesSQL() ​

    [m] getCommentOnTableSQL 

    protected function getCommentOnTableSQL(
    string $tableName,
    ?string $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​?string ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnTableSQL() ​

    [m] getCommentOnColumnSQL 

    public function getCommentOnColumnSQL(
    string $tableName,
    string $columnName,
    string|null $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    ​string|​null ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnColumnSQL() ​

    [m] getInlineColumnCommentSQL Returns the SQL to create inline comment on a column.

    Returns the SQL to create inline comment on a column. 
    public function getInlineColumnCommentSQL(string $comment): string
    Parameter
    type name summary
    ​string ​$comment ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getInlineColumnCommentSQL() ​Returns the SQL to create inline comment on a column.

    [m] getAlterSchemaSQL Generates SQL statements that can be used to apply the diff.

    Generates SQL statements that can be used to apply the diff. 
    public function getAlterSchemaSQL(Doctrine\DBAL\Schema\SchemaDiff $diff): array|list
    Parameter
    type name summary
    ​SchemaDiff ​$diff ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAlterSchemaSQL() ​Generates SQL statements that can be used to apply the diff.

    [m] getDropSequenceSQL Returns the SQL snippet to drop an existing sequence.

    Returns the SQL snippet to drop an existing sequence. 
    public function getDropSequenceSQL(Doctrine\DBAL\Schema\Sequence|string $sequence): string
    Parameter
    type name summary
    ​Sequence|​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSequenceSQL() ​Returns the SQL snippet to drop an existing sequence.

    [m] getCreateConstraintSQL Returns the SQL to create a constraint on a table on this platform.

    deprecated

    Returns the SQL to create a constraint on a table on this platform. 
    public function getCreateConstraintSQL(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateConstraintSQL() ​Returns the SQL to create a constraint on a table on this platform.
    See
    type summary
    ​AbstractPlatform::getCreateIndexSQL() ​
    ​AbstractPlatform::getCreateForeignKeySQL() ​

    [m] getCreateIndexSQL Returns the SQL to create an index on a table on this platform.

    Returns the SQL to create an index on a table on this platform. 
    public function getCreateIndexSQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateIndexSQL() ​Returns the SQL to create an index on a table on this platform.

    [m] getPartialIndexSQL Adds condition for partial index.

    Adds condition for partial index. 
    protected function getPartialIndexSQL(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPartialIndexSQL() ​Adds condition for partial index.

    [m] getCreateIndexSQLFlags Adds additional flags for index generation.

    Adds additional flags for index generation. 
    protected function getCreateIndexSQLFlags(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateIndexSQLFlags() ​Adds additional flags for index generation.

    [m] getCreateSchemaSQL Returns the SQL to create a named schema.

    Returns the SQL to create a named schema. 
    public function getCreateSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateSchemaSQL() ​Returns the SQL to create a named schema.

    [m] getCreateUniqueConstraintSQL Returns the SQL to create a unique constraint on a table on this platform.

    Returns the SQL to create a unique constraint on a table on this platform. 
    public function getCreateUniqueConstraintSQL(
    Doctrine\DBAL\Schema\UniqueConstraint $constraint,
    string $tableName
): string
    Parameter
    type name summary
    ​UniqueConstraint ​$constraint ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateUniqueConstraintSQL() ​Returns the SQL to create a unique constraint on a table on this platform.

    [m] getDropSchemaSQL Returns the SQL snippet to drop a schema.

    Returns the SQL snippet to drop a schema. 
    public function getDropSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSchemaSQL() ​Returns the SQL snippet to drop a schema.

    [m] quoteIdentifier Quotes a string so that it can be safely used as a table or column name,

    Quotes a string so that it can be safely used as a table or column name, 
    public function quoteIdentifier(string $str): string

    even if it is a reserved word of the platform. This also detects identifier chains separated by dot and quotes them independently.

    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.

    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteIdentifier() ​Quotes a string so that it can be safely used as a table or column name,

    [m] quoteSingleIdentifier Quotes a single identifier (no dot chain separation).

    Quotes a single identifier (no dot chain separation). 
    public function quoteSingleIdentifier(string $str): string
    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteSingleIdentifier() ​Quotes a single identifier (no dot chain separation).

    [m] getCreateForeignKeySQL Returns the SQL to create a new foreign key.

    Returns the SQL to create a new foreign key. 
    public function getCreateForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key constraint.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateForeignKeySQL() ​Returns the SQL to create a new foreign key.

    [m] getRenameTableSQL 

    public function getRenameTableSQL(
    string $oldName,
    string $newName
): array|list
    Parameter
    type name summary
    ​string ​$oldName ​
    ​string ​$newName ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRenameTableSQL() ​

    [m] onSchemaAlterTableAddColumn 

    protected function onSchemaAlterTableAddColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    mixed[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​mixed[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableAddColumn() ​

    [m] onSchemaAlterTableRemoveColumn 

    protected function onSchemaAlterTableRemoveColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRemoveColumn() ​

    [m] onSchemaAlterTableChangeColumn 

    protected function onSchemaAlterTableChangeColumn(
    Doctrine\DBAL\Schema\ColumnDiff $columnDiff,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​ColumnDiff ​$columnDiff ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableChangeColumn() ​

    [m] onSchemaAlterTableRenameColumn 

    protected function onSchemaAlterTableRenameColumn(
    string $oldColumnName,
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​string ​$oldColumnName ​
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRenameColumn() ​

    [m] onSchemaAlterTable 

    protected function onSchemaAlterTable(
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$sql
): bool
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    ​string[] ​&$sql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTable() ​

    [m] getPreAlterTableIndexForeignKeySQL 

    protected function getPreAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPreAlterTableIndexForeignKeySQL() ​

    [m] getPostAlterTableIndexForeignKeySQL 

    protected function getPostAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPostAlterTableIndexForeignKeySQL() ​

    [m] getColumnDeclarationListSQL Gets declaration of a number of columns in bulk.

    Gets declaration of a number of columns in bulk. 
    public function getColumnDeclarationListSQL(array|mixed[][] $columns): string
    Parameter
    type name summary
    ​array|​mixed[][] ​$columns ​A multidimensional associative array.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationListSQL() ​Gets declaration of a number of columns in bulk.

    [m] getDecimalTypeDeclarationSQL Returns the SQL snippet that declares a floating point column of arbitrary precision.

    Returns the SQL snippet that declares a floating point column of arbitrary precision. 
    public function getDecimalTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDecimalTypeDeclarationSQL() ​Returns the SQL snippet that declares a floating point column of arbitrary precision.

    [m] getDefaultValueDeclarationSQL Obtains DBMS specific SQL code portion needed to set a default value

    Obtains DBMS specific SQL code portion needed to set a default value 
    public function getDefaultValueDeclarationSQL(mixed[] $column): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​mixed[] ​$column ​The column definition array.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a default value.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDefaultValueDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a default value

    [m] getCheckDeclarationSQL Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    Obtains DBMS specific SQL code portion needed to set a CHECK constraint 
    public function getCheckDeclarationSQL(array|string[]|mixed[][] $definition): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​string[]|​mixed[][] ​$definition ​The check definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a CHECK constraint.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCheckDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    [m] getUniqueConstraintDeclarationSQL Obtains DBMS specific SQL code portion needed to set a unique

    Obtains DBMS specific SQL code portion needed to set a unique 
    public function getUniqueConstraintDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\UniqueConstraint $constraint
): string

    constraint declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the unique constraint.
    ​UniqueConstraint ​$constraint ​The unique constraint definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a constraint.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueConstraintDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a unique

    [m] getIndexDeclarationSQL Obtains DBMS specific SQL code portion needed to set an index

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\Index $index
): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the index.
    ​Index ​$index ​The index definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set an index.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getCustomTypeDeclarationSQL Obtains SQL code portion needed to create a custom column,

    deprecated

    Obtains SQL code portion needed to create a custom column, 
    public function getCustomTypeDeclarationSQL(array|mixed[] $column): string

    e.g. when a column has the "columnDefinition" keyword. Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCustomTypeDeclarationSQL() ​Obtains SQL code portion needed to create a custom column,

    [m] getIndexFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexFieldDeclarationListSQL(Doctrine\DBAL\Schema\Index $index): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getColumnsFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getColumnsFieldDeclarationListSQL(array|mixed[] $columns): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$columns ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnsFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getTemporaryTableSQL Returns the required SQL string that fits between CREATE ... TABLE

    deprecated

    Returns the required SQL string that fits between CREATE ... TABLE 
    public function getTemporaryTableSQL(): string

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

    Return
    type summary
    ​string ​The string required to be placed between "CREATE" and "TABLE"
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableSQL() ​Returns the required SQL string that fits between CREATE ... TABLE

    [m] getTemporaryTableName Some vendors require temporary table names to be qualified specially.

    Some vendors require temporary table names to be qualified specially. 
    public function getTemporaryTableName(string $tableName): string
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableName() ​Some vendors require temporary table names to be qualified specially.

    [m] getForeignKeyDeclarationSQL Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyDeclarationSQL() ​Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getForeignKeyBaseDeclarationSQL Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyBaseDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyBaseDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getUniqueFieldDeclarationSQL Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    deprecated

    Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint 
    public function getUniqueFieldDeclarationSQL(): string

    of a column declaration to be used in statements like CREATE TABLE.

    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the UNIQUE constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueFieldDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    [m] getColumnCharsetDeclarationSQL Obtains DBMS specific SQL code portion needed to set the CHARACTER SET

    Obtains DBMS specific SQL code portion needed to set the CHARACTER SET 
    public function getColumnCharsetDeclarationSQL(string $charset): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$charset ​The name of the charset.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the CHARACTER SET
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnCharsetDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the CHARACTER SET

    [m] getColumnCollationDeclarationSQL Obtains DBMS specific SQL code portion needed to set the COLLATION

    Obtains DBMS specific SQL code portion needed to set the COLLATION 
    public function getColumnCollationDeclarationSQL(string $collation): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$collation ​The name of the collation.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the COLLATION
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnCollationDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the COLLATION

    [m] prefersIdentityColumns Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    deprecated

    Whether the platform prefers identity columns (eg. autoincrement) for ID generation. 
    public function prefersIdentityColumns(): bool

    Subclasses should override this method to return TRUE if they prefer identity columns.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::prefersIdentityColumns() ​Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    [m] convertBooleans Some platforms need the boolean values to be converted.

    Some platforms need the boolean values to be converted. 
    public function convertBooleans(mixed $item): mixed

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

    Note: if the input is not a boolean the original input might be returned.

    There are two contexts when converting booleans: Literals and Prepared Statements. This method should handle the literal case

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertBooleans() ​Some platforms need the boolean values to be converted.

    [m] convertFromBoolean Some platforms have boolean literals that needs to be correctly converted

    Some platforms have boolean literals that needs to be correctly converted 
    public function convertFromBoolean(T $item): (T

    The default conversion tries to convert value into bool "(bool)$item"

    Parameter
    type name summary
    ​T ​$item ​
    Return
    type summary
    ​(T ​is null ? null : bool)
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertFromBoolean() ​Some platforms have boolean literals that needs to be correctly converted

    [m] convertBooleansToDatabaseValue This method should handle the prepared statements case. When there is no

    This method should handle the prepared statements case. When there is no 
    public function convertBooleansToDatabaseValue(mixed $item): mixed

    distinction, it's OK to use the same method.

    Note: if the input is not a boolean the original input might be returned.

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertBooleansToDatabaseValue() ​This method should handle the prepared statements case. When there is no

    [m] getCurrentDateSQL Returns the SQL specific for the platform to get the current date.

    Returns the SQL specific for the platform to get the current date. 
    public function getCurrentDateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentDateSQL() ​Returns the SQL specific for the platform to get the current date.

    [m] getCurrentTimeSQL Returns the SQL specific for the platform to get the current time.

    Returns the SQL specific for the platform to get the current time. 
    public function getCurrentTimeSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimeSQL() ​Returns the SQL specific for the platform to get the current time.

    [m] getCurrentTimestampSQL Returns the SQL specific for the platform to get the current timestamp

    Returns the SQL specific for the platform to get the current timestamp 
    public function getCurrentTimestampSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimestampSQL() ​Returns the SQL specific for the platform to get the current timestamp

    [m] getListNamespacesSQL Returns the SQL statement for retrieving the namespaces defined in the database.

    deprecated

    Returns the SQL statement for retrieving the namespaces defined in the database. 
    public function getListNamespacesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListNamespacesSQL() ​Returns the SQL statement for retrieving the namespaces defined in the database.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] getListUsersSQL

    deprecated 

    public function getListUsersSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListUsersSQL() ​

    [m] getCreateViewSQL 

    public function getCreateViewSQL(
    string $name,
    string $sql
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$sql ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateViewSQL() ​

    [m] getDropViewSQL 

    public function getDropViewSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropViewSQL() ​

    [m] getFloatDeclarationSQL 

    public function getFloatDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getFloatDeclarationSQL() ​

    [m] getDefaultTransactionIsolationLevel Gets the default transaction isolation level of the platform.

    Gets the default transaction isolation level of the platform. 
    public function getDefaultTransactionIsolationLevel(): Doctrine\DBAL\TransactionIsolationLevel::*()
    Return
    type summary
    ​TransactionIsolationLevel::*() ​The default isolation level.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDefaultTransactionIsolationLevel() ​Gets the default transaction isolation level of the platform.
    See
    type summary
    ​TransactionIsolationLevel ​

    [m] supportsIdentityColumns Whether the platform supports identity columns.

    Whether the platform supports identity columns. 
    public function supportsIdentityColumns(): bool

    Identity columns are columns that receive an auto-generated value from the database on insert of a row.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsIdentityColumns() ​Whether the platform supports identity columns.

    [m] supportsIndexes Whether the platform supports indexes.

    deprecated

    Whether the platform supports indexes. 
    public function supportsIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsIndexes() ​Whether the platform supports indexes.

    [m] supportsPartialIndexes Whether the platform supports partial indexes.

    Whether the platform supports partial indexes. 
    public function supportsPartialIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPartialIndexes() ​Whether the platform supports partial indexes.

    [m] supportsColumnLengthIndexes Whether the platform supports indexes with column length definitions.

    Whether the platform supports indexes with column length definitions. 
    public function supportsColumnLengthIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsColumnLengthIndexes() ​Whether the platform supports indexes with column length definitions.

    [m] supportsAlterTable Whether the platform supports altering tables.

    deprecated

    Whether the platform supports altering tables. 
    public function supportsAlterTable(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsAlterTable() ​Whether the platform supports altering tables.

    [m] supportsTransactions Whether the platform supports transactions.

    deprecated

    Whether the platform supports transactions. 
    public function supportsTransactions(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsTransactions() ​Whether the platform supports transactions.

    [m] supportsSavepoints Whether the platform supports savepoints.

    Whether the platform supports savepoints. 
    public function supportsSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSavepoints() ​Whether the platform supports savepoints.

    [m] supportsPrimaryConstraints Whether the platform supports primary key constraints.

    deprecated

    Whether the platform supports primary key constraints. 
    public function supportsPrimaryConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPrimaryConstraints() ​Whether the platform supports primary key constraints.

    [m] supportsForeignKeyConstraints Whether the platform supports foreign key constraints.

    deprecated

    Whether the platform supports foreign key constraints. 
    public function supportsForeignKeyConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsForeignKeyConstraints() ​Whether the platform supports foreign key constraints.

    [m] supportsSchemas Whether the platform supports database schemas.

    Whether the platform supports database schemas. 
    public function supportsSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSchemas() ​Whether the platform supports database schemas.

    [m] canEmulateSchemas Whether this platform can emulate schemas.

    deprecated

    Whether this platform can emulate schemas. 
    public function canEmulateSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::canEmulateSchemas() ​Whether this platform can emulate schemas.
    See
    type summary
    ​AbstractManager::introspectSchema() ​

    [m] getDefaultSchemaName Returns the default schema name.

    deprecated

    Returns the default schema name. 
    public function getDefaultSchemaName(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDefaultSchemaName() ​Returns the default schema name.

    [m] supportsCreateDropDatabase Whether this platform supports create database.

    deprecated

    Whether this platform supports create database. 
    public function supportsCreateDropDatabase(): bool

    Some databases don't allow to create and drop databases at all or only with certain tools.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsCreateDropDatabase() ​Whether this platform supports create database.

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

    deprecated

    Whether the platform supports getting the affected rows of a recent update/delete type query. 
    public function supportsGettingAffectedRows(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsGettingAffectedRows() ​Whether the platform supports getting the affected rows of a recent update/delete type query.

    [m] supportsInlineColumnComments Whether this platform support to add inline column comments as postfix.

    Whether this platform support to add inline column comments as postfix. 
    public function supportsInlineColumnComments(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsInlineColumnComments() ​Whether this platform support to add inline column comments as postfix.

    [m] hasNativeGuidType Does this platform have native guid type.

    deprecated

    Does this platform have native guid type. 
    public function hasNativeGuidType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasNativeGuidType() ​Does this platform have native guid type.

    [m] hasNativeJsonType Does this platform have native JSON type.

    deprecated

    Does this platform have native JSON type. 
    public function hasNativeJsonType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasNativeJsonType() ​Does this platform have native JSON type.

    [m] supportsViews Whether this platform supports views.

    deprecated

    Whether this platform supports views. 
    public function supportsViews(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsViews() ​Whether this platform supports views.

    [m] supportsColumnCollation Does this platform support column collation?

    Does this platform support column collation? 
    public function supportsColumnCollation(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsColumnCollation() ​Does this platform support column collation?

    [m] getDateTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeFormatString(): string

    the format of a stored datetime value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] modifyLimitQuery Adds an driver-specific LIMIT clause to the query.

    final

    Adds an driver-specific LIMIT clause to the query. 
    final public function modifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset = 0
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset = 0 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::modifyLimitQuery() ​Adds an driver-specific LIMIT clause to the query.

    [m] supportsLimitOffset Whether the database platform support offsets in modify limit clauses.

    deprecated

    Whether the database platform support offsets in modify limit clauses. 
    public function supportsLimitOffset(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsLimitOffset() ​Whether the database platform support offsets in modify limit clauses.

    [m] getEmptyIdentityInsertSQL Returns the insert SQL for an empty insert statement.

    Returns the insert SQL for an empty insert statement. 
    public function getEmptyIdentityInsertSQL(
    string $quotedTableName,
    string $quotedIdentifierColumnName
): string
    Parameter
    type name summary
    ​string ​$quotedTableName ​
    ​string ​$quotedIdentifierColumnName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEmptyIdentityInsertSQL() ​Returns the insert SQL for an empty insert statement.

    [m] createSavePoint Returns the SQL to create a new savepoint.

    Returns the SQL to create a new savepoint. 
    public function createSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSavePoint() ​Returns the SQL to create a new savepoint.

    [m] rollbackSavePoint Returns the SQL to rollback a savepoint.

    Returns the SQL to rollback a savepoint. 
    public function rollbackSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::rollbackSavePoint() ​Returns the SQL to rollback a savepoint.

    [m] getReservedKeywordsList Returns the keyword list instance of this platform.

    final

    Returns the keyword list instance of this platform. 
    final public function getReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList
    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​If no keyword list is specified.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getReservedKeywordsList() ​Returns the keyword list instance of this platform.

    [m] createReservedKeywordsList Creates an instance of the reserved keyword list of this platform.

    Creates an instance of the reserved keyword list of this platform. 
    protected function createReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList

    This method will become @abstract in DBAL 4.0.0.

    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createReservedKeywordsList() ​Creates an instance of the reserved keyword list of this platform.

    [m] quoteStringLiteral Quotes a literal string.

    Quotes a literal string. 
    public function quoteStringLiteral(string $str): string

    This method is NOT meant to fix SQL injections! It is only meant to escape this platform's string literal quote character inside the given literal string.

    Parameter
    type name summary
    ​string ​$str ​The literal string to be quoted.
    Return
    type summary
    ​string ​The quoted literal string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteStringLiteral() ​Quotes a literal string.

    [m] getStringLiteralQuoteCharacter Gets the character used for string literal quoting.

    deprecated

    Gets the character used for string literal quoting. 
    public function getStringLiteralQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringLiteralQuoteCharacter() ​Gets the character used for string literal quoting.
    See
    type summary
    ​AbstractPlatform::quoteStringLiteral() ​

    [m] escapeStringForLike Escapes metacharacters in a string intended to be used with a LIKE

    final

    Escapes metacharacters in a string intended to be used with a LIKE 
    final public function escapeStringForLike(
    string $inputString,
    string $escapeChar
): string

    operator.

    Parameter
    type name summary
    ​string ​$inputString ​a literal, unquoted string
    ​string ​$escapeChar ​should be reused by the caller in the LIKE
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::escapeStringForLike() ​Escapes metacharacters in a string intended to be used with a LIKE

    [m] createSQLParser 

    public function createSQLParser(): Doctrine\DBAL\SQL\Parser
    Return
    type summary
    ​Parser ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSQLParser() ​

    [m] getLikeWildcardCharacters 

    protected function getLikeWildcardCharacters(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] columnsEqual Compares the definitions of the given columns in the context of this platform.

    Compares the definitions of the given columns in the context of this platform. 
    public function columnsEqual(
    Doctrine\DBAL\Schema\Column $column1,
    Doctrine\DBAL\Schema\Column $column2
): bool
    Parameter
    type name summary
    ​Column ​$column1 ​
    ​Column ​$column2 ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::columnsEqual() ​Compares the definitions of the given columns in the context of this platform.

    [C] PostgreSQLPlatform Provides the behavior, features and SQL dialect of the PostgreSQL database platform of the oldest supported version.

    Provides the behavior, features and SQL dialect of the PostgreSQL database platform of the oldest supported version.

    Hierarchy

    Parents
    type summary
    ​AbstractPlatform ​Base class for all DatabasePlatforms. The DatabasePlatforms are the central

    [C] CREATE_INDEXES 

    public const int CREATE_INDEXES = 1
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_INDEXES ​

    [C] CREATE_FOREIGNKEYS 

    public const int CREATE_FOREIGNKEYS = 2
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_FOREIGNKEYS ​

    [p] $doctrineTypeMapping 

    protected string[]|null $doctrineTypeMapping = null

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeMapping ​

    [p] $doctrineTypeComments Contains a list of all columns that should generate parseable column comments for type-detection

    deprecated

    Contains a list of all columns that should generate parseable column comments for type-detection 
    protected string[]|null $doctrineTypeComments = null

    in reverse engineering scenarios.

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeComments ​Contains a list of all columns that should generate parseable column comments for type-detection

    [p] $_eventManager

    deprecated 

    protected Doctrine\Common\EventManager|null $_eventManager = null

    Type: EventManager|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_eventManager ​

    [p] $_keywords Holds the KeywordList instance for the current platform.

    Holds the KeywordList instance for the current platform. 
    protected Doctrine\DBAL\Platforms\Keywords\KeywordList|null $_keywords = null

    Type: KeywordList|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_keywords ​Holds the KeywordList instance for the current platform.

    [m] setUseBooleanTrueFalseStrings PostgreSQL has different behavior with some drivers

    PostgreSQL has different behavior with some drivers 
    public function setUseBooleanTrueFalseStrings(bool $flag): void

    with regard to how booleans have to be handled.

    Enables use of 'true'/'false' or otherwise 1 and 0 instead.

    Parameter
    type name summary
    ​bool ​$flag ​
    Return
    type summary
    ​void ​

    [m] getSubstringExpression <tag_inheritdoc data-type='' data-description=''>Returns a SQL snippet to get a substring inside an SQL statement.

    Returns a SQL snippet to get a substring inside an SQL statement. 
    public function getSubstringExpression(
    string $string,
    string|int $start,
    string|int|null $length = null
): string

    Note: Not SQL92, but common functionality.

    SQLite only supports the 2 parameter variant of this function.

    Parameter
    type name summary
    ​string ​$string ​An sql string literal or column name/alias.
    ​string|​int ​$start ​Where to start the substring portion.
    ​string|​int|​null ​$length = null ​The substring portion length.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSubstringExpression() ​Returns a SQL snippet to get a substring inside an SQL statement.

    [m] getNowExpression Returns the SQL snippet to get the current system date.

    deprecated

    Returns the SQL snippet to get the current system date. 
    public function getNowExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getNowExpression() ​Returns the SQL snippet to get the current system date.

    [m] getRegexpExpression Returns the regular expression operator.

    Returns the regular expression operator. 
    public function getRegexpExpression(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getRegexpExpression() ​Returns the regular expression operator.

    [m] getLocateExpression Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str. 
    public function getLocateExpression(
    string $str,
    string $substr,
    string|int|false $startPos = false
): string
    Parameter
    type name summary
    ​string ​$str ​Literal string.
    ​string ​$substr ​Literal string to find.
    ​string|​int|​false ​$startPos = false ​Position to start at, beginning of string by default.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getLocateExpression() ​Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    [m] getDateArithmeticIntervalExpression Returns the SQL for a date arithmetic expression.

    Returns the SQL for a date arithmetic expression. 
    protected function getDateArithmeticIntervalExpression(
    string $date,
    string $operator,
    int|string $interval,
    string $unit
): string
    Parameter
    type name summary
    ​string ​$date ​The column or literal representing a date
    ​string ​$operator ​The arithmetic operator (+ or -).
    ​int|​string ​$interval ​The interval that shall be calculated into the date.
    ​string ​$unit ​The unit of the interval that shall be calculated into the date.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateArithmeticIntervalExpression() ​Returns the SQL for a date arithmetic expression.

    [m] getDateDiffExpression <tag_inheritdoc data-type='' data-description=''>Returns the SQL to calculate the difference in days between the two passed dates.

    Returns the SQL to calculate the difference in days between the two passed dates. 
    public function getDateDiffExpression(
    string $date1,
    string $date2
): string

    Computes diff = date1 - date2.

    Parameter
    type name summary
    ​string ​$date1 ​
    ​string ​$date2 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateDiffExpression() ​Returns the SQL to calculate the difference in days between the two passed dates.

    [m] getCurrentDatabaseExpression Returns the SQL expression which represents the currently selected database.

    Returns the SQL expression which represents the currently selected database. 
    public function getCurrentDatabaseExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCurrentDatabaseExpression() ​Returns the SQL expression which represents the currently selected database.

    [m] supportsSequences Whether the platform supports sequences.

    Whether the platform supports sequences. 
    public function supportsSequences(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsSequences() ​Whether the platform supports sequences.

    [m] supportsSchemas Whether the platform supports database schemas.

    Whether the platform supports database schemas. 
    public function supportsSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsSchemas() ​Whether the platform supports database schemas.

    [m] getDefaultSchemaName Returns the default schema name.

    deprecated

    Returns the default schema name. 
    public function getDefaultSchemaName(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDefaultSchemaName() ​Returns the default schema name.

    [m] supportsIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform supports identity columns.

    Whether the platform supports identity columns. 
    public function supportsIdentityColumns(): bool

    Identity columns are columns that receive an auto-generated value from the database on insert of a row.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsIdentityColumns() ​Whether the platform supports identity columns.

    [m] supportsPartialIndexes Whether the platform supports partial indexes.

    Whether the platform supports partial indexes. 
    public function supportsPartialIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsPartialIndexes() ​Whether the platform supports partial indexes.
    See
    type summary
    ​AbstractPlatform ​

    [m] usesSequenceEmulatedIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform emulates identity columns through sequences.

    deprecated

    Whether the platform emulates identity columns through sequences. 
    public function usesSequenceEmulatedIdentityColumns(): bool

    Some platforms that do not support identity columns natively but support sequences can emulate identity columns by using sequences.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::usesSequenceEmulatedIdentityColumns() ​Whether the platform emulates identity columns through sequences.

    [m] getIdentitySequenceName Returns the name of the sequence for a particular identity column in a particular table.

    deprecated

    Returns the name of the sequence for a particular identity column in a particular table. 
    public function getIdentitySequenceName(
    string $tableName,
    string $columnName
): string
    Parameter
    type name summary
    ​string ​$tableName ​The name of the table to return the sequence name for.
    ​string ​$columnName ​The name of the identity column in the table to return the sequence name for.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getIdentitySequenceName() ​Returns the name of the sequence for a particular identity column in a particular table.
    See
    type summary
    ​usesSequenceEmulatedIdentityColumns ​

    [m] supportsCommentOnStatement Whether this platform support the proprietary syntax "COMMENT ON asset".

    Whether this platform support the proprietary syntax "COMMENT ON asset". 
    public function supportsCommentOnStatement(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsCommentOnStatement() ​Whether this platform support the proprietary syntax "COMMENT ON asset".
    See
    type summary
    ​AbstractPlatform ​

    [m] hasNativeGuidType Does this platform have native guid type.

    deprecated

    Does this platform have native guid type. 
    public function hasNativeGuidType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::hasNativeGuidType() ​Does this platform have native guid type.

    [m] createSelectSQLBuilder 

    public function createSelectSQLBuilder(): Doctrine\DBAL\SQL\Builder\SelectSQLBuilder
    Return
    type summary
    ​SelectSQLBuilder ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::createSelectSQLBuilder() ​

    [m] getListDatabasesSQL 

    public function getListDatabasesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListDatabasesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getListNamespacesSQL Returns the SQL statement for retrieving the namespaces defined in the database.

    deprecated

    Returns the SQL statement for retrieving the namespaces defined in the database. 
    public function getListNamespacesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListNamespacesSQL() ​Returns the SQL statement for retrieving the namespaces defined in the database.
    See
    type summary
    ​PostgreSQLSchemaManager::listSchemaNames() ​
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] getListSequencesSQL 

    public function getListSequencesSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListSequencesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getListTablesSQL

    deprecated 

    public function getListTablesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTablesSQL() ​

    [m] getListViewsSQL Returns the SQL to list all views of a database or user.

    Returns the SQL to list all views of a database or user. 
    public function getListViewsSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListViewsSQL() ​Returns the SQL to list all views of a database or user.
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getListTableForeignKeysSQL

    deprecated 

    public function getListTableForeignKeysSQL(
    string $table,
    string|null $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableForeignKeysSQL() ​

    [m] getListTableConstraintsSQL

    deprecated 

    public function getListTableConstraintsSQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableConstraintsSQL() ​

    [m] getListTableIndexesSQL

    deprecated 

    public function getListTableIndexesSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableIndexesSQL() ​

    [m] getListTableColumnsSQL

    deprecated 

    public function getListTableColumnsSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableColumnsSQL() ​

    [m] getAdvancedForeignKeyOptionsSQL <tag_inheritdoc data-type='' data-description=''>Returns the FOREIGN KEY query section dealing with non-standard options

    Returns the FOREIGN KEY query section dealing with non-standard options 
    public function getAdvancedForeignKeyOptionsSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    as MATCH, INITIALLY DEFERRED, ON UPDATE, ...

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getAdvancedForeignKeyOptionsSQL() ​Returns the FOREIGN KEY query section dealing with non-standard options
    See
    type summary
    ​AbstractPlatform ​

    [m] getAlterTableSQL <tag_inheritdoc data-type='' data-description=''>Gets the SQL statements for altering an existing table.

    Gets the SQL statements for altering an existing table. 
    public function getAlterTableSQL(Doctrine\DBAL\Schema\TableDiff $diff): list

    This method returns an array of SQL statements, since some platforms need several statements.

    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getAlterTableSQL() ​Gets the SQL statements for altering an existing table.

    [m] getRenameIndexSQL Returns the SQL for renaming an index on a table.

    Returns the SQL for renaming an index on a table. 
    protected function getRenameIndexSQL(
    string $oldIndexName,
    Doctrine\DBAL\Schema\Index $index,
    string $tableName
): string[]
    Parameter
    type name summary
    ​string ​$oldIndexName ​The name of the index to rename from.
    ​Index ​$index ​The definition of the index to rename to.
    ​string ​$tableName ​The table to rename the given index on.
    Return
    type summary
    ​string[] ​The sequence of SQL statements for renaming the given index.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getRenameIndexSQL() ​Returns the SQL for renaming an index on a table.

    [m] getCommentOnColumnSQL 

    public function getCommentOnColumnSQL(
    string $tableName,
    string $columnName,
    string|null $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    ​string|​null ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCommentOnColumnSQL() ​
    See
    type summary
    ​AbstractPlatform ​

    [m] getCreateSequenceSQL Returns the SQL to create a sequence on this platform.

    Returns the SQL to create a sequence on this platform. 
    public function getCreateSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateSequenceSQL() ​Returns the SQL to create a sequence on this platform.

    [m] getAlterSequenceSQL Returns the SQL to change a sequence on this platform.

    Returns the SQL to change a sequence on this platform. 
    public function getAlterSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getAlterSequenceSQL() ​Returns the SQL to change a sequence on this platform.

    [m] getDropSequenceSQL Returns the SQL snippet to drop an existing sequence.

    Returns the SQL snippet to drop an existing sequence. 
    public function getDropSequenceSQL(Doctrine\DBAL\Schema\Sequence|string $sequence): string
    Parameter
    type name summary
    ​Sequence|​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDropSequenceSQL() ​Returns the SQL snippet to drop an existing sequence.

    [m] getDropForeignKeySQL Returns the SQL to drop a foreign key.

    Returns the SQL to drop a foreign key. 
    public function getDropForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDropForeignKeySQL() ​Returns the SQL to drop a foreign key.

    [m] getDropIndexSQL Returns the SQL to drop an index from a table.

    Returns the SQL to drop an index from a table. 
    public function getDropIndexSQL(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string|null $table = null
): string
    Parameter
    type name summary
    ​Index|​string ​$index ​
    ​Table|​string|​null ​$table = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDropIndexSQL() ​Returns the SQL to drop an index from a table.

    [m] _getCreateTableSQL Returns the SQL used to create a table.

    Returns the SQL used to create a table. 
    protected function _getCreateTableSQL(
    string $name,
    array|mixed[][] $columns,
    array|mixed[] $options = []
): string[]
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​mixed[][] ​$columns ​
    ​array|​mixed[] ​$options = [] ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::_getCreateTableSQL() ​Returns the SQL used to create a table.

    [m] convertBooleans <tag_inheritdoc data-type='' data-description=''>Some platforms need the boolean values to be converted.

    Some platforms need the boolean values to be converted. 
    public function convertBooleans(mixed $item): mixed

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

    Note: if the input is not a boolean the original input might be returned.

    There are two contexts when converting booleans: Literals and Prepared Statements. This method should handle the literal case

    Postgres wants boolean values converted to the strings 'true'/'false'.

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::convertBooleans() ​Some platforms need the boolean values to be converted.

    [m] convertBooleansToDatabaseValue <tag_inheritdoc data-type='' data-description=''>This method should handle the prepared statements case. When there is no

    This method should handle the prepared statements case. When there is no 
    public function convertBooleansToDatabaseValue(mixed $item): mixed

    distinction, it's OK to use the same method.

    Note: if the input is not a boolean the original input might be returned.

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::convertBooleansToDatabaseValue() ​This method should handle the prepared statements case. When there is no

    [m] convertFromBoolean <tag_inheritdoc data-type='' data-description=''>Some platforms have boolean literals that needs to be correctly converted

    Some platforms have boolean literals that needs to be correctly converted 
    public function convertFromBoolean(T $item): (T

    The default conversion tries to convert value into bool "(bool)$item"

    Parameter
    type name summary
    ​T ​$item ​
    Return
    type summary
    ​(T ​is null ? null : bool)
    Prototype
    kind source summary
    ​override ​AbstractPlatform::convertFromBoolean() ​Some platforms have boolean literals that needs to be correctly converted

    [m] getSequenceNextValSQL 

    public function getSequenceNextValSQL(string $sequence): string
    Parameter
    type name summary
    ​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSequenceNextValSQL() ​

    [m] getSetTransactionIsolationSQL Returns the SQL to set the transaction isolation level.

    Returns the SQL to set the transaction isolation level. 
    public function getSetTransactionIsolationSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSetTransactionIsolationSQL() ​Returns the SQL to set the transaction isolation level.

    [m] getBooleanTypeDeclarationSQL Returns the SQL snippet that declares a boolean column.

    Returns the SQL snippet that declares a boolean column. 
    public function getBooleanTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBooleanTypeDeclarationSQL() ​Returns the SQL snippet that declares a boolean column.

    [m] getIntegerTypeDeclarationSQL Returns the SQL snippet that declares a 4 byte integer column.

    Returns the SQL snippet that declares a 4 byte integer column. 
    public function getIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares a 4 byte integer column.

    [m] getBigIntTypeDeclarationSQL Returns the SQL snippet that declares an 8 byte integer column.

    Returns the SQL snippet that declares an 8 byte integer column. 
    public function getBigIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBigIntTypeDeclarationSQL() ​Returns the SQL snippet that declares an 8 byte integer column.

    [m] getSmallIntTypeDeclarationSQL Returns the SQL snippet that declares a 2 byte integer column.

    Returns the SQL snippet that declares a 2 byte integer column. 
    public function getSmallIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSmallIntTypeDeclarationSQL() ​Returns the SQL snippet that declares a 2 byte integer column.

    [m] getGuidTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to declare a GUID/UUID column.

    Returns the SQL snippet to declare a GUID/UUID column. 
    public function getGuidTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CHAR(36) and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getGuidTypeDeclarationSQL() ​Returns the SQL snippet to declare a GUID/UUID column.

    [m] getDateTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create datetime columns in

    Obtains DBMS specific SQL to be used to create datetime columns in 
    public function getDateTimeTypeDeclarationSQL(array|mixed[] $column): string

    statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTimeTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create datetime columns in

    [m] getDateTimeTzTypeDeclarationSQL Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    Obtains DBMS specific SQL to be used to create datetime with timezone offset columns. 
    public function getDateTimeTzTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTimeTzTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    [m] getDateTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create date columns in statements

    Obtains DBMS specific SQL to be used to create date columns in statements 
    public function getDateTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create date columns in statements

    [m] getTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create time columns in statements

    Obtains DBMS specific SQL to be used to create time columns in statements 
    public function getTimeTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTimeTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create time columns in statements

    [m] _getCommonIntegerTypeDeclarationSQL Returns the SQL snippet that declares common properties of an integer column.

    Returns the SQL snippet that declares common properties of an integer column. 
    protected function _getCommonIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::_getCommonIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares common properties of an integer column.

    [m] getVarcharTypeDeclarationSQLSnippet 

    protected function getVarcharTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​
    ​bool ​$fixed ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getVarcharTypeDeclarationSQLSnippet() ​

    [m] getBinaryTypeDeclarationSQLSnippet Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    protected function getBinaryTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​The length of the column.
    ​bool ​$fixed ​Whether the column length is fixed.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBinaryTypeDeclarationSQLSnippet() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getClobTypeDeclarationSQL Returns the SQL snippet used to declare a CLOB column type.

    Returns the SQL snippet used to declare a CLOB column type. 
    public function getClobTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getClobTypeDeclarationSQL() ​Returns the SQL snippet used to declare a CLOB column type.

    [m] getName Gets the name of the platform.

    deprecated

    Gets the name of the platform. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getName() ​Gets the name of the platform.

    [m] getDateTimeTzFormatString <tag_inheritdoc data-type='' data-description=''>Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeTzFormatString(): string

    the format of a stored datetime with timezone value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTimeTzFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getEmptyIdentityInsertSQL Returns the insert SQL for an empty insert statement.

    Returns the insert SQL for an empty insert statement. 
    public function getEmptyIdentityInsertSQL(
    string $quotedTableName,
    string $quotedIdentifierColumnName
): string
    Parameter
    type name summary
    ​string ​$quotedTableName ​
    ​string ​$quotedIdentifierColumnName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getEmptyIdentityInsertSQL() ​Returns the insert SQL for an empty insert statement.

    [m] getTruncateTableSQL <tag_inheritdoc data-type='' data-description=''>Generates a Truncate Table SQL statement for a given table.

    Generates a Truncate Table SQL statement for a given table. 
    public function getTruncateTableSQL(
    string $tableName,
    bool $cascade = false
): string

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

    Parameter
    type name summary
    ​string ​$tableName ​
    ​bool ​$cascade = false ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTruncateTableSQL() ​Generates a Truncate Table SQL statement for a given table.

    [m] getDefaultColumnValueSQLSnippet Get the snippet used to retrieve the default value for a given column

    Get the snippet used to retrieve the default value for a given column 
    public function getDefaultColumnValueSQLSnippet(): string
    Return
    type summary
    ​string ​

    [m] getReadLockSQL <tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock. 
    public function getReadLockSQL(): string

    This defaults to the ANSI SQL "FOR UPDATE", which is an exclusive lock (Write). Some database vendors allow to lighten this constraint up to be a real read lock.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getReadLockSQL() ​Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    [m] initializeDoctrineTypeMappings Lazy load Doctrine Type Mappings.

    Lazy load Doctrine Type Mappings. 
    protected function initializeDoctrineTypeMappings(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::initializeDoctrineTypeMappings() ​Lazy load Doctrine Type Mappings.

    [m] getVarcharMaxLength Gets the maximum length of a varchar column.

    deprecated

    Gets the maximum length of a varchar column. 
    public function getVarcharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getVarcharMaxLength() ​Gets the maximum length of a varchar column.

    [m] getBinaryMaxLength Gets the maximum length of a binary column.

    deprecated

    Gets the maximum length of a binary column. 
    public function getBinaryMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBinaryMaxLength() ​Gets the maximum length of a binary column.

    [m] getBinaryDefaultLength Gets the default length of a binary column.

    deprecated

    Gets the default length of a binary column. 
    public function getBinaryDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBinaryDefaultLength() ​Gets the default length of a binary column.

    [m] hasNativeJsonType Does this platform have native JSON type.

    deprecated

    Does this platform have native JSON type. 
    public function hasNativeJsonType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::hasNativeJsonType() ​Does this platform have native JSON type.

    [m] getReservedKeywordsClass Returns the class name of the reserved keywords list.

    deprecated

    Returns the class name of the reserved keywords list. 
    protected function getReservedKeywordsClass(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getReservedKeywordsClass() ​Returns the class name of the reserved keywords list.
    See
    type summary
    ​PostgreSQLPlatform::createReservedKeywordsList() ​
    ​AbstractPlatform::createReservedKeywordsList() ​

    [m] getBlobTypeDeclarationSQL Returns the SQL Snippet used to declare a BLOB column type.

    Returns the SQL Snippet used to declare a BLOB column type. 
    public function getBlobTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBlobTypeDeclarationSQL() ​Returns the SQL Snippet used to declare a BLOB column type.

    [m] getDefaultValueDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set a default value

    Obtains DBMS specific SQL code portion needed to set a default value 
    public function getDefaultValueDeclarationSQL(mixed[] $column): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​mixed[] ​$column ​The column definition array.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a default value.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDefaultValueDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a default value
    See
    type summary
    ​AbstractPlatform ​

    [m] supportsColumnCollation Does this platform support column collation?

    Does this platform support column collation? 
    public function supportsColumnCollation(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsColumnCollation() ​Does this platform support column collation?
    See
    type summary
    ​AbstractPlatform ​

    [m] getJsonTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to declare a JSON column.

    Returns the SQL snippet to declare a JSON column. 
    public function getJsonTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CLOB and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getJsonTypeDeclarationSQL() ​Returns the SQL snippet to declare a JSON column.

    [m] getListTableMetadataSQL

    deprecated 

    public function getListTableMetadataSQL(
    string $table,
    ?string $schema = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​?string ​$schema = null ​
    Return
    type summary
    ​string ​

    [m] createSchemaManager Creates the schema manager that can be used to inspect and change the underlying

    Creates the schema manager that can be used to inspect and change the underlying 
    public function createSchemaManager(Doctrine\DBAL\Connection $connection): Doctrine\DBAL\Schema\PostgreSQLSchemaManager

    database schema according to the dialect of the platform.

    Parameter
    type name summary
    ​Connection ​$connection ​
    Return
    type summary
    ​PostgreSQLSchemaManager ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::createSchemaManager() ​Creates the schema manager that can be used to inspect and change the underlying

    [m] setDisableTypeComments

    final

    final public function setDisableTypeComments(bool $value)
    Parameter
    type name summary
    ​bool ​$value ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setDisableTypeComments() ​

    [m] setEventManager Sets the EventManager used by the Platform.

    deprecated

    Sets the EventManager used by the Platform. 
    public function setEventManager(Doctrine\Common\EventManager $eventManager): void
    Parameter
    type name summary
    ​EventManager ​$eventManager ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setEventManager() ​Sets the EventManager used by the Platform.

    [m] getEventManager Gets the EventManager used by the Platform.

    deprecated

    Gets the EventManager used by the Platform. 
    public function getEventManager(): Doctrine\Common\EventManager|null
    Return
    type summary
    ​EventManager|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEventManager() ​Gets the EventManager used by the Platform.

    [m] getAsciiStringTypeDeclarationSQL Returns the SQL snippet used to declare a column that can

    Returns the SQL snippet used to declare a column that can 
    public function getAsciiStringTypeDeclarationSQL(array|mixed[] $column): string

    store characters in the ASCII character set

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAsciiStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a column that can

    [m] getVarcharTypeDeclarationSQL Returns the SQL snippet used to declare a VARCHAR column type.

    deprecated

    Returns the SQL snippet used to declare a VARCHAR column type. 
    public function getVarcharTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharTypeDeclarationSQL() ​Returns the SQL snippet used to declare a VARCHAR column type.

    [m] getStringTypeDeclarationSQL Returns the SQL snippet used to declare a string column type.

    Returns the SQL snippet used to declare a string column type. 
    public function getStringTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a string column type.

    [m] getBinaryTypeDeclarationSQL Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    public function getBinaryTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryTypeDeclarationSQL() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] registerDoctrineTypeMapping Registers a doctrine type to be used in conjunction with a column type of this platform.

    Registers a doctrine type to be used in conjunction with a column type of this platform. 
    public function registerDoctrineTypeMapping(
    string $dbType,
    string $doctrineType
): void
    Parameter
    type name summary
    ​string ​$dbType ​
    ​string ​$doctrineType ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​If the type is not found.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::registerDoctrineTypeMapping() ​Registers a doctrine type to be used in conjunction with a column type of this platform.

    [m] getDoctrineTypeMapping Gets the Doctrine type that is mapped for the given database column type.

    Gets the Doctrine type that is mapped for the given database column type. 
    public function getDoctrineTypeMapping(string $dbType): string
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeMapping() ​Gets the Doctrine type that is mapped for the given database column type.

    [m] hasDoctrineTypeMappingFor Checks if a database type is currently supported by this platform.

    Checks if a database type is currently supported by this platform. 
    public function hasDoctrineTypeMappingFor(string $dbType): bool
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasDoctrineTypeMappingFor() ​Checks if a database type is currently supported by this platform.

    [m] initializeCommentedDoctrineTypes Initializes the Doctrine Type comments instance variable for in_array() checks.

    deprecated

    Initializes the Doctrine Type comments instance variable for in_array() checks. 
    protected function initializeCommentedDoctrineTypes(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::initializeCommentedDoctrineTypes() ​Initializes the Doctrine Type comments instance variable for in_array() checks.

    [m] isCommentedDoctrineType Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    deprecated

    Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type? 
    public function isCommentedDoctrineType(Doctrine\DBAL\Types\Type $doctrineType): bool
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::isCommentedDoctrineType() ​Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    [m] markDoctrineTypeCommented Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements. 
    public function markDoctrineTypeCommented(string|Doctrine\DBAL\Types\Type $doctrineType): void
    Parameter
    type name summary
    ​string|​Type ​$doctrineType ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::markDoctrineTypeCommented() ​Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    [m] getDoctrineTypeComment Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    deprecated

    Gets the comment to append to a column comment that helps parsing this type in reverse engineering. 
    public function getDoctrineTypeComment(Doctrine\DBAL\Types\Type $doctrineType): string
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeComment() ​Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    [m] getColumnComment Gets the comment of a passed column modified by potential doctrine type comment hints.

    deprecated

    Gets the comment of a passed column modified by potential doctrine type comment hints. 
    protected function getColumnComment(Doctrine\DBAL\Schema\Column $column): string|null
    Parameter
    type name summary
    ​Column ​$column ​
    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnComment() ​Gets the comment of a passed column modified by potential doctrine type comment hints.

    [m] getIdentifierQuoteCharacter Gets the character used for identifier quoting.

    deprecated

    Gets the character used for identifier quoting. 
    public function getIdentifierQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIdentifierQuoteCharacter() ​Gets the character used for identifier quoting.
    See
    type summary
    ​AbstractPlatform::quoteIdentifier() ​

    [m] getSqlCommentStartString Gets the string portion that starts an SQL comment.

    deprecated

    Gets the string portion that starts an SQL comment. 
    public function getSqlCommentStartString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentStartString() ​Gets the string portion that starts an SQL comment.

    [m] getSqlCommentEndString Gets the string portion that ends an SQL comment.

    deprecated

    Gets the string portion that ends an SQL comment. 
    public function getSqlCommentEndString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentEndString() ​Gets the string portion that ends an SQL comment.

    [m] getCharMaxLength Gets the maximum length of a char column.

    deprecated

    Gets the maximum length of a char column. 
    public function getCharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCharMaxLength() ​Gets the maximum length of a char column.

    [m] getVarcharDefaultLength Gets the default length of a varchar column.

    deprecated

    Gets the default length of a varchar column. 
    public function getVarcharDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharDefaultLength() ​Gets the default length of a varchar column.

    [m] getWildcards Gets all SQL wildcard characters of the platform.

    deprecated

    Gets all SQL wildcard characters of the platform. 
    public function getWildcards(): string[]
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWildcards() ​Gets all SQL wildcard characters of the platform.
    See
    type summary
    ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] getAvgExpression Returns the SQL snippet to get the average value of a column.

    deprecated

    Returns the SQL snippet to get the average value of a column. 
    public function getAvgExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an AVG aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAvgExpression() ​Returns the SQL snippet to get the average value of a column.

    [m] getCountExpression Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    deprecated

    Returns the SQL snippet to get the number of rows (without a NULL value) of a column. 
    public function getCountExpression(string|int $column): string

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

    Parameter
    type name summary
    ​string|​int ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a COUNT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCountExpression() ​Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    [m] getMaxExpression Returns the SQL snippet to get the highest value of a column.

    deprecated

    Returns the SQL snippet to get the highest value of a column. 
    public function getMaxExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MAX aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxExpression() ​Returns the SQL snippet to get the highest value of a column.

    [m] getMinExpression Returns the SQL snippet to get the lowest value of a column.

    deprecated

    Returns the SQL snippet to get the lowest value of a column. 
    public function getMinExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MIN aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMinExpression() ​Returns the SQL snippet to get the lowest value of a column.

    [m] getSumExpression Returns the SQL snippet to get the total sum of a column.

    deprecated

    Returns the SQL snippet to get the total sum of a column. 
    public function getSumExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a SUM aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSumExpression() ​Returns the SQL snippet to get the total sum of a column.

    [m] getMd5Expression Returns the SQL snippet to get the md5 sum of a column.

    deprecated

    Returns the SQL snippet to get the md5 sum of a column. 
    public function getMd5Expression(string $column): string

    Note: Not SQL92, but common functionality.

    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMd5Expression() ​Returns the SQL snippet to get the md5 sum of a column.

    [m] getLengthExpression Returns the SQL snippet to get the length of a text column in characters.

    Returns the SQL snippet to get the length of a text column in characters. 
    public function getLengthExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLengthExpression() ​Returns the SQL snippet to get the length of a text column in characters.

    [m] getSqrtExpression Returns the SQL snippet to get the squared value of a column.

    deprecated

    Returns the SQL snippet to get the squared value of a column. 
    public function getSqrtExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an SQRT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqrtExpression() ​Returns the SQL snippet to get the squared value of a column.

    [m] getRoundExpression Returns the SQL snippet to round a numeric column to the number of decimals specified.

    deprecated

    Returns the SQL snippet to round a numeric column to the number of decimals specified. 
    public function getRoundExpression(
    string $column,
    string|int $decimals = 0
): string
    Parameter
    type name summary
    ​string ​$column ​
    ​string|​int ​$decimals = 0 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRoundExpression() ​Returns the SQL snippet to round a numeric column to the number of decimals specified.

    [m] getModExpression Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2. 
    public function getModExpression(
    string $expression1,
    string $expression2
): string
    Parameter
    type name summary
    ​string ​$expression1 ​
    ​string ​$expression2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getModExpression() ​Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    [m] getTrimExpression Returns the SQL snippet to trim a string.

    Returns the SQL snippet to trim a string. 
    public function getTrimExpression(
    string $str,
    int $mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED,
    string|bool $char = false
): string
    Parameter
    type name summary
    ​string ​$str ​The expression to apply the trim to.
    ​int ​$mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED ​The position of the trim (leading/trailing/both).
    ​string|​bool ​$char = false ​The char to trim, has to be quoted already. Defaults to space.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTrimExpression() ​Returns the SQL snippet to trim a string.

    [m] getRtrimExpression Returns the SQL snippet to trim trailing space characters from the expression.

    deprecated

    Returns the SQL snippet to trim trailing space characters from the expression. 
    public function getRtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRtrimExpression() ​Returns the SQL snippet to trim trailing space characters from the expression.

    [m] getLtrimExpression Returns the SQL snippet to trim leading space characters from the expression.

    deprecated

    Returns the SQL snippet to trim leading space characters from the expression. 
    public function getLtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLtrimExpression() ​Returns the SQL snippet to trim leading space characters from the expression.

    [m] getUpperExpression Returns the SQL snippet to change all characters from the expression to uppercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to uppercase, 
    public function getUpperExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUpperExpression() ​Returns the SQL snippet to change all characters from the expression to uppercase,

    [m] getLowerExpression Returns the SQL snippet to change all characters from the expression to lowercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to lowercase, 
    public function getLowerExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLowerExpression() ​Returns the SQL snippet to change all characters from the expression to lowercase,

    [m] getConcatExpression Returns a SQL snippet to concatenate the given expressions.

    Returns a SQL snippet to concatenate the given expressions. 
    public function getConcatExpression(): string

    Accepts an arbitrary number of string parameters. Each parameter must contain an expression.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getConcatExpression() ​Returns a SQL snippet to concatenate the given expressions.

    [m] getNotExpression Returns the SQL for a logical not.

    deprecated

    Returns the SQL for a logical not. 
    public function getNotExpression(string $expression): string

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

    Parameter
    type name summary
    ​string ​$expression ​
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getNotExpression() ​Returns the SQL for a logical not.

    [m] getIsNullExpression Returns the SQL that checks if an expression is null.

    deprecated

    Returns the SQL that checks if an expression is null. 
    public function getIsNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNullExpression() ​Returns the SQL that checks if an expression is null.

    [m] getIsNotNullExpression Returns the SQL that checks if an expression is not null.

    deprecated

    Returns the SQL that checks if an expression is not null. 
    public function getIsNotNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNotNullExpression() ​Returns the SQL that checks if an expression is not null.

    [m] getBetweenExpression Returns the SQL that checks if an expression evaluates to a value between two values.

    deprecated

    Returns the SQL that checks if an expression evaluates to a value between two values. 
    public function getBetweenExpression(
    string $expression,
    string $value1,
    string $value2
): string

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

    Parameter
    type name summary
    ​string ​$expression ​The value to compare to.
    ​string ​$value1 ​The lower value to compare with.
    ​string ​$value2 ​The higher value to compare with.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBetweenExpression() ​Returns the SQL that checks if an expression evaluates to a value between two values.

    [m] getAcosExpression Returns the SQL to get the arccosine of a value.

    deprecated

    Returns the SQL to get the arccosine of a value. 
    public function getAcosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAcosExpression() ​Returns the SQL to get the arccosine of a value.

    [m] getSinExpression Returns the SQL to get the sine of a value.

    deprecated

    Returns the SQL to get the sine of a value. 
    public function getSinExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSinExpression() ​Returns the SQL to get the sine of a value.

    [m] getPiExpression Returns the SQL to get the PI value.

    deprecated

    Returns the SQL to get the PI value. 
    public function getPiExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPiExpression() ​Returns the SQL to get the PI value.

    [m] getCosExpression Returns the SQL to get the cosine of a value.

    deprecated

    Returns the SQL to get the cosine of a value. 
    public function getCosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCosExpression() ​Returns the SQL to get the cosine of a value.

    [m] getDateAddSecondsExpression Returns the SQL to add the number of given seconds to a date.

    Returns the SQL to add the number of given seconds to a date. 
    public function getDateAddSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddSecondsExpression() ​Returns the SQL to add the number of given seconds to a date.

    [m] getDateSubSecondsExpression Returns the SQL to subtract the number of given seconds from a date.

    Returns the SQL to subtract the number of given seconds from a date. 
    public function getDateSubSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubSecondsExpression() ​Returns the SQL to subtract the number of given seconds from a date.

    [m] getDateAddMinutesExpression Returns the SQL to add the number of given minutes to a date.

    Returns the SQL to add the number of given minutes to a date. 
    public function getDateAddMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMinutesExpression() ​Returns the SQL to add the number of given minutes to a date.

    [m] getDateSubMinutesExpression Returns the SQL to subtract the number of given minutes from a date.

    Returns the SQL to subtract the number of given minutes from a date. 
    public function getDateSubMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMinutesExpression() ​Returns the SQL to subtract the number of given minutes from a date.

    [m] getDateAddHourExpression Returns the SQL to add the number of given hours to a date.

    Returns the SQL to add the number of given hours to a date. 
    public function getDateAddHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddHourExpression() ​Returns the SQL to add the number of given hours to a date.

    [m] getDateSubHourExpression Returns the SQL to subtract the number of given hours to a date.

    Returns the SQL to subtract the number of given hours to a date. 
    public function getDateSubHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubHourExpression() ​Returns the SQL to subtract the number of given hours to a date.

    [m] getDateAddDaysExpression Returns the SQL to add the number of given days to a date.

    Returns the SQL to add the number of given days to a date. 
    public function getDateAddDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddDaysExpression() ​Returns the SQL to add the number of given days to a date.

    [m] getDateSubDaysExpression Returns the SQL to subtract the number of given days to a date.

    Returns the SQL to subtract the number of given days to a date. 
    public function getDateSubDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubDaysExpression() ​Returns the SQL to subtract the number of given days to a date.

    [m] getDateAddWeeksExpression Returns the SQL to add the number of given weeks to a date.

    Returns the SQL to add the number of given weeks to a date. 
    public function getDateAddWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddWeeksExpression() ​Returns the SQL to add the number of given weeks to a date.

    [m] getDateSubWeeksExpression Returns the SQL to subtract the number of given weeks from a date.

    Returns the SQL to subtract the number of given weeks from a date. 
    public function getDateSubWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubWeeksExpression() ​Returns the SQL to subtract the number of given weeks from a date.

    [m] getDateAddMonthExpression Returns the SQL to add the number of given months to a date.

    Returns the SQL to add the number of given months to a date. 
    public function getDateAddMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMonthExpression() ​Returns the SQL to add the number of given months to a date.

    [m] getDateSubMonthExpression Returns the SQL to subtract the number of given months to a date.

    Returns the SQL to subtract the number of given months to a date. 
    public function getDateSubMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMonthExpression() ​Returns the SQL to subtract the number of given months to a date.

    [m] getDateAddQuartersExpression Returns the SQL to add the number of given quarters to a date.

    Returns the SQL to add the number of given quarters to a date. 
    public function getDateAddQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddQuartersExpression() ​Returns the SQL to add the number of given quarters to a date.

    [m] getDateSubQuartersExpression Returns the SQL to subtract the number of given quarters from a date.

    Returns the SQL to subtract the number of given quarters from a date. 
    public function getDateSubQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubQuartersExpression() ​Returns the SQL to subtract the number of given quarters from a date.

    [m] getDateAddYearsExpression Returns the SQL to add the number of given years to a date.

    Returns the SQL to add the number of given years to a date. 
    public function getDateAddYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddYearsExpression() ​Returns the SQL to add the number of given years to a date.

    [m] getDateSubYearsExpression Returns the SQL to subtract the number of given years from a date.

    Returns the SQL to subtract the number of given years from a date. 
    public function getDateSubYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubYearsExpression() ​Returns the SQL to subtract the number of given years from a date.

    [m] multiplyInterval Generates the SQL expression which represents the given date interval multiplied by a number

    Generates the SQL expression which represents the given date interval multiplied by a number 
    protected function multiplyInterval(
    string $interval,
    int $multiplier
): string
    Parameter
    type name summary
    ​string ​$interval ​SQL expression describing the interval value
    ​int ​$multiplier ​Interval multiplier
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::multiplyInterval() ​Generates the SQL expression which represents the given date interval multiplied by a number

    [m] getBitAndComparisonExpression Returns the SQL bit AND comparison expression.

    Returns the SQL bit AND comparison expression. 
    public function getBitAndComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitAndComparisonExpression() ​Returns the SQL bit AND comparison expression.

    [m] getBitOrComparisonExpression Returns the SQL bit OR comparison expression.

    Returns the SQL bit OR comparison expression. 
    public function getBitOrComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitOrComparisonExpression() ​Returns the SQL bit OR comparison expression.

    [m] getForUpdateSQL Returns the FOR UPDATE expression.

    deprecated

    Returns the FOR UPDATE expression. 
    public function getForUpdateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForUpdateSQL() ​Returns the FOR UPDATE expression.

    [m] appendLockHint Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    Honors that some SQL vendors such as MsSql use table hints for locking instead of the 
    public function appendLockHint(
    string $fromClause,
    int $lockMode
): string

    ANSI SQL FOR UPDATE specification.

    Parameter
    type name summary
    ​string ​$fromClause ​The FROM clause to append the hint for the given lock mode to
    ​int ​$lockMode ​One of the Doctrine\DBAL\LockMode::* constants
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::appendLockHint() ​Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    [m] getWriteLockSQL Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows. 
    public function getWriteLockSQL(): string

    The semantics of this lock mode should equal the SELECT .. FOR UPDATE of the ANSI SQL standard.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWriteLockSQL() ​Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    [m] getDropTableSQL Returns the SQL snippet to drop an existing table.

    Returns the SQL snippet to drop an existing table. 
    public function getDropTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTableSQL() ​Returns the SQL snippet to drop an existing table.

    [m] getDropTemporaryTableSQL Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction. 
    public function getDropTemporaryTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTemporaryTableSQL() ​Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    [m] getDropConstraintSQL Returns the SQL to drop a constraint.

    Returns the SQL to drop a constraint. 
    public function getDropConstraintSQL(
    Doctrine\DBAL\Schema\Constraint|string $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint|​string ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropConstraintSQL() ​Returns the SQL to drop a constraint.
    See
    type summary
    ​AbstractPlatform ​

    [m] getDropUniqueConstraintSQL Returns the SQL to drop a unique constraint.

    Returns the SQL to drop a unique constraint. 
    public function getDropUniqueConstraintSQL(
    string $name,
    string $tableName
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropUniqueConstraintSQL() ​Returns the SQL to drop a unique constraint.

    [m] getCreateTableSQL Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    Returns the SQL statement(s) to create a table with the specified name, columns and constraints 
    public function getCreateTableSQL(
    Doctrine\DBAL\Schema\Table $table,
    int $createFlags = self::CREATE_INDEXES
): list

    on this platform.

    Parameter
    type name summary
    ​Table ​$table ​
    ​int ​$createFlags = self::CREATE_INDEXES ​
    Return
    type summary
    ​list ​The list of SQL statements.
    Throws
    type summary
    ​Exception ​
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableSQL() ​Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    [m] getCreateTableWithoutForeignKeysSQL

    final

    final protected function getCreateTableWithoutForeignKeysSQL(Doctrine\DBAL\Schema\Table $table): array|list
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableWithoutForeignKeysSQL() ​

    [m] getCreateTablesSQL 

    public function getCreateTablesSQL(array|Doctrine\DBAL\Schema\Table[] $tables): array|list
    Parameter
    type name summary
    ​array|​Table[] ​$tables ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTablesSQL() ​

    [m] getDropTablesSQL 

    public function getDropTablesSQL(array|list $tables): array|list
    Parameter
    type name summary
    ​array|​list ​$tables ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTablesSQL() ​

    [m] getCommentOnTableSQL 

    protected function getCommentOnTableSQL(
    string $tableName,
    ?string $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​?string ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnTableSQL() ​

    [m] getInlineColumnCommentSQL Returns the SQL to create inline comment on a column.

    Returns the SQL to create inline comment on a column. 
    public function getInlineColumnCommentSQL(string $comment): string
    Parameter
    type name summary
    ​string ​$comment ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getInlineColumnCommentSQL() ​Returns the SQL to create inline comment on a column.

    [m] getCreateTemporaryTableSnippetSQL 

    public function getCreateTemporaryTableSnippetSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTemporaryTableSnippetSQL() ​

    [m] getAlterSchemaSQL Generates SQL statements that can be used to apply the diff.

    Generates SQL statements that can be used to apply the diff. 
    public function getAlterSchemaSQL(Doctrine\DBAL\Schema\SchemaDiff $diff): array|list
    Parameter
    type name summary
    ​SchemaDiff ​$diff ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAlterSchemaSQL() ​Generates SQL statements that can be used to apply the diff.

    [m] getCreateConstraintSQL Returns the SQL to create a constraint on a table on this platform.

    deprecated

    Returns the SQL to create a constraint on a table on this platform. 
    public function getCreateConstraintSQL(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateConstraintSQL() ​Returns the SQL to create a constraint on a table on this platform.
    See
    type summary
    ​AbstractPlatform::getCreateIndexSQL() ​
    ​AbstractPlatform::getCreateForeignKeySQL() ​

    [m] getCreateIndexSQL Returns the SQL to create an index on a table on this platform.

    Returns the SQL to create an index on a table on this platform. 
    public function getCreateIndexSQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateIndexSQL() ​Returns the SQL to create an index on a table on this platform.

    [m] getPartialIndexSQL Adds condition for partial index.

    Adds condition for partial index. 
    protected function getPartialIndexSQL(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPartialIndexSQL() ​Adds condition for partial index.

    [m] getCreateIndexSQLFlags Adds additional flags for index generation.

    Adds additional flags for index generation. 
    protected function getCreateIndexSQLFlags(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateIndexSQLFlags() ​Adds additional flags for index generation.

    [m] getCreatePrimaryKeySQL Returns the SQL to create an unnamed primary key constraint.

    Returns the SQL to create an unnamed primary key constraint. 
    public function getCreatePrimaryKeySQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreatePrimaryKeySQL() ​Returns the SQL to create an unnamed primary key constraint.

    [m] getCreateSchemaSQL Returns the SQL to create a named schema.

    Returns the SQL to create a named schema. 
    public function getCreateSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateSchemaSQL() ​Returns the SQL to create a named schema.

    [m] getCreateUniqueConstraintSQL Returns the SQL to create a unique constraint on a table on this platform.

    Returns the SQL to create a unique constraint on a table on this platform. 
    public function getCreateUniqueConstraintSQL(
    Doctrine\DBAL\Schema\UniqueConstraint $constraint,
    string $tableName
): string
    Parameter
    type name summary
    ​UniqueConstraint ​$constraint ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateUniqueConstraintSQL() ​Returns the SQL to create a unique constraint on a table on this platform.

    [m] getDropSchemaSQL Returns the SQL snippet to drop a schema.

    Returns the SQL snippet to drop a schema. 
    public function getDropSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSchemaSQL() ​Returns the SQL snippet to drop a schema.

    [m] quoteIdentifier Quotes a string so that it can be safely used as a table or column name,

    Quotes a string so that it can be safely used as a table or column name, 
    public function quoteIdentifier(string $str): string

    even if it is a reserved word of the platform. This also detects identifier chains separated by dot and quotes them independently.

    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.

    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteIdentifier() ​Quotes a string so that it can be safely used as a table or column name,

    [m] quoteSingleIdentifier Quotes a single identifier (no dot chain separation).

    Quotes a single identifier (no dot chain separation). 
    public function quoteSingleIdentifier(string $str): string
    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteSingleIdentifier() ​Quotes a single identifier (no dot chain separation).

    [m] getCreateForeignKeySQL Returns the SQL to create a new foreign key.

    Returns the SQL to create a new foreign key. 
    public function getCreateForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key constraint.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateForeignKeySQL() ​Returns the SQL to create a new foreign key.

    [m] getRenameTableSQL 

    public function getRenameTableSQL(
    string $oldName,
    string $newName
): array|list
    Parameter
    type name summary
    ​string ​$oldName ​
    ​string ​$newName ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRenameTableSQL() ​

    [m] onSchemaAlterTableAddColumn 

    protected function onSchemaAlterTableAddColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    mixed[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​mixed[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableAddColumn() ​

    [m] onSchemaAlterTableRemoveColumn 

    protected function onSchemaAlterTableRemoveColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRemoveColumn() ​

    [m] onSchemaAlterTableChangeColumn 

    protected function onSchemaAlterTableChangeColumn(
    Doctrine\DBAL\Schema\ColumnDiff $columnDiff,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​ColumnDiff ​$columnDiff ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableChangeColumn() ​

    [m] onSchemaAlterTableRenameColumn 

    protected function onSchemaAlterTableRenameColumn(
    string $oldColumnName,
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​string ​$oldColumnName ​
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRenameColumn() ​

    [m] onSchemaAlterTable 

    protected function onSchemaAlterTable(
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$sql
): bool
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    ​string[] ​&$sql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTable() ​

    [m] getPreAlterTableIndexForeignKeySQL 

    protected function getPreAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPreAlterTableIndexForeignKeySQL() ​

    [m] getPostAlterTableIndexForeignKeySQL 

    protected function getPostAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPostAlterTableIndexForeignKeySQL() ​

    [m] getColumnDeclarationListSQL Gets declaration of a number of columns in bulk.

    Gets declaration of a number of columns in bulk. 
    public function getColumnDeclarationListSQL(array|mixed[][] $columns): string
    Parameter
    type name summary
    ​array|​mixed[][] ​$columns ​A multidimensional associative array.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationListSQL() ​Gets declaration of a number of columns in bulk.

    [m] getColumnDeclarationSQL Obtains DBMS specific SQL code portion needed to declare a generic type

    Obtains DBMS specific SQL code portion needed to declare a generic type 
    public function getColumnDeclarationSQL(
    string $name,
    array|mixed[] $column
): string

    column to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name the column to be declared.
    ​array|​mixed[] ​$column ​An associative array with the name of the properties
    Return
    type summary
    ​string ​DBMS specific SQL code portion that should be used to declare the column.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to declare a generic type

    [m] getDecimalTypeDeclarationSQL Returns the SQL snippet that declares a floating point column of arbitrary precision.

    Returns the SQL snippet that declares a floating point column of arbitrary precision. 
    public function getDecimalTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDecimalTypeDeclarationSQL() ​Returns the SQL snippet that declares a floating point column of arbitrary precision.

    [m] getCheckDeclarationSQL Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    Obtains DBMS specific SQL code portion needed to set a CHECK constraint 
    public function getCheckDeclarationSQL(array|string[]|mixed[][] $definition): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​string[]|​mixed[][] ​$definition ​The check definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a CHECK constraint.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCheckDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    [m] getUniqueConstraintDeclarationSQL Obtains DBMS specific SQL code portion needed to set a unique

    Obtains DBMS specific SQL code portion needed to set a unique 
    public function getUniqueConstraintDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\UniqueConstraint $constraint
): string

    constraint declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the unique constraint.
    ​UniqueConstraint ​$constraint ​The unique constraint definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a constraint.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueConstraintDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a unique

    [m] getIndexDeclarationSQL Obtains DBMS specific SQL code portion needed to set an index

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\Index $index
): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the index.
    ​Index ​$index ​The index definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set an index.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getCustomTypeDeclarationSQL Obtains SQL code portion needed to create a custom column,

    deprecated

    Obtains SQL code portion needed to create a custom column, 
    public function getCustomTypeDeclarationSQL(array|mixed[] $column): string

    e.g. when a column has the "columnDefinition" keyword. Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCustomTypeDeclarationSQL() ​Obtains SQL code portion needed to create a custom column,

    [m] getIndexFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexFieldDeclarationListSQL(Doctrine\DBAL\Schema\Index $index): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getColumnsFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getColumnsFieldDeclarationListSQL(array|mixed[] $columns): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$columns ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnsFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getTemporaryTableSQL Returns the required SQL string that fits between CREATE ... TABLE

    deprecated

    Returns the required SQL string that fits between CREATE ... TABLE 
    public function getTemporaryTableSQL(): string

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

    Return
    type summary
    ​string ​The string required to be placed between "CREATE" and "TABLE"
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableSQL() ​Returns the required SQL string that fits between CREATE ... TABLE

    [m] getTemporaryTableName Some vendors require temporary table names to be qualified specially.

    Some vendors require temporary table names to be qualified specially. 
    public function getTemporaryTableName(string $tableName): string
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableName() ​Some vendors require temporary table names to be qualified specially.

    [m] getForeignKeyDeclarationSQL Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyDeclarationSQL() ​Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getForeignKeyReferentialActionSQL Returns the given referential action in uppercase if valid, otherwise throws an exception.

    Returns the given referential action in uppercase if valid, otherwise throws an exception. 
    public function getForeignKeyReferentialActionSQL(string $action): string
    Parameter
    type name summary
    ​string ​$action ​The foreign key referential action.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​If unknown referential action given.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyReferentialActionSQL() ​Returns the given referential action in uppercase if valid, otherwise throws an exception.

    [m] getForeignKeyBaseDeclarationSQL Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyBaseDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyBaseDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getUniqueFieldDeclarationSQL Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    deprecated

    Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint 
    public function getUniqueFieldDeclarationSQL(): string

    of a column declaration to be used in statements like CREATE TABLE.

    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the UNIQUE constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueFieldDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    [m] getColumnCharsetDeclarationSQL Obtains DBMS specific SQL code portion needed to set the CHARACTER SET

    Obtains DBMS specific SQL code portion needed to set the CHARACTER SET 
    public function getColumnCharsetDeclarationSQL(string $charset): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$charset ​The name of the charset.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the CHARACTER SET
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnCharsetDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the CHARACTER SET

    [m] getColumnCollationDeclarationSQL Obtains DBMS specific SQL code portion needed to set the COLLATION

    Obtains DBMS specific SQL code portion needed to set the COLLATION 
    public function getColumnCollationDeclarationSQL(string $collation): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$collation ​The name of the collation.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the COLLATION
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnCollationDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the COLLATION

    [m] prefersIdentityColumns Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    deprecated

    Whether the platform prefers identity columns (eg. autoincrement) for ID generation. 
    public function prefersIdentityColumns(): bool

    Subclasses should override this method to return TRUE if they prefer identity columns.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::prefersIdentityColumns() ​Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    [m] getCurrentDateSQL Returns the SQL specific for the platform to get the current date.

    Returns the SQL specific for the platform to get the current date. 
    public function getCurrentDateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentDateSQL() ​Returns the SQL specific for the platform to get the current date.

    [m] getCurrentTimeSQL Returns the SQL specific for the platform to get the current time.

    Returns the SQL specific for the platform to get the current time. 
    public function getCurrentTimeSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimeSQL() ​Returns the SQL specific for the platform to get the current time.

    [m] getCurrentTimestampSQL Returns the SQL specific for the platform to get the current timestamp

    Returns the SQL specific for the platform to get the current timestamp 
    public function getCurrentTimestampSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimestampSQL() ​Returns the SQL specific for the platform to get the current timestamp

    [m] _getTransactionIsolationLevelSQL Returns the SQL for a given transaction isolation level Connection constant.

    Returns the SQL for a given transaction isolation level Connection constant. 
    protected function _getTransactionIsolationLevelSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::_getTransactionIsolationLevelSQL() ​Returns the SQL for a given transaction isolation level Connection constant.

    [m] getListUsersSQL

    deprecated 

    public function getListUsersSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListUsersSQL() ​

    [m] getCreateViewSQL 

    public function getCreateViewSQL(
    string $name,
    string $sql
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$sql ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateViewSQL() ​

    [m] getDropViewSQL 

    public function getDropViewSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropViewSQL() ​

    [m] getCreateDatabaseSQL Returns the SQL to create a new database.

    Returns the SQL to create a new database. 
    public function getCreateDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateDatabaseSQL() ​Returns the SQL to create a new database.

    [m] getDropDatabaseSQL Returns the SQL snippet to drop an existing database.

    Returns the SQL snippet to drop an existing database. 
    public function getDropDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be dropped.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropDatabaseSQL() ​Returns the SQL snippet to drop an existing database.

    [m] getFloatDeclarationSQL 

    public function getFloatDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getFloatDeclarationSQL() ​

    [m] getDefaultTransactionIsolationLevel Gets the default transaction isolation level of the platform.

    Gets the default transaction isolation level of the platform. 
    public function getDefaultTransactionIsolationLevel(): Doctrine\DBAL\TransactionIsolationLevel::*()
    Return
    type summary
    ​TransactionIsolationLevel::*() ​The default isolation level.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDefaultTransactionIsolationLevel() ​Gets the default transaction isolation level of the platform.
    See
    type summary
    ​TransactionIsolationLevel ​

    [m] supportsIndexes Whether the platform supports indexes.

    deprecated

    Whether the platform supports indexes. 
    public function supportsIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsIndexes() ​Whether the platform supports indexes.

    [m] supportsColumnLengthIndexes Whether the platform supports indexes with column length definitions.

    Whether the platform supports indexes with column length definitions. 
    public function supportsColumnLengthIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsColumnLengthIndexes() ​Whether the platform supports indexes with column length definitions.

    [m] supportsAlterTable Whether the platform supports altering tables.

    deprecated

    Whether the platform supports altering tables. 
    public function supportsAlterTable(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsAlterTable() ​Whether the platform supports altering tables.

    [m] supportsTransactions Whether the platform supports transactions.

    deprecated

    Whether the platform supports transactions. 
    public function supportsTransactions(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsTransactions() ​Whether the platform supports transactions.

    [m] supportsSavepoints Whether the platform supports savepoints.

    Whether the platform supports savepoints. 
    public function supportsSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSavepoints() ​Whether the platform supports savepoints.

    [m] supportsReleaseSavepoints Whether the platform supports releasing savepoints.

    Whether the platform supports releasing savepoints. 
    public function supportsReleaseSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsReleaseSavepoints() ​Whether the platform supports releasing savepoints.

    [m] supportsPrimaryConstraints Whether the platform supports primary key constraints.

    deprecated

    Whether the platform supports primary key constraints. 
    public function supportsPrimaryConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPrimaryConstraints() ​Whether the platform supports primary key constraints.

    [m] supportsForeignKeyConstraints Whether the platform supports foreign key constraints.

    deprecated

    Whether the platform supports foreign key constraints. 
    public function supportsForeignKeyConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsForeignKeyConstraints() ​Whether the platform supports foreign key constraints.

    [m] canEmulateSchemas Whether this platform can emulate schemas.

    deprecated

    Whether this platform can emulate schemas. 
    public function canEmulateSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::canEmulateSchemas() ​Whether this platform can emulate schemas.
    See
    type summary
    ​AbstractManager::introspectSchema() ​

    [m] supportsCreateDropDatabase Whether this platform supports create database.

    deprecated

    Whether this platform supports create database. 
    public function supportsCreateDropDatabase(): bool

    Some databases don't allow to create and drop databases at all or only with certain tools.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsCreateDropDatabase() ​Whether this platform supports create database.

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

    deprecated

    Whether the platform supports getting the affected rows of a recent update/delete type query. 
    public function supportsGettingAffectedRows(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsGettingAffectedRows() ​Whether the platform supports getting the affected rows of a recent update/delete type query.

    [m] supportsInlineColumnComments Whether this platform support to add inline column comments as postfix.

    Whether this platform support to add inline column comments as postfix. 
    public function supportsInlineColumnComments(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsInlineColumnComments() ​Whether this platform support to add inline column comments as postfix.

    [m] supportsViews Whether this platform supports views.

    deprecated

    Whether this platform supports views. 
    public function supportsViews(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsViews() ​Whether this platform supports views.

    [m] getDateTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeFormatString(): string

    the format of a stored datetime value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateFormatString(): string

    the format of a stored date value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getTimeFormatString(): string

    the format of a stored time value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] modifyLimitQuery Adds an driver-specific LIMIT clause to the query.

    final

    Adds an driver-specific LIMIT clause to the query. 
    final public function modifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset = 0
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset = 0 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::modifyLimitQuery() ​Adds an driver-specific LIMIT clause to the query.

    [m] doModifyLimitQuery Adds an platform-specific LIMIT clause to the query.

    Adds an platform-specific LIMIT clause to the query. 
    protected function doModifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::doModifyLimitQuery() ​Adds an platform-specific LIMIT clause to the query.

    [m] supportsLimitOffset Whether the database platform support offsets in modify limit clauses.

    deprecated

    Whether the database platform support offsets in modify limit clauses. 
    public function supportsLimitOffset(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsLimitOffset() ​Whether the database platform support offsets in modify limit clauses.

    [m] getMaxIdentifierLength Maximum length of any given database identifier, like tables or column names.

    Maximum length of any given database identifier, like tables or column names. 
    public function getMaxIdentifierLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxIdentifierLength() ​Maximum length of any given database identifier, like tables or column names.

    [m] getDummySelectSQL This is for test reasons, many vendors have special requirements for dummy statements.

    This is for test reasons, many vendors have special requirements for dummy statements. 
    public function getDummySelectSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDummySelectSQL() ​This is for test reasons, many vendors have special requirements for dummy statements.

    [m] createSavePoint Returns the SQL to create a new savepoint.

    Returns the SQL to create a new savepoint. 
    public function createSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSavePoint() ​Returns the SQL to create a new savepoint.

    [m] releaseSavePoint Returns the SQL to release a savepoint.

    Returns the SQL to release a savepoint. 
    public function releaseSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::releaseSavePoint() ​Returns the SQL to release a savepoint.

    [m] rollbackSavePoint Returns the SQL to rollback a savepoint.

    Returns the SQL to rollback a savepoint. 
    public function rollbackSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::rollbackSavePoint() ​Returns the SQL to rollback a savepoint.

    [m] getReservedKeywordsList Returns the keyword list instance of this platform.

    final

    Returns the keyword list instance of this platform. 
    final public function getReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList
    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​If no keyword list is specified.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getReservedKeywordsList() ​Returns the keyword list instance of this platform.

    [m] createReservedKeywordsList Creates an instance of the reserved keyword list of this platform.

    Creates an instance of the reserved keyword list of this platform. 
    protected function createReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList

    This method will become @abstract in DBAL 4.0.0.

    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createReservedKeywordsList() ​Creates an instance of the reserved keyword list of this platform.

    [m] quoteStringLiteral Quotes a literal string.

    Quotes a literal string. 
    public function quoteStringLiteral(string $str): string

    This method is NOT meant to fix SQL injections! It is only meant to escape this platform's string literal quote character inside the given literal string.

    Parameter
    type name summary
    ​string ​$str ​The literal string to be quoted.
    Return
    type summary
    ​string ​The quoted literal string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteStringLiteral() ​Quotes a literal string.

    [m] getStringLiteralQuoteCharacter Gets the character used for string literal quoting.

    deprecated

    Gets the character used for string literal quoting. 
    public function getStringLiteralQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringLiteralQuoteCharacter() ​Gets the character used for string literal quoting.
    See
    type summary
    ​AbstractPlatform::quoteStringLiteral() ​

    [m] escapeStringForLike Escapes metacharacters in a string intended to be used with a LIKE

    final

    Escapes metacharacters in a string intended to be used with a LIKE 
    final public function escapeStringForLike(
    string $inputString,
    string $escapeChar
): string

    operator.

    Parameter
    type name summary
    ​string ​$inputString ​a literal, unquoted string
    ​string ​$escapeChar ​should be reused by the caller in the LIKE
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::escapeStringForLike() ​Escapes metacharacters in a string intended to be used with a LIKE

    [m] createSQLParser 

    public function createSQLParser(): Doctrine\DBAL\SQL\Parser
    Return
    type summary
    ​Parser ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSQLParser() ​

    [m] getLikeWildcardCharacters 

    protected function getLikeWildcardCharacters(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] columnsEqual Compares the definitions of the given columns in the context of this platform.

    Compares the definitions of the given columns in the context of this platform. 
    public function columnsEqual(
    Doctrine\DBAL\Schema\Column $column1,
    Doctrine\DBAL\Schema\Column $column2
): bool
    Parameter
    type name summary
    ​Column ​$column1 ​
    ​Column ​$column2 ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::columnsEqual() ​Compares the definitions of the given columns in the context of this platform.

    [C] SqlitePlatform The SqlitePlatform class describes the specifics and dialects of the SQLite

    The SqlitePlatform class describes the specifics and dialects of the SQLite database platform.

    Hierarchy

    Parents
    type summary
    ​AbstractPlatform ​Base class for all DatabasePlatforms. The DatabasePlatforms are the central

    [C] CREATE_INDEXES 

    public const int CREATE_INDEXES = 1
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_INDEXES ​

    [C] CREATE_FOREIGNKEYS 

    public const int CREATE_FOREIGNKEYS = 2
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_FOREIGNKEYS ​

    [p] $doctrineTypeMapping 

    protected string[]|null $doctrineTypeMapping = null

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeMapping ​

    [p] $doctrineTypeComments Contains a list of all columns that should generate parseable column comments for type-detection

    deprecated

    Contains a list of all columns that should generate parseable column comments for type-detection 
    protected string[]|null $doctrineTypeComments = null

    in reverse engineering scenarios.

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeComments ​Contains a list of all columns that should generate parseable column comments for type-detection

    [p] $_eventManager

    deprecated 

    protected Doctrine\Common\EventManager|null $_eventManager = null

    Type: EventManager|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_eventManager ​

    [p] $_keywords Holds the KeywordList instance for the current platform.

    Holds the KeywordList instance for the current platform. 
    protected Doctrine\DBAL\Platforms\Keywords\KeywordList|null $_keywords = null

    Type: KeywordList|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_keywords ​Holds the KeywordList instance for the current platform.

    [m] getRegexpExpression Returns the regular expression operator.

    Returns the regular expression operator. 
    public function getRegexpExpression(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getRegexpExpression() ​Returns the regular expression operator.

    [m] getNowExpression

    deprecated 

    public function getNowExpression(string $type = "timestamp"): string
    Parameter
    type name summary
    ​string ​$type = "timestamp" ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getNowExpression() ​Returns the SQL snippet to get the current system date.

    [m] getModExpression Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2. 
    public function getModExpression(
    string $expression1,
    string $expression2
): string
    Parameter
    type name summary
    ​string ​$expression1 ​
    ​string ​$expression2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getModExpression() ​Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    [m] getTrimExpression Returns the SQL snippet to trim a string.

    Returns the SQL snippet to trim a string. 
    public function getTrimExpression(
    string $str,
    int $mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED,
    string|bool $char = false
): string
    Parameter
    type name summary
    ​string ​$str ​The expression to apply the trim to.
    ​int ​$mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED ​The position of the trim (leading/trailing/both).
    ​string|​bool ​$char = false ​The char to trim, has to be quoted already. Defaults to space.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTrimExpression() ​Returns the SQL snippet to trim a string.

    [m] getSubstringExpression <tag_inheritdoc data-type='' data-description=''>Returns a SQL snippet to get a substring inside an SQL statement.

    Returns a SQL snippet to get a substring inside an SQL statement. 
    public function getSubstringExpression(
    string $string,
    string|int $start,
    string|int|null $length = null
): string

    Note: Not SQL92, but common functionality.

    SQLite only supports the 2 parameter variant of this function.

    SQLite only supports the 2 parameter variant of this function

    Parameter
    type name summary
    ​string ​$string ​An sql string literal or column name/alias.
    ​string|​int ​$start ​Where to start the substring portion.
    ​string|​int|​null ​$length = null ​The substring portion length.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSubstringExpression() ​Returns a SQL snippet to get a substring inside an SQL statement.

    [m] getLocateExpression Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str. 
    public function getLocateExpression(
    string $str,
    string $substr,
    string|int|false $startPos = false
): string
    Parameter
    type name summary
    ​string ​$str ​Literal string.
    ​string ​$substr ​Literal string to find.
    ​string|​int|​false ​$startPos = false ​Position to start at, beginning of string by default.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getLocateExpression() ​Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    [m] getDateArithmeticIntervalExpression Returns the SQL for a date arithmetic expression.

    Returns the SQL for a date arithmetic expression. 
    protected function getDateArithmeticIntervalExpression(
    string $date,
    string $operator,
    int|string $interval,
    string $unit
): string
    Parameter
    type name summary
    ​string ​$date ​The column or literal representing a date
    ​string ​$operator ​The arithmetic operator (+ or -).
    ​int|​string ​$interval ​The interval that shall be calculated into the date.
    ​string ​$unit ​The unit of the interval that shall be calculated into the date.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateArithmeticIntervalExpression() ​Returns the SQL for a date arithmetic expression.

    [m] getDateDiffExpression <tag_inheritdoc data-type='' data-description=''>Returns the SQL to calculate the difference in days between the two passed dates.

    Returns the SQL to calculate the difference in days between the two passed dates. 
    public function getDateDiffExpression(
    string $date1,
    string $date2
): string

    Computes diff = date1 - date2.

    Parameter
    type name summary
    ​string ​$date1 ​
    ​string ​$date2 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateDiffExpression() ​Returns the SQL to calculate the difference in days between the two passed dates.

    [m] getCurrentDatabaseExpression Returns the SQL expression which represents the currently selected database.

    Returns the SQL expression which represents the currently selected database. 
    public function getCurrentDatabaseExpression(): string

    The DBAL doesn't support databases on the SQLite platform. The expression here always returns a fixed string as an indicator of an implicitly selected database.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCurrentDatabaseExpression() ​Returns the SQL expression which represents the currently selected database.
    See
    type summary
    ​Connection::getDatabase() ​

    [m] createSelectSQLBuilder 

    public function createSelectSQLBuilder(): Doctrine\DBAL\SQL\Builder\SelectSQLBuilder
    Return
    type summary
    ​SelectSQLBuilder ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::createSelectSQLBuilder() ​

    [m] _getTransactionIsolationLevelSQL Returns the SQL for a given transaction isolation level Connection constant.

    Returns the SQL for a given transaction isolation level Connection constant. 
    protected function _getTransactionIsolationLevelSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::_getTransactionIsolationLevelSQL() ​Returns the SQL for a given transaction isolation level Connection constant.

    [m] getSetTransactionIsolationSQL Returns the SQL to set the transaction isolation level.

    Returns the SQL to set the transaction isolation level. 
    public function getSetTransactionIsolationSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSetTransactionIsolationSQL() ​Returns the SQL to set the transaction isolation level.

    [m] prefersIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    deprecated

    Whether the platform prefers identity columns (eg. autoincrement) for ID generation. 
    public function prefersIdentityColumns(): bool

    Subclasses should override this method to return TRUE if they prefer identity columns.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::prefersIdentityColumns() ​Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    [m] getBooleanTypeDeclarationSQL Returns the SQL snippet that declares a boolean column.

    Returns the SQL snippet that declares a boolean column. 
    public function getBooleanTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBooleanTypeDeclarationSQL() ​Returns the SQL snippet that declares a boolean column.

    [m] getIntegerTypeDeclarationSQL Returns the SQL snippet that declares a 4 byte integer column.

    Returns the SQL snippet that declares a 4 byte integer column. 
    public function getIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares a 4 byte integer column.

    [m] getBigIntTypeDeclarationSQL Returns the SQL snippet that declares an 8 byte integer column.

    Returns the SQL snippet that declares an 8 byte integer column. 
    public function getBigIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBigIntTypeDeclarationSQL() ​Returns the SQL snippet that declares an 8 byte integer column.

    [m] getTinyIntTypeDeclarationSQL

    deprecated 

    public function getTinyIntTypeDeclarationSQL(array $column): string
    Parameter
    type name summary
    ​array ​$column ​
    Return
    type summary
    ​string ​
    See
    type summary
    ​SqlitePlatform::getSmallIntTypeDeclarationSQL() ​

    [m] getSmallIntTypeDeclarationSQL Returns the SQL snippet that declares a 2 byte integer column.

    Returns the SQL snippet that declares a 2 byte integer column. 
    public function getSmallIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSmallIntTypeDeclarationSQL() ​Returns the SQL snippet that declares a 2 byte integer column.

    [m] getMediumIntTypeDeclarationSQL

    deprecated 

    public function getMediumIntTypeDeclarationSQL(array $column): string
    Parameter
    type name summary
    ​array ​$column ​
    Return
    type summary
    ​string ​
    See
    type summary
    ​SqlitePlatform::getIntegerTypeDeclarationSQL() ​

    [m] getDateTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create datetime columns in

    Obtains DBMS specific SQL to be used to create datetime columns in 
    public function getDateTimeTypeDeclarationSQL(array|mixed[] $column): string

    statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTimeTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create datetime columns in

    [m] getDateTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create date columns in statements

    Obtains DBMS specific SQL to be used to create date columns in statements 
    public function getDateTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create date columns in statements

    [m] getTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create time columns in statements

    Obtains DBMS specific SQL to be used to create time columns in statements 
    public function getTimeTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTimeTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create time columns in statements

    [m] _getCommonIntegerTypeDeclarationSQL Returns the SQL snippet that declares common properties of an integer column.

    Returns the SQL snippet that declares common properties of an integer column. 
    protected function _getCommonIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::_getCommonIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares common properties of an integer column.

    [m] disableSchemaEmulation Disables schema emulation.

    deprecated

    Disables schema emulation. 
    public function disableSchemaEmulation()

    Schema emulation is enabled by default to maintain backwards compatibility. Disable it to opt-in to the behavior of DBAL 4.

    [m] getForeignKeyDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getForeignKeyDeclarationSQL() ​Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
    See
    type summary
    ​AbstractPlatform ​

    [m] _getCreateTableSQL Returns the SQL used to create a table.

    Returns the SQL used to create a table. 
    protected function _getCreateTableSQL(
    string $name,
    array|mixed[][] $columns,
    array|mixed[] $options = []
): string[]
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​mixed[][] ​$columns ​
    ​array|​mixed[] ​$options = [] ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::_getCreateTableSQL() ​Returns the SQL used to create a table.

    [m] getVarcharTypeDeclarationSQLSnippet 

    protected function getVarcharTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​
    ​bool ​$fixed ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getVarcharTypeDeclarationSQLSnippet() ​

    [m] getBinaryTypeDeclarationSQLSnippet Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    protected function getBinaryTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​The length of the column.
    ​bool ​$fixed ​Whether the column length is fixed.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBinaryTypeDeclarationSQLSnippet() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getBinaryMaxLength Gets the maximum length of a binary column.

    deprecated

    Gets the maximum length of a binary column. 
    public function getBinaryMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBinaryMaxLength() ​Gets the maximum length of a binary column.

    [m] getBinaryDefaultLength Gets the default length of a binary column.

    deprecated

    Gets the default length of a binary column. 
    public function getBinaryDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBinaryDefaultLength() ​Gets the default length of a binary column.

    [m] getClobTypeDeclarationSQL Returns the SQL snippet used to declare a CLOB column type.

    Returns the SQL snippet used to declare a CLOB column type. 
    public function getClobTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getClobTypeDeclarationSQL() ​Returns the SQL snippet used to declare a CLOB column type.

    [m] getListTableConstraintsSQL

    deprecated 

    public function getListTableConstraintsSQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableConstraintsSQL() ​

    [m] getListTableColumnsSQL

    deprecated 

    public function getListTableColumnsSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableColumnsSQL() ​

    [m] getListTableIndexesSQL

    deprecated 

    public function getListTableIndexesSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableIndexesSQL() ​

    [m] getListTablesSQL

    deprecated 

    public function getListTablesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTablesSQL() ​

    [m] getListViewsSQL Returns the SQL to list all views of a database or user.

    Returns the SQL to list all views of a database or user. 
    public function getListViewsSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListViewsSQL() ​Returns the SQL to list all views of a database or user.
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getAdvancedForeignKeyOptionsSQL <tag_inheritdoc data-type='' data-description=''>Returns the FOREIGN KEY query section dealing with non-standard options

    Returns the FOREIGN KEY query section dealing with non-standard options 
    public function getAdvancedForeignKeyOptionsSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    as MATCH, INITIALLY DEFERRED, ON UPDATE, ...

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getAdvancedForeignKeyOptionsSQL() ​Returns the FOREIGN KEY query section dealing with non-standard options
    See
    type summary
    ​AbstractPlatform ​

    [m] supportsCreateDropDatabase <tag_inheritdoc data-type='' data-description=''>Whether this platform supports create database.

    deprecated

    Whether this platform supports create database. 
    public function supportsCreateDropDatabase(): bool

    Some databases don't allow to create and drop databases at all or only with certain tools.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsCreateDropDatabase() ​Whether this platform supports create database.

    [m] supportsIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform supports identity columns.

    Whether the platform supports identity columns. 
    public function supportsIdentityColumns(): bool

    Identity columns are columns that receive an auto-generated value from the database on insert of a row.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsIdentityColumns() ​Whether the platform supports identity columns.

    [m] supportsColumnCollation Does this platform support column collation?

    Does this platform support column collation? 
    public function supportsColumnCollation(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsColumnCollation() ​Does this platform support column collation?
    See
    type summary
    ​AbstractPlatform ​

    [m] supportsInlineColumnComments Whether this platform support to add inline column comments as postfix.

    Whether this platform support to add inline column comments as postfix. 
    public function supportsInlineColumnComments(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsInlineColumnComments() ​Whether this platform support to add inline column comments as postfix.
    See
    type summary
    ​AbstractPlatform ​

    [m] getName Gets the name of the platform.

    deprecated

    Gets the name of the platform. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getName() ​Gets the name of the platform.

    [m] getTruncateTableSQL <tag_inheritdoc data-type='' data-description=''>Generates a Truncate Table SQL statement for a given table.

    Generates a Truncate Table SQL statement for a given table. 
    public function getTruncateTableSQL(
    string $tableName,
    bool $cascade = false
): string

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

    Parameter
    type name summary
    ​string ​$tableName ​
    ​bool ​$cascade = false ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTruncateTableSQL() ​Generates a Truncate Table SQL statement for a given table.

    [M] udfSqrt User-defined function for Sqlite that is used with PDO::sqliteCreateFunction().

    deprecated

    User-defined function for Sqlite that is used with PDO::sqliteCreateFunction(). 
    public static function udfSqrt(int|float $value): float
    Parameter
    type name summary
    ​int|​float ​$value ​
    Return
    type summary
    ​float ​
    See
    type summary
    ​SqlitePlatform::sqrt() ​

    [M] udfMod User-defined function for Sqlite that implements MOD(a, b).

    deprecated

    User-defined function for Sqlite that implements MOD(a, b). 
    public static function udfMod(
    int $a,
    int $b
): int
    Parameter
    type name summary
    ​int ​$a ​
    ​int ​$b ​
    Return
    type summary
    ​int ​
    See
    type summary
    ​UserDefinedFunctions::mod() ​

    [M] udfLocate

    deprecated 

    public static function udfLocate(
    string $str,
    string $substr,
    int $offset = 0
): int
    Parameter
    type name summary
    ​string ​$str ​
    ​string ​$substr ​
    ​int ​$offset = 0 ​
    Return
    type summary
    ​int ​
    See
    type summary
    ​UserDefinedFunctions::locate() ​

    [m] getForUpdateSQL Returns the FOR UPDATE expression.

    deprecated

    Returns the FOR UPDATE expression. 
    public function getForUpdateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getForUpdateSQL() ​Returns the FOR UPDATE expression.

    [m] getInlineColumnCommentSQL Returns the SQL to create inline comment on a column.

    Returns the SQL to create inline comment on a column. 
    public function getInlineColumnCommentSQL(string $comment): string
    Parameter
    type name summary
    ​string ​$comment ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getInlineColumnCommentSQL() ​Returns the SQL to create inline comment on a column.
    See
    type summary
    ​AbstractPlatform ​

    [m] initializeDoctrineTypeMappings Lazy load Doctrine Type Mappings.

    Lazy load Doctrine Type Mappings. 
    protected function initializeDoctrineTypeMappings(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::initializeDoctrineTypeMappings() ​Lazy load Doctrine Type Mappings.

    [m] getReservedKeywordsClass Returns the class name of the reserved keywords list.

    deprecated

    Returns the class name of the reserved keywords list. 
    protected function getReservedKeywordsClass(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getReservedKeywordsClass() ​Returns the class name of the reserved keywords list.
    See
    type summary
    ​SqlitePlatform::createReservedKeywordsList() ​
    ​AbstractPlatform::createReservedKeywordsList() ​

    [m] getPreAlterTableIndexForeignKeySQL 

    protected function getPreAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getPreAlterTableIndexForeignKeySQL() ​

    [m] getPostAlterTableIndexForeignKeySQL 

    protected function getPostAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getPostAlterTableIndexForeignKeySQL() ​

    [m] doModifyLimitQuery Adds an platform-specific LIMIT clause to the query.

    Adds an platform-specific LIMIT clause to the query. 
    protected function doModifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::doModifyLimitQuery() ​Adds an platform-specific LIMIT clause to the query.

    [m] getBlobTypeDeclarationSQL Returns the SQL Snippet used to declare a BLOB column type.

    Returns the SQL Snippet used to declare a BLOB column type. 
    public function getBlobTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBlobTypeDeclarationSQL() ​Returns the SQL Snippet used to declare a BLOB column type.

    [m] getTemporaryTableName Some vendors require temporary table names to be qualified specially.

    Some vendors require temporary table names to be qualified specially. 
    public function getTemporaryTableName(string $tableName): string
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTemporaryTableName() ​Some vendors require temporary table names to be qualified specially.

    [m] canEmulateSchemas Whether this platform can emulate schemas.

    deprecated

    Whether this platform can emulate schemas. 
    public function canEmulateSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::canEmulateSchemas() ​Whether this platform can emulate schemas.
    See
    type summary
    ​AbstractManager::introspectSchema() ​

    [m] getCreateTablesSQL 

    public function getCreateTablesSQL(array|Doctrine\DBAL\Schema\Table[] $tables): array
    Parameter
    type name summary
    ​array|​Table[] ​$tables ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateTablesSQL() ​

    [m] getCreateIndexSQL Returns the SQL to create an index on a table on this platform.

    Returns the SQL to create an index on a table on this platform. 
    public function getCreateIndexSQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateIndexSQL() ​Returns the SQL to create an index on a table on this platform.

    [m] getDropTablesSQL 

    public function getDropTablesSQL(array|list $tables): array
    Parameter
    type name summary
    ​array|​list ​$tables ​
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDropTablesSQL() ​

    [m] getCreatePrimaryKeySQL Returns the SQL to create an unnamed primary key constraint.

    Returns the SQL to create an unnamed primary key constraint. 
    public function getCreatePrimaryKeySQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreatePrimaryKeySQL() ​Returns the SQL to create an unnamed primary key constraint.

    [m] getCreateForeignKeySQL Returns the SQL to create a new foreign key.

    Returns the SQL to create a new foreign key. 
    public function getCreateForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key constraint.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateForeignKeySQL() ​Returns the SQL to create a new foreign key.

    [m] getDropForeignKeySQL Returns the SQL to drop a foreign key.

    Returns the SQL to drop a foreign key. 
    public function getDropForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDropForeignKeySQL() ​Returns the SQL to drop a foreign key.

    [m] getCreateConstraintSQL Returns the SQL to create a constraint on a table on this platform.

    deprecated

    Returns the SQL to create a constraint on a table on this platform. 
    public function getCreateConstraintSQL(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateConstraintSQL() ​Returns the SQL to create a constraint on a table on this platform.
    See
    type summary
    ​AbstractPlatform::getCreateIndexSQL() ​
    ​AbstractPlatform::getCreateForeignKeySQL() ​

    [m] getCreateTableSQL <tag_inheritdoc data-type='' data-description=''>Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    Returns the SQL statement(s) to create a table with the specified name, columns and constraints 
    public function getCreateTableSQL(
    Doctrine\DBAL\Schema\Table $table,
    int|null $createFlags = self::CREATE_INDEXES
): list

    on this platform.

    Parameter
    type name summary
    ​Table ​$table ​
    ​int|​null ​$createFlags = self::CREATE_INDEXES ​
    Return
    type summary
    ​list ​The list of SQL statements.
    Throws
    type summary
    ​Exception ​
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateTableSQL() ​Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    [m] getListTableForeignKeysSQL

    deprecated 

    public function getListTableForeignKeysSQL(
    string $table,
    string|null $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableForeignKeysSQL() ​

    [m] getAlterTableSQL <tag_inheritdoc data-type='' data-description=''>Gets the SQL statements for altering an existing table.

    Gets the SQL statements for altering an existing table. 
    public function getAlterTableSQL(Doctrine\DBAL\Schema\TableDiff $diff): list

    This method returns an array of SQL statements, since some platforms need several statements.

    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getAlterTableSQL() ​Gets the SQL statements for altering an existing table.

    [m] createSchemaManager Creates the schema manager that can be used to inspect and change the underlying

    Creates the schema manager that can be used to inspect and change the underlying 
    public function createSchemaManager(Doctrine\DBAL\Connection $connection): Doctrine\DBAL\Schema\SqliteSchemaManager

    database schema according to the dialect of the platform.

    Parameter
    type name summary
    ​Connection ​$connection ​
    Return
    type summary
    ​SqliteSchemaManager ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::createSchemaManager() ​Creates the schema manager that can be used to inspect and change the underlying

    [m] setDisableTypeComments

    final

    final public function setDisableTypeComments(bool $value)
    Parameter
    type name summary
    ​bool ​$value ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setDisableTypeComments() ​

    [m] setEventManager Sets the EventManager used by the Platform.

    deprecated

    Sets the EventManager used by the Platform. 
    public function setEventManager(Doctrine\Common\EventManager $eventManager): void
    Parameter
    type name summary
    ​EventManager ​$eventManager ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setEventManager() ​Sets the EventManager used by the Platform.

    [m] getEventManager Gets the EventManager used by the Platform.

    deprecated

    Gets the EventManager used by the Platform. 
    public function getEventManager(): Doctrine\Common\EventManager|null
    Return
    type summary
    ​EventManager|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEventManager() ​Gets the EventManager used by the Platform.

    [m] getAsciiStringTypeDeclarationSQL Returns the SQL snippet used to declare a column that can

    Returns the SQL snippet used to declare a column that can 
    public function getAsciiStringTypeDeclarationSQL(array|mixed[] $column): string

    store characters in the ASCII character set

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAsciiStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a column that can

    [m] getVarcharTypeDeclarationSQL Returns the SQL snippet used to declare a VARCHAR column type.

    deprecated

    Returns the SQL snippet used to declare a VARCHAR column type. 
    public function getVarcharTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharTypeDeclarationSQL() ​Returns the SQL snippet used to declare a VARCHAR column type.

    [m] getStringTypeDeclarationSQL Returns the SQL snippet used to declare a string column type.

    Returns the SQL snippet used to declare a string column type. 
    public function getStringTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a string column type.

    [m] getBinaryTypeDeclarationSQL Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    public function getBinaryTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryTypeDeclarationSQL() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getGuidTypeDeclarationSQL Returns the SQL snippet to declare a GUID/UUID column.

    Returns the SQL snippet to declare a GUID/UUID column. 
    public function getGuidTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CHAR(36) and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getGuidTypeDeclarationSQL() ​Returns the SQL snippet to declare a GUID/UUID column.

    [m] getJsonTypeDeclarationSQL Returns the SQL snippet to declare a JSON column.

    Returns the SQL snippet to declare a JSON column. 
    public function getJsonTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CLOB and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getJsonTypeDeclarationSQL() ​Returns the SQL snippet to declare a JSON column.

    [m] registerDoctrineTypeMapping Registers a doctrine type to be used in conjunction with a column type of this platform.

    Registers a doctrine type to be used in conjunction with a column type of this platform. 
    public function registerDoctrineTypeMapping(
    string $dbType,
    string $doctrineType
): void
    Parameter
    type name summary
    ​string ​$dbType ​
    ​string ​$doctrineType ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​If the type is not found.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::registerDoctrineTypeMapping() ​Registers a doctrine type to be used in conjunction with a column type of this platform.

    [m] getDoctrineTypeMapping Gets the Doctrine type that is mapped for the given database column type.

    Gets the Doctrine type that is mapped for the given database column type. 
    public function getDoctrineTypeMapping(string $dbType): string
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeMapping() ​Gets the Doctrine type that is mapped for the given database column type.

    [m] hasDoctrineTypeMappingFor Checks if a database type is currently supported by this platform.

    Checks if a database type is currently supported by this platform. 
    public function hasDoctrineTypeMappingFor(string $dbType): bool
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasDoctrineTypeMappingFor() ​Checks if a database type is currently supported by this platform.

    [m] initializeCommentedDoctrineTypes Initializes the Doctrine Type comments instance variable for in_array() checks.

    deprecated

    Initializes the Doctrine Type comments instance variable for in_array() checks. 
    protected function initializeCommentedDoctrineTypes(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::initializeCommentedDoctrineTypes() ​Initializes the Doctrine Type comments instance variable for in_array() checks.

    [m] isCommentedDoctrineType Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    deprecated

    Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type? 
    public function isCommentedDoctrineType(Doctrine\DBAL\Types\Type $doctrineType): bool
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::isCommentedDoctrineType() ​Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    [m] markDoctrineTypeCommented Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements. 
    public function markDoctrineTypeCommented(string|Doctrine\DBAL\Types\Type $doctrineType): void
    Parameter
    type name summary
    ​string|​Type ​$doctrineType ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::markDoctrineTypeCommented() ​Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    [m] getDoctrineTypeComment Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    deprecated

    Gets the comment to append to a column comment that helps parsing this type in reverse engineering. 
    public function getDoctrineTypeComment(Doctrine\DBAL\Types\Type $doctrineType): string
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeComment() ​Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    [m] getColumnComment Gets the comment of a passed column modified by potential doctrine type comment hints.

    deprecated

    Gets the comment of a passed column modified by potential doctrine type comment hints. 
    protected function getColumnComment(Doctrine\DBAL\Schema\Column $column): string|null
    Parameter
    type name summary
    ​Column ​$column ​
    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnComment() ​Gets the comment of a passed column modified by potential doctrine type comment hints.

    [m] getIdentifierQuoteCharacter Gets the character used for identifier quoting.

    deprecated

    Gets the character used for identifier quoting. 
    public function getIdentifierQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIdentifierQuoteCharacter() ​Gets the character used for identifier quoting.
    See
    type summary
    ​AbstractPlatform::quoteIdentifier() ​

    [m] getSqlCommentStartString Gets the string portion that starts an SQL comment.

    deprecated

    Gets the string portion that starts an SQL comment. 
    public function getSqlCommentStartString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentStartString() ​Gets the string portion that starts an SQL comment.

    [m] getSqlCommentEndString Gets the string portion that ends an SQL comment.

    deprecated

    Gets the string portion that ends an SQL comment. 
    public function getSqlCommentEndString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentEndString() ​Gets the string portion that ends an SQL comment.

    [m] getCharMaxLength Gets the maximum length of a char column.

    deprecated

    Gets the maximum length of a char column. 
    public function getCharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCharMaxLength() ​Gets the maximum length of a char column.

    [m] getVarcharMaxLength Gets the maximum length of a varchar column.

    deprecated

    Gets the maximum length of a varchar column. 
    public function getVarcharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharMaxLength() ​Gets the maximum length of a varchar column.

    [m] getVarcharDefaultLength Gets the default length of a varchar column.

    deprecated

    Gets the default length of a varchar column. 
    public function getVarcharDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharDefaultLength() ​Gets the default length of a varchar column.

    [m] getWildcards Gets all SQL wildcard characters of the platform.

    deprecated

    Gets all SQL wildcard characters of the platform. 
    public function getWildcards(): string[]
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWildcards() ​Gets all SQL wildcard characters of the platform.
    See
    type summary
    ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] getAvgExpression Returns the SQL snippet to get the average value of a column.

    deprecated

    Returns the SQL snippet to get the average value of a column. 
    public function getAvgExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an AVG aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAvgExpression() ​Returns the SQL snippet to get the average value of a column.

    [m] getCountExpression Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    deprecated

    Returns the SQL snippet to get the number of rows (without a NULL value) of a column. 
    public function getCountExpression(string|int $column): string

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

    Parameter
    type name summary
    ​string|​int ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a COUNT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCountExpression() ​Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    [m] getMaxExpression Returns the SQL snippet to get the highest value of a column.

    deprecated

    Returns the SQL snippet to get the highest value of a column. 
    public function getMaxExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MAX aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxExpression() ​Returns the SQL snippet to get the highest value of a column.

    [m] getMinExpression Returns the SQL snippet to get the lowest value of a column.

    deprecated

    Returns the SQL snippet to get the lowest value of a column. 
    public function getMinExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MIN aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMinExpression() ​Returns the SQL snippet to get the lowest value of a column.

    [m] getSumExpression Returns the SQL snippet to get the total sum of a column.

    deprecated

    Returns the SQL snippet to get the total sum of a column. 
    public function getSumExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a SUM aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSumExpression() ​Returns the SQL snippet to get the total sum of a column.

    [m] getMd5Expression Returns the SQL snippet to get the md5 sum of a column.

    deprecated

    Returns the SQL snippet to get the md5 sum of a column. 
    public function getMd5Expression(string $column): string

    Note: Not SQL92, but common functionality.

    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMd5Expression() ​Returns the SQL snippet to get the md5 sum of a column.

    [m] getLengthExpression Returns the SQL snippet to get the length of a text column in characters.

    Returns the SQL snippet to get the length of a text column in characters. 
    public function getLengthExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLengthExpression() ​Returns the SQL snippet to get the length of a text column in characters.

    [m] getSqrtExpression Returns the SQL snippet to get the squared value of a column.

    deprecated

    Returns the SQL snippet to get the squared value of a column. 
    public function getSqrtExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an SQRT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqrtExpression() ​Returns the SQL snippet to get the squared value of a column.

    [m] getRoundExpression Returns the SQL snippet to round a numeric column to the number of decimals specified.

    deprecated

    Returns the SQL snippet to round a numeric column to the number of decimals specified. 
    public function getRoundExpression(
    string $column,
    string|int $decimals = 0
): string
    Parameter
    type name summary
    ​string ​$column ​
    ​string|​int ​$decimals = 0 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRoundExpression() ​Returns the SQL snippet to round a numeric column to the number of decimals specified.

    [m] getRtrimExpression Returns the SQL snippet to trim trailing space characters from the expression.

    deprecated

    Returns the SQL snippet to trim trailing space characters from the expression. 
    public function getRtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRtrimExpression() ​Returns the SQL snippet to trim trailing space characters from the expression.

    [m] getLtrimExpression Returns the SQL snippet to trim leading space characters from the expression.

    deprecated

    Returns the SQL snippet to trim leading space characters from the expression. 
    public function getLtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLtrimExpression() ​Returns the SQL snippet to trim leading space characters from the expression.

    [m] getUpperExpression Returns the SQL snippet to change all characters from the expression to uppercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to uppercase, 
    public function getUpperExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUpperExpression() ​Returns the SQL snippet to change all characters from the expression to uppercase,

    [m] getLowerExpression Returns the SQL snippet to change all characters from the expression to lowercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to lowercase, 
    public function getLowerExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLowerExpression() ​Returns the SQL snippet to change all characters from the expression to lowercase,

    [m] getConcatExpression Returns a SQL snippet to concatenate the given expressions.

    Returns a SQL snippet to concatenate the given expressions. 
    public function getConcatExpression(): string

    Accepts an arbitrary number of string parameters. Each parameter must contain an expression.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getConcatExpression() ​Returns a SQL snippet to concatenate the given expressions.

    [m] getNotExpression Returns the SQL for a logical not.

    deprecated

    Returns the SQL for a logical not. 
    public function getNotExpression(string $expression): string

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

    Parameter
    type name summary
    ​string ​$expression ​
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getNotExpression() ​Returns the SQL for a logical not.

    [m] getIsNullExpression Returns the SQL that checks if an expression is null.

    deprecated

    Returns the SQL that checks if an expression is null. 
    public function getIsNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNullExpression() ​Returns the SQL that checks if an expression is null.

    [m] getIsNotNullExpression Returns the SQL that checks if an expression is not null.

    deprecated

    Returns the SQL that checks if an expression is not null. 
    public function getIsNotNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNotNullExpression() ​Returns the SQL that checks if an expression is not null.

    [m] getBetweenExpression Returns the SQL that checks if an expression evaluates to a value between two values.

    deprecated

    Returns the SQL that checks if an expression evaluates to a value between two values. 
    public function getBetweenExpression(
    string $expression,
    string $value1,
    string $value2
): string

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

    Parameter
    type name summary
    ​string ​$expression ​The value to compare to.
    ​string ​$value1 ​The lower value to compare with.
    ​string ​$value2 ​The higher value to compare with.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBetweenExpression() ​Returns the SQL that checks if an expression evaluates to a value between two values.

    [m] getAcosExpression Returns the SQL to get the arccosine of a value.

    deprecated

    Returns the SQL to get the arccosine of a value. 
    public function getAcosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAcosExpression() ​Returns the SQL to get the arccosine of a value.

    [m] getSinExpression Returns the SQL to get the sine of a value.

    deprecated

    Returns the SQL to get the sine of a value. 
    public function getSinExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSinExpression() ​Returns the SQL to get the sine of a value.

    [m] getPiExpression Returns the SQL to get the PI value.

    deprecated

    Returns the SQL to get the PI value. 
    public function getPiExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPiExpression() ​Returns the SQL to get the PI value.

    [m] getCosExpression Returns the SQL to get the cosine of a value.

    deprecated

    Returns the SQL to get the cosine of a value. 
    public function getCosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCosExpression() ​Returns the SQL to get the cosine of a value.

    [m] getDateAddSecondsExpression Returns the SQL to add the number of given seconds to a date.

    Returns the SQL to add the number of given seconds to a date. 
    public function getDateAddSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddSecondsExpression() ​Returns the SQL to add the number of given seconds to a date.

    [m] getDateSubSecondsExpression Returns the SQL to subtract the number of given seconds from a date.

    Returns the SQL to subtract the number of given seconds from a date. 
    public function getDateSubSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubSecondsExpression() ​Returns the SQL to subtract the number of given seconds from a date.

    [m] getDateAddMinutesExpression Returns the SQL to add the number of given minutes to a date.

    Returns the SQL to add the number of given minutes to a date. 
    public function getDateAddMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMinutesExpression() ​Returns the SQL to add the number of given minutes to a date.

    [m] getDateSubMinutesExpression Returns the SQL to subtract the number of given minutes from a date.

    Returns the SQL to subtract the number of given minutes from a date. 
    public function getDateSubMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMinutesExpression() ​Returns the SQL to subtract the number of given minutes from a date.

    [m] getDateAddHourExpression Returns the SQL to add the number of given hours to a date.

    Returns the SQL to add the number of given hours to a date. 
    public function getDateAddHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddHourExpression() ​Returns the SQL to add the number of given hours to a date.

    [m] getDateSubHourExpression Returns the SQL to subtract the number of given hours to a date.

    Returns the SQL to subtract the number of given hours to a date. 
    public function getDateSubHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubHourExpression() ​Returns the SQL to subtract the number of given hours to a date.

    [m] getDateAddDaysExpression Returns the SQL to add the number of given days to a date.

    Returns the SQL to add the number of given days to a date. 
    public function getDateAddDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddDaysExpression() ​Returns the SQL to add the number of given days to a date.

    [m] getDateSubDaysExpression Returns the SQL to subtract the number of given days to a date.

    Returns the SQL to subtract the number of given days to a date. 
    public function getDateSubDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubDaysExpression() ​Returns the SQL to subtract the number of given days to a date.

    [m] getDateAddWeeksExpression Returns the SQL to add the number of given weeks to a date.

    Returns the SQL to add the number of given weeks to a date. 
    public function getDateAddWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddWeeksExpression() ​Returns the SQL to add the number of given weeks to a date.

    [m] getDateSubWeeksExpression Returns the SQL to subtract the number of given weeks from a date.

    Returns the SQL to subtract the number of given weeks from a date. 
    public function getDateSubWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubWeeksExpression() ​Returns the SQL to subtract the number of given weeks from a date.

    [m] getDateAddMonthExpression Returns the SQL to add the number of given months to a date.

    Returns the SQL to add the number of given months to a date. 
    public function getDateAddMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMonthExpression() ​Returns the SQL to add the number of given months to a date.

    [m] getDateSubMonthExpression Returns the SQL to subtract the number of given months to a date.

    Returns the SQL to subtract the number of given months to a date. 
    public function getDateSubMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMonthExpression() ​Returns the SQL to subtract the number of given months to a date.

    [m] getDateAddQuartersExpression Returns the SQL to add the number of given quarters to a date.

    Returns the SQL to add the number of given quarters to a date. 
    public function getDateAddQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddQuartersExpression() ​Returns the SQL to add the number of given quarters to a date.

    [m] getDateSubQuartersExpression Returns the SQL to subtract the number of given quarters from a date.

    Returns the SQL to subtract the number of given quarters from a date. 
    public function getDateSubQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubQuartersExpression() ​Returns the SQL to subtract the number of given quarters from a date.

    [m] getDateAddYearsExpression Returns the SQL to add the number of given years to a date.

    Returns the SQL to add the number of given years to a date. 
    public function getDateAddYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddYearsExpression() ​Returns the SQL to add the number of given years to a date.

    [m] getDateSubYearsExpression Returns the SQL to subtract the number of given years from a date.

    Returns the SQL to subtract the number of given years from a date. 
    public function getDateSubYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubYearsExpression() ​Returns the SQL to subtract the number of given years from a date.

    [m] multiplyInterval Generates the SQL expression which represents the given date interval multiplied by a number

    Generates the SQL expression which represents the given date interval multiplied by a number 
    protected function multiplyInterval(
    string $interval,
    int $multiplier
): string
    Parameter
    type name summary
    ​string ​$interval ​SQL expression describing the interval value
    ​int ​$multiplier ​Interval multiplier
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::multiplyInterval() ​Generates the SQL expression which represents the given date interval multiplied by a number

    [m] getBitAndComparisonExpression Returns the SQL bit AND comparison expression.

    Returns the SQL bit AND comparison expression. 
    public function getBitAndComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitAndComparisonExpression() ​Returns the SQL bit AND comparison expression.

    [m] getBitOrComparisonExpression Returns the SQL bit OR comparison expression.

    Returns the SQL bit OR comparison expression. 
    public function getBitOrComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitOrComparisonExpression() ​Returns the SQL bit OR comparison expression.

    [m] appendLockHint Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    Honors that some SQL vendors such as MsSql use table hints for locking instead of the 
    public function appendLockHint(
    string $fromClause,
    int $lockMode
): string

    ANSI SQL FOR UPDATE specification.

    Parameter
    type name summary
    ​string ​$fromClause ​The FROM clause to append the hint for the given lock mode to
    ​int ​$lockMode ​One of the Doctrine\DBAL\LockMode::* constants
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::appendLockHint() ​Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    [m] getReadLockSQL Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock. 
    public function getReadLockSQL(): string

    This defaults to the ANSI SQL "FOR UPDATE", which is an exclusive lock (Write). Some database vendors allow to lighten this constraint up to be a real read lock.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getReadLockSQL() ​Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    [m] getWriteLockSQL Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows. 
    public function getWriteLockSQL(): string

    The semantics of this lock mode should equal the SELECT .. FOR UPDATE of the ANSI SQL standard.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWriteLockSQL() ​Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    [m] getDropTableSQL Returns the SQL snippet to drop an existing table.

    Returns the SQL snippet to drop an existing table. 
    public function getDropTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTableSQL() ​Returns the SQL snippet to drop an existing table.

    [m] getDropTemporaryTableSQL Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction. 
    public function getDropTemporaryTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTemporaryTableSQL() ​Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    [m] getDropIndexSQL Returns the SQL to drop an index from a table.

    Returns the SQL to drop an index from a table. 
    public function getDropIndexSQL(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string|null $table = null
): string
    Parameter
    type name summary
    ​Index|​string ​$index ​
    ​Table|​string|​null ​$table = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropIndexSQL() ​Returns the SQL to drop an index from a table.

    [m] getDropConstraintSQL Returns the SQL to drop a constraint.

    Returns the SQL to drop a constraint. 
    public function getDropConstraintSQL(
    Doctrine\DBAL\Schema\Constraint|string $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint|​string ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropConstraintSQL() ​Returns the SQL to drop a constraint.
    See
    type summary
    ​AbstractPlatform ​

    [m] getDropUniqueConstraintSQL Returns the SQL to drop a unique constraint.

    Returns the SQL to drop a unique constraint. 
    public function getDropUniqueConstraintSQL(
    string $name,
    string $tableName
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropUniqueConstraintSQL() ​Returns the SQL to drop a unique constraint.

    [m] getCreateTableWithoutForeignKeysSQL

    final

    final protected function getCreateTableWithoutForeignKeysSQL(Doctrine\DBAL\Schema\Table $table): array|list
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableWithoutForeignKeysSQL() ​

    [m] getCommentOnTableSQL 

    protected function getCommentOnTableSQL(
    string $tableName,
    ?string $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​?string ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnTableSQL() ​

    [m] getCommentOnColumnSQL 

    public function getCommentOnColumnSQL(
    string $tableName,
    string $columnName,
    string|null $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    ​string|​null ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnColumnSQL() ​

    [m] getCreateTemporaryTableSnippetSQL 

    public function getCreateTemporaryTableSnippetSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTemporaryTableSnippetSQL() ​

    [m] getAlterSchemaSQL Generates SQL statements that can be used to apply the diff.

    Generates SQL statements that can be used to apply the diff. 
    public function getAlterSchemaSQL(Doctrine\DBAL\Schema\SchemaDiff $diff): array|list
    Parameter
    type name summary
    ​SchemaDiff ​$diff ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAlterSchemaSQL() ​Generates SQL statements that can be used to apply the diff.

    [m] getCreateSequenceSQL Returns the SQL to create a sequence on this platform.

    Returns the SQL to create a sequence on this platform. 
    public function getCreateSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateSequenceSQL() ​Returns the SQL to create a sequence on this platform.

    [m] getAlterSequenceSQL Returns the SQL to change a sequence on this platform.

    Returns the SQL to change a sequence on this platform. 
    public function getAlterSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAlterSequenceSQL() ​Returns the SQL to change a sequence on this platform.

    [m] getDropSequenceSQL Returns the SQL snippet to drop an existing sequence.

    Returns the SQL snippet to drop an existing sequence. 
    public function getDropSequenceSQL(Doctrine\DBAL\Schema\Sequence|string $sequence): string
    Parameter
    type name summary
    ​Sequence|​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSequenceSQL() ​Returns the SQL snippet to drop an existing sequence.

    [m] getPartialIndexSQL Adds condition for partial index.

    Adds condition for partial index. 
    protected function getPartialIndexSQL(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPartialIndexSQL() ​Adds condition for partial index.

    [m] getCreateIndexSQLFlags Adds additional flags for index generation.

    Adds additional flags for index generation. 
    protected function getCreateIndexSQLFlags(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateIndexSQLFlags() ​Adds additional flags for index generation.

    [m] getCreateSchemaSQL Returns the SQL to create a named schema.

    Returns the SQL to create a named schema. 
    public function getCreateSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateSchemaSQL() ​Returns the SQL to create a named schema.

    [m] getCreateUniqueConstraintSQL Returns the SQL to create a unique constraint on a table on this platform.

    Returns the SQL to create a unique constraint on a table on this platform. 
    public function getCreateUniqueConstraintSQL(
    Doctrine\DBAL\Schema\UniqueConstraint $constraint,
    string $tableName
): string
    Parameter
    type name summary
    ​UniqueConstraint ​$constraint ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateUniqueConstraintSQL() ​Returns the SQL to create a unique constraint on a table on this platform.

    [m] getDropSchemaSQL Returns the SQL snippet to drop a schema.

    Returns the SQL snippet to drop a schema. 
    public function getDropSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSchemaSQL() ​Returns the SQL snippet to drop a schema.

    [m] quoteIdentifier Quotes a string so that it can be safely used as a table or column name,

    Quotes a string so that it can be safely used as a table or column name, 
    public function quoteIdentifier(string $str): string

    even if it is a reserved word of the platform. This also detects identifier chains separated by dot and quotes them independently.

    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.

    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteIdentifier() ​Quotes a string so that it can be safely used as a table or column name,

    [m] quoteSingleIdentifier Quotes a single identifier (no dot chain separation).

    Quotes a single identifier (no dot chain separation). 
    public function quoteSingleIdentifier(string $str): string
    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteSingleIdentifier() ​Quotes a single identifier (no dot chain separation).

    [m] getRenameTableSQL 

    public function getRenameTableSQL(
    string $oldName,
    string $newName
): array|list
    Parameter
    type name summary
    ​string ​$oldName ​
    ​string ​$newName ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRenameTableSQL() ​

    [m] onSchemaAlterTableAddColumn 

    protected function onSchemaAlterTableAddColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    mixed[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​mixed[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableAddColumn() ​

    [m] onSchemaAlterTableRemoveColumn 

    protected function onSchemaAlterTableRemoveColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRemoveColumn() ​

    [m] onSchemaAlterTableChangeColumn 

    protected function onSchemaAlterTableChangeColumn(
    Doctrine\DBAL\Schema\ColumnDiff $columnDiff,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​ColumnDiff ​$columnDiff ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableChangeColumn() ​

    [m] onSchemaAlterTableRenameColumn 

    protected function onSchemaAlterTableRenameColumn(
    string $oldColumnName,
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​string ​$oldColumnName ​
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRenameColumn() ​

    [m] onSchemaAlterTable 

    protected function onSchemaAlterTable(
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$sql
): bool
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    ​string[] ​&$sql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTable() ​

    [m] getRenameIndexSQL Returns the SQL for renaming an index on a table.

    Returns the SQL for renaming an index on a table. 
    protected function getRenameIndexSQL(
    string $oldIndexName,
    Doctrine\DBAL\Schema\Index $index,
    string $tableName
): string[]
    Parameter
    type name summary
    ​string ​$oldIndexName ​The name of the index to rename from.
    ​Index ​$index ​The definition of the index to rename to.
    ​string ​$tableName ​The table to rename the given index on.
    Return
    type summary
    ​string[] ​The sequence of SQL statements for renaming the given index.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRenameIndexSQL() ​Returns the SQL for renaming an index on a table.

    [m] getColumnDeclarationListSQL Gets declaration of a number of columns in bulk.

    Gets declaration of a number of columns in bulk. 
    public function getColumnDeclarationListSQL(array|mixed[][] $columns): string
    Parameter
    type name summary
    ​array|​mixed[][] ​$columns ​A multidimensional associative array.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationListSQL() ​Gets declaration of a number of columns in bulk.

    [m] getColumnDeclarationSQL Obtains DBMS specific SQL code portion needed to declare a generic type

    Obtains DBMS specific SQL code portion needed to declare a generic type 
    public function getColumnDeclarationSQL(
    string $name,
    array|mixed[] $column
): string

    column to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name the column to be declared.
    ​array|​mixed[] ​$column ​An associative array with the name of the properties
    Return
    type summary
    ​string ​DBMS specific SQL code portion that should be used to declare the column.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to declare a generic type

    [m] getDecimalTypeDeclarationSQL Returns the SQL snippet that declares a floating point column of arbitrary precision.

    Returns the SQL snippet that declares a floating point column of arbitrary precision. 
    public function getDecimalTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDecimalTypeDeclarationSQL() ​Returns the SQL snippet that declares a floating point column of arbitrary precision.

    [m] getDefaultValueDeclarationSQL Obtains DBMS specific SQL code portion needed to set a default value

    Obtains DBMS specific SQL code portion needed to set a default value 
    public function getDefaultValueDeclarationSQL(mixed[] $column): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​mixed[] ​$column ​The column definition array.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a default value.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDefaultValueDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a default value

    [m] getCheckDeclarationSQL Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    Obtains DBMS specific SQL code portion needed to set a CHECK constraint 
    public function getCheckDeclarationSQL(array|string[]|mixed[][] $definition): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​string[]|​mixed[][] ​$definition ​The check definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a CHECK constraint.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCheckDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    [m] getUniqueConstraintDeclarationSQL Obtains DBMS specific SQL code portion needed to set a unique

    Obtains DBMS specific SQL code portion needed to set a unique 
    public function getUniqueConstraintDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\UniqueConstraint $constraint
): string

    constraint declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the unique constraint.
    ​UniqueConstraint ​$constraint ​The unique constraint definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a constraint.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueConstraintDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a unique

    [m] getIndexDeclarationSQL Obtains DBMS specific SQL code portion needed to set an index

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\Index $index
): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the index.
    ​Index ​$index ​The index definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set an index.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getCustomTypeDeclarationSQL Obtains SQL code portion needed to create a custom column,

    deprecated

    Obtains SQL code portion needed to create a custom column, 
    public function getCustomTypeDeclarationSQL(array|mixed[] $column): string

    e.g. when a column has the "columnDefinition" keyword. Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCustomTypeDeclarationSQL() ​Obtains SQL code portion needed to create a custom column,

    [m] getIndexFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexFieldDeclarationListSQL(Doctrine\DBAL\Schema\Index $index): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getColumnsFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getColumnsFieldDeclarationListSQL(array|mixed[] $columns): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$columns ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnsFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getTemporaryTableSQL Returns the required SQL string that fits between CREATE ... TABLE

    deprecated

    Returns the required SQL string that fits between CREATE ... TABLE 
    public function getTemporaryTableSQL(): string

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

    Return
    type summary
    ​string ​The string required to be placed between "CREATE" and "TABLE"
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableSQL() ​Returns the required SQL string that fits between CREATE ... TABLE

    [m] getForeignKeyReferentialActionSQL Returns the given referential action in uppercase if valid, otherwise throws an exception.

    Returns the given referential action in uppercase if valid, otherwise throws an exception. 
    public function getForeignKeyReferentialActionSQL(string $action): string
    Parameter
    type name summary
    ​string ​$action ​The foreign key referential action.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​If unknown referential action given.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyReferentialActionSQL() ​Returns the given referential action in uppercase if valid, otherwise throws an exception.

    [m] getForeignKeyBaseDeclarationSQL Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyBaseDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyBaseDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getUniqueFieldDeclarationSQL Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    deprecated

    Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint 
    public function getUniqueFieldDeclarationSQL(): string

    of a column declaration to be used in statements like CREATE TABLE.

    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the UNIQUE constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueFieldDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    [m] getColumnCharsetDeclarationSQL Obtains DBMS specific SQL code portion needed to set the CHARACTER SET

    Obtains DBMS specific SQL code portion needed to set the CHARACTER SET 
    public function getColumnCharsetDeclarationSQL(string $charset): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$charset ​The name of the charset.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the CHARACTER SET
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnCharsetDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the CHARACTER SET

    [m] getColumnCollationDeclarationSQL Obtains DBMS specific SQL code portion needed to set the COLLATION

    Obtains DBMS specific SQL code portion needed to set the COLLATION 
    public function getColumnCollationDeclarationSQL(string $collation): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$collation ​The name of the collation.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the COLLATION
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnCollationDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the COLLATION

    [m] convertBooleans Some platforms need the boolean values to be converted.

    Some platforms need the boolean values to be converted. 
    public function convertBooleans(mixed $item): mixed

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

    Note: if the input is not a boolean the original input might be returned.

    There are two contexts when converting booleans: Literals and Prepared Statements. This method should handle the literal case

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertBooleans() ​Some platforms need the boolean values to be converted.

    [m] convertFromBoolean Some platforms have boolean literals that needs to be correctly converted

    Some platforms have boolean literals that needs to be correctly converted 
    public function convertFromBoolean(T $item): (T

    The default conversion tries to convert value into bool "(bool)$item"

    Parameter
    type name summary
    ​T ​$item ​
    Return
    type summary
    ​(T ​is null ? null : bool)
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertFromBoolean() ​Some platforms have boolean literals that needs to be correctly converted

    [m] convertBooleansToDatabaseValue This method should handle the prepared statements case. When there is no

    This method should handle the prepared statements case. When there is no 
    public function convertBooleansToDatabaseValue(mixed $item): mixed

    distinction, it's OK to use the same method.

    Note: if the input is not a boolean the original input might be returned.

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertBooleansToDatabaseValue() ​This method should handle the prepared statements case. When there is no

    [m] getCurrentDateSQL Returns the SQL specific for the platform to get the current date.

    Returns the SQL specific for the platform to get the current date. 
    public function getCurrentDateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentDateSQL() ​Returns the SQL specific for the platform to get the current date.

    [m] getCurrentTimeSQL Returns the SQL specific for the platform to get the current time.

    Returns the SQL specific for the platform to get the current time. 
    public function getCurrentTimeSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimeSQL() ​Returns the SQL specific for the platform to get the current time.

    [m] getCurrentTimestampSQL Returns the SQL specific for the platform to get the current timestamp

    Returns the SQL specific for the platform to get the current timestamp 
    public function getCurrentTimestampSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimestampSQL() ​Returns the SQL specific for the platform to get the current timestamp

    [m] getListDatabasesSQL 

    public function getListDatabasesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListDatabasesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​

    [m] getListNamespacesSQL Returns the SQL statement for retrieving the namespaces defined in the database.

    deprecated

    Returns the SQL statement for retrieving the namespaces defined in the database. 
    public function getListNamespacesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListNamespacesSQL() ​Returns the SQL statement for retrieving the namespaces defined in the database.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] getListSequencesSQL 

    public function getListSequencesSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListSequencesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​

    [m] getListUsersSQL

    deprecated 

    public function getListUsersSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListUsersSQL() ​

    [m] getCreateViewSQL 

    public function getCreateViewSQL(
    string $name,
    string $sql
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$sql ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateViewSQL() ​

    [m] getDropViewSQL 

    public function getDropViewSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropViewSQL() ​

    [m] getSequenceNextValSQL 

    public function getSequenceNextValSQL(string $sequence): string
    Parameter
    type name summary
    ​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSequenceNextValSQL() ​

    [m] getCreateDatabaseSQL Returns the SQL to create a new database.

    Returns the SQL to create a new database. 
    public function getCreateDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateDatabaseSQL() ​Returns the SQL to create a new database.

    [m] getDropDatabaseSQL Returns the SQL snippet to drop an existing database.

    Returns the SQL snippet to drop an existing database. 
    public function getDropDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be dropped.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropDatabaseSQL() ​Returns the SQL snippet to drop an existing database.

    [m] getDateTimeTzTypeDeclarationSQL Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    Obtains DBMS specific SQL to be used to create datetime with timezone offset columns. 
    public function getDateTimeTzTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeTzTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    [m] getFloatDeclarationSQL 

    public function getFloatDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getFloatDeclarationSQL() ​

    [m] getDefaultTransactionIsolationLevel Gets the default transaction isolation level of the platform.

    Gets the default transaction isolation level of the platform. 
    public function getDefaultTransactionIsolationLevel(): Doctrine\DBAL\TransactionIsolationLevel::*()
    Return
    type summary
    ​TransactionIsolationLevel::*() ​The default isolation level.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDefaultTransactionIsolationLevel() ​Gets the default transaction isolation level of the platform.
    See
    type summary
    ​TransactionIsolationLevel ​

    [m] supportsSequences Whether the platform supports sequences.

    Whether the platform supports sequences. 
    public function supportsSequences(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSequences() ​Whether the platform supports sequences.

    [m] usesSequenceEmulatedIdentityColumns Whether the platform emulates identity columns through sequences.

    deprecated

    Whether the platform emulates identity columns through sequences. 
    public function usesSequenceEmulatedIdentityColumns(): bool

    Some platforms that do not support identity columns natively but support sequences can emulate identity columns by using sequences.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::usesSequenceEmulatedIdentityColumns() ​Whether the platform emulates identity columns through sequences.

    [m] getIdentitySequenceName Returns the name of the sequence for a particular identity column in a particular table.

    deprecated

    Returns the name of the sequence for a particular identity column in a particular table. 
    public function getIdentitySequenceName(
    string $tableName,
    string $columnName
): string
    Parameter
    type name summary
    ​string ​$tableName ​The name of the table to return the sequence name for.
    ​string ​$columnName ​The name of the identity column in the table to return the sequence name for.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIdentitySequenceName() ​Returns the name of the sequence for a particular identity column in a particular table.
    See
    type summary
    ​usesSequenceEmulatedIdentityColumns ​

    [m] supportsIndexes Whether the platform supports indexes.

    deprecated

    Whether the platform supports indexes. 
    public function supportsIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsIndexes() ​Whether the platform supports indexes.

    [m] supportsPartialIndexes Whether the platform supports partial indexes.

    Whether the platform supports partial indexes. 
    public function supportsPartialIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPartialIndexes() ​Whether the platform supports partial indexes.

    [m] supportsColumnLengthIndexes Whether the platform supports indexes with column length definitions.

    Whether the platform supports indexes with column length definitions. 
    public function supportsColumnLengthIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsColumnLengthIndexes() ​Whether the platform supports indexes with column length definitions.

    [m] supportsAlterTable Whether the platform supports altering tables.

    deprecated

    Whether the platform supports altering tables. 
    public function supportsAlterTable(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsAlterTable() ​Whether the platform supports altering tables.

    [m] supportsTransactions Whether the platform supports transactions.

    deprecated

    Whether the platform supports transactions. 
    public function supportsTransactions(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsTransactions() ​Whether the platform supports transactions.

    [m] supportsSavepoints Whether the platform supports savepoints.

    Whether the platform supports savepoints. 
    public function supportsSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSavepoints() ​Whether the platform supports savepoints.

    [m] supportsReleaseSavepoints Whether the platform supports releasing savepoints.

    Whether the platform supports releasing savepoints. 
    public function supportsReleaseSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsReleaseSavepoints() ​Whether the platform supports releasing savepoints.

    [m] supportsPrimaryConstraints Whether the platform supports primary key constraints.

    deprecated

    Whether the platform supports primary key constraints. 
    public function supportsPrimaryConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPrimaryConstraints() ​Whether the platform supports primary key constraints.

    [m] supportsForeignKeyConstraints Whether the platform supports foreign key constraints.

    deprecated

    Whether the platform supports foreign key constraints. 
    public function supportsForeignKeyConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsForeignKeyConstraints() ​Whether the platform supports foreign key constraints.

    [m] supportsSchemas Whether the platform supports database schemas.

    Whether the platform supports database schemas. 
    public function supportsSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSchemas() ​Whether the platform supports database schemas.

    [m] getDefaultSchemaName Returns the default schema name.

    deprecated

    Returns the default schema name. 
    public function getDefaultSchemaName(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDefaultSchemaName() ​Returns the default schema name.

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

    deprecated

    Whether the platform supports getting the affected rows of a recent update/delete type query. 
    public function supportsGettingAffectedRows(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsGettingAffectedRows() ​Whether the platform supports getting the affected rows of a recent update/delete type query.

    [m] supportsCommentOnStatement Whether this platform support the proprietary syntax "COMMENT ON asset".

    Whether this platform support the proprietary syntax "COMMENT ON asset". 
    public function supportsCommentOnStatement(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsCommentOnStatement() ​Whether this platform support the proprietary syntax "COMMENT ON asset".

    [m] hasNativeGuidType Does this platform have native guid type.

    deprecated

    Does this platform have native guid type. 
    public function hasNativeGuidType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasNativeGuidType() ​Does this platform have native guid type.

    [m] hasNativeJsonType Does this platform have native JSON type.

    deprecated

    Does this platform have native JSON type. 
    public function hasNativeJsonType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasNativeJsonType() ​Does this platform have native JSON type.

    [m] supportsViews Whether this platform supports views.

    deprecated

    Whether this platform supports views. 
    public function supportsViews(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsViews() ​Whether this platform supports views.

    [m] getDateTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeFormatString(): string

    the format of a stored datetime value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateTimeTzFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeTzFormatString(): string

    the format of a stored datetime with timezone value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeTzFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateFormatString(): string

    the format of a stored date value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getTimeFormatString(): string

    the format of a stored time value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] modifyLimitQuery Adds an driver-specific LIMIT clause to the query.

    final

    Adds an driver-specific LIMIT clause to the query. 
    final public function modifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset = 0
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset = 0 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::modifyLimitQuery() ​Adds an driver-specific LIMIT clause to the query.

    [m] supportsLimitOffset Whether the database platform support offsets in modify limit clauses.

    deprecated

    Whether the database platform support offsets in modify limit clauses. 
    public function supportsLimitOffset(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsLimitOffset() ​Whether the database platform support offsets in modify limit clauses.

    [m] getMaxIdentifierLength Maximum length of any given database identifier, like tables or column names.

    Maximum length of any given database identifier, like tables or column names. 
    public function getMaxIdentifierLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxIdentifierLength() ​Maximum length of any given database identifier, like tables or column names.

    [m] getEmptyIdentityInsertSQL Returns the insert SQL for an empty insert statement.

    Returns the insert SQL for an empty insert statement. 
    public function getEmptyIdentityInsertSQL(
    string $quotedTableName,
    string $quotedIdentifierColumnName
): string
    Parameter
    type name summary
    ​string ​$quotedTableName ​
    ​string ​$quotedIdentifierColumnName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEmptyIdentityInsertSQL() ​Returns the insert SQL for an empty insert statement.

    [m] getDummySelectSQL This is for test reasons, many vendors have special requirements for dummy statements.

    This is for test reasons, many vendors have special requirements for dummy statements. 
    public function getDummySelectSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDummySelectSQL() ​This is for test reasons, many vendors have special requirements for dummy statements.

    [m] createSavePoint Returns the SQL to create a new savepoint.

    Returns the SQL to create a new savepoint. 
    public function createSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSavePoint() ​Returns the SQL to create a new savepoint.

    [m] releaseSavePoint Returns the SQL to release a savepoint.

    Returns the SQL to release a savepoint. 
    public function releaseSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::releaseSavePoint() ​Returns the SQL to release a savepoint.

    [m] rollbackSavePoint Returns the SQL to rollback a savepoint.

    Returns the SQL to rollback a savepoint. 
    public function rollbackSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::rollbackSavePoint() ​Returns the SQL to rollback a savepoint.

    [m] getReservedKeywordsList Returns the keyword list instance of this platform.

    final

    Returns the keyword list instance of this platform. 
    final public function getReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList
    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​If no keyword list is specified.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getReservedKeywordsList() ​Returns the keyword list instance of this platform.

    [m] createReservedKeywordsList Creates an instance of the reserved keyword list of this platform.

    Creates an instance of the reserved keyword list of this platform. 
    protected function createReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList

    This method will become @abstract in DBAL 4.0.0.

    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createReservedKeywordsList() ​Creates an instance of the reserved keyword list of this platform.

    [m] quoteStringLiteral Quotes a literal string.

    Quotes a literal string. 
    public function quoteStringLiteral(string $str): string

    This method is NOT meant to fix SQL injections! It is only meant to escape this platform's string literal quote character inside the given literal string.

    Parameter
    type name summary
    ​string ​$str ​The literal string to be quoted.
    Return
    type summary
    ​string ​The quoted literal string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteStringLiteral() ​Quotes a literal string.

    [m] getStringLiteralQuoteCharacter Gets the character used for string literal quoting.

    deprecated

    Gets the character used for string literal quoting. 
    public function getStringLiteralQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringLiteralQuoteCharacter() ​Gets the character used for string literal quoting.
    See
    type summary
    ​AbstractPlatform::quoteStringLiteral() ​

    [m] escapeStringForLike Escapes metacharacters in a string intended to be used with a LIKE

    final

    Escapes metacharacters in a string intended to be used with a LIKE 
    final public function escapeStringForLike(
    string $inputString,
    string $escapeChar
): string

    operator.

    Parameter
    type name summary
    ​string ​$inputString ​a literal, unquoted string
    ​string ​$escapeChar ​should be reused by the caller in the LIKE
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::escapeStringForLike() ​Escapes metacharacters in a string intended to be used with a LIKE

    [m] createSQLParser 

    public function createSQLParser(): Doctrine\DBAL\SQL\Parser
    Return
    type summary
    ​Parser ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSQLParser() ​

    [m] getLikeWildcardCharacters 

    protected function getLikeWildcardCharacters(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] columnsEqual Compares the definitions of the given columns in the context of this platform.

    Compares the definitions of the given columns in the context of this platform. 
    public function columnsEqual(
    Doctrine\DBAL\Schema\Column $column1,
    Doctrine\DBAL\Schema\Column $column2
): bool
    Parameter
    type name summary
    ​Column ​$column1 ​
    ​Column ​$column2 ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::columnsEqual() ​Compares the definitions of the given columns in the context of this platform.

    [C] SQLServerPlatform Provides the behavior, features and SQL dialect of the Microsoft SQL Server database platform

    Provides the behavior, features and SQL dialect of the Microsoft SQL Server database platform of the oldest supported version.

    Hierarchy

    Parents
    type summary
    ​AbstractPlatform ​Base class for all DatabasePlatforms. The DatabasePlatforms are the central

    [C] CREATE_INDEXES 

    public const int CREATE_INDEXES = 1
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_INDEXES ​

    [C] CREATE_FOREIGNKEYS 

    public const int CREATE_FOREIGNKEYS = 2
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_FOREIGNKEYS ​

    [p] $doctrineTypeMapping 

    protected string[]|null $doctrineTypeMapping = null

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeMapping ​

    [p] $doctrineTypeComments Contains a list of all columns that should generate parseable column comments for type-detection

    deprecated

    Contains a list of all columns that should generate parseable column comments for type-detection 
    protected string[]|null $doctrineTypeComments = null

    in reverse engineering scenarios.

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeComments ​Contains a list of all columns that should generate parseable column comments for type-detection

    [p] $_eventManager

    deprecated 

    protected Doctrine\Common\EventManager|null $_eventManager = null

    Type: EventManager|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_eventManager ​

    [p] $_keywords Holds the KeywordList instance for the current platform.

    Holds the KeywordList instance for the current platform. 
    protected Doctrine\DBAL\Platforms\Keywords\KeywordList|null $_keywords = null

    Type: KeywordList|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_keywords ​Holds the KeywordList instance for the current platform.

    [m] createSelectSQLBuilder 

    public function createSelectSQLBuilder(): Doctrine\DBAL\SQL\Builder\SelectSQLBuilder
    Return
    type summary
    ​SelectSQLBuilder ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::createSelectSQLBuilder() ​

    [m] getCurrentDateSQL Returns the SQL specific for the platform to get the current date.

    Returns the SQL specific for the platform to get the current date. 
    public function getCurrentDateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCurrentDateSQL() ​Returns the SQL specific for the platform to get the current date.

    [m] getCurrentTimeSQL Returns the SQL specific for the platform to get the current time.

    Returns the SQL specific for the platform to get the current time. 
    public function getCurrentTimeSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCurrentTimeSQL() ​Returns the SQL specific for the platform to get the current time.

    [m] getDateArithmeticIntervalExpression Returns the SQL for a date arithmetic expression.

    Returns the SQL for a date arithmetic expression. 
    protected function getDateArithmeticIntervalExpression(
    string $date,
    string $operator,
    int|string $interval,
    string $unit
): string
    Parameter
    type name summary
    ​string ​$date ​The column or literal representing a date
    ​string ​$operator ​The arithmetic operator (+ or -).
    ​int|​string ​$interval ​The interval that shall be calculated into the date.
    ​string ​$unit ​The unit of the interval that shall be calculated into the date.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateArithmeticIntervalExpression() ​Returns the SQL for a date arithmetic expression.

    [m] getDateDiffExpression <tag_inheritdoc data-type='' data-description=''>Returns the SQL to calculate the difference in days between the two passed dates.

    Returns the SQL to calculate the difference in days between the two passed dates. 
    public function getDateDiffExpression(
    string $date1,
    string $date2
): string

    Computes diff = date1 - date2.

    Parameter
    type name summary
    ​string ​$date1 ​
    ​string ​$date2 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateDiffExpression() ​Returns the SQL to calculate the difference in days between the two passed dates.

    [m] prefersIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    deprecated

    Whether the platform prefers identity columns (eg. autoincrement) for ID generation. 
    public function prefersIdentityColumns(): bool

    Subclasses should override this method to return TRUE if they prefer identity columns.

    Microsoft SQL Server prefers "autoincrement" identity columns since sequences can only be emulated with a table.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::prefersIdentityColumns() ​Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    [m] supportsIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform supports identity columns.

    Whether the platform supports identity columns. 
    public function supportsIdentityColumns(): bool

    Identity columns are columns that receive an auto-generated value from the database on insert of a row.

    Microsoft SQL Server supports this through AUTO_INCREMENT columns.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsIdentityColumns() ​Whether the platform supports identity columns.

    [m] supportsReleaseSavepoints Whether the platform supports releasing savepoints.

    Whether the platform supports releasing savepoints. 
    public function supportsReleaseSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsReleaseSavepoints() ​Whether the platform supports releasing savepoints.

    [m] supportsSchemas Whether the platform supports database schemas.

    Whether the platform supports database schemas. 
    public function supportsSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsSchemas() ​Whether the platform supports database schemas.

    [m] getDefaultSchemaName Returns the default schema name.

    deprecated

    Returns the default schema name. 
    public function getDefaultSchemaName(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDefaultSchemaName() ​Returns the default schema name.

    [m] supportsColumnCollation Does this platform support column collation?

    Does this platform support column collation? 
    public function supportsColumnCollation(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsColumnCollation() ​Does this platform support column collation?
    See
    type summary
    ​AbstractPlatform ​

    [m] supportsSequences Whether the platform supports sequences.

    Whether the platform supports sequences. 
    public function supportsSequences(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::supportsSequences() ​Whether the platform supports sequences.

    [m] getAlterSequenceSQL Returns the SQL to change a sequence on this platform.

    Returns the SQL to change a sequence on this platform. 
    public function getAlterSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getAlterSequenceSQL() ​Returns the SQL to change a sequence on this platform.

    [m] getCreateSequenceSQL Returns the SQL to create a sequence on this platform.

    Returns the SQL to create a sequence on this platform. 
    public function getCreateSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateSequenceSQL() ​Returns the SQL to create a sequence on this platform.

    [m] getListSequencesSQL 

    public function getListSequencesSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListSequencesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getSequenceNextValSQL 

    public function getSequenceNextValSQL(string $sequence): string
    Parameter
    type name summary
    ​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSequenceNextValSQL() ​

    [m] hasNativeGuidType Does this platform have native guid type.

    deprecated

    Does this platform have native guid type. 
    public function hasNativeGuidType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::hasNativeGuidType() ​Does this platform have native guid type.

    [m] getDropForeignKeySQL Returns the SQL to drop a foreign key.

    Returns the SQL to drop a foreign key. 
    public function getDropForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDropForeignKeySQL() ​Returns the SQL to drop a foreign key.

    [m] getDropIndexSQL Returns the SQL to drop an index from a table.

    Returns the SQL to drop an index from a table. 
    public function getDropIndexSQL(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string|null $table = null
): string
    Parameter
    type name summary
    ​Index|​string ​$index ​
    ​Table|​string|​null ​$table = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDropIndexSQL() ​Returns the SQL to drop an index from a table.

    [m] _getCreateTableSQL Returns the SQL used to create a table.

    Returns the SQL used to create a table. 
    protected function _getCreateTableSQL(
    string $name,
    array|mixed[][] $columns,
    array|mixed[] $options = []
): string[]
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​mixed[][] ​$columns ​
    ​array|​mixed[] ​$options = [] ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::_getCreateTableSQL() ​Returns the SQL used to create a table.

    [m] getCreatePrimaryKeySQL Returns the SQL to create an unnamed primary key constraint.

    Returns the SQL to create an unnamed primary key constraint. 
    public function getCreatePrimaryKeySQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreatePrimaryKeySQL() ​Returns the SQL to create an unnamed primary key constraint.

    [m] getCreateColumnCommentSQL Returns the SQL statement for creating a column comment.

    Returns the SQL statement for creating a column comment. 
    protected function getCreateColumnCommentSQL(
    string $tableName,
    string $columnName,
    string|null $comment
): string

    SQL Server does not support native column comments, therefore the extended properties functionality is used as a workaround to store them. The property name used to store column comments is "MS_Description" which provides compatibility with SQL Server Management Studio, as column comments are stored in the same property there when specifying a column's "Description" attribute.

    Parameter
    type name summary
    ​string ​$tableName ​The quoted table name to which the column belongs.
    ​string ​$columnName ​The quoted column name to create the comment for.
    ​string|​null ​$comment ​The column's comment.
    Return
    type summary
    ​string ​

    [m] getDefaultConstraintDeclarationSQL Returns the SQL snippet for declaring a default constraint.

    Returns the SQL snippet for declaring a default constraint. 
    public function getDefaultConstraintDeclarationSQL(
    string $table,
    array|mixed[] $column
): string
    Parameter
    type name summary
    ​string ​$table ​Name of the table to return the default constraint declaration for.
    ​array|​mixed[] ​$column ​Column definition.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​

    [m] getCreateIndexSQL Returns the SQL to create an index on a table on this platform.

    Returns the SQL to create an index on a table on this platform. 
    public function getCreateIndexSQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateIndexSQL() ​Returns the SQL to create an index on a table on this platform.

    [m] getCreateIndexSQLFlags Adds additional flags for index generation.

    Adds additional flags for index generation. 
    protected function getCreateIndexSQLFlags(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateIndexSQLFlags() ​Adds additional flags for index generation.

    [m] getAlterTableSQL <tag_inheritdoc data-type='' data-description=''>Gets the SQL statements for altering an existing table.

    Gets the SQL statements for altering an existing table. 
    public function getAlterTableSQL(Doctrine\DBAL\Schema\TableDiff $diff): list

    This method returns an array of SQL statements, since some platforms need several statements.

    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getAlterTableSQL() ​Gets the SQL statements for altering an existing table.

    [m] getRenameTableSQL 

    public function getRenameTableSQL(
    string $oldName,
    string $newName
): array
    Parameter
    type name summary
    ​string ​$oldName ​
    ​string ​$newName ​
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getRenameTableSQL() ​

    [m] getAlterColumnCommentSQL Returns the SQL statement for altering a column comment.

    Returns the SQL statement for altering a column comment. 
    protected function getAlterColumnCommentSQL(
    string $tableName,
    string $columnName,
    string|null $comment
): string

    SQL Server does not support native column comments, therefore the extended properties functionality is used as a workaround to store them. The property name used to store column comments is "MS_Description" which provides compatibility with SQL Server Management Studio, as column comments are stored in the same property there when specifying a column's "Description" attribute.

    Parameter
    type name summary
    ​string ​$tableName ​The quoted table name to which the column belongs.
    ​string ​$columnName ​The quoted column name to alter the comment for.
    ​string|​null ​$comment ​The column's comment.
    Return
    type summary
    ​string ​

    [m] getDropColumnCommentSQL Returns the SQL statement for dropping a column comment.

    Returns the SQL statement for dropping a column comment. 
    protected function getDropColumnCommentSQL(
    string $tableName,
    string $columnName
): string

    SQL Server does not support native column comments, therefore the extended properties functionality is used as a workaround to store them. The property name used to store column comments is "MS_Description" which provides compatibility with SQL Server Management Studio, as column comments are stored in the same property there when specifying a column's "Description" attribute.

    Parameter
    type name summary
    ​string ​$tableName ​The quoted table name to which the column belongs.
    ​string ​$columnName ​The quoted column name to drop the comment for.
    Return
    type summary
    ​string ​

    [m] getRenameIndexSQL Returns the SQL for renaming an index on a table.

    Returns the SQL for renaming an index on a table. 
    protected function getRenameIndexSQL(
    string $oldIndexName,
    Doctrine\DBAL\Schema\Index $index,
    string $tableName
): string[]
    Parameter
    type name summary
    ​string ​$oldIndexName ​The name of the index to rename from.
    ​Index ​$index ​The definition of the index to rename to.
    ​string ​$tableName ​The table to rename the given index on.
    Return
    type summary
    ​string[] ​The sequence of SQL statements for renaming the given index.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getRenameIndexSQL() ​Returns the SQL for renaming an index on a table.

    [m] getAddExtendedPropertySQL Returns the SQL statement for adding an extended property to a database object.

    Returns the SQL statement for adding an extended property to a database object. 
    public function getAddExtendedPropertySQL(
    string $name,
    string|null $value = null,
    string|null $level0Type = null,
    string|null $level0Name = null,
    string|null $level1Type = null,
    string|null $level1Name = null,
    string|null $level2Type = null,
    string|null $level2Name = null
): string
    Parameter
    type name summary
    ​string ​$name ​The name of the property to add.
    ​string|​null ​$value = null ​The value of the property to add.
    ​string|​null ​$level0Type = null ​The type of the object at level 0 the property belongs to.
    ​string|​null ​$level0Name = null ​The name of the object at level 0 the property belongs to.
    ​string|​null ​$level1Type = null ​The type of the object at level 1 the property belongs to.
    ​string|​null ​$level1Name = null ​The name of the object at level 1 the property belongs to.
    ​string|​null ​$level2Type = null ​The type of the object at level 2 the property belongs to.
    ​string|​null ​$level2Name = null ​The name of the object at level 2 the property belongs to.
    Return
    type summary
    ​string ​

    [m] getDropExtendedPropertySQL Returns the SQL statement for dropping an extended property from a database object.

    Returns the SQL statement for dropping an extended property from a database object. 
    public function getDropExtendedPropertySQL(
    string $name,
    string|null $level0Type = null,
    string|null $level0Name = null,
    string|null $level1Type = null,
    string|null $level1Name = null,
    string|null $level2Type = null,
    string|null $level2Name = null
): string
    Parameter
    type name summary
    ​string ​$name ​The name of the property to drop.
    ​string|​null ​$level0Type = null ​The type of the object at level 0 the property belongs to.
    ​string|​null ​$level0Name = null ​The name of the object at level 0 the property belongs to.
    ​string|​null ​$level1Type = null ​The type of the object at level 1 the property belongs to.
    ​string|​null ​$level1Name = null ​The name of the object at level 1 the property belongs to.
    ​string|​null ​$level2Type = null ​The type of the object at level 2 the property belongs to.
    ​string|​null ​$level2Name = null ​The name of the object at level 2 the property belongs to.
    Return
    type summary
    ​string ​

    [m] getUpdateExtendedPropertySQL Returns the SQL statement for updating an extended property of a database object.

    Returns the SQL statement for updating an extended property of a database object. 
    public function getUpdateExtendedPropertySQL(
    string $name,
    string|null $value = null,
    string|null $level0Type = null,
    string|null $level0Name = null,
    string|null $level1Type = null,
    string|null $level1Name = null,
    string|null $level2Type = null,
    string|null $level2Name = null
): string
    Parameter
    type name summary
    ​string ​$name ​The name of the property to update.
    ​string|​null ​$value = null ​The value of the property to update.
    ​string|​null ​$level0Type = null ​The type of the object at level 0 the property belongs to.
    ​string|​null ​$level0Name = null ​The name of the object at level 0 the property belongs to.
    ​string|​null ​$level1Type = null ​The type of the object at level 1 the property belongs to.
    ​string|​null ​$level1Name = null ​The name of the object at level 1 the property belongs to.
    ​string|​null ​$level2Type = null ​The type of the object at level 2 the property belongs to.
    ​string|​null ​$level2Name = null ​The name of the object at level 2 the property belongs to.
    Return
    type summary
    ​string ​

    [m] getEmptyIdentityInsertSQL Returns the insert SQL for an empty insert statement.

    Returns the insert SQL for an empty insert statement. 
    public function getEmptyIdentityInsertSQL(
    string $quotedTableName,
    string $quotedIdentifierColumnName
): string
    Parameter
    type name summary
    ​string ​$quotedTableName ​
    ​string ​$quotedIdentifierColumnName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getEmptyIdentityInsertSQL() ​Returns the insert SQL for an empty insert statement.

    [m] getListTablesSQL

    deprecated 

    public function getListTablesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTablesSQL() ​

    [m] getListTableColumnsSQL

    deprecated 

    public function getListTableColumnsSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableColumnsSQL() ​

    [m] getListTableForeignKeysSQL

    deprecated 

    public function getListTableForeignKeysSQL(
    string $table,
    string|null $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableForeignKeysSQL() ​

    [m] getListTableIndexesSQL

    deprecated 

    public function getListTableIndexesSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListTableIndexesSQL() ​

    [m] getListViewsSQL Returns the SQL to list all views of a database or user.

    Returns the SQL to list all views of a database or user. 
    public function getListViewsSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListViewsSQL() ​Returns the SQL to list all views of a database or user.
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getLocateExpression Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str. 
    public function getLocateExpression(
    string $str,
    string $substr,
    string|int|false $startPos = false
): string
    Parameter
    type name summary
    ​string ​$str ​Literal string.
    ​string ​$substr ​Literal string to find.
    ​string|​int|​false ​$startPos = false ​Position to start at, beginning of string by default.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getLocateExpression() ​Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    [m] getModExpression Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2. 
    public function getModExpression(
    string $expression1,
    string $expression2
): string
    Parameter
    type name summary
    ​string ​$expression1 ​
    ​string ​$expression2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getModExpression() ​Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    [m] getTrimExpression Returns the SQL snippet to trim a string.

    Returns the SQL snippet to trim a string. 
    public function getTrimExpression(
    string $str,
    int $mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED,
    string|bool $char = false
): string
    Parameter
    type name summary
    ​string ​$str ​The expression to apply the trim to.
    ​int ​$mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED ​The position of the trim (leading/trailing/both).
    ​string|​bool ​$char = false ​The char to trim, has to be quoted already. Defaults to space.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTrimExpression() ​Returns the SQL snippet to trim a string.

    [m] getConcatExpression <tag_inheritdoc data-type='' data-description=''>Returns a SQL snippet to concatenate the given expressions.

    Returns a SQL snippet to concatenate the given expressions. 
    public function getConcatExpression(): string

    Accepts an arbitrary number of string parameters. Each parameter must contain an expression.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getConcatExpression() ​Returns a SQL snippet to concatenate the given expressions.

    [m] getListDatabasesSQL 

    public function getListDatabasesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListDatabasesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getListNamespacesSQL Returns the SQL statement for retrieving the namespaces defined in the database.

    deprecated

    Returns the SQL statement for retrieving the namespaces defined in the database. 
    public function getListNamespacesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getListNamespacesSQL() ​Returns the SQL statement for retrieving the namespaces defined in the database.
    See
    type summary
    ​SQLServerSchemaManager::listSchemaNames() ​
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] getSubstringExpression <tag_inheritdoc data-type='' data-description=''>Returns a SQL snippet to get a substring inside an SQL statement.

    Returns a SQL snippet to get a substring inside an SQL statement. 
    public function getSubstringExpression(
    string $string,
    string|int $start,
    string|int|null $length = null
): string

    Note: Not SQL92, but common functionality.

    SQLite only supports the 2 parameter variant of this function.

    Parameter
    type name summary
    ​string ​$string ​An sql string literal or column name/alias.
    ​string|​int ​$start ​Where to start the substring portion.
    ​string|​int|​null ​$length = null ​The substring portion length.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSubstringExpression() ​Returns a SQL snippet to get a substring inside an SQL statement.

    [m] getLengthExpression Returns the SQL snippet to get the length of a text column in characters.

    Returns the SQL snippet to get the length of a text column in characters. 
    public function getLengthExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getLengthExpression() ​Returns the SQL snippet to get the length of a text column in characters.

    [m] getCurrentDatabaseExpression Returns the SQL expression which represents the currently selected database.

    Returns the SQL expression which represents the currently selected database. 
    public function getCurrentDatabaseExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCurrentDatabaseExpression() ​Returns the SQL expression which represents the currently selected database.

    [m] getSetTransactionIsolationSQL Returns the SQL to set the transaction isolation level.

    Returns the SQL to set the transaction isolation level. 
    public function getSetTransactionIsolationSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSetTransactionIsolationSQL() ​Returns the SQL to set the transaction isolation level.

    [m] getIntegerTypeDeclarationSQL Returns the SQL snippet that declares a 4 byte integer column.

    Returns the SQL snippet that declares a 4 byte integer column. 
    public function getIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares a 4 byte integer column.

    [m] getBigIntTypeDeclarationSQL Returns the SQL snippet that declares an 8 byte integer column.

    Returns the SQL snippet that declares an 8 byte integer column. 
    public function getBigIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBigIntTypeDeclarationSQL() ​Returns the SQL snippet that declares an 8 byte integer column.

    [m] getSmallIntTypeDeclarationSQL Returns the SQL snippet that declares a 2 byte integer column.

    Returns the SQL snippet that declares a 2 byte integer column. 
    public function getSmallIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getSmallIntTypeDeclarationSQL() ​Returns the SQL snippet that declares a 2 byte integer column.

    [m] getGuidTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to declare a GUID/UUID column.

    Returns the SQL snippet to declare a GUID/UUID column. 
    public function getGuidTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CHAR(36) and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getGuidTypeDeclarationSQL() ​Returns the SQL snippet to declare a GUID/UUID column.

    [m] getDateTimeTzTypeDeclarationSQL Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    Obtains DBMS specific SQL to be used to create datetime with timezone offset columns. 
    public function getDateTimeTzTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTimeTzTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    [m] getAsciiStringTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet used to declare a column that can

    Returns the SQL snippet used to declare a column that can 
    public function getAsciiStringTypeDeclarationSQL(array|mixed[] $column): string

    store characters in the ASCII character set

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getAsciiStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a column that can

    [m] getVarcharTypeDeclarationSQLSnippet 

    protected function getVarcharTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​
    ​bool ​$fixed ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getVarcharTypeDeclarationSQLSnippet() ​

    [m] getBinaryTypeDeclarationSQLSnippet Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    protected function getBinaryTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​The length of the column.
    ​bool ​$fixed ​Whether the column length is fixed.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBinaryTypeDeclarationSQLSnippet() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getBinaryMaxLength Gets the maximum length of a binary column.

    deprecated

    Gets the maximum length of a binary column. 
    public function getBinaryMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBinaryMaxLength() ​Gets the maximum length of a binary column.

    [m] getClobTypeDeclarationSQL Returns the SQL snippet used to declare a CLOB column type.

    Returns the SQL snippet used to declare a CLOB column type. 
    public function getClobTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getClobTypeDeclarationSQL() ​Returns the SQL snippet used to declare a CLOB column type.

    [m] _getCommonIntegerTypeDeclarationSQL Returns the SQL snippet that declares common properties of an integer column.

    Returns the SQL snippet that declares common properties of an integer column. 
    protected function _getCommonIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::_getCommonIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares common properties of an integer column.

    [m] getDateTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create datetime columns in

    Obtains DBMS specific SQL to be used to create datetime columns in 
    public function getDateTimeTypeDeclarationSQL(array|mixed[] $column): string

    statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTimeTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create datetime columns in

    [m] getDateTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create date columns in statements

    Obtains DBMS specific SQL to be used to create date columns in statements 
    public function getDateTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create date columns in statements

    [m] getTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create time columns in statements

    Obtains DBMS specific SQL to be used to create time columns in statements 
    public function getTimeTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTimeTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create time columns in statements

    [m] getBooleanTypeDeclarationSQL Returns the SQL snippet that declares a boolean column.

    Returns the SQL snippet that declares a boolean column. 
    public function getBooleanTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBooleanTypeDeclarationSQL() ​Returns the SQL snippet that declares a boolean column.

    [m] doModifyLimitQuery Adds an platform-specific LIMIT clause to the query.

    Adds an platform-specific LIMIT clause to the query. 
    protected function doModifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::doModifyLimitQuery() ​Adds an platform-specific LIMIT clause to the query.

    [m] convertBooleans <tag_inheritdoc data-type='' data-description=''>Some platforms need the boolean values to be converted.

    Some platforms need the boolean values to be converted. 
    public function convertBooleans(mixed $item): mixed

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

    Note: if the input is not a boolean the original input might be returned.

    There are two contexts when converting booleans: Literals and Prepared Statements. This method should handle the literal case

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::convertBooleans() ​Some platforms need the boolean values to be converted.

    [m] getCreateTemporaryTableSnippetSQL 

    public function getCreateTemporaryTableSnippetSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCreateTemporaryTableSnippetSQL() ​

    [m] getTemporaryTableName Some vendors require temporary table names to be qualified specially.

    Some vendors require temporary table names to be qualified specially. 
    public function getTemporaryTableName(string $tableName): string
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTemporaryTableName() ​Some vendors require temporary table names to be qualified specially.

    [m] getDateTimeFormatString <tag_inheritdoc data-type='' data-description=''>Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeFormatString(): string

    the format of a stored datetime value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateFormatString <tag_inheritdoc data-type='' data-description=''>Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateFormatString(): string

    the format of a stored date value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getTimeFormatString <tag_inheritdoc data-type='' data-description=''>Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getTimeFormatString(): string

    the format of a stored time value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateTimeTzFormatString <tag_inheritdoc data-type='' data-description=''>Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeTzFormatString(): string

    the format of a stored datetime with timezone value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDateTimeTzFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getName Gets the name of the platform.

    deprecated

    Gets the name of the platform. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getName() ​Gets the name of the platform.

    [m] initializeDoctrineTypeMappings Lazy load Doctrine Type Mappings.

    Lazy load Doctrine Type Mappings. 
    protected function initializeDoctrineTypeMappings(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::initializeDoctrineTypeMappings() ​Lazy load Doctrine Type Mappings.

    [m] createSavePoint Returns the SQL to create a new savepoint.

    Returns the SQL to create a new savepoint. 
    public function createSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::createSavePoint() ​Returns the SQL to create a new savepoint.

    [m] releaseSavePoint Returns the SQL to release a savepoint.

    Returns the SQL to release a savepoint. 
    public function releaseSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::releaseSavePoint() ​Returns the SQL to release a savepoint.

    [m] rollbackSavePoint Returns the SQL to rollback a savepoint.

    Returns the SQL to rollback a savepoint. 
    public function rollbackSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::rollbackSavePoint() ​Returns the SQL to rollback a savepoint.

    [m] getForeignKeyReferentialActionSQL Returns the given referential action in uppercase if valid, otherwise throws an exception.

    Returns the given referential action in uppercase if valid, otherwise throws an exception. 
    public function getForeignKeyReferentialActionSQL(string $action): string
    Parameter
    type name summary
    ​string ​$action ​The foreign key referential action.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​If unknown referential action given.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getForeignKeyReferentialActionSQL() ​Returns the given referential action in uppercase if valid, otherwise throws an exception.
    See
    type summary
    ​AbstractPlatform ​

    [m] appendLockHint Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    Honors that some SQL vendors such as MsSql use table hints for locking instead of the 
    public function appendLockHint(
    string $fromClause,
    int $lockMode
): string

    ANSI SQL FOR UPDATE specification.

    Parameter
    type name summary
    ​string ​$fromClause ​The FROM clause to append the hint for the given lock mode to
    ​int ​$lockMode ​One of the Doctrine\DBAL\LockMode::* constants
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::appendLockHint() ​Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    [m] getForUpdateSQL Returns the FOR UPDATE expression.

    deprecated

    Returns the FOR UPDATE expression. 
    public function getForUpdateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getForUpdateSQL() ​Returns the FOR UPDATE expression.

    [m] getReservedKeywordsClass Returns the class name of the reserved keywords list.

    deprecated

    Returns the class name of the reserved keywords list. 
    protected function getReservedKeywordsClass(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getReservedKeywordsClass() ​Returns the class name of the reserved keywords list.
    See
    type summary
    ​SQLServerPlatform::createReservedKeywordsList() ​
    ​AbstractPlatform::createReservedKeywordsList() ​

    [m] quoteSingleIdentifier Quotes a single identifier (no dot chain separation).

    Quotes a single identifier (no dot chain separation). 
    public function quoteSingleIdentifier(string $str): string
    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::quoteSingleIdentifier() ​Quotes a single identifier (no dot chain separation).

    [m] getTruncateTableSQL <tag_inheritdoc data-type='' data-description=''>Generates a Truncate Table SQL statement for a given table.

    Generates a Truncate Table SQL statement for a given table. 
    public function getTruncateTableSQL(
    string $tableName,
    bool $cascade = false
): string

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

    Parameter
    type name summary
    ​string ​$tableName ​
    ​bool ​$cascade = false ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getTruncateTableSQL() ​Generates a Truncate Table SQL statement for a given table.

    [m] getBlobTypeDeclarationSQL Returns the SQL Snippet used to declare a BLOB column type.

    Returns the SQL Snippet used to declare a BLOB column type. 
    public function getBlobTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getBlobTypeDeclarationSQL() ​Returns the SQL Snippet used to declare a BLOB column type.

    [m] getColumnDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to declare a generic type

    Obtains DBMS specific SQL code portion needed to declare a generic type 
    public function getColumnDeclarationSQL(
    string $name,
    array|mixed[] $column
): string

    column to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name the column to be declared.
    ​array|​mixed[] ​$column ​An associative array with the name of the properties
    Return
    type summary
    ​string ​DBMS specific SQL code portion that should be used to declare the column.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getColumnDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to declare a generic type
    See
    type summary
    ​AbstractPlatform ​

    [m] getColumnCollationDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set the COLLATION

    Obtains DBMS specific SQL code portion needed to set the COLLATION 
    public function getColumnCollationDeclarationSQL(string $collation): string

    of a column declaration to be used in statements like CREATE TABLE.

    SQL Server does not support quoting collation identifiers.

    Parameter
    type name summary
    ​string ​$collation ​The name of the collation.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the COLLATION
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getColumnCollationDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the COLLATION

    [m] columnsEqual Compares the definitions of the given columns in the context of this platform.

    Compares the definitions of the given columns in the context of this platform. 
    public function columnsEqual(
    Doctrine\DBAL\Schema\Column $column1,
    Doctrine\DBAL\Schema\Column $column2
): bool
    Parameter
    type name summary
    ​Column ​$column1 ​
    ​Column ​$column2 ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::columnsEqual() ​Compares the definitions of the given columns in the context of this platform.

    [m] getLikeWildcardCharacters 

    protected function getLikeWildcardCharacters(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] getCommentOnTableSQL 

    protected function getCommentOnTableSQL(
    string $tableName,
    ?string $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​?string ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getCommentOnTableSQL() ​

    [m] getListTableMetadataSQL

    deprecated 

    public function getListTableMetadataSQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​

    [m] createSchemaManager Creates the schema manager that can be used to inspect and change the underlying

    Creates the schema manager that can be used to inspect and change the underlying 
    public function createSchemaManager(Doctrine\DBAL\Connection $connection): Doctrine\DBAL\Schema\SQLServerSchemaManager

    database schema according to the dialect of the platform.

    Parameter
    type name summary
    ​Connection ​$connection ​
    Return
    type summary
    ​SQLServerSchemaManager ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::createSchemaManager() ​Creates the schema manager that can be used to inspect and change the underlying

    [m] setDisableTypeComments

    final

    final public function setDisableTypeComments(bool $value)
    Parameter
    type name summary
    ​bool ​$value ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setDisableTypeComments() ​

    [m] setEventManager Sets the EventManager used by the Platform.

    deprecated

    Sets the EventManager used by the Platform. 
    public function setEventManager(Doctrine\Common\EventManager $eventManager): void
    Parameter
    type name summary
    ​EventManager ​$eventManager ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setEventManager() ​Sets the EventManager used by the Platform.

    [m] getEventManager Gets the EventManager used by the Platform.

    deprecated

    Gets the EventManager used by the Platform. 
    public function getEventManager(): Doctrine\Common\EventManager|null
    Return
    type summary
    ​EventManager|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEventManager() ​Gets the EventManager used by the Platform.

    [m] getVarcharTypeDeclarationSQL Returns the SQL snippet used to declare a VARCHAR column type.

    deprecated

    Returns the SQL snippet used to declare a VARCHAR column type. 
    public function getVarcharTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharTypeDeclarationSQL() ​Returns the SQL snippet used to declare a VARCHAR column type.

    [m] getStringTypeDeclarationSQL Returns the SQL snippet used to declare a string column type.

    Returns the SQL snippet used to declare a string column type. 
    public function getStringTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a string column type.

    [m] getBinaryTypeDeclarationSQL Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    public function getBinaryTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryTypeDeclarationSQL() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getJsonTypeDeclarationSQL Returns the SQL snippet to declare a JSON column.

    Returns the SQL snippet to declare a JSON column. 
    public function getJsonTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CLOB and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getJsonTypeDeclarationSQL() ​Returns the SQL snippet to declare a JSON column.

    [m] registerDoctrineTypeMapping Registers a doctrine type to be used in conjunction with a column type of this platform.

    Registers a doctrine type to be used in conjunction with a column type of this platform. 
    public function registerDoctrineTypeMapping(
    string $dbType,
    string $doctrineType
): void
    Parameter
    type name summary
    ​string ​$dbType ​
    ​string ​$doctrineType ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​If the type is not found.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::registerDoctrineTypeMapping() ​Registers a doctrine type to be used in conjunction with a column type of this platform.

    [m] getDoctrineTypeMapping Gets the Doctrine type that is mapped for the given database column type.

    Gets the Doctrine type that is mapped for the given database column type. 
    public function getDoctrineTypeMapping(string $dbType): string
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeMapping() ​Gets the Doctrine type that is mapped for the given database column type.

    [m] hasDoctrineTypeMappingFor Checks if a database type is currently supported by this platform.

    Checks if a database type is currently supported by this platform. 
    public function hasDoctrineTypeMappingFor(string $dbType): bool
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasDoctrineTypeMappingFor() ​Checks if a database type is currently supported by this platform.

    [m] initializeCommentedDoctrineTypes Initializes the Doctrine Type comments instance variable for in_array() checks.

    deprecated

    Initializes the Doctrine Type comments instance variable for in_array() checks. 
    protected function initializeCommentedDoctrineTypes(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::initializeCommentedDoctrineTypes() ​Initializes the Doctrine Type comments instance variable for in_array() checks.

    [m] isCommentedDoctrineType Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    deprecated

    Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type? 
    public function isCommentedDoctrineType(Doctrine\DBAL\Types\Type $doctrineType): bool
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::isCommentedDoctrineType() ​Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    [m] markDoctrineTypeCommented Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements. 
    public function markDoctrineTypeCommented(string|Doctrine\DBAL\Types\Type $doctrineType): void
    Parameter
    type name summary
    ​string|​Type ​$doctrineType ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::markDoctrineTypeCommented() ​Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    [m] getDoctrineTypeComment Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    deprecated

    Gets the comment to append to a column comment that helps parsing this type in reverse engineering. 
    public function getDoctrineTypeComment(Doctrine\DBAL\Types\Type $doctrineType): string
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeComment() ​Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    [m] getColumnComment Gets the comment of a passed column modified by potential doctrine type comment hints.

    deprecated

    Gets the comment of a passed column modified by potential doctrine type comment hints. 
    protected function getColumnComment(Doctrine\DBAL\Schema\Column $column): string|null
    Parameter
    type name summary
    ​Column ​$column ​
    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnComment() ​Gets the comment of a passed column modified by potential doctrine type comment hints.

    [m] getIdentifierQuoteCharacter Gets the character used for identifier quoting.

    deprecated

    Gets the character used for identifier quoting. 
    public function getIdentifierQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIdentifierQuoteCharacter() ​Gets the character used for identifier quoting.
    See
    type summary
    ​AbstractPlatform::quoteIdentifier() ​

    [m] getSqlCommentStartString Gets the string portion that starts an SQL comment.

    deprecated

    Gets the string portion that starts an SQL comment. 
    public function getSqlCommentStartString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentStartString() ​Gets the string portion that starts an SQL comment.

    [m] getSqlCommentEndString Gets the string portion that ends an SQL comment.

    deprecated

    Gets the string portion that ends an SQL comment. 
    public function getSqlCommentEndString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentEndString() ​Gets the string portion that ends an SQL comment.

    [m] getCharMaxLength Gets the maximum length of a char column.

    deprecated

    Gets the maximum length of a char column. 
    public function getCharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCharMaxLength() ​Gets the maximum length of a char column.

    [m] getVarcharMaxLength Gets the maximum length of a varchar column.

    deprecated

    Gets the maximum length of a varchar column. 
    public function getVarcharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharMaxLength() ​Gets the maximum length of a varchar column.

    [m] getVarcharDefaultLength Gets the default length of a varchar column.

    deprecated

    Gets the default length of a varchar column. 
    public function getVarcharDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharDefaultLength() ​Gets the default length of a varchar column.

    [m] getBinaryDefaultLength Gets the default length of a binary column.

    deprecated

    Gets the default length of a binary column. 
    public function getBinaryDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryDefaultLength() ​Gets the default length of a binary column.

    [m] getWildcards Gets all SQL wildcard characters of the platform.

    deprecated

    Gets all SQL wildcard characters of the platform. 
    public function getWildcards(): string[]
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWildcards() ​Gets all SQL wildcard characters of the platform.
    See
    type summary
    ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] getRegexpExpression Returns the regular expression operator.

    Returns the regular expression operator. 
    public function getRegexpExpression(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRegexpExpression() ​Returns the regular expression operator.

    [m] getAvgExpression Returns the SQL snippet to get the average value of a column.

    deprecated

    Returns the SQL snippet to get the average value of a column. 
    public function getAvgExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an AVG aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAvgExpression() ​Returns the SQL snippet to get the average value of a column.

    [m] getCountExpression Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    deprecated

    Returns the SQL snippet to get the number of rows (without a NULL value) of a column. 
    public function getCountExpression(string|int $column): string

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

    Parameter
    type name summary
    ​string|​int ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a COUNT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCountExpression() ​Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    [m] getMaxExpression Returns the SQL snippet to get the highest value of a column.

    deprecated

    Returns the SQL snippet to get the highest value of a column. 
    public function getMaxExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MAX aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxExpression() ​Returns the SQL snippet to get the highest value of a column.

    [m] getMinExpression Returns the SQL snippet to get the lowest value of a column.

    deprecated

    Returns the SQL snippet to get the lowest value of a column. 
    public function getMinExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MIN aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMinExpression() ​Returns the SQL snippet to get the lowest value of a column.

    [m] getSumExpression Returns the SQL snippet to get the total sum of a column.

    deprecated

    Returns the SQL snippet to get the total sum of a column. 
    public function getSumExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a SUM aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSumExpression() ​Returns the SQL snippet to get the total sum of a column.

    [m] getMd5Expression Returns the SQL snippet to get the md5 sum of a column.

    deprecated

    Returns the SQL snippet to get the md5 sum of a column. 
    public function getMd5Expression(string $column): string

    Note: Not SQL92, but common functionality.

    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMd5Expression() ​Returns the SQL snippet to get the md5 sum of a column.

    [m] getSqrtExpression Returns the SQL snippet to get the squared value of a column.

    deprecated

    Returns the SQL snippet to get the squared value of a column. 
    public function getSqrtExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an SQRT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqrtExpression() ​Returns the SQL snippet to get the squared value of a column.

    [m] getRoundExpression Returns the SQL snippet to round a numeric column to the number of decimals specified.

    deprecated

    Returns the SQL snippet to round a numeric column to the number of decimals specified. 
    public function getRoundExpression(
    string $column,
    string|int $decimals = 0
): string
    Parameter
    type name summary
    ​string ​$column ​
    ​string|​int ​$decimals = 0 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRoundExpression() ​Returns the SQL snippet to round a numeric column to the number of decimals specified.

    [m] getRtrimExpression Returns the SQL snippet to trim trailing space characters from the expression.

    deprecated

    Returns the SQL snippet to trim trailing space characters from the expression. 
    public function getRtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRtrimExpression() ​Returns the SQL snippet to trim trailing space characters from the expression.

    [m] getLtrimExpression Returns the SQL snippet to trim leading space characters from the expression.

    deprecated

    Returns the SQL snippet to trim leading space characters from the expression. 
    public function getLtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLtrimExpression() ​Returns the SQL snippet to trim leading space characters from the expression.

    [m] getUpperExpression Returns the SQL snippet to change all characters from the expression to uppercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to uppercase, 
    public function getUpperExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUpperExpression() ​Returns the SQL snippet to change all characters from the expression to uppercase,

    [m] getLowerExpression Returns the SQL snippet to change all characters from the expression to lowercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to lowercase, 
    public function getLowerExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLowerExpression() ​Returns the SQL snippet to change all characters from the expression to lowercase,

    [m] getNowExpression Returns the SQL snippet to get the current system date.

    deprecated

    Returns the SQL snippet to get the current system date. 
    public function getNowExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getNowExpression() ​Returns the SQL snippet to get the current system date.

    [m] getNotExpression Returns the SQL for a logical not.

    deprecated

    Returns the SQL for a logical not. 
    public function getNotExpression(string $expression): string

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

    Parameter
    type name summary
    ​string ​$expression ​
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getNotExpression() ​Returns the SQL for a logical not.

    [m] getIsNullExpression Returns the SQL that checks if an expression is null.

    deprecated

    Returns the SQL that checks if an expression is null. 
    public function getIsNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNullExpression() ​Returns the SQL that checks if an expression is null.

    [m] getIsNotNullExpression Returns the SQL that checks if an expression is not null.

    deprecated

    Returns the SQL that checks if an expression is not null. 
    public function getIsNotNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNotNullExpression() ​Returns the SQL that checks if an expression is not null.

    [m] getBetweenExpression Returns the SQL that checks if an expression evaluates to a value between two values.

    deprecated

    Returns the SQL that checks if an expression evaluates to a value between two values. 
    public function getBetweenExpression(
    string $expression,
    string $value1,
    string $value2
): string

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

    Parameter
    type name summary
    ​string ​$expression ​The value to compare to.
    ​string ​$value1 ​The lower value to compare with.
    ​string ​$value2 ​The higher value to compare with.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBetweenExpression() ​Returns the SQL that checks if an expression evaluates to a value between two values.

    [m] getAcosExpression Returns the SQL to get the arccosine of a value.

    deprecated

    Returns the SQL to get the arccosine of a value. 
    public function getAcosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAcosExpression() ​Returns the SQL to get the arccosine of a value.

    [m] getSinExpression Returns the SQL to get the sine of a value.

    deprecated

    Returns the SQL to get the sine of a value. 
    public function getSinExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSinExpression() ​Returns the SQL to get the sine of a value.

    [m] getPiExpression Returns the SQL to get the PI value.

    deprecated

    Returns the SQL to get the PI value. 
    public function getPiExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPiExpression() ​Returns the SQL to get the PI value.

    [m] getCosExpression Returns the SQL to get the cosine of a value.

    deprecated

    Returns the SQL to get the cosine of a value. 
    public function getCosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCosExpression() ​Returns the SQL to get the cosine of a value.

    [m] getDateAddSecondsExpression Returns the SQL to add the number of given seconds to a date.

    Returns the SQL to add the number of given seconds to a date. 
    public function getDateAddSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddSecondsExpression() ​Returns the SQL to add the number of given seconds to a date.

    [m] getDateSubSecondsExpression Returns the SQL to subtract the number of given seconds from a date.

    Returns the SQL to subtract the number of given seconds from a date. 
    public function getDateSubSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubSecondsExpression() ​Returns the SQL to subtract the number of given seconds from a date.

    [m] getDateAddMinutesExpression Returns the SQL to add the number of given minutes to a date.

    Returns the SQL to add the number of given minutes to a date. 
    public function getDateAddMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMinutesExpression() ​Returns the SQL to add the number of given minutes to a date.

    [m] getDateSubMinutesExpression Returns the SQL to subtract the number of given minutes from a date.

    Returns the SQL to subtract the number of given minutes from a date. 
    public function getDateSubMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMinutesExpression() ​Returns the SQL to subtract the number of given minutes from a date.

    [m] getDateAddHourExpression Returns the SQL to add the number of given hours to a date.

    Returns the SQL to add the number of given hours to a date. 
    public function getDateAddHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddHourExpression() ​Returns the SQL to add the number of given hours to a date.

    [m] getDateSubHourExpression Returns the SQL to subtract the number of given hours to a date.

    Returns the SQL to subtract the number of given hours to a date. 
    public function getDateSubHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubHourExpression() ​Returns the SQL to subtract the number of given hours to a date.

    [m] getDateAddDaysExpression Returns the SQL to add the number of given days to a date.

    Returns the SQL to add the number of given days to a date. 
    public function getDateAddDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddDaysExpression() ​Returns the SQL to add the number of given days to a date.

    [m] getDateSubDaysExpression Returns the SQL to subtract the number of given days to a date.

    Returns the SQL to subtract the number of given days to a date. 
    public function getDateSubDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubDaysExpression() ​Returns the SQL to subtract the number of given days to a date.

    [m] getDateAddWeeksExpression Returns the SQL to add the number of given weeks to a date.

    Returns the SQL to add the number of given weeks to a date. 
    public function getDateAddWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddWeeksExpression() ​Returns the SQL to add the number of given weeks to a date.

    [m] getDateSubWeeksExpression Returns the SQL to subtract the number of given weeks from a date.

    Returns the SQL to subtract the number of given weeks from a date. 
    public function getDateSubWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubWeeksExpression() ​Returns the SQL to subtract the number of given weeks from a date.

    [m] getDateAddMonthExpression Returns the SQL to add the number of given months to a date.

    Returns the SQL to add the number of given months to a date. 
    public function getDateAddMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMonthExpression() ​Returns the SQL to add the number of given months to a date.

    [m] getDateSubMonthExpression Returns the SQL to subtract the number of given months to a date.

    Returns the SQL to subtract the number of given months to a date. 
    public function getDateSubMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMonthExpression() ​Returns the SQL to subtract the number of given months to a date.

    [m] getDateAddQuartersExpression Returns the SQL to add the number of given quarters to a date.

    Returns the SQL to add the number of given quarters to a date. 
    public function getDateAddQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddQuartersExpression() ​Returns the SQL to add the number of given quarters to a date.

    [m] getDateSubQuartersExpression Returns the SQL to subtract the number of given quarters from a date.

    Returns the SQL to subtract the number of given quarters from a date. 
    public function getDateSubQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubQuartersExpression() ​Returns the SQL to subtract the number of given quarters from a date.

    [m] getDateAddYearsExpression Returns the SQL to add the number of given years to a date.

    Returns the SQL to add the number of given years to a date. 
    public function getDateAddYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddYearsExpression() ​Returns the SQL to add the number of given years to a date.

    [m] getDateSubYearsExpression Returns the SQL to subtract the number of given years from a date.

    Returns the SQL to subtract the number of given years from a date. 
    public function getDateSubYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubYearsExpression() ​Returns the SQL to subtract the number of given years from a date.

    [m] multiplyInterval Generates the SQL expression which represents the given date interval multiplied by a number

    Generates the SQL expression which represents the given date interval multiplied by a number 
    protected function multiplyInterval(
    string $interval,
    int $multiplier
): string
    Parameter
    type name summary
    ​string ​$interval ​SQL expression describing the interval value
    ​int ​$multiplier ​Interval multiplier
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::multiplyInterval() ​Generates the SQL expression which represents the given date interval multiplied by a number

    [m] getBitAndComparisonExpression Returns the SQL bit AND comparison expression.

    Returns the SQL bit AND comparison expression. 
    public function getBitAndComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitAndComparisonExpression() ​Returns the SQL bit AND comparison expression.

    [m] getBitOrComparisonExpression Returns the SQL bit OR comparison expression.

    Returns the SQL bit OR comparison expression. 
    public function getBitOrComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitOrComparisonExpression() ​Returns the SQL bit OR comparison expression.

    [m] getReadLockSQL Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock. 
    public function getReadLockSQL(): string

    This defaults to the ANSI SQL "FOR UPDATE", which is an exclusive lock (Write). Some database vendors allow to lighten this constraint up to be a real read lock.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getReadLockSQL() ​Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    [m] getWriteLockSQL Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows. 
    public function getWriteLockSQL(): string

    The semantics of this lock mode should equal the SELECT .. FOR UPDATE of the ANSI SQL standard.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWriteLockSQL() ​Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    [m] getDropTableSQL Returns the SQL snippet to drop an existing table.

    Returns the SQL snippet to drop an existing table. 
    public function getDropTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTableSQL() ​Returns the SQL snippet to drop an existing table.

    [m] getDropTemporaryTableSQL Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction. 
    public function getDropTemporaryTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTemporaryTableSQL() ​Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    [m] getDropConstraintSQL Returns the SQL to drop a constraint.

    Returns the SQL to drop a constraint. 
    public function getDropConstraintSQL(
    Doctrine\DBAL\Schema\Constraint|string $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint|​string ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropConstraintSQL() ​Returns the SQL to drop a constraint.
    See
    type summary
    ​AbstractPlatform ​

    [m] getDropUniqueConstraintSQL Returns the SQL to drop a unique constraint.

    Returns the SQL to drop a unique constraint. 
    public function getDropUniqueConstraintSQL(
    string $name,
    string $tableName
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropUniqueConstraintSQL() ​Returns the SQL to drop a unique constraint.

    [m] getCreateTableSQL Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    Returns the SQL statement(s) to create a table with the specified name, columns and constraints 
    public function getCreateTableSQL(
    Doctrine\DBAL\Schema\Table $table,
    int $createFlags = self::CREATE_INDEXES
): list

    on this platform.

    Parameter
    type name summary
    ​Table ​$table ​
    ​int ​$createFlags = self::CREATE_INDEXES ​
    Return
    type summary
    ​list ​The list of SQL statements.
    Throws
    type summary
    ​Exception ​
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableSQL() ​Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    [m] getCreateTableWithoutForeignKeysSQL

    final

    final protected function getCreateTableWithoutForeignKeysSQL(Doctrine\DBAL\Schema\Table $table): array|list
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableWithoutForeignKeysSQL() ​

    [m] getCreateTablesSQL 

    public function getCreateTablesSQL(array|Doctrine\DBAL\Schema\Table[] $tables): array|list
    Parameter
    type name summary
    ​array|​Table[] ​$tables ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTablesSQL() ​

    [m] getDropTablesSQL 

    public function getDropTablesSQL(array|list $tables): array|list
    Parameter
    type name summary
    ​array|​list ​$tables ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTablesSQL() ​

    [m] getCommentOnColumnSQL 

    public function getCommentOnColumnSQL(
    string $tableName,
    string $columnName,
    string|null $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    ​string|​null ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnColumnSQL() ​

    [m] getInlineColumnCommentSQL Returns the SQL to create inline comment on a column.

    Returns the SQL to create inline comment on a column. 
    public function getInlineColumnCommentSQL(string $comment): string
    Parameter
    type name summary
    ​string ​$comment ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getInlineColumnCommentSQL() ​Returns the SQL to create inline comment on a column.

    [m] getAlterSchemaSQL Generates SQL statements that can be used to apply the diff.

    Generates SQL statements that can be used to apply the diff. 
    public function getAlterSchemaSQL(Doctrine\DBAL\Schema\SchemaDiff $diff): array|list
    Parameter
    type name summary
    ​SchemaDiff ​$diff ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAlterSchemaSQL() ​Generates SQL statements that can be used to apply the diff.

    [m] getDropSequenceSQL Returns the SQL snippet to drop an existing sequence.

    Returns the SQL snippet to drop an existing sequence. 
    public function getDropSequenceSQL(Doctrine\DBAL\Schema\Sequence|string $sequence): string
    Parameter
    type name summary
    ​Sequence|​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSequenceSQL() ​Returns the SQL snippet to drop an existing sequence.

    [m] getCreateConstraintSQL Returns the SQL to create a constraint on a table on this platform.

    deprecated

    Returns the SQL to create a constraint on a table on this platform. 
    public function getCreateConstraintSQL(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateConstraintSQL() ​Returns the SQL to create a constraint on a table on this platform.
    See
    type summary
    ​AbstractPlatform::getCreateIndexSQL() ​
    ​AbstractPlatform::getCreateForeignKeySQL() ​

    [m] getPartialIndexSQL Adds condition for partial index.

    Adds condition for partial index. 
    protected function getPartialIndexSQL(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPartialIndexSQL() ​Adds condition for partial index.

    [m] getCreateSchemaSQL Returns the SQL to create a named schema.

    Returns the SQL to create a named schema. 
    public function getCreateSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateSchemaSQL() ​Returns the SQL to create a named schema.

    [m] getCreateUniqueConstraintSQL Returns the SQL to create a unique constraint on a table on this platform.

    Returns the SQL to create a unique constraint on a table on this platform. 
    public function getCreateUniqueConstraintSQL(
    Doctrine\DBAL\Schema\UniqueConstraint $constraint,
    string $tableName
): string
    Parameter
    type name summary
    ​UniqueConstraint ​$constraint ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateUniqueConstraintSQL() ​Returns the SQL to create a unique constraint on a table on this platform.

    [m] getDropSchemaSQL Returns the SQL snippet to drop a schema.

    Returns the SQL snippet to drop a schema. 
    public function getDropSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSchemaSQL() ​Returns the SQL snippet to drop a schema.

    [m] quoteIdentifier Quotes a string so that it can be safely used as a table or column name,

    Quotes a string so that it can be safely used as a table or column name, 
    public function quoteIdentifier(string $str): string

    even if it is a reserved word of the platform. This also detects identifier chains separated by dot and quotes them independently.

    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.

    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteIdentifier() ​Quotes a string so that it can be safely used as a table or column name,

    [m] getCreateForeignKeySQL Returns the SQL to create a new foreign key.

    Returns the SQL to create a new foreign key. 
    public function getCreateForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key constraint.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateForeignKeySQL() ​Returns the SQL to create a new foreign key.

    [m] onSchemaAlterTableAddColumn 

    protected function onSchemaAlterTableAddColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    mixed[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​mixed[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableAddColumn() ​

    [m] onSchemaAlterTableRemoveColumn 

    protected function onSchemaAlterTableRemoveColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRemoveColumn() ​

    [m] onSchemaAlterTableChangeColumn 

    protected function onSchemaAlterTableChangeColumn(
    Doctrine\DBAL\Schema\ColumnDiff $columnDiff,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​ColumnDiff ​$columnDiff ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableChangeColumn() ​

    [m] onSchemaAlterTableRenameColumn 

    protected function onSchemaAlterTableRenameColumn(
    string $oldColumnName,
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​string ​$oldColumnName ​
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRenameColumn() ​

    [m] onSchemaAlterTable 

    protected function onSchemaAlterTable(
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$sql
): bool
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    ​string[] ​&$sql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTable() ​

    [m] getPreAlterTableIndexForeignKeySQL 

    protected function getPreAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPreAlterTableIndexForeignKeySQL() ​

    [m] getPostAlterTableIndexForeignKeySQL 

    protected function getPostAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPostAlterTableIndexForeignKeySQL() ​

    [m] getColumnDeclarationListSQL Gets declaration of a number of columns in bulk.

    Gets declaration of a number of columns in bulk. 
    public function getColumnDeclarationListSQL(array|mixed[][] $columns): string
    Parameter
    type name summary
    ​array|​mixed[][] ​$columns ​A multidimensional associative array.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationListSQL() ​Gets declaration of a number of columns in bulk.

    [m] getDecimalTypeDeclarationSQL Returns the SQL snippet that declares a floating point column of arbitrary precision.

    Returns the SQL snippet that declares a floating point column of arbitrary precision. 
    public function getDecimalTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDecimalTypeDeclarationSQL() ​Returns the SQL snippet that declares a floating point column of arbitrary precision.

    [m] getDefaultValueDeclarationSQL Obtains DBMS specific SQL code portion needed to set a default value

    Obtains DBMS specific SQL code portion needed to set a default value 
    public function getDefaultValueDeclarationSQL(mixed[] $column): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​mixed[] ​$column ​The column definition array.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a default value.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDefaultValueDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a default value

    [m] getCheckDeclarationSQL Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    Obtains DBMS specific SQL code portion needed to set a CHECK constraint 
    public function getCheckDeclarationSQL(array|string[]|mixed[][] $definition): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​string[]|​mixed[][] ​$definition ​The check definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a CHECK constraint.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCheckDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    [m] getUniqueConstraintDeclarationSQL Obtains DBMS specific SQL code portion needed to set a unique

    Obtains DBMS specific SQL code portion needed to set a unique 
    public function getUniqueConstraintDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\UniqueConstraint $constraint
): string

    constraint declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the unique constraint.
    ​UniqueConstraint ​$constraint ​The unique constraint definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a constraint.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueConstraintDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a unique

    [m] getIndexDeclarationSQL Obtains DBMS specific SQL code portion needed to set an index

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\Index $index
): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the index.
    ​Index ​$index ​The index definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set an index.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getCustomTypeDeclarationSQL Obtains SQL code portion needed to create a custom column,

    deprecated

    Obtains SQL code portion needed to create a custom column, 
    public function getCustomTypeDeclarationSQL(array|mixed[] $column): string

    e.g. when a column has the "columnDefinition" keyword. Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCustomTypeDeclarationSQL() ​Obtains SQL code portion needed to create a custom column,

    [m] getIndexFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexFieldDeclarationListSQL(Doctrine\DBAL\Schema\Index $index): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getColumnsFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getColumnsFieldDeclarationListSQL(array|mixed[] $columns): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$columns ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnsFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getTemporaryTableSQL Returns the required SQL string that fits between CREATE ... TABLE

    deprecated

    Returns the required SQL string that fits between CREATE ... TABLE 
    public function getTemporaryTableSQL(): string

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

    Return
    type summary
    ​string ​The string required to be placed between "CREATE" and "TABLE"
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableSQL() ​Returns the required SQL string that fits between CREATE ... TABLE

    [m] getForeignKeyDeclarationSQL Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyDeclarationSQL() ​Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getAdvancedForeignKeyOptionsSQL Returns the FOREIGN KEY query section dealing with non-standard options

    Returns the FOREIGN KEY query section dealing with non-standard options 
    public function getAdvancedForeignKeyOptionsSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    as MATCH, INITIALLY DEFERRED, ON UPDATE, ...

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAdvancedForeignKeyOptionsSQL() ​Returns the FOREIGN KEY query section dealing with non-standard options

    [m] getForeignKeyBaseDeclarationSQL Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyBaseDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyBaseDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getUniqueFieldDeclarationSQL Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    deprecated

    Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint 
    public function getUniqueFieldDeclarationSQL(): string

    of a column declaration to be used in statements like CREATE TABLE.

    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the UNIQUE constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueFieldDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    [m] getColumnCharsetDeclarationSQL Obtains DBMS specific SQL code portion needed to set the CHARACTER SET

    Obtains DBMS specific SQL code portion needed to set the CHARACTER SET 
    public function getColumnCharsetDeclarationSQL(string $charset): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$charset ​The name of the charset.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the CHARACTER SET
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnCharsetDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the CHARACTER SET

    [m] convertFromBoolean Some platforms have boolean literals that needs to be correctly converted

    Some platforms have boolean literals that needs to be correctly converted 
    public function convertFromBoolean(T $item): (T

    The default conversion tries to convert value into bool "(bool)$item"

    Parameter
    type name summary
    ​T ​$item ​
    Return
    type summary
    ​(T ​is null ? null : bool)
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertFromBoolean() ​Some platforms have boolean literals that needs to be correctly converted

    [m] convertBooleansToDatabaseValue This method should handle the prepared statements case. When there is no

    This method should handle the prepared statements case. When there is no 
    public function convertBooleansToDatabaseValue(mixed $item): mixed

    distinction, it's OK to use the same method.

    Note: if the input is not a boolean the original input might be returned.

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertBooleansToDatabaseValue() ​This method should handle the prepared statements case. When there is no

    [m] getCurrentTimestampSQL Returns the SQL specific for the platform to get the current timestamp

    Returns the SQL specific for the platform to get the current timestamp 
    public function getCurrentTimestampSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimestampSQL() ​Returns the SQL specific for the platform to get the current timestamp

    [m] _getTransactionIsolationLevelSQL Returns the SQL for a given transaction isolation level Connection constant.

    Returns the SQL for a given transaction isolation level Connection constant. 
    protected function _getTransactionIsolationLevelSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::_getTransactionIsolationLevelSQL() ​Returns the SQL for a given transaction isolation level Connection constant.

    [m] getListTableConstraintsSQL

    deprecated 

    public function getListTableConstraintsSQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListTableConstraintsSQL() ​

    [m] getListUsersSQL

    deprecated 

    public function getListUsersSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListUsersSQL() ​

    [m] getCreateViewSQL 

    public function getCreateViewSQL(
    string $name,
    string $sql
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$sql ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateViewSQL() ​

    [m] getDropViewSQL 

    public function getDropViewSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropViewSQL() ​

    [m] getCreateDatabaseSQL Returns the SQL to create a new database.

    Returns the SQL to create a new database. 
    public function getCreateDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateDatabaseSQL() ​Returns the SQL to create a new database.

    [m] getDropDatabaseSQL Returns the SQL snippet to drop an existing database.

    Returns the SQL snippet to drop an existing database. 
    public function getDropDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be dropped.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropDatabaseSQL() ​Returns the SQL snippet to drop an existing database.

    [m] getFloatDeclarationSQL 

    public function getFloatDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getFloatDeclarationSQL() ​

    [m] getDefaultTransactionIsolationLevel Gets the default transaction isolation level of the platform.

    Gets the default transaction isolation level of the platform. 
    public function getDefaultTransactionIsolationLevel(): Doctrine\DBAL\TransactionIsolationLevel::*()
    Return
    type summary
    ​TransactionIsolationLevel::*() ​The default isolation level.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDefaultTransactionIsolationLevel() ​Gets the default transaction isolation level of the platform.
    See
    type summary
    ​TransactionIsolationLevel ​

    [m] usesSequenceEmulatedIdentityColumns Whether the platform emulates identity columns through sequences.

    deprecated

    Whether the platform emulates identity columns through sequences. 
    public function usesSequenceEmulatedIdentityColumns(): bool

    Some platforms that do not support identity columns natively but support sequences can emulate identity columns by using sequences.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::usesSequenceEmulatedIdentityColumns() ​Whether the platform emulates identity columns through sequences.

    [m] getIdentitySequenceName Returns the name of the sequence for a particular identity column in a particular table.

    deprecated

    Returns the name of the sequence for a particular identity column in a particular table. 
    public function getIdentitySequenceName(
    string $tableName,
    string $columnName
): string
    Parameter
    type name summary
    ​string ​$tableName ​The name of the table to return the sequence name for.
    ​string ​$columnName ​The name of the identity column in the table to return the sequence name for.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIdentitySequenceName() ​Returns the name of the sequence for a particular identity column in a particular table.
    See
    type summary
    ​usesSequenceEmulatedIdentityColumns ​

    [m] supportsIndexes Whether the platform supports indexes.

    deprecated

    Whether the platform supports indexes. 
    public function supportsIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsIndexes() ​Whether the platform supports indexes.

    [m] supportsPartialIndexes Whether the platform supports partial indexes.

    Whether the platform supports partial indexes. 
    public function supportsPartialIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPartialIndexes() ​Whether the platform supports partial indexes.

    [m] supportsColumnLengthIndexes Whether the platform supports indexes with column length definitions.

    Whether the platform supports indexes with column length definitions. 
    public function supportsColumnLengthIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsColumnLengthIndexes() ​Whether the platform supports indexes with column length definitions.

    [m] supportsAlterTable Whether the platform supports altering tables.

    deprecated

    Whether the platform supports altering tables. 
    public function supportsAlterTable(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsAlterTable() ​Whether the platform supports altering tables.

    [m] supportsTransactions Whether the platform supports transactions.

    deprecated

    Whether the platform supports transactions. 
    public function supportsTransactions(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsTransactions() ​Whether the platform supports transactions.

    [m] supportsSavepoints Whether the platform supports savepoints.

    Whether the platform supports savepoints. 
    public function supportsSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSavepoints() ​Whether the platform supports savepoints.

    [m] supportsPrimaryConstraints Whether the platform supports primary key constraints.

    deprecated

    Whether the platform supports primary key constraints. 
    public function supportsPrimaryConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPrimaryConstraints() ​Whether the platform supports primary key constraints.

    [m] supportsForeignKeyConstraints Whether the platform supports foreign key constraints.

    deprecated

    Whether the platform supports foreign key constraints. 
    public function supportsForeignKeyConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsForeignKeyConstraints() ​Whether the platform supports foreign key constraints.

    [m] canEmulateSchemas Whether this platform can emulate schemas.

    deprecated

    Whether this platform can emulate schemas. 
    public function canEmulateSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::canEmulateSchemas() ​Whether this platform can emulate schemas.
    See
    type summary
    ​AbstractManager::introspectSchema() ​

    [m] supportsCreateDropDatabase Whether this platform supports create database.

    deprecated

    Whether this platform supports create database. 
    public function supportsCreateDropDatabase(): bool

    Some databases don't allow to create and drop databases at all or only with certain tools.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsCreateDropDatabase() ​Whether this platform supports create database.

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

    deprecated

    Whether the platform supports getting the affected rows of a recent update/delete type query. 
    public function supportsGettingAffectedRows(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsGettingAffectedRows() ​Whether the platform supports getting the affected rows of a recent update/delete type query.

    [m] supportsInlineColumnComments Whether this platform support to add inline column comments as postfix.

    Whether this platform support to add inline column comments as postfix. 
    public function supportsInlineColumnComments(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsInlineColumnComments() ​Whether this platform support to add inline column comments as postfix.

    [m] supportsCommentOnStatement Whether this platform support the proprietary syntax "COMMENT ON asset".

    Whether this platform support the proprietary syntax "COMMENT ON asset". 
    public function supportsCommentOnStatement(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsCommentOnStatement() ​Whether this platform support the proprietary syntax "COMMENT ON asset".

    [m] hasNativeJsonType Does this platform have native JSON type.

    deprecated

    Does this platform have native JSON type. 
    public function hasNativeJsonType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasNativeJsonType() ​Does this platform have native JSON type.

    [m] supportsViews Whether this platform supports views.

    deprecated

    Whether this platform supports views. 
    public function supportsViews(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsViews() ​Whether this platform supports views.

    [m] modifyLimitQuery Adds an driver-specific LIMIT clause to the query.

    final

    Adds an driver-specific LIMIT clause to the query. 
    final public function modifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset = 0
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset = 0 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::modifyLimitQuery() ​Adds an driver-specific LIMIT clause to the query.

    [m] supportsLimitOffset Whether the database platform support offsets in modify limit clauses.

    deprecated

    Whether the database platform support offsets in modify limit clauses. 
    public function supportsLimitOffset(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsLimitOffset() ​Whether the database platform support offsets in modify limit clauses.

    [m] getMaxIdentifierLength Maximum length of any given database identifier, like tables or column names.

    Maximum length of any given database identifier, like tables or column names. 
    public function getMaxIdentifierLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxIdentifierLength() ​Maximum length of any given database identifier, like tables or column names.

    [m] getDummySelectSQL This is for test reasons, many vendors have special requirements for dummy statements.

    This is for test reasons, many vendors have special requirements for dummy statements. 
    public function getDummySelectSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDummySelectSQL() ​This is for test reasons, many vendors have special requirements for dummy statements.

    [m] getReservedKeywordsList Returns the keyword list instance of this platform.

    final

    Returns the keyword list instance of this platform. 
    final public function getReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList
    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​If no keyword list is specified.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getReservedKeywordsList() ​Returns the keyword list instance of this platform.

    [m] createReservedKeywordsList Creates an instance of the reserved keyword list of this platform.

    Creates an instance of the reserved keyword list of this platform. 
    protected function createReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList

    This method will become @abstract in DBAL 4.0.0.

    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createReservedKeywordsList() ​Creates an instance of the reserved keyword list of this platform.

    [m] quoteStringLiteral Quotes a literal string.

    Quotes a literal string. 
    public function quoteStringLiteral(string $str): string

    This method is NOT meant to fix SQL injections! It is only meant to escape this platform's string literal quote character inside the given literal string.

    Parameter
    type name summary
    ​string ​$str ​The literal string to be quoted.
    Return
    type summary
    ​string ​The quoted literal string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteStringLiteral() ​Quotes a literal string.

    [m] getStringLiteralQuoteCharacter Gets the character used for string literal quoting.

    deprecated

    Gets the character used for string literal quoting. 
    public function getStringLiteralQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringLiteralQuoteCharacter() ​Gets the character used for string literal quoting.
    See
    type summary
    ​AbstractPlatform::quoteStringLiteral() ​

    [m] escapeStringForLike Escapes metacharacters in a string intended to be used with a LIKE

    final

    Escapes metacharacters in a string intended to be used with a LIKE 
    final public function escapeStringForLike(
    string $inputString,
    string $escapeChar
): string

    operator.

    Parameter
    type name summary
    ​string ​$inputString ​a literal, unquoted string
    ​string ​$escapeChar ​should be reused by the caller in the LIKE
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::escapeStringForLike() ​Escapes metacharacters in a string intended to be used with a LIKE

    [m] createSQLParser 

    public function createSQLParser(): Doctrine\DBAL\SQL\Parser
    Return
    type summary
    ​Parser ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSQLParser() ​

    [C] MariaDb1027Platform Provides the behavior, features and SQL dialect of the MariaDB 10.2 database platform.

    deprecated

    Provides the behavior, features and SQL dialect of the MariaDB 10.2 database platform.

    See
    type summary
    ​MariaDBPlatform ​

    Hierarchy

    Parents
    type summary
    ​MariaDBPlatform ​Provides the behavior, features and SQL dialect of the MariaDB database platform of the oldest supported version.
    ​MySQLPlatform ​Provides the behavior, features and SQL dialect of the Oracle MySQL database platform
    ​AbstractMySQLPlatform ​Provides the base implementation for the lowest versions of supported MySQL-like database platforms.
    ​AbstractPlatform ​Base class for all DatabasePlatforms. The DatabasePlatforms are the central

    [C] LENGTH_LIMIT_TINYTEXT 

    public const int LENGTH_LIMIT_TINYTEXT = 255
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_TINYTEXT ​

    [C] LENGTH_LIMIT_TEXT 

    public const int LENGTH_LIMIT_TEXT = 65535
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_TEXT ​

    [C] LENGTH_LIMIT_MEDIUMTEXT 

    public const int LENGTH_LIMIT_MEDIUMTEXT = 16777215
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_MEDIUMTEXT ​

    [C] LENGTH_LIMIT_TINYBLOB 

    public const int LENGTH_LIMIT_TINYBLOB = 255
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_TINYBLOB ​

    [C] LENGTH_LIMIT_BLOB 

    public const int LENGTH_LIMIT_BLOB = 65535
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_BLOB ​

    [C] LENGTH_LIMIT_MEDIUMBLOB 

    public const int LENGTH_LIMIT_MEDIUMBLOB = 16777215
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_MEDIUMBLOB ​

    [C] CREATE_INDEXES 

    public const int CREATE_INDEXES = 1
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_INDEXES ​

    [C] CREATE_FOREIGNKEYS 

    public const int CREATE_FOREIGNKEYS = 2
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_FOREIGNKEYS ​

    [p] $doctrineTypeMapping 

    protected string[]|null $doctrineTypeMapping = null

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeMapping ​

    [p] $doctrineTypeComments Contains a list of all columns that should generate parseable column comments for type-detection

    deprecated

    Contains a list of all columns that should generate parseable column comments for type-detection 
    protected string[]|null $doctrineTypeComments = null

    in reverse engineering scenarios.

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeComments ​Contains a list of all columns that should generate parseable column comments for type-detection

    [p] $_eventManager

    deprecated 

    protected Doctrine\Common\EventManager|null $_eventManager = null

    Type: EventManager|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_eventManager ​

    [p] $_keywords Holds the KeywordList instance for the current platform.

    Holds the KeywordList instance for the current platform. 
    protected Doctrine\DBAL\Platforms\Keywords\KeywordList|null $_keywords = null

    Type: KeywordList|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_keywords ​Holds the KeywordList instance for the current platform.

    [m] getDefaultValueDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set a default value

    Obtains DBMS specific SQL code portion needed to set a default value 
    public function getDefaultValueDeclarationSQL(mixed[] $column): string

    declaration to be used in statements like CREATE TABLE.

    Hop over the Doctrine\DBAL\Platforms\AbstractMySQLPlatform implementation until 4.0.x where Doctrine\DBAL\Platforms\MariaDBPlatform no longer extends Doctrine\DBAL\Platforms\MySQLPlatform.

    Parameter
    type name summary
    ​mixed[] ​$column ​The column definition array.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a default value.
    Prototype
    kind source summary
    ​inherit ​MariaDBPlatform::getDefaultValueDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set a default value
    See
    type summary
    ​AbstractMySQLPlatform ​
    ​MariaDBPlatform ​
    ​MySQLPlatform ​
    ​AbstractPlatform ​

    [m] getJsonTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to declare a JSON column.

    Returns the SQL snippet to declare a JSON column. 
    public function getJsonTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CLOB and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​MariaDBPlatform::getJsonTypeDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to declare a JSON column.

    [m] getReservedKeywordsClass

    deprecated 

    protected function getReservedKeywordsClass(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​MariaDBPlatform::getReservedKeywordsClass() ​
    See
    type summary
    ​MariaDBPlatform::createReservedKeywordsList() ​

    [m] initializeDoctrineTypeMappings Lazy load Doctrine Type Mappings.

    Lazy load Doctrine Type Mappings. 
    protected function initializeDoctrineTypeMappings(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​MariaDBPlatform::initializeDoctrineTypeMappings() ​Lazy load Doctrine Type Mappings.

    [m] doModifyLimitQuery Adds an platform-specific LIMIT clause to the query.

    Adds an platform-specific LIMIT clause to the query. 
    protected function doModifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::doModifyLimitQuery() ​Adds an platform-specific LIMIT clause to the query.

    [m] getIdentifierQuoteCharacter Gets the character used for identifier quoting.

    deprecated

    Gets the character used for identifier quoting. 
    public function getIdentifierQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getIdentifierQuoteCharacter() ​Gets the character used for identifier quoting.
    See
    type summary
    ​AbstractMySQLPlatform::quoteIdentifier() ​
    ​AbstractPlatform::quoteIdentifier() ​

    [m] getRegexpExpression Returns the regular expression operator.

    Returns the regular expression operator. 
    public function getRegexpExpression(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getRegexpExpression() ​Returns the regular expression operator.

    [m] getLocateExpression Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str. 
    public function getLocateExpression(
    string $str,
    string $substr,
    string|int|false $startPos = false
): string
    Parameter
    type name summary
    ​string ​$str ​Literal string.
    ​string ​$substr ​Literal string to find.
    ​string|​int|​false ​$startPos = false ​Position to start at, beginning of string by default.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getLocateExpression() ​Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    [m] getConcatExpression <tag_inheritdoc data-type='' data-description=''>Returns a SQL snippet to concatenate the given expressions.

    Returns a SQL snippet to concatenate the given expressions. 
    public function getConcatExpression(): string

    Accepts an arbitrary number of string parameters. Each parameter must contain an expression.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getConcatExpression() ​<tag_inheritdoc data-type='' data-description=''>Returns a SQL snippet to concatenate the given expressions.

    [m] getDateArithmeticIntervalExpression Returns the SQL for a date arithmetic expression.

    Returns the SQL for a date arithmetic expression. 
    protected function getDateArithmeticIntervalExpression(
    string $date,
    string $operator,
    int|string $interval,
    string $unit
): string
    Parameter
    type name summary
    ​string ​$date ​The column or literal representing a date
    ​string ​$operator ​The arithmetic operator (+ or -).
    ​int|​string ​$interval ​The interval that shall be calculated into the date.
    ​string ​$unit ​The unit of the interval that shall be calculated into the date.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDateArithmeticIntervalExpression() ​Returns the SQL for a date arithmetic expression.

    [m] getDateDiffExpression <tag_inheritdoc data-type='' data-description=''>Returns the SQL to calculate the difference in days between the two passed dates.

    Returns the SQL to calculate the difference in days between the two passed dates. 
    public function getDateDiffExpression(
    string $date1,
    string $date2
): string

    Computes diff = date1 - date2.

    Parameter
    type name summary
    ​string ​$date1 ​
    ​string ​$date2 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDateDiffExpression() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQL to calculate the difference in days between the two passed dates.

    [m] getCurrentDatabaseExpression Returns the SQL expression which represents the currently selected database.

    Returns the SQL expression which represents the currently selected database. 
    public function getCurrentDatabaseExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getCurrentDatabaseExpression() ​Returns the SQL expression which represents the currently selected database.

    [m] getLengthExpression Returns the SQL snippet to get the length of a text column in characters.

    Returns the SQL snippet to get the length of a text column in characters. 
    public function getLengthExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getLengthExpression() ​Returns the SQL snippet to get the length of a text column in characters.

    [m] getListDatabasesSQL 

    public function getListDatabasesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListDatabasesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getListTableConstraintsSQL

    deprecated 

    public function getListTableConstraintsSQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableConstraintsSQL() ​

    [m] getListTableIndexesSQL

    deprecated 

    public function getListTableIndexesSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableIndexesSQL() ​

    [m] getListViewsSQL Returns the SQL to list all views of a database or user.

    Returns the SQL to list all views of a database or user. 
    public function getListViewsSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListViewsSQL() ​Returns the SQL to list all views of a database or user.
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getListTableForeignKeysSQL

    deprecated 

    public function getListTableForeignKeysSQL(
    string $table,
    string|null $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableForeignKeysSQL() ​

    [m] getVarcharTypeDeclarationSQLSnippet 

    protected function getVarcharTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​
    ​bool ​$fixed ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getVarcharTypeDeclarationSQLSnippet() ​

    [m] getBinaryTypeDeclarationSQLSnippet Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    protected function getBinaryTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​The length of the column.
    ​bool ​$fixed ​Whether the column length is fixed.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBinaryTypeDeclarationSQLSnippet() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getClobTypeDeclarationSQL Gets the SQL snippet used to declare a CLOB column type.

    Gets the SQL snippet used to declare a CLOB column type. 
    public function getClobTypeDeclarationSQL(array|mixed[] $column): string
    TINYTEXT   : 2 ^  8 - 1 = 255
TEXT       : 2 ^ 16 - 1 = 65535
MEDIUMTEXT : 2 ^ 24 - 1 = 16777215
LONGTEXT   : 2 ^ 32 - 1 = 4294967295

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

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getClobTypeDeclarationSQL() ​Gets the SQL snippet used to declare a CLOB column type.

    [m] getDateTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create datetime columns in

    Obtains DBMS specific SQL to be used to create datetime columns in 
    public function getDateTimeTypeDeclarationSQL(array|mixed[] $column): string

    statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDateTimeTypeDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create datetime columns in

    [m] getDateTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create date columns in statements

    Obtains DBMS specific SQL to be used to create date columns in statements 
    public function getDateTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDateTypeDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create date columns in statements

    [m] getTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create time columns in statements

    Obtains DBMS specific SQL to be used to create time columns in statements 
    public function getTimeTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getTimeTypeDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create time columns in statements

    [m] getBooleanTypeDeclarationSQL Returns the SQL snippet that declares a boolean column.

    Returns the SQL snippet that declares a boolean column. 
    public function getBooleanTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBooleanTypeDeclarationSQL() ​Returns the SQL snippet that declares a boolean column.

    [m] prefersIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    deprecated

    Whether the platform prefers identity columns (eg. autoincrement) for ID generation. 
    public function prefersIdentityColumns(): bool

    Subclasses should override this method to return TRUE if they prefer identity columns.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::prefersIdentityColumns() ​<tag_inheritdoc data-type='' data-description=''>Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    [m] supportsIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform supports identity columns.

    Whether the platform supports identity columns. 
    public function supportsIdentityColumns(): bool

    Identity columns are columns that receive an auto-generated value from the database on insert of a row.

    MySQL supports this through AUTO_INCREMENT columns.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::supportsIdentityColumns() ​<tag_inheritdoc data-type='' data-description=''>Whether the platform supports identity columns.

    [m] supportsInlineColumnComments Whether this platform support to add inline column comments as postfix.

    Whether this platform support to add inline column comments as postfix. 
    public function supportsInlineColumnComments(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::supportsInlineColumnComments() ​Whether this platform support to add inline column comments as postfix.
    See
    type summary
    ​AbstractPlatform ​

    [m] supportsColumnCollation Does this platform support column collation?

    Does this platform support column collation? 
    public function supportsColumnCollation(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::supportsColumnCollation() ​Does this platform support column collation?
    See
    type summary
    ​AbstractPlatform ​

    [m] getListTablesSQL

    deprecated 

    public function getListTablesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTablesSQL() ​

    [m] getListTableColumnsSQL

    deprecated 

    public function getListTableColumnsSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableColumnsSQL() ​

    [m] getColumnTypeSQLSnippets

    deprecated 

    public function getColumnTypeSQLSnippets(string $tableAlias = "c"): array
    Parameter
    type name summary
    ​string ​$tableAlias = "c" ​
    Return
    type summary
    ​array ​string}
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getColumnTypeSQLSnippets() ​
    See
    type summary
    ​AbstractMySQLPlatform::getColumnTypeSQLSnippet() ​

    [m] getColumnTypeSQLSnippet The SQL snippet required to elucidate a column type

    The SQL snippet required to elucidate a column type 
    public function getColumnTypeSQLSnippet(
    string $tableAlias = "c",
    ?string $databaseName = null
): string

    Returns a column type SELECT snippet string

    Parameter
    type name summary
    ​string ​$tableAlias = "c" ​
    ​?string ​$databaseName = null ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getColumnTypeSQLSnippet() ​The SQL snippet required to elucidate a column type

    [m] getListTableMetadataSQL

    deprecated 

    public function getListTableMetadataSQL(
    string $table,
    ?string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​?string ​$database = null ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableMetadataSQL() ​

    [m] getCreateTablesSQL 

    public function getCreateTablesSQL(array|Doctrine\DBAL\Schema\Table[] $tables): array
    Parameter
    type name summary
    ​array|​Table[] ​$tables ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getCreateTablesSQL() ​

    [m] _getCreateTableSQL Returns the SQL used to create a table.

    Returns the SQL used to create a table. 
    protected function _getCreateTableSQL(
    string $name,
    array|mixed[][] $columns,
    array|mixed[] $options = []
): string[]
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​mixed[][] ​$columns ​
    ​array|​mixed[] ​$options = [] ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::_getCreateTableSQL() ​Returns the SQL used to create a table.

    [m] createSelectSQLBuilder 

    public function createSelectSQLBuilder(): Doctrine\DBAL\SQL\Builder\SelectSQLBuilder
    Return
    type summary
    ​SelectSQLBuilder ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::createSelectSQLBuilder() ​

    [m] getAlterTableSQL <tag_inheritdoc data-type='' data-description=''>Gets the SQL statements for altering an existing table.

    Gets the SQL statements for altering an existing table. 
    public function getAlterTableSQL(Doctrine\DBAL\Schema\TableDiff $diff): list

    This method returns an array of SQL statements, since some platforms need several statements.

    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getAlterTableSQL() ​<tag_inheritdoc data-type='' data-description=''>Gets the SQL statements for altering an existing table.

    [m] getPreAlterTableIndexForeignKeySQL 

    protected function getPreAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getPreAlterTableIndexForeignKeySQL() ​

    [m] getPreAlterTableRenameIndexForeignKeySQL 

    protected function getPreAlterTableRenameIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​The table diff to gather the SQL for.
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getPreAlterTableRenameIndexForeignKeySQL() ​

    [m] getPostAlterTableIndexForeignKeySQL 

    protected function getPostAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getPostAlterTableIndexForeignKeySQL() ​

    [m] getPostAlterTableRenameIndexForeignKeySQL 

    protected function getPostAlterTableRenameIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​The table diff to gather the SQL for.
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getPostAlterTableRenameIndexForeignKeySQL() ​

    [m] getCreateIndexSQLFlags Adds additional flags for index generation.

    Adds additional flags for index generation. 
    protected function getCreateIndexSQLFlags(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getCreateIndexSQLFlags() ​Adds additional flags for index generation.

    [m] getIntegerTypeDeclarationSQL Returns the SQL snippet that declares a 4 byte integer column.

    Returns the SQL snippet that declares a 4 byte integer column. 
    public function getIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares a 4 byte integer column.

    [m] getBigIntTypeDeclarationSQL Returns the SQL snippet that declares an 8 byte integer column.

    Returns the SQL snippet that declares an 8 byte integer column. 
    public function getBigIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBigIntTypeDeclarationSQL() ​Returns the SQL snippet that declares an 8 byte integer column.

    [m] getSmallIntTypeDeclarationSQL Returns the SQL snippet that declares a 2 byte integer column.

    Returns the SQL snippet that declares a 2 byte integer column. 
    public function getSmallIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getSmallIntTypeDeclarationSQL() ​Returns the SQL snippet that declares a 2 byte integer column.

    [m] getFloatDeclarationSQL 

    public function getFloatDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getFloatDeclarationSQL() ​

    [m] getDecimalTypeDeclarationSQL Returns the SQL snippet that declares a floating point column of arbitrary precision.

    Returns the SQL snippet that declares a floating point column of arbitrary precision. 
    public function getDecimalTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDecimalTypeDeclarationSQL() ​Returns the SQL snippet that declares a floating point column of arbitrary precision.

    [m] _getCommonIntegerTypeDeclarationSQL Returns the SQL snippet that declares common properties of an integer column.

    Returns the SQL snippet that declares common properties of an integer column. 
    protected function _getCommonIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::_getCommonIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares common properties of an integer column.

    [m] getColumnCharsetDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set the CHARACTER SET

    Obtains DBMS specific SQL code portion needed to set the CHARACTER SET 
    public function getColumnCharsetDeclarationSQL(string $charset): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$charset ​The name of the charset.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the CHARACTER SET
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getColumnCharsetDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set the CHARACTER SET
    See
    type summary
    ​AbstractPlatform ​

    [m] getAdvancedForeignKeyOptionsSQL <tag_inheritdoc data-type='' data-description=''>Returns the FOREIGN KEY query section dealing with non-standard options

    Returns the FOREIGN KEY query section dealing with non-standard options 
    public function getAdvancedForeignKeyOptionsSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    as MATCH, INITIALLY DEFERRED, ON UPDATE, ...

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getAdvancedForeignKeyOptionsSQL() ​<tag_inheritdoc data-type='' data-description=''>Returns the FOREIGN KEY query section dealing with non-standard options
    See
    type summary
    ​AbstractPlatform ​

    [m] getDropIndexSQL Returns the SQL to drop an index from a table.

    Returns the SQL to drop an index from a table. 
    public function getDropIndexSQL(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string|null $table = null
): string
    Parameter
    type name summary
    ​Index|​string ​$index ​
    ​Table|​string|​null ​$table = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDropIndexSQL() ​Returns the SQL to drop an index from a table.

    [m] getDropPrimaryKeySQL 

    protected function getDropPrimaryKeySQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDropPrimaryKeySQL() ​

    [m] getDropUniqueConstraintSQL The ALTER TABLE ... DROP CONSTRAINT syntax is only available as of MySQL 8.0.19.

    The ALTER TABLE ... DROP CONSTRAINT syntax is only available as of MySQL 8.0.19. 
    public function getDropUniqueConstraintSQL(
    string $name,
    string $tableName
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDropUniqueConstraintSQL() ​The ALTER TABLE ... DROP CONSTRAINT syntax is only available as of MySQL 8.0.19.

    [m] getSetTransactionIsolationSQL Returns the SQL to set the transaction isolation level.

    Returns the SQL to set the transaction isolation level. 
    public function getSetTransactionIsolationSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getSetTransactionIsolationSQL() ​Returns the SQL to set the transaction isolation level.

    [m] getName Gets the name of the platform.

    deprecated

    Gets the name of the platform. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getName() ​Gets the name of the platform.

    [m] getReadLockSQL <tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock. 
    public function getReadLockSQL(): string

    This defaults to the ANSI SQL "FOR UPDATE", which is an exclusive lock (Write). Some database vendors allow to lighten this constraint up to be a real read lock.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getReadLockSQL() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    [m] getVarcharMaxLength Gets the maximum length of a varchar column.

    deprecated

    Gets the maximum length of a varchar column. 
    public function getVarcharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getVarcharMaxLength() ​Gets the maximum length of a varchar column.

    [m] getBinaryMaxLength Gets the maximum length of a binary column.

    deprecated

    Gets the maximum length of a binary column. 
    public function getBinaryMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBinaryMaxLength() ​Gets the maximum length of a binary column.

    [m] getDropTemporaryTableSQL Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction. 
    public function getDropTemporaryTableSQL(Doctrine\DBAL\Schema\Table|string $table): string

    MySQL commits a transaction implicitly when DROP TABLE is executed, however not if DROP TEMPORARY TABLE is executed.

    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDropTemporaryTableSQL() ​Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    [m] getBlobTypeDeclarationSQL Gets the SQL Snippet used to declare a BLOB column type.

    Gets the SQL Snippet used to declare a BLOB column type. 
    public function getBlobTypeDeclarationSQL(array|mixed[] $column): string
    TINYBLOB   : 2 ^  8 - 1 = 255
BLOB       : 2 ^ 16 - 1 = 65535
MEDIUMBLOB : 2 ^ 24 - 1 = 16777215
LONGBLOB   : 2 ^ 32 - 1 = 4294967295

    Returns the SQL Snippet used to declare a BLOB column type.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBlobTypeDeclarationSQL() ​Gets the SQL Snippet used to declare a BLOB column type.

    [m] quoteStringLiteral <tag_inheritdoc data-type='' data-description=''>Quotes a literal string.

    Quotes a literal string. 
    public function quoteStringLiteral(string $str): string

    This method is NOT meant to fix SQL injections! It is only meant to escape this platform's string literal quote character inside the given literal string.

    Parameter
    type name summary
    ​string ​$str ​The literal string to be quoted.
    Return
    type summary
    ​string ​The quoted literal string.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::quoteStringLiteral() ​<tag_inheritdoc data-type='' data-description=''>Quotes a literal string.

    [m] getDefaultTransactionIsolationLevel Gets the default transaction isolation level of the platform.

    Gets the default transaction isolation level of the platform. 
    public function getDefaultTransactionIsolationLevel(): Doctrine\DBAL\TransactionIsolationLevel::*()
    Return
    type summary
    ​TransactionIsolationLevel::*() ​The default isolation level.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDefaultTransactionIsolationLevel() ​Gets the default transaction isolation level of the platform.
    See
    type summary
    ​TransactionIsolationLevel ​

    [m] supportsColumnLengthIndexes Whether the platform supports indexes with column length definitions.

    Whether the platform supports indexes with column length definitions. 
    public function supportsColumnLengthIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::supportsColumnLengthIndexes() ​Whether the platform supports indexes with column length definitions.

    [m] getDatabaseNameSQL

    deprecated 

    protected function getDatabaseNameSQL(?string $databaseName): string
    Parameter
    type name summary
    ​?string ​$databaseName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDatabaseNameSQL() ​

    [m] createSchemaManager Creates the schema manager that can be used to inspect and change the underlying

    Creates the schema manager that can be used to inspect and change the underlying 
    public function createSchemaManager(Doctrine\DBAL\Connection $connection): Doctrine\DBAL\Schema\MySQLSchemaManager

    database schema according to the dialect of the platform.

    Parameter
    type name summary
    ​Connection ​$connection ​
    Return
    type summary
    ​MySQLSchemaManager ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::createSchemaManager() ​Creates the schema manager that can be used to inspect and change the underlying

    [m] fetchTableOptionsByTable 

    public function fetchTableOptionsByTable(bool $includeTableName): string
    Parameter
    type name summary
    ​bool ​$includeTableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::fetchTableOptionsByTable() ​

    [m] setDisableTypeComments

    final

    final public function setDisableTypeComments(bool $value)
    Parameter
    type name summary
    ​bool ​$value ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setDisableTypeComments() ​

    [m] setEventManager Sets the EventManager used by the Platform.

    deprecated

    Sets the EventManager used by the Platform. 
    public function setEventManager(Doctrine\Common\EventManager $eventManager): void
    Parameter
    type name summary
    ​EventManager ​$eventManager ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setEventManager() ​Sets the EventManager used by the Platform.

    [m] getEventManager Gets the EventManager used by the Platform.

    deprecated

    Gets the EventManager used by the Platform. 
    public function getEventManager(): Doctrine\Common\EventManager|null
    Return
    type summary
    ​EventManager|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEventManager() ​Gets the EventManager used by the Platform.

    [m] getAsciiStringTypeDeclarationSQL Returns the SQL snippet used to declare a column that can

    Returns the SQL snippet used to declare a column that can 
    public function getAsciiStringTypeDeclarationSQL(array|mixed[] $column): string

    store characters in the ASCII character set

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAsciiStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a column that can

    [m] getVarcharTypeDeclarationSQL Returns the SQL snippet used to declare a VARCHAR column type.

    deprecated

    Returns the SQL snippet used to declare a VARCHAR column type. 
    public function getVarcharTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharTypeDeclarationSQL() ​Returns the SQL snippet used to declare a VARCHAR column type.

    [m] getStringTypeDeclarationSQL Returns the SQL snippet used to declare a string column type.

    Returns the SQL snippet used to declare a string column type. 
    public function getStringTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a string column type.

    [m] getBinaryTypeDeclarationSQL Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    public function getBinaryTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryTypeDeclarationSQL() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getGuidTypeDeclarationSQL Returns the SQL snippet to declare a GUID/UUID column.

    Returns the SQL snippet to declare a GUID/UUID column. 
    public function getGuidTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CHAR(36) and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getGuidTypeDeclarationSQL() ​Returns the SQL snippet to declare a GUID/UUID column.

    [m] registerDoctrineTypeMapping Registers a doctrine type to be used in conjunction with a column type of this platform.

    Registers a doctrine type to be used in conjunction with a column type of this platform. 
    public function registerDoctrineTypeMapping(
    string $dbType,
    string $doctrineType
): void
    Parameter
    type name summary
    ​string ​$dbType ​
    ​string ​$doctrineType ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​If the type is not found.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::registerDoctrineTypeMapping() ​Registers a doctrine type to be used in conjunction with a column type of this platform.

    [m] getDoctrineTypeMapping Gets the Doctrine type that is mapped for the given database column type.

    Gets the Doctrine type that is mapped for the given database column type. 
    public function getDoctrineTypeMapping(string $dbType): string
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeMapping() ​Gets the Doctrine type that is mapped for the given database column type.

    [m] hasDoctrineTypeMappingFor Checks if a database type is currently supported by this platform.

    Checks if a database type is currently supported by this platform. 
    public function hasDoctrineTypeMappingFor(string $dbType): bool
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasDoctrineTypeMappingFor() ​Checks if a database type is currently supported by this platform.

    [m] initializeCommentedDoctrineTypes Initializes the Doctrine Type comments instance variable for in_array() checks.

    deprecated

    Initializes the Doctrine Type comments instance variable for in_array() checks. 
    protected function initializeCommentedDoctrineTypes(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::initializeCommentedDoctrineTypes() ​Initializes the Doctrine Type comments instance variable for in_array() checks.

    [m] isCommentedDoctrineType Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    deprecated

    Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type? 
    public function isCommentedDoctrineType(Doctrine\DBAL\Types\Type $doctrineType): bool
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::isCommentedDoctrineType() ​Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    [m] markDoctrineTypeCommented Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements. 
    public function markDoctrineTypeCommented(string|Doctrine\DBAL\Types\Type $doctrineType): void
    Parameter
    type name summary
    ​string|​Type ​$doctrineType ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::markDoctrineTypeCommented() ​Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    [m] getDoctrineTypeComment Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    deprecated

    Gets the comment to append to a column comment that helps parsing this type in reverse engineering. 
    public function getDoctrineTypeComment(Doctrine\DBAL\Types\Type $doctrineType): string
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeComment() ​Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    [m] getColumnComment Gets the comment of a passed column modified by potential doctrine type comment hints.

    deprecated

    Gets the comment of a passed column modified by potential doctrine type comment hints. 
    protected function getColumnComment(Doctrine\DBAL\Schema\Column $column): string|null
    Parameter
    type name summary
    ​Column ​$column ​
    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnComment() ​Gets the comment of a passed column modified by potential doctrine type comment hints.

    [m] getSqlCommentStartString Gets the string portion that starts an SQL comment.

    deprecated

    Gets the string portion that starts an SQL comment. 
    public function getSqlCommentStartString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentStartString() ​Gets the string portion that starts an SQL comment.

    [m] getSqlCommentEndString Gets the string portion that ends an SQL comment.

    deprecated

    Gets the string portion that ends an SQL comment. 
    public function getSqlCommentEndString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentEndString() ​Gets the string portion that ends an SQL comment.

    [m] getCharMaxLength Gets the maximum length of a char column.

    deprecated

    Gets the maximum length of a char column. 
    public function getCharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCharMaxLength() ​Gets the maximum length of a char column.

    [m] getVarcharDefaultLength Gets the default length of a varchar column.

    deprecated

    Gets the default length of a varchar column. 
    public function getVarcharDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharDefaultLength() ​Gets the default length of a varchar column.

    [m] getBinaryDefaultLength Gets the default length of a binary column.

    deprecated

    Gets the default length of a binary column. 
    public function getBinaryDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryDefaultLength() ​Gets the default length of a binary column.

    [m] getWildcards Gets all SQL wildcard characters of the platform.

    deprecated

    Gets all SQL wildcard characters of the platform. 
    public function getWildcards(): string[]
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWildcards() ​Gets all SQL wildcard characters of the platform.
    See
    type summary
    ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] getAvgExpression Returns the SQL snippet to get the average value of a column.

    deprecated

    Returns the SQL snippet to get the average value of a column. 
    public function getAvgExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an AVG aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAvgExpression() ​Returns the SQL snippet to get the average value of a column.

    [m] getCountExpression Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    deprecated

    Returns the SQL snippet to get the number of rows (without a NULL value) of a column. 
    public function getCountExpression(string|int $column): string

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

    Parameter
    type name summary
    ​string|​int ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a COUNT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCountExpression() ​Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    [m] getMaxExpression Returns the SQL snippet to get the highest value of a column.

    deprecated

    Returns the SQL snippet to get the highest value of a column. 
    public function getMaxExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MAX aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxExpression() ​Returns the SQL snippet to get the highest value of a column.

    [m] getMinExpression Returns the SQL snippet to get the lowest value of a column.

    deprecated

    Returns the SQL snippet to get the lowest value of a column. 
    public function getMinExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MIN aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMinExpression() ​Returns the SQL snippet to get the lowest value of a column.

    [m] getSumExpression Returns the SQL snippet to get the total sum of a column.

    deprecated

    Returns the SQL snippet to get the total sum of a column. 
    public function getSumExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a SUM aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSumExpression() ​Returns the SQL snippet to get the total sum of a column.

    [m] getMd5Expression Returns the SQL snippet to get the md5 sum of a column.

    deprecated

    Returns the SQL snippet to get the md5 sum of a column. 
    public function getMd5Expression(string $column): string

    Note: Not SQL92, but common functionality.

    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMd5Expression() ​Returns the SQL snippet to get the md5 sum of a column.

    [m] getSqrtExpression Returns the SQL snippet to get the squared value of a column.

    deprecated

    Returns the SQL snippet to get the squared value of a column. 
    public function getSqrtExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an SQRT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqrtExpression() ​Returns the SQL snippet to get the squared value of a column.

    [m] getRoundExpression Returns the SQL snippet to round a numeric column to the number of decimals specified.

    deprecated

    Returns the SQL snippet to round a numeric column to the number of decimals specified. 
    public function getRoundExpression(
    string $column,
    string|int $decimals = 0
): string
    Parameter
    type name summary
    ​string ​$column ​
    ​string|​int ​$decimals = 0 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRoundExpression() ​Returns the SQL snippet to round a numeric column to the number of decimals specified.

    [m] getModExpression Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2. 
    public function getModExpression(
    string $expression1,
    string $expression2
): string
    Parameter
    type name summary
    ​string ​$expression1 ​
    ​string ​$expression2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getModExpression() ​Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    [m] getTrimExpression Returns the SQL snippet to trim a string.

    Returns the SQL snippet to trim a string. 
    public function getTrimExpression(
    string $str,
    int $mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED,
    string|bool $char = false
): string
    Parameter
    type name summary
    ​string ​$str ​The expression to apply the trim to.
    ​int ​$mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED ​The position of the trim (leading/trailing/both).
    ​string|​bool ​$char = false ​The char to trim, has to be quoted already. Defaults to space.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTrimExpression() ​Returns the SQL snippet to trim a string.

    [m] getRtrimExpression Returns the SQL snippet to trim trailing space characters from the expression.

    deprecated

    Returns the SQL snippet to trim trailing space characters from the expression. 
    public function getRtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRtrimExpression() ​Returns the SQL snippet to trim trailing space characters from the expression.

    [m] getLtrimExpression Returns the SQL snippet to trim leading space characters from the expression.

    deprecated

    Returns the SQL snippet to trim leading space characters from the expression. 
    public function getLtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLtrimExpression() ​Returns the SQL snippet to trim leading space characters from the expression.

    [m] getUpperExpression Returns the SQL snippet to change all characters from the expression to uppercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to uppercase, 
    public function getUpperExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUpperExpression() ​Returns the SQL snippet to change all characters from the expression to uppercase,

    [m] getLowerExpression Returns the SQL snippet to change all characters from the expression to lowercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to lowercase, 
    public function getLowerExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLowerExpression() ​Returns the SQL snippet to change all characters from the expression to lowercase,

    [m] getNowExpression Returns the SQL snippet to get the current system date.

    deprecated

    Returns the SQL snippet to get the current system date. 
    public function getNowExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getNowExpression() ​Returns the SQL snippet to get the current system date.

    [m] getSubstringExpression Returns a SQL snippet to get a substring inside an SQL statement.

    Returns a SQL snippet to get a substring inside an SQL statement. 
    public function getSubstringExpression(
    string $string,
    string|int $start,
    string|int|null $length = null
): string

    Note: Not SQL92, but common functionality.

    SQLite only supports the 2 parameter variant of this function.

    Parameter
    type name summary
    ​string ​$string ​An sql string literal or column name/alias.
    ​string|​int ​$start ​Where to start the substring portion.
    ​string|​int|​null ​$length = null ​The substring portion length.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSubstringExpression() ​Returns a SQL snippet to get a substring inside an SQL statement.

    [m] getNotExpression Returns the SQL for a logical not.

    deprecated

    Returns the SQL for a logical not. 
    public function getNotExpression(string $expression): string

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

    Parameter
    type name summary
    ​string ​$expression ​
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getNotExpression() ​Returns the SQL for a logical not.

    [m] getIsNullExpression Returns the SQL that checks if an expression is null.

    deprecated

    Returns the SQL that checks if an expression is null. 
    public function getIsNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNullExpression() ​Returns the SQL that checks if an expression is null.

    [m] getIsNotNullExpression Returns the SQL that checks if an expression is not null.

    deprecated

    Returns the SQL that checks if an expression is not null. 
    public function getIsNotNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNotNullExpression() ​Returns the SQL that checks if an expression is not null.

    [m] getBetweenExpression Returns the SQL that checks if an expression evaluates to a value between two values.

    deprecated

    Returns the SQL that checks if an expression evaluates to a value between two values. 
    public function getBetweenExpression(
    string $expression,
    string $value1,
    string $value2
): string

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

    Parameter
    type name summary
    ​string ​$expression ​The value to compare to.
    ​string ​$value1 ​The lower value to compare with.
    ​string ​$value2 ​The higher value to compare with.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBetweenExpression() ​Returns the SQL that checks if an expression evaluates to a value between two values.

    [m] getAcosExpression Returns the SQL to get the arccosine of a value.

    deprecated

    Returns the SQL to get the arccosine of a value. 
    public function getAcosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAcosExpression() ​Returns the SQL to get the arccosine of a value.

    [m] getSinExpression Returns the SQL to get the sine of a value.

    deprecated

    Returns the SQL to get the sine of a value. 
    public function getSinExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSinExpression() ​Returns the SQL to get the sine of a value.

    [m] getPiExpression Returns the SQL to get the PI value.

    deprecated

    Returns the SQL to get the PI value. 
    public function getPiExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPiExpression() ​Returns the SQL to get the PI value.

    [m] getCosExpression Returns the SQL to get the cosine of a value.

    deprecated

    Returns the SQL to get the cosine of a value. 
    public function getCosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCosExpression() ​Returns the SQL to get the cosine of a value.

    [m] getDateAddSecondsExpression Returns the SQL to add the number of given seconds to a date.

    Returns the SQL to add the number of given seconds to a date. 
    public function getDateAddSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddSecondsExpression() ​Returns the SQL to add the number of given seconds to a date.

    [m] getDateSubSecondsExpression Returns the SQL to subtract the number of given seconds from a date.

    Returns the SQL to subtract the number of given seconds from a date. 
    public function getDateSubSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubSecondsExpression() ​Returns the SQL to subtract the number of given seconds from a date.

    [m] getDateAddMinutesExpression Returns the SQL to add the number of given minutes to a date.

    Returns the SQL to add the number of given minutes to a date. 
    public function getDateAddMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMinutesExpression() ​Returns the SQL to add the number of given minutes to a date.

    [m] getDateSubMinutesExpression Returns the SQL to subtract the number of given minutes from a date.

    Returns the SQL to subtract the number of given minutes from a date. 
    public function getDateSubMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMinutesExpression() ​Returns the SQL to subtract the number of given minutes from a date.

    [m] getDateAddHourExpression Returns the SQL to add the number of given hours to a date.

    Returns the SQL to add the number of given hours to a date. 
    public function getDateAddHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddHourExpression() ​Returns the SQL to add the number of given hours to a date.

    [m] getDateSubHourExpression Returns the SQL to subtract the number of given hours to a date.

    Returns the SQL to subtract the number of given hours to a date. 
    public function getDateSubHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubHourExpression() ​Returns the SQL to subtract the number of given hours to a date.

    [m] getDateAddDaysExpression Returns the SQL to add the number of given days to a date.

    Returns the SQL to add the number of given days to a date. 
    public function getDateAddDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddDaysExpression() ​Returns the SQL to add the number of given days to a date.

    [m] getDateSubDaysExpression Returns the SQL to subtract the number of given days to a date.

    Returns the SQL to subtract the number of given days to a date. 
    public function getDateSubDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubDaysExpression() ​Returns the SQL to subtract the number of given days to a date.

    [m] getDateAddWeeksExpression Returns the SQL to add the number of given weeks to a date.

    Returns the SQL to add the number of given weeks to a date. 
    public function getDateAddWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddWeeksExpression() ​Returns the SQL to add the number of given weeks to a date.

    [m] getDateSubWeeksExpression Returns the SQL to subtract the number of given weeks from a date.

    Returns the SQL to subtract the number of given weeks from a date. 
    public function getDateSubWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubWeeksExpression() ​Returns the SQL to subtract the number of given weeks from a date.

    [m] getDateAddMonthExpression Returns the SQL to add the number of given months to a date.

    Returns the SQL to add the number of given months to a date. 
    public function getDateAddMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMonthExpression() ​Returns the SQL to add the number of given months to a date.

    [m] getDateSubMonthExpression Returns the SQL to subtract the number of given months to a date.

    Returns the SQL to subtract the number of given months to a date. 
    public function getDateSubMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMonthExpression() ​Returns the SQL to subtract the number of given months to a date.

    [m] getDateAddQuartersExpression Returns the SQL to add the number of given quarters to a date.

    Returns the SQL to add the number of given quarters to a date. 
    public function getDateAddQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddQuartersExpression() ​Returns the SQL to add the number of given quarters to a date.

    [m] getDateSubQuartersExpression Returns the SQL to subtract the number of given quarters from a date.

    Returns the SQL to subtract the number of given quarters from a date. 
    public function getDateSubQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubQuartersExpression() ​Returns the SQL to subtract the number of given quarters from a date.

    [m] getDateAddYearsExpression Returns the SQL to add the number of given years to a date.

    Returns the SQL to add the number of given years to a date. 
    public function getDateAddYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddYearsExpression() ​Returns the SQL to add the number of given years to a date.

    [m] getDateSubYearsExpression Returns the SQL to subtract the number of given years from a date.

    Returns the SQL to subtract the number of given years from a date. 
    public function getDateSubYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubYearsExpression() ​Returns the SQL to subtract the number of given years from a date.

    [m] multiplyInterval Generates the SQL expression which represents the given date interval multiplied by a number

    Generates the SQL expression which represents the given date interval multiplied by a number 
    protected function multiplyInterval(
    string $interval,
    int $multiplier
): string
    Parameter
    type name summary
    ​string ​$interval ​SQL expression describing the interval value
    ​int ​$multiplier ​Interval multiplier
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::multiplyInterval() ​Generates the SQL expression which represents the given date interval multiplied by a number

    [m] getBitAndComparisonExpression Returns the SQL bit AND comparison expression.

    Returns the SQL bit AND comparison expression. 
    public function getBitAndComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitAndComparisonExpression() ​Returns the SQL bit AND comparison expression.

    [m] getBitOrComparisonExpression Returns the SQL bit OR comparison expression.

    Returns the SQL bit OR comparison expression. 
    public function getBitOrComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitOrComparisonExpression() ​Returns the SQL bit OR comparison expression.

    [m] getForUpdateSQL Returns the FOR UPDATE expression.

    deprecated

    Returns the FOR UPDATE expression. 
    public function getForUpdateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForUpdateSQL() ​Returns the FOR UPDATE expression.

    [m] appendLockHint Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    Honors that some SQL vendors such as MsSql use table hints for locking instead of the 
    public function appendLockHint(
    string $fromClause,
    int $lockMode
): string

    ANSI SQL FOR UPDATE specification.

    Parameter
    type name summary
    ​string ​$fromClause ​The FROM clause to append the hint for the given lock mode to
    ​int ​$lockMode ​One of the Doctrine\DBAL\LockMode::* constants
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::appendLockHint() ​Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    [m] getWriteLockSQL Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows. 
    public function getWriteLockSQL(): string

    The semantics of this lock mode should equal the SELECT .. FOR UPDATE of the ANSI SQL standard.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWriteLockSQL() ​Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    [m] getDropTableSQL Returns the SQL snippet to drop an existing table.

    Returns the SQL snippet to drop an existing table. 
    public function getDropTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTableSQL() ​Returns the SQL snippet to drop an existing table.

    [m] getDropConstraintSQL Returns the SQL to drop a constraint.

    Returns the SQL to drop a constraint. 
    public function getDropConstraintSQL(
    Doctrine\DBAL\Schema\Constraint|string $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint|​string ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropConstraintSQL() ​Returns the SQL to drop a constraint.
    See
    type summary
    ​AbstractPlatform ​

    [m] getDropForeignKeySQL Returns the SQL to drop a foreign key.

    Returns the SQL to drop a foreign key. 
    public function getDropForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropForeignKeySQL() ​Returns the SQL to drop a foreign key.

    [m] getCreateTableSQL Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    Returns the SQL statement(s) to create a table with the specified name, columns and constraints 
    public function getCreateTableSQL(
    Doctrine\DBAL\Schema\Table $table,
    int $createFlags = self::CREATE_INDEXES
): list

    on this platform.

    Parameter
    type name summary
    ​Table ​$table ​
    ​int ​$createFlags = self::CREATE_INDEXES ​
    Return
    type summary
    ​list ​The list of SQL statements.
    Throws
    type summary
    ​Exception ​
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableSQL() ​Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    [m] getCreateTableWithoutForeignKeysSQL

    final

    final protected function getCreateTableWithoutForeignKeysSQL(Doctrine\DBAL\Schema\Table $table): array|list
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableWithoutForeignKeysSQL() ​

    [m] getDropTablesSQL 

    public function getDropTablesSQL(array|list $tables): array|list
    Parameter
    type name summary
    ​array|​list ​$tables ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTablesSQL() ​

    [m] getCommentOnTableSQL 

    protected function getCommentOnTableSQL(
    string $tableName,
    ?string $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​?string ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnTableSQL() ​

    [m] getCommentOnColumnSQL 

    public function getCommentOnColumnSQL(
    string $tableName,
    string $columnName,
    string|null $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    ​string|​null ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnColumnSQL() ​

    [m] getInlineColumnCommentSQL Returns the SQL to create inline comment on a column.

    Returns the SQL to create inline comment on a column. 
    public function getInlineColumnCommentSQL(string $comment): string
    Parameter
    type name summary
    ​string ​$comment ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getInlineColumnCommentSQL() ​Returns the SQL to create inline comment on a column.

    [m] getCreateTemporaryTableSnippetSQL 

    public function getCreateTemporaryTableSnippetSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTemporaryTableSnippetSQL() ​

    [m] getAlterSchemaSQL Generates SQL statements that can be used to apply the diff.

    Generates SQL statements that can be used to apply the diff. 
    public function getAlterSchemaSQL(Doctrine\DBAL\Schema\SchemaDiff $diff): array|list
    Parameter
    type name summary
    ​SchemaDiff ​$diff ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAlterSchemaSQL() ​Generates SQL statements that can be used to apply the diff.

    [m] getCreateSequenceSQL Returns the SQL to create a sequence on this platform.

    Returns the SQL to create a sequence on this platform. 
    public function getCreateSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateSequenceSQL() ​Returns the SQL to create a sequence on this platform.

    [m] getAlterSequenceSQL Returns the SQL to change a sequence on this platform.

    Returns the SQL to change a sequence on this platform. 
    public function getAlterSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAlterSequenceSQL() ​Returns the SQL to change a sequence on this platform.

    [m] getDropSequenceSQL Returns the SQL snippet to drop an existing sequence.

    Returns the SQL snippet to drop an existing sequence. 
    public function getDropSequenceSQL(Doctrine\DBAL\Schema\Sequence|string $sequence): string
    Parameter
    type name summary
    ​Sequence|​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSequenceSQL() ​Returns the SQL snippet to drop an existing sequence.

    [m] getCreateConstraintSQL Returns the SQL to create a constraint on a table on this platform.

    deprecated

    Returns the SQL to create a constraint on a table on this platform. 
    public function getCreateConstraintSQL(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateConstraintSQL() ​Returns the SQL to create a constraint on a table on this platform.
    See
    type summary
    ​AbstractPlatform::getCreateIndexSQL() ​
    ​AbstractPlatform::getCreateForeignKeySQL() ​

    [m] getCreateIndexSQL Returns the SQL to create an index on a table on this platform.

    Returns the SQL to create an index on a table on this platform. 
    public function getCreateIndexSQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateIndexSQL() ​Returns the SQL to create an index on a table on this platform.

    [m] getPartialIndexSQL Adds condition for partial index.

    Adds condition for partial index. 
    protected function getPartialIndexSQL(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPartialIndexSQL() ​Adds condition for partial index.

    [m] getCreatePrimaryKeySQL Returns the SQL to create an unnamed primary key constraint.

    Returns the SQL to create an unnamed primary key constraint. 
    public function getCreatePrimaryKeySQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreatePrimaryKeySQL() ​Returns the SQL to create an unnamed primary key constraint.

    [m] getCreateSchemaSQL Returns the SQL to create a named schema.

    Returns the SQL to create a named schema. 
    public function getCreateSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateSchemaSQL() ​Returns the SQL to create a named schema.

    [m] getCreateUniqueConstraintSQL Returns the SQL to create a unique constraint on a table on this platform.

    Returns the SQL to create a unique constraint on a table on this platform. 
    public function getCreateUniqueConstraintSQL(
    Doctrine\DBAL\Schema\UniqueConstraint $constraint,
    string $tableName
): string
    Parameter
    type name summary
    ​UniqueConstraint ​$constraint ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateUniqueConstraintSQL() ​Returns the SQL to create a unique constraint on a table on this platform.

    [m] getDropSchemaSQL Returns the SQL snippet to drop a schema.

    Returns the SQL snippet to drop a schema. 
    public function getDropSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSchemaSQL() ​Returns the SQL snippet to drop a schema.

    [m] quoteIdentifier Quotes a string so that it can be safely used as a table or column name,

    Quotes a string so that it can be safely used as a table or column name, 
    public function quoteIdentifier(string $str): string

    even if it is a reserved word of the platform. This also detects identifier chains separated by dot and quotes them independently.

    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.

    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteIdentifier() ​Quotes a string so that it can be safely used as a table or column name,

    [m] quoteSingleIdentifier Quotes a single identifier (no dot chain separation).

    Quotes a single identifier (no dot chain separation). 
    public function quoteSingleIdentifier(string $str): string
    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteSingleIdentifier() ​Quotes a single identifier (no dot chain separation).

    [m] getCreateForeignKeySQL Returns the SQL to create a new foreign key.

    Returns the SQL to create a new foreign key. 
    public function getCreateForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key constraint.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateForeignKeySQL() ​Returns the SQL to create a new foreign key.

    [m] getRenameTableSQL 

    public function getRenameTableSQL(
    string $oldName,
    string $newName
): array|list
    Parameter
    type name summary
    ​string ​$oldName ​
    ​string ​$newName ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRenameTableSQL() ​

    [m] onSchemaAlterTableAddColumn 

    protected function onSchemaAlterTableAddColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    mixed[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​mixed[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableAddColumn() ​

    [m] onSchemaAlterTableRemoveColumn 

    protected function onSchemaAlterTableRemoveColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRemoveColumn() ​

    [m] onSchemaAlterTableChangeColumn 

    protected function onSchemaAlterTableChangeColumn(
    Doctrine\DBAL\Schema\ColumnDiff $columnDiff,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​ColumnDiff ​$columnDiff ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableChangeColumn() ​

    [m] onSchemaAlterTableRenameColumn 

    protected function onSchemaAlterTableRenameColumn(
    string $oldColumnName,
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​string ​$oldColumnName ​
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRenameColumn() ​

    [m] onSchemaAlterTable 

    protected function onSchemaAlterTable(
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$sql
): bool
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    ​string[] ​&$sql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTable() ​

    [m] getRenameIndexSQL Returns the SQL for renaming an index on a table.

    Returns the SQL for renaming an index on a table. 
    protected function getRenameIndexSQL(
    string $oldIndexName,
    Doctrine\DBAL\Schema\Index $index,
    string $tableName
): string[]
    Parameter
    type name summary
    ​string ​$oldIndexName ​The name of the index to rename from.
    ​Index ​$index ​The definition of the index to rename to.
    ​string ​$tableName ​The table to rename the given index on.
    Return
    type summary
    ​string[] ​The sequence of SQL statements for renaming the given index.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRenameIndexSQL() ​Returns the SQL for renaming an index on a table.

    [m] getColumnDeclarationListSQL Gets declaration of a number of columns in bulk.

    Gets declaration of a number of columns in bulk. 
    public function getColumnDeclarationListSQL(array|mixed[][] $columns): string
    Parameter
    type name summary
    ​array|​mixed[][] ​$columns ​A multidimensional associative array.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationListSQL() ​Gets declaration of a number of columns in bulk.

    [m] getColumnDeclarationSQL Obtains DBMS specific SQL code portion needed to declare a generic type

    Obtains DBMS specific SQL code portion needed to declare a generic type 
    public function getColumnDeclarationSQL(
    string $name,
    array|mixed[] $column
): string

    column to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name the column to be declared.
    ​array|​mixed[] ​$column ​An associative array with the name of the properties
    Return
    type summary
    ​string ​DBMS specific SQL code portion that should be used to declare the column.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to declare a generic type

    [m] getCheckDeclarationSQL Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    Obtains DBMS specific SQL code portion needed to set a CHECK constraint 
    public function getCheckDeclarationSQL(array|string[]|mixed[][] $definition): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​string[]|​mixed[][] ​$definition ​The check definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a CHECK constraint.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCheckDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    [m] getUniqueConstraintDeclarationSQL Obtains DBMS specific SQL code portion needed to set a unique

    Obtains DBMS specific SQL code portion needed to set a unique 
    public function getUniqueConstraintDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\UniqueConstraint $constraint
): string

    constraint declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the unique constraint.
    ​UniqueConstraint ​$constraint ​The unique constraint definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a constraint.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueConstraintDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a unique

    [m] getIndexDeclarationSQL Obtains DBMS specific SQL code portion needed to set an index

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\Index $index
): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the index.
    ​Index ​$index ​The index definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set an index.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getCustomTypeDeclarationSQL Obtains SQL code portion needed to create a custom column,

    deprecated

    Obtains SQL code portion needed to create a custom column, 
    public function getCustomTypeDeclarationSQL(array|mixed[] $column): string

    e.g. when a column has the "columnDefinition" keyword. Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCustomTypeDeclarationSQL() ​Obtains SQL code portion needed to create a custom column,

    [m] getIndexFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexFieldDeclarationListSQL(Doctrine\DBAL\Schema\Index $index): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getColumnsFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getColumnsFieldDeclarationListSQL(array|mixed[] $columns): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$columns ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnsFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getTemporaryTableSQL Returns the required SQL string that fits between CREATE ... TABLE

    deprecated

    Returns the required SQL string that fits between CREATE ... TABLE 
    public function getTemporaryTableSQL(): string

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

    Return
    type summary
    ​string ​The string required to be placed between "CREATE" and "TABLE"
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableSQL() ​Returns the required SQL string that fits between CREATE ... TABLE

    [m] getTemporaryTableName Some vendors require temporary table names to be qualified specially.

    Some vendors require temporary table names to be qualified specially. 
    public function getTemporaryTableName(string $tableName): string
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableName() ​Some vendors require temporary table names to be qualified specially.

    [m] getForeignKeyDeclarationSQL Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyDeclarationSQL() ​Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getForeignKeyReferentialActionSQL Returns the given referential action in uppercase if valid, otherwise throws an exception.

    Returns the given referential action in uppercase if valid, otherwise throws an exception. 
    public function getForeignKeyReferentialActionSQL(string $action): string
    Parameter
    type name summary
    ​string ​$action ​The foreign key referential action.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​If unknown referential action given.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyReferentialActionSQL() ​Returns the given referential action in uppercase if valid, otherwise throws an exception.

    [m] getForeignKeyBaseDeclarationSQL Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyBaseDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyBaseDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getUniqueFieldDeclarationSQL Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    deprecated

    Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint 
    public function getUniqueFieldDeclarationSQL(): string

    of a column declaration to be used in statements like CREATE TABLE.

    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the UNIQUE constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueFieldDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    [m] getColumnCollationDeclarationSQL Obtains DBMS specific SQL code portion needed to set the COLLATION

    Obtains DBMS specific SQL code portion needed to set the COLLATION 
    public function getColumnCollationDeclarationSQL(string $collation): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$collation ​The name of the collation.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the COLLATION
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnCollationDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the COLLATION

    [m] convertBooleans Some platforms need the boolean values to be converted.

    Some platforms need the boolean values to be converted. 
    public function convertBooleans(mixed $item): mixed

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

    Note: if the input is not a boolean the original input might be returned.

    There are two contexts when converting booleans: Literals and Prepared Statements. This method should handle the literal case

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertBooleans() ​Some platforms need the boolean values to be converted.

    [m] convertFromBoolean Some platforms have boolean literals that needs to be correctly converted

    Some platforms have boolean literals that needs to be correctly converted 
    public function convertFromBoolean(T $item): (T

    The default conversion tries to convert value into bool "(bool)$item"

    Parameter
    type name summary
    ​T ​$item ​
    Return
    type summary
    ​(T ​is null ? null : bool)
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertFromBoolean() ​Some platforms have boolean literals that needs to be correctly converted

    [m] convertBooleansToDatabaseValue This method should handle the prepared statements case. When there is no

    This method should handle the prepared statements case. When there is no 
    public function convertBooleansToDatabaseValue(mixed $item): mixed

    distinction, it's OK to use the same method.

    Note: if the input is not a boolean the original input might be returned.

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertBooleansToDatabaseValue() ​This method should handle the prepared statements case. When there is no

    [m] getCurrentDateSQL Returns the SQL specific for the platform to get the current date.

    Returns the SQL specific for the platform to get the current date. 
    public function getCurrentDateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentDateSQL() ​Returns the SQL specific for the platform to get the current date.

    [m] getCurrentTimeSQL Returns the SQL specific for the platform to get the current time.

    Returns the SQL specific for the platform to get the current time. 
    public function getCurrentTimeSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimeSQL() ​Returns the SQL specific for the platform to get the current time.

    [m] getCurrentTimestampSQL Returns the SQL specific for the platform to get the current timestamp

    Returns the SQL specific for the platform to get the current timestamp 
    public function getCurrentTimestampSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimestampSQL() ​Returns the SQL specific for the platform to get the current timestamp

    [m] _getTransactionIsolationLevelSQL Returns the SQL for a given transaction isolation level Connection constant.

    Returns the SQL for a given transaction isolation level Connection constant. 
    protected function _getTransactionIsolationLevelSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::_getTransactionIsolationLevelSQL() ​Returns the SQL for a given transaction isolation level Connection constant.

    [m] getListNamespacesSQL Returns the SQL statement for retrieving the namespaces defined in the database.

    deprecated

    Returns the SQL statement for retrieving the namespaces defined in the database. 
    public function getListNamespacesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListNamespacesSQL() ​Returns the SQL statement for retrieving the namespaces defined in the database.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] getListSequencesSQL 

    public function getListSequencesSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListSequencesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​

    [m] getListUsersSQL

    deprecated 

    public function getListUsersSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListUsersSQL() ​

    [m] getCreateViewSQL 

    public function getCreateViewSQL(
    string $name,
    string $sql
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$sql ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateViewSQL() ​

    [m] getDropViewSQL 

    public function getDropViewSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropViewSQL() ​

    [m] getSequenceNextValSQL 

    public function getSequenceNextValSQL(string $sequence): string
    Parameter
    type name summary
    ​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSequenceNextValSQL() ​

    [m] getCreateDatabaseSQL Returns the SQL to create a new database.

    Returns the SQL to create a new database. 
    public function getCreateDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateDatabaseSQL() ​Returns the SQL to create a new database.

    [m] getDropDatabaseSQL Returns the SQL snippet to drop an existing database.

    Returns the SQL snippet to drop an existing database. 
    public function getDropDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be dropped.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropDatabaseSQL() ​Returns the SQL snippet to drop an existing database.

    [m] getDateTimeTzTypeDeclarationSQL Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    Obtains DBMS specific SQL to be used to create datetime with timezone offset columns. 
    public function getDateTimeTzTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeTzTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    [m] supportsSequences Whether the platform supports sequences.

    Whether the platform supports sequences. 
    public function supportsSequences(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSequences() ​Whether the platform supports sequences.

    [m] usesSequenceEmulatedIdentityColumns Whether the platform emulates identity columns through sequences.

    deprecated

    Whether the platform emulates identity columns through sequences. 
    public function usesSequenceEmulatedIdentityColumns(): bool

    Some platforms that do not support identity columns natively but support sequences can emulate identity columns by using sequences.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::usesSequenceEmulatedIdentityColumns() ​Whether the platform emulates identity columns through sequences.

    [m] getIdentitySequenceName Returns the name of the sequence for a particular identity column in a particular table.

    deprecated

    Returns the name of the sequence for a particular identity column in a particular table. 
    public function getIdentitySequenceName(
    string $tableName,
    string $columnName
): string
    Parameter
    type name summary
    ​string ​$tableName ​The name of the table to return the sequence name for.
    ​string ​$columnName ​The name of the identity column in the table to return the sequence name for.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIdentitySequenceName() ​Returns the name of the sequence for a particular identity column in a particular table.
    See
    type summary
    ​usesSequenceEmulatedIdentityColumns ​

    [m] supportsIndexes Whether the platform supports indexes.

    deprecated

    Whether the platform supports indexes. 
    public function supportsIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsIndexes() ​Whether the platform supports indexes.

    [m] supportsPartialIndexes Whether the platform supports partial indexes.

    Whether the platform supports partial indexes. 
    public function supportsPartialIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPartialIndexes() ​Whether the platform supports partial indexes.

    [m] supportsAlterTable Whether the platform supports altering tables.

    deprecated

    Whether the platform supports altering tables. 
    public function supportsAlterTable(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsAlterTable() ​Whether the platform supports altering tables.

    [m] supportsTransactions Whether the platform supports transactions.

    deprecated

    Whether the platform supports transactions. 
    public function supportsTransactions(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsTransactions() ​Whether the platform supports transactions.

    [m] supportsSavepoints Whether the platform supports savepoints.

    Whether the platform supports savepoints. 
    public function supportsSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSavepoints() ​Whether the platform supports savepoints.

    [m] supportsReleaseSavepoints Whether the platform supports releasing savepoints.

    Whether the platform supports releasing savepoints. 
    public function supportsReleaseSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsReleaseSavepoints() ​Whether the platform supports releasing savepoints.

    [m] supportsPrimaryConstraints Whether the platform supports primary key constraints.

    deprecated

    Whether the platform supports primary key constraints. 
    public function supportsPrimaryConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPrimaryConstraints() ​Whether the platform supports primary key constraints.

    [m] supportsForeignKeyConstraints Whether the platform supports foreign key constraints.

    deprecated

    Whether the platform supports foreign key constraints. 
    public function supportsForeignKeyConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsForeignKeyConstraints() ​Whether the platform supports foreign key constraints.

    [m] supportsSchemas Whether the platform supports database schemas.

    Whether the platform supports database schemas. 
    public function supportsSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSchemas() ​Whether the platform supports database schemas.

    [m] canEmulateSchemas Whether this platform can emulate schemas.

    deprecated

    Whether this platform can emulate schemas. 
    public function canEmulateSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::canEmulateSchemas() ​Whether this platform can emulate schemas.
    See
    type summary
    ​AbstractManager::introspectSchema() ​

    [m] getDefaultSchemaName Returns the default schema name.

    deprecated

    Returns the default schema name. 
    public function getDefaultSchemaName(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDefaultSchemaName() ​Returns the default schema name.

    [m] supportsCreateDropDatabase Whether this platform supports create database.

    deprecated

    Whether this platform supports create database. 
    public function supportsCreateDropDatabase(): bool

    Some databases don't allow to create and drop databases at all or only with certain tools.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsCreateDropDatabase() ​Whether this platform supports create database.

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

    deprecated

    Whether the platform supports getting the affected rows of a recent update/delete type query. 
    public function supportsGettingAffectedRows(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsGettingAffectedRows() ​Whether the platform supports getting the affected rows of a recent update/delete type query.

    [m] supportsCommentOnStatement Whether this platform support the proprietary syntax "COMMENT ON asset".

    Whether this platform support the proprietary syntax "COMMENT ON asset". 
    public function supportsCommentOnStatement(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsCommentOnStatement() ​Whether this platform support the proprietary syntax "COMMENT ON asset".

    [m] hasNativeGuidType Does this platform have native guid type.

    deprecated

    Does this platform have native guid type. 
    public function hasNativeGuidType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasNativeGuidType() ​Does this platform have native guid type.

    [m] hasNativeJsonType Does this platform have native JSON type.

    deprecated

    Does this platform have native JSON type. 
    public function hasNativeJsonType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasNativeJsonType() ​Does this platform have native JSON type.

    [m] supportsViews Whether this platform supports views.

    deprecated

    Whether this platform supports views. 
    public function supportsViews(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsViews() ​Whether this platform supports views.

    [m] getDateTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeFormatString(): string

    the format of a stored datetime value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateTimeTzFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeTzFormatString(): string

    the format of a stored datetime with timezone value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeTzFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateFormatString(): string

    the format of a stored date value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getTimeFormatString(): string

    the format of a stored time value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] modifyLimitQuery Adds an driver-specific LIMIT clause to the query.

    final

    Adds an driver-specific LIMIT clause to the query. 
    final public function modifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset = 0
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset = 0 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::modifyLimitQuery() ​Adds an driver-specific LIMIT clause to the query.

    [m] supportsLimitOffset Whether the database platform support offsets in modify limit clauses.

    deprecated

    Whether the database platform support offsets in modify limit clauses. 
    public function supportsLimitOffset(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsLimitOffset() ​Whether the database platform support offsets in modify limit clauses.

    [m] getMaxIdentifierLength Maximum length of any given database identifier, like tables or column names.

    Maximum length of any given database identifier, like tables or column names. 
    public function getMaxIdentifierLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxIdentifierLength() ​Maximum length of any given database identifier, like tables or column names.

    [m] getEmptyIdentityInsertSQL Returns the insert SQL for an empty insert statement.

    Returns the insert SQL for an empty insert statement. 
    public function getEmptyIdentityInsertSQL(
    string $quotedTableName,
    string $quotedIdentifierColumnName
): string
    Parameter
    type name summary
    ​string ​$quotedTableName ​
    ​string ​$quotedIdentifierColumnName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEmptyIdentityInsertSQL() ​Returns the insert SQL for an empty insert statement.

    [m] getTruncateTableSQL Generates a Truncate Table SQL statement for a given table.

    Generates a Truncate Table SQL statement for a given table. 
    public function getTruncateTableSQL(
    string $tableName,
    bool $cascade = false
): string

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

    Parameter
    type name summary
    ​string ​$tableName ​
    ​bool ​$cascade = false ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTruncateTableSQL() ​Generates a Truncate Table SQL statement for a given table.

    [m] getDummySelectSQL This is for test reasons, many vendors have special requirements for dummy statements.

    This is for test reasons, many vendors have special requirements for dummy statements. 
    public function getDummySelectSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDummySelectSQL() ​This is for test reasons, many vendors have special requirements for dummy statements.

    [m] createSavePoint Returns the SQL to create a new savepoint.

    Returns the SQL to create a new savepoint. 
    public function createSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSavePoint() ​Returns the SQL to create a new savepoint.

    [m] releaseSavePoint Returns the SQL to release a savepoint.

    Returns the SQL to release a savepoint. 
    public function releaseSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::releaseSavePoint() ​Returns the SQL to release a savepoint.

    [m] rollbackSavePoint Returns the SQL to rollback a savepoint.

    Returns the SQL to rollback a savepoint. 
    public function rollbackSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::rollbackSavePoint() ​Returns the SQL to rollback a savepoint.

    [m] getReservedKeywordsList Returns the keyword list instance of this platform.

    final

    Returns the keyword list instance of this platform. 
    final public function getReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList
    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​If no keyword list is specified.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getReservedKeywordsList() ​Returns the keyword list instance of this platform.

    [m] createReservedKeywordsList Creates an instance of the reserved keyword list of this platform.

    Creates an instance of the reserved keyword list of this platform. 
    protected function createReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList

    This method will become @abstract in DBAL 4.0.0.

    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createReservedKeywordsList() ​Creates an instance of the reserved keyword list of this platform.

    [m] getStringLiteralQuoteCharacter Gets the character used for string literal quoting.

    deprecated

    Gets the character used for string literal quoting. 
    public function getStringLiteralQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringLiteralQuoteCharacter() ​Gets the character used for string literal quoting.
    See
    type summary
    ​AbstractPlatform::quoteStringLiteral() ​

    [m] escapeStringForLike Escapes metacharacters in a string intended to be used with a LIKE

    final

    Escapes metacharacters in a string intended to be used with a LIKE 
    final public function escapeStringForLike(
    string $inputString,
    string $escapeChar
): string

    operator.

    Parameter
    type name summary
    ​string ​$inputString ​a literal, unquoted string
    ​string ​$escapeChar ​should be reused by the caller in the LIKE
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::escapeStringForLike() ​Escapes metacharacters in a string intended to be used with a LIKE

    [m] createSQLParser 

    public function createSQLParser(): Doctrine\DBAL\SQL\Parser
    Return
    type summary
    ​Parser ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSQLParser() ​

    [m] getLikeWildcardCharacters 

    protected function getLikeWildcardCharacters(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] columnsEqual Compares the definitions of the given columns in the context of this platform.

    Compares the definitions of the given columns in the context of this platform. 
    public function columnsEqual(
    Doctrine\DBAL\Schema\Column $column1,
    Doctrine\DBAL\Schema\Column $column2
): bool
    Parameter
    type name summary
    ​Column ​$column1 ​
    ​Column ​$column2 ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::columnsEqual() ​Compares the definitions of the given columns in the context of this platform.

    [C] MariaDBPlatform Provides the behavior, features and SQL dialect of the MariaDB database platform of the oldest supported version.

    Provides the behavior, features and SQL dialect of the MariaDB database platform of the oldest supported version.

    Hierarchy

    Parents
    type summary
    ​MySQLPlatform ​Provides the behavior, features and SQL dialect of the Oracle MySQL database platform
    ​AbstractMySQLPlatform ​Provides the base implementation for the lowest versions of supported MySQL-like database platforms.
    ​AbstractPlatform ​Base class for all DatabasePlatforms. The DatabasePlatforms are the central

    [C] LENGTH_LIMIT_TINYTEXT 

    public const int LENGTH_LIMIT_TINYTEXT = 255
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_TINYTEXT ​

    [C] LENGTH_LIMIT_TEXT 

    public const int LENGTH_LIMIT_TEXT = 65535
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_TEXT ​

    [C] LENGTH_LIMIT_MEDIUMTEXT 

    public const int LENGTH_LIMIT_MEDIUMTEXT = 16777215
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_MEDIUMTEXT ​

    [C] LENGTH_LIMIT_TINYBLOB 

    public const int LENGTH_LIMIT_TINYBLOB = 255
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_TINYBLOB ​

    [C] LENGTH_LIMIT_BLOB 

    public const int LENGTH_LIMIT_BLOB = 65535
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_BLOB ​

    [C] LENGTH_LIMIT_MEDIUMBLOB 

    public const int LENGTH_LIMIT_MEDIUMBLOB = 16777215
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::LENGTH_LIMIT_MEDIUMBLOB ​

    [C] CREATE_INDEXES 

    public const int CREATE_INDEXES = 1
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_INDEXES ​

    [C] CREATE_FOREIGNKEYS 

    public const int CREATE_FOREIGNKEYS = 2
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::CREATE_FOREIGNKEYS ​

    [p] $doctrineTypeMapping 

    protected string[]|null $doctrineTypeMapping = null

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeMapping ​

    [p] $doctrineTypeComments Contains a list of all columns that should generate parseable column comments for type-detection

    deprecated

    Contains a list of all columns that should generate parseable column comments for type-detection 
    protected string[]|null $doctrineTypeComments = null

    in reverse engineering scenarios.

    Type: string[]|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$doctrineTypeComments ​Contains a list of all columns that should generate parseable column comments for type-detection

    [p] $_eventManager

    deprecated 

    protected Doctrine\Common\EventManager|null $_eventManager = null

    Type: EventManager|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_eventManager ​

    [p] $_keywords Holds the KeywordList instance for the current platform.

    Holds the KeywordList instance for the current platform. 
    protected Doctrine\DBAL\Platforms\Keywords\KeywordList|null $_keywords = null

    Type: KeywordList|​null

    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::$_keywords ​Holds the KeywordList instance for the current platform.

    [m] getDefaultValueDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set a default value

    Obtains DBMS specific SQL code portion needed to set a default value 
    public function getDefaultValueDeclarationSQL(mixed[] $column): string

    declaration to be used in statements like CREATE TABLE.

    Hop over the Doctrine\DBAL\Platforms\AbstractMySQLPlatform implementation until 4.0.x where Doctrine\DBAL\Platforms\MariaDBPlatform no longer extends Doctrine\DBAL\Platforms\MySQLPlatform.

    Parameter
    type name summary
    ​mixed[] ​$column ​The column definition array.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a default value.
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getDefaultValueDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a default value
    See
    type summary
    ​AbstractMySQLPlatform ​
    ​MariaDBPlatform ​
    ​MySQLPlatform ​
    ​AbstractPlatform ​

    [m] getJsonTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to declare a JSON column.

    Returns the SQL snippet to declare a JSON column. 
    public function getJsonTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CLOB and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getJsonTypeDeclarationSQL() ​Returns the SQL snippet to declare a JSON column.

    [m] getReservedKeywordsClass

    deprecated 

    protected function getReservedKeywordsClass(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::getReservedKeywordsClass() ​Returns the class name of the reserved keywords list.
    See
    type summary
    ​MariaDBPlatform::createReservedKeywordsList() ​

    [m] initializeDoctrineTypeMappings Lazy load Doctrine Type Mappings.

    Lazy load Doctrine Type Mappings. 
    protected function initializeDoctrineTypeMappings(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​override ​AbstractPlatform::initializeDoctrineTypeMappings() ​Lazy load Doctrine Type Mappings.

    [m] doModifyLimitQuery Adds an platform-specific LIMIT clause to the query.

    Adds an platform-specific LIMIT clause to the query. 
    protected function doModifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::doModifyLimitQuery() ​Adds an platform-specific LIMIT clause to the query.

    [m] getIdentifierQuoteCharacter Gets the character used for identifier quoting.

    deprecated

    Gets the character used for identifier quoting. 
    public function getIdentifierQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getIdentifierQuoteCharacter() ​Gets the character used for identifier quoting.
    See
    type summary
    ​AbstractMySQLPlatform::quoteIdentifier() ​
    ​AbstractPlatform::quoteIdentifier() ​

    [m] getRegexpExpression Returns the regular expression operator.

    Returns the regular expression operator. 
    public function getRegexpExpression(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getRegexpExpression() ​Returns the regular expression operator.

    [m] getLocateExpression Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str. 
    public function getLocateExpression(
    string $str,
    string $substr,
    string|int|false $startPos = false
): string
    Parameter
    type name summary
    ​string ​$str ​Literal string.
    ​string ​$substr ​Literal string to find.
    ​string|​int|​false ​$startPos = false ​Position to start at, beginning of string by default.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getLocateExpression() ​Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str.

    [m] getConcatExpression <tag_inheritdoc data-type='' data-description=''>Returns a SQL snippet to concatenate the given expressions.

    Returns a SQL snippet to concatenate the given expressions. 
    public function getConcatExpression(): string

    Accepts an arbitrary number of string parameters. Each parameter must contain an expression.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getConcatExpression() ​<tag_inheritdoc data-type='' data-description=''>Returns a SQL snippet to concatenate the given expressions.

    [m] getDateArithmeticIntervalExpression Returns the SQL for a date arithmetic expression.

    Returns the SQL for a date arithmetic expression. 
    protected function getDateArithmeticIntervalExpression(
    string $date,
    string $operator,
    int|string $interval,
    string $unit
): string
    Parameter
    type name summary
    ​string ​$date ​The column or literal representing a date
    ​string ​$operator ​The arithmetic operator (+ or -).
    ​int|​string ​$interval ​The interval that shall be calculated into the date.
    ​string ​$unit ​The unit of the interval that shall be calculated into the date.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDateArithmeticIntervalExpression() ​Returns the SQL for a date arithmetic expression.

    [m] getDateDiffExpression <tag_inheritdoc data-type='' data-description=''>Returns the SQL to calculate the difference in days between the two passed dates.

    Returns the SQL to calculate the difference in days between the two passed dates. 
    public function getDateDiffExpression(
    string $date1,
    string $date2
): string

    Computes diff = date1 - date2.

    Parameter
    type name summary
    ​string ​$date1 ​
    ​string ​$date2 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDateDiffExpression() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQL to calculate the difference in days between the two passed dates.

    [m] getCurrentDatabaseExpression Returns the SQL expression which represents the currently selected database.

    Returns the SQL expression which represents the currently selected database. 
    public function getCurrentDatabaseExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getCurrentDatabaseExpression() ​Returns the SQL expression which represents the currently selected database.

    [m] getLengthExpression Returns the SQL snippet to get the length of a text column in characters.

    Returns the SQL snippet to get the length of a text column in characters. 
    public function getLengthExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getLengthExpression() ​Returns the SQL snippet to get the length of a text column in characters.

    [m] getListDatabasesSQL 

    public function getListDatabasesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListDatabasesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getListTableConstraintsSQL

    deprecated 

    public function getListTableConstraintsSQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableConstraintsSQL() ​

    [m] getListTableIndexesSQL

    deprecated 

    public function getListTableIndexesSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableIndexesSQL() ​

    [m] getListViewsSQL Returns the SQL to list all views of a database or user.

    Returns the SQL to list all views of a database or user. 
    public function getListViewsSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListViewsSQL() ​Returns the SQL to list all views of a database or user.
    See
    type summary
    ​AbstractSchemaManager ​
    ​AbstractSchemaManager ​

    [m] getListTableForeignKeysSQL

    deprecated 

    public function getListTableForeignKeysSQL(
    string $table,
    string|null $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableForeignKeysSQL() ​

    [m] getVarcharTypeDeclarationSQLSnippet 

    protected function getVarcharTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​
    ​bool ​$fixed ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getVarcharTypeDeclarationSQLSnippet() ​

    [m] getBinaryTypeDeclarationSQLSnippet Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    protected function getBinaryTypeDeclarationSQLSnippet(
    int|false $length,
    bool $fixed
): string
    Parameter
    type name summary
    ​int|​false ​$length ​The length of the column.
    ​bool ​$fixed ​Whether the column length is fixed.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBinaryTypeDeclarationSQLSnippet() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getClobTypeDeclarationSQL Gets the SQL snippet used to declare a CLOB column type.

    Gets the SQL snippet used to declare a CLOB column type. 
    public function getClobTypeDeclarationSQL(array|mixed[] $column): string
    TINYTEXT   : 2 ^  8 - 1 = 255
TEXT       : 2 ^ 16 - 1 = 65535
MEDIUMTEXT : 2 ^ 24 - 1 = 16777215
LONGTEXT   : 2 ^ 32 - 1 = 4294967295

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

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getClobTypeDeclarationSQL() ​Gets the SQL snippet used to declare a CLOB column type.

    [m] getDateTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create datetime columns in

    Obtains DBMS specific SQL to be used to create datetime columns in 
    public function getDateTimeTypeDeclarationSQL(array|mixed[] $column): string

    statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDateTimeTypeDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create datetime columns in

    [m] getDateTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create date columns in statements

    Obtains DBMS specific SQL to be used to create date columns in statements 
    public function getDateTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDateTypeDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create date columns in statements

    [m] getTimeTypeDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create time columns in statements

    Obtains DBMS specific SQL to be used to create time columns in statements 
    public function getTimeTypeDeclarationSQL(array|mixed[] $column): string

    like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getTimeTypeDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL to be used to create time columns in statements

    [m] getBooleanTypeDeclarationSQL Returns the SQL snippet that declares a boolean column.

    Returns the SQL snippet that declares a boolean column. 
    public function getBooleanTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBooleanTypeDeclarationSQL() ​Returns the SQL snippet that declares a boolean column.

    [m] prefersIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    deprecated

    Whether the platform prefers identity columns (eg. autoincrement) for ID generation. 
    public function prefersIdentityColumns(): bool

    Subclasses should override this method to return TRUE if they prefer identity columns.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::prefersIdentityColumns() ​<tag_inheritdoc data-type='' data-description=''>Whether the platform prefers identity columns (eg. autoincrement) for ID generation.

    [m] supportsIdentityColumns <tag_inheritdoc data-type='' data-description=''>Whether the platform supports identity columns.

    Whether the platform supports identity columns. 
    public function supportsIdentityColumns(): bool

    Identity columns are columns that receive an auto-generated value from the database on insert of a row.

    MySQL supports this through AUTO_INCREMENT columns.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::supportsIdentityColumns() ​<tag_inheritdoc data-type='' data-description=''>Whether the platform supports identity columns.

    [m] supportsInlineColumnComments Whether this platform support to add inline column comments as postfix.

    Whether this platform support to add inline column comments as postfix. 
    public function supportsInlineColumnComments(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::supportsInlineColumnComments() ​Whether this platform support to add inline column comments as postfix.
    See
    type summary
    ​AbstractPlatform ​

    [m] supportsColumnCollation Does this platform support column collation?

    Does this platform support column collation? 
    public function supportsColumnCollation(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::supportsColumnCollation() ​Does this platform support column collation?
    See
    type summary
    ​AbstractPlatform ​

    [m] getListTablesSQL

    deprecated 

    public function getListTablesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTablesSQL() ​

    [m] getListTableColumnsSQL

    deprecated 

    public function getListTableColumnsSQL(
    string $table,
    string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​string ​$database = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableColumnsSQL() ​

    [m] getColumnTypeSQLSnippets

    deprecated 

    public function getColumnTypeSQLSnippets(string $tableAlias = "c"): array
    Parameter
    type name summary
    ​string ​$tableAlias = "c" ​
    Return
    type summary
    ​array ​string}
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getColumnTypeSQLSnippets() ​
    See
    type summary
    ​AbstractMySQLPlatform::getColumnTypeSQLSnippet() ​

    [m] getColumnTypeSQLSnippet The SQL snippet required to elucidate a column type

    The SQL snippet required to elucidate a column type 
    public function getColumnTypeSQLSnippet(
    string $tableAlias = "c",
    ?string $databaseName = null
): string

    Returns a column type SELECT snippet string

    Parameter
    type name summary
    ​string ​$tableAlias = "c" ​
    ​?string ​$databaseName = null ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getColumnTypeSQLSnippet() ​The SQL snippet required to elucidate a column type

    [m] getListTableMetadataSQL

    deprecated 

    public function getListTableMetadataSQL(
    string $table,
    ?string $database = null
): string
    Parameter
    type name summary
    ​string ​$table ​
    ​?string ​$database = null ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getListTableMetadataSQL() ​

    [m] getCreateTablesSQL 

    public function getCreateTablesSQL(array|Doctrine\DBAL\Schema\Table[] $tables): array
    Parameter
    type name summary
    ​array|​Table[] ​$tables ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getCreateTablesSQL() ​

    [m] _getCreateTableSQL Returns the SQL used to create a table.

    Returns the SQL used to create a table. 
    protected function _getCreateTableSQL(
    string $name,
    array|mixed[][] $columns,
    array|mixed[] $options = []
): string[]
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​mixed[][] ​$columns ​
    ​array|​mixed[] ​$options = [] ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::_getCreateTableSQL() ​Returns the SQL used to create a table.

    [m] createSelectSQLBuilder 

    public function createSelectSQLBuilder(): Doctrine\DBAL\SQL\Builder\SelectSQLBuilder
    Return
    type summary
    ​SelectSQLBuilder ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::createSelectSQLBuilder() ​

    [m] getAlterTableSQL <tag_inheritdoc data-type='' data-description=''>Gets the SQL statements for altering an existing table.

    Gets the SQL statements for altering an existing table. 
    public function getAlterTableSQL(Doctrine\DBAL\Schema\TableDiff $diff): list

    This method returns an array of SQL statements, since some platforms need several statements.

    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getAlterTableSQL() ​<tag_inheritdoc data-type='' data-description=''>Gets the SQL statements for altering an existing table.

    [m] getPreAlterTableIndexForeignKeySQL 

    protected function getPreAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getPreAlterTableIndexForeignKeySQL() ​

    [m] getPreAlterTableRenameIndexForeignKeySQL 

    protected function getPreAlterTableRenameIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​The table diff to gather the SQL for.
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getPreAlterTableRenameIndexForeignKeySQL() ​

    [m] getPostAlterTableIndexForeignKeySQL 

    protected function getPostAlterTableIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getPostAlterTableIndexForeignKeySQL() ​

    [m] getPostAlterTableRenameIndexForeignKeySQL 

    protected function getPostAlterTableRenameIndexForeignKeySQL(Doctrine\DBAL\Schema\TableDiff $diff): string[]
    Parameter
    type name summary
    ​TableDiff ​$diff ​The table diff to gather the SQL for.
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getPostAlterTableRenameIndexForeignKeySQL() ​

    [m] getCreateIndexSQLFlags Adds additional flags for index generation.

    Adds additional flags for index generation. 
    protected function getCreateIndexSQLFlags(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getCreateIndexSQLFlags() ​Adds additional flags for index generation.

    [m] getIntegerTypeDeclarationSQL Returns the SQL snippet that declares a 4 byte integer column.

    Returns the SQL snippet that declares a 4 byte integer column. 
    public function getIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares a 4 byte integer column.

    [m] getBigIntTypeDeclarationSQL Returns the SQL snippet that declares an 8 byte integer column.

    Returns the SQL snippet that declares an 8 byte integer column. 
    public function getBigIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBigIntTypeDeclarationSQL() ​Returns the SQL snippet that declares an 8 byte integer column.

    [m] getSmallIntTypeDeclarationSQL Returns the SQL snippet that declares a 2 byte integer column.

    Returns the SQL snippet that declares a 2 byte integer column. 
    public function getSmallIntTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getSmallIntTypeDeclarationSQL() ​Returns the SQL snippet that declares a 2 byte integer column.

    [m] getFloatDeclarationSQL 

    public function getFloatDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getFloatDeclarationSQL() ​

    [m] getDecimalTypeDeclarationSQL Returns the SQL snippet that declares a floating point column of arbitrary precision.

    Returns the SQL snippet that declares a floating point column of arbitrary precision. 
    public function getDecimalTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDecimalTypeDeclarationSQL() ​Returns the SQL snippet that declares a floating point column of arbitrary precision.

    [m] _getCommonIntegerTypeDeclarationSQL Returns the SQL snippet that declares common properties of an integer column.

    Returns the SQL snippet that declares common properties of an integer column. 
    protected function _getCommonIntegerTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::_getCommonIntegerTypeDeclarationSQL() ​Returns the SQL snippet that declares common properties of an integer column.

    [m] getColumnCharsetDeclarationSQL <tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set the CHARACTER SET

    Obtains DBMS specific SQL code portion needed to set the CHARACTER SET 
    public function getColumnCharsetDeclarationSQL(string $charset): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$charset ​The name of the charset.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the CHARACTER SET
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getColumnCharsetDeclarationSQL() ​<tag_inheritdoc data-type='' data-description=''>Obtains DBMS specific SQL code portion needed to set the CHARACTER SET
    See
    type summary
    ​AbstractPlatform ​

    [m] getAdvancedForeignKeyOptionsSQL <tag_inheritdoc data-type='' data-description=''>Returns the FOREIGN KEY query section dealing with non-standard options

    Returns the FOREIGN KEY query section dealing with non-standard options 
    public function getAdvancedForeignKeyOptionsSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    as MATCH, INITIALLY DEFERRED, ON UPDATE, ...

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getAdvancedForeignKeyOptionsSQL() ​<tag_inheritdoc data-type='' data-description=''>Returns the FOREIGN KEY query section dealing with non-standard options
    See
    type summary
    ​AbstractPlatform ​

    [m] getDropIndexSQL Returns the SQL to drop an index from a table.

    Returns the SQL to drop an index from a table. 
    public function getDropIndexSQL(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string|null $table = null
): string
    Parameter
    type name summary
    ​Index|​string ​$index ​
    ​Table|​string|​null ​$table = null ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDropIndexSQL() ​Returns the SQL to drop an index from a table.

    [m] getDropPrimaryKeySQL 

    protected function getDropPrimaryKeySQL(string $table): string
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDropPrimaryKeySQL() ​

    [m] getDropUniqueConstraintSQL The ALTER TABLE ... DROP CONSTRAINT syntax is only available as of MySQL 8.0.19.

    The ALTER TABLE ... DROP CONSTRAINT syntax is only available as of MySQL 8.0.19. 
    public function getDropUniqueConstraintSQL(
    string $name,
    string $tableName
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDropUniqueConstraintSQL() ​The ALTER TABLE ... DROP CONSTRAINT syntax is only available as of MySQL 8.0.19.

    [m] getSetTransactionIsolationSQL Returns the SQL to set the transaction isolation level.

    Returns the SQL to set the transaction isolation level. 
    public function getSetTransactionIsolationSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getSetTransactionIsolationSQL() ​Returns the SQL to set the transaction isolation level.

    [m] getName Gets the name of the platform.

    deprecated

    Gets the name of the platform. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getName() ​Gets the name of the platform.

    [m] getReadLockSQL <tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock. 
    public function getReadLockSQL(): string

    This defaults to the ANSI SQL "FOR UPDATE", which is an exclusive lock (Write). Some database vendors allow to lighten this constraint up to be a real read lock.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getReadLockSQL() ​<tag_inheritdoc data-type='' data-description=''>Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.

    [m] getVarcharMaxLength Gets the maximum length of a varchar column.

    deprecated

    Gets the maximum length of a varchar column. 
    public function getVarcharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getVarcharMaxLength() ​Gets the maximum length of a varchar column.

    [m] getBinaryMaxLength Gets the maximum length of a binary column.

    deprecated

    Gets the maximum length of a binary column. 
    public function getBinaryMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBinaryMaxLength() ​Gets the maximum length of a binary column.

    [m] getDropTemporaryTableSQL Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction. 
    public function getDropTemporaryTableSQL(Doctrine\DBAL\Schema\Table|string $table): string

    MySQL commits a transaction implicitly when DROP TABLE is executed, however not if DROP TEMPORARY TABLE is executed.

    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDropTemporaryTableSQL() ​Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.

    [m] getBlobTypeDeclarationSQL Gets the SQL Snippet used to declare a BLOB column type.

    Gets the SQL Snippet used to declare a BLOB column type. 
    public function getBlobTypeDeclarationSQL(array|mixed[] $column): string
    TINYBLOB   : 2 ^  8 - 1 = 255
BLOB       : 2 ^ 16 - 1 = 65535
MEDIUMBLOB : 2 ^ 24 - 1 = 16777215
LONGBLOB   : 2 ^ 32 - 1 = 4294967295

    Returns the SQL Snippet used to declare a BLOB column type.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getBlobTypeDeclarationSQL() ​Gets the SQL Snippet used to declare a BLOB column type.

    [m] quoteStringLiteral <tag_inheritdoc data-type='' data-description=''>Quotes a literal string.

    Quotes a literal string. 
    public function quoteStringLiteral(string $str): string

    This method is NOT meant to fix SQL injections! It is only meant to escape this platform's string literal quote character inside the given literal string.

    Parameter
    type name summary
    ​string ​$str ​The literal string to be quoted.
    Return
    type summary
    ​string ​The quoted literal string.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::quoteStringLiteral() ​<tag_inheritdoc data-type='' data-description=''>Quotes a literal string.

    [m] getDefaultTransactionIsolationLevel Gets the default transaction isolation level of the platform.

    Gets the default transaction isolation level of the platform. 
    public function getDefaultTransactionIsolationLevel(): Doctrine\DBAL\TransactionIsolationLevel::*()
    Return
    type summary
    ​TransactionIsolationLevel::*() ​The default isolation level.
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDefaultTransactionIsolationLevel() ​Gets the default transaction isolation level of the platform.
    See
    type summary
    ​TransactionIsolationLevel ​

    [m] supportsColumnLengthIndexes Whether the platform supports indexes with column length definitions.

    Whether the platform supports indexes with column length definitions. 
    public function supportsColumnLengthIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::supportsColumnLengthIndexes() ​Whether the platform supports indexes with column length definitions.

    [m] getDatabaseNameSQL

    deprecated 

    protected function getDatabaseNameSQL(?string $databaseName): string
    Parameter
    type name summary
    ​?string ​$databaseName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::getDatabaseNameSQL() ​

    [m] createSchemaManager Creates the schema manager that can be used to inspect and change the underlying

    Creates the schema manager that can be used to inspect and change the underlying 
    public function createSchemaManager(Doctrine\DBAL\Connection $connection): Doctrine\DBAL\Schema\MySQLSchemaManager

    database schema according to the dialect of the platform.

    Parameter
    type name summary
    ​Connection ​$connection ​
    Return
    type summary
    ​MySQLSchemaManager ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::createSchemaManager() ​Creates the schema manager that can be used to inspect and change the underlying

    [m] fetchTableOptionsByTable 

    public function fetchTableOptionsByTable(bool $includeTableName): string
    Parameter
    type name summary
    ​bool ​$includeTableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractMySQLPlatform::fetchTableOptionsByTable() ​

    [m] setDisableTypeComments

    final

    final public function setDisableTypeComments(bool $value)
    Parameter
    type name summary
    ​bool ​$value ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setDisableTypeComments() ​

    [m] setEventManager Sets the EventManager used by the Platform.

    deprecated

    Sets the EventManager used by the Platform. 
    public function setEventManager(Doctrine\Common\EventManager $eventManager): void
    Parameter
    type name summary
    ​EventManager ​$eventManager ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::setEventManager() ​Sets the EventManager used by the Platform.

    [m] getEventManager Gets the EventManager used by the Platform.

    deprecated

    Gets the EventManager used by the Platform. 
    public function getEventManager(): Doctrine\Common\EventManager|null
    Return
    type summary
    ​EventManager|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEventManager() ​Gets the EventManager used by the Platform.

    [m] getAsciiStringTypeDeclarationSQL Returns the SQL snippet used to declare a column that can

    Returns the SQL snippet used to declare a column that can 
    public function getAsciiStringTypeDeclarationSQL(array|mixed[] $column): string

    store characters in the ASCII character set

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAsciiStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a column that can

    [m] getVarcharTypeDeclarationSQL Returns the SQL snippet used to declare a VARCHAR column type.

    deprecated

    Returns the SQL snippet used to declare a VARCHAR column type. 
    public function getVarcharTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharTypeDeclarationSQL() ​Returns the SQL snippet used to declare a VARCHAR column type.

    [m] getStringTypeDeclarationSQL Returns the SQL snippet used to declare a string column type.

    Returns the SQL snippet used to declare a string column type. 
    public function getStringTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringTypeDeclarationSQL() ​Returns the SQL snippet used to declare a string column type.

    [m] getBinaryTypeDeclarationSQL Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    Returns the SQL snippet used to declare a BINARY/VARBINARY column type. 
    public function getBinaryTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryTypeDeclarationSQL() ​Returns the SQL snippet used to declare a BINARY/VARBINARY column type.

    [m] getGuidTypeDeclarationSQL Returns the SQL snippet to declare a GUID/UUID column.

    Returns the SQL snippet to declare a GUID/UUID column. 
    public function getGuidTypeDeclarationSQL(array|mixed[] $column): string

    By default this maps directly to a CHAR(36) and only maps to more special datatypes when the underlying databases support this datatype.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getGuidTypeDeclarationSQL() ​Returns the SQL snippet to declare a GUID/UUID column.

    [m] registerDoctrineTypeMapping Registers a doctrine type to be used in conjunction with a column type of this platform.

    Registers a doctrine type to be used in conjunction with a column type of this platform. 
    public function registerDoctrineTypeMapping(
    string $dbType,
    string $doctrineType
): void
    Parameter
    type name summary
    ​string ​$dbType ​
    ​string ​$doctrineType ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​If the type is not found.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::registerDoctrineTypeMapping() ​Registers a doctrine type to be used in conjunction with a column type of this platform.

    [m] getDoctrineTypeMapping Gets the Doctrine type that is mapped for the given database column type.

    Gets the Doctrine type that is mapped for the given database column type. 
    public function getDoctrineTypeMapping(string $dbType): string
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeMapping() ​Gets the Doctrine type that is mapped for the given database column type.

    [m] hasDoctrineTypeMappingFor Checks if a database type is currently supported by this platform.

    Checks if a database type is currently supported by this platform. 
    public function hasDoctrineTypeMappingFor(string $dbType): bool
    Parameter
    type name summary
    ​string ​$dbType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasDoctrineTypeMappingFor() ​Checks if a database type is currently supported by this platform.

    [m] initializeCommentedDoctrineTypes Initializes the Doctrine Type comments instance variable for in_array() checks.

    deprecated

    Initializes the Doctrine Type comments instance variable for in_array() checks. 
    protected function initializeCommentedDoctrineTypes(): void
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::initializeCommentedDoctrineTypes() ​Initializes the Doctrine Type comments instance variable for in_array() checks.

    [m] isCommentedDoctrineType Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    deprecated

    Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type? 
    public function isCommentedDoctrineType(Doctrine\DBAL\Types\Type $doctrineType): bool
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::isCommentedDoctrineType() ​Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?

    [m] markDoctrineTypeCommented Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements. 
    public function markDoctrineTypeCommented(string|Doctrine\DBAL\Types\Type $doctrineType): void
    Parameter
    type name summary
    ​string|​Type ​$doctrineType ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::markDoctrineTypeCommented() ​Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.

    [m] getDoctrineTypeComment Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    deprecated

    Gets the comment to append to a column comment that helps parsing this type in reverse engineering. 
    public function getDoctrineTypeComment(Doctrine\DBAL\Types\Type $doctrineType): string
    Parameter
    type name summary
    ​Type ​$doctrineType ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDoctrineTypeComment() ​Gets the comment to append to a column comment that helps parsing this type in reverse engineering.

    [m] getColumnComment Gets the comment of a passed column modified by potential doctrine type comment hints.

    deprecated

    Gets the comment of a passed column modified by potential doctrine type comment hints. 
    protected function getColumnComment(Doctrine\DBAL\Schema\Column $column): string|null
    Parameter
    type name summary
    ​Column ​$column ​
    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnComment() ​Gets the comment of a passed column modified by potential doctrine type comment hints.

    [m] getSqlCommentStartString Gets the string portion that starts an SQL comment.

    deprecated

    Gets the string portion that starts an SQL comment. 
    public function getSqlCommentStartString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentStartString() ​Gets the string portion that starts an SQL comment.

    [m] getSqlCommentEndString Gets the string portion that ends an SQL comment.

    deprecated

    Gets the string portion that ends an SQL comment. 
    public function getSqlCommentEndString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqlCommentEndString() ​Gets the string portion that ends an SQL comment.

    [m] getCharMaxLength Gets the maximum length of a char column.

    deprecated

    Gets the maximum length of a char column. 
    public function getCharMaxLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCharMaxLength() ​Gets the maximum length of a char column.

    [m] getVarcharDefaultLength Gets the default length of a varchar column.

    deprecated

    Gets the default length of a varchar column. 
    public function getVarcharDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getVarcharDefaultLength() ​Gets the default length of a varchar column.

    [m] getBinaryDefaultLength Gets the default length of a binary column.

    deprecated

    Gets the default length of a binary column. 
    public function getBinaryDefaultLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBinaryDefaultLength() ​Gets the default length of a binary column.

    [m] getWildcards Gets all SQL wildcard characters of the platform.

    deprecated

    Gets all SQL wildcard characters of the platform. 
    public function getWildcards(): string[]
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWildcards() ​Gets all SQL wildcard characters of the platform.
    See
    type summary
    ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] getAvgExpression Returns the SQL snippet to get the average value of a column.

    deprecated

    Returns the SQL snippet to get the average value of a column. 
    public function getAvgExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an AVG aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAvgExpression() ​Returns the SQL snippet to get the average value of a column.

    [m] getCountExpression Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    deprecated

    Returns the SQL snippet to get the number of rows (without a NULL value) of a column. 
    public function getCountExpression(string|int $column): string

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

    Parameter
    type name summary
    ​string|​int ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a COUNT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCountExpression() ​Returns the SQL snippet to get the number of rows (without a NULL value) of a column.

    [m] getMaxExpression Returns the SQL snippet to get the highest value of a column.

    deprecated

    Returns the SQL snippet to get the highest value of a column. 
    public function getMaxExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MAX aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxExpression() ​Returns the SQL snippet to get the highest value of a column.

    [m] getMinExpression Returns the SQL snippet to get the lowest value of a column.

    deprecated

    Returns the SQL snippet to get the lowest value of a column. 
    public function getMinExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a MIN aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMinExpression() ​Returns the SQL snippet to get the lowest value of a column.

    [m] getSumExpression Returns the SQL snippet to get the total sum of a column.

    deprecated

    Returns the SQL snippet to get the total sum of a column. 
    public function getSumExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including a SUM aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSumExpression() ​Returns the SQL snippet to get the total sum of a column.

    [m] getMd5Expression Returns the SQL snippet to get the md5 sum of a column.

    deprecated

    Returns the SQL snippet to get the md5 sum of a column. 
    public function getMd5Expression(string $column): string

    Note: Not SQL92, but common functionality.

    Parameter
    type name summary
    ​string ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMd5Expression() ​Returns the SQL snippet to get the md5 sum of a column.

    [m] getSqrtExpression Returns the SQL snippet to get the squared value of a column.

    deprecated

    Returns the SQL snippet to get the squared value of a column. 
    public function getSqrtExpression(string $column): string
    Parameter
    type name summary
    ​string ​$column ​The column to use.
    Return
    type summary
    ​string ​Generated SQL including an SQRT aggregate function.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSqrtExpression() ​Returns the SQL snippet to get the squared value of a column.

    [m] getRoundExpression Returns the SQL snippet to round a numeric column to the number of decimals specified.

    deprecated

    Returns the SQL snippet to round a numeric column to the number of decimals specified. 
    public function getRoundExpression(
    string $column,
    string|int $decimals = 0
): string
    Parameter
    type name summary
    ​string ​$column ​
    ​string|​int ​$decimals = 0 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRoundExpression() ​Returns the SQL snippet to round a numeric column to the number of decimals specified.

    [m] getModExpression Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2. 
    public function getModExpression(
    string $expression1,
    string $expression2
): string
    Parameter
    type name summary
    ​string ​$expression1 ​
    ​string ​$expression2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getModExpression() ​Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2.

    [m] getTrimExpression Returns the SQL snippet to trim a string.

    Returns the SQL snippet to trim a string. 
    public function getTrimExpression(
    string $str,
    int $mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED,
    string|bool $char = false
): string
    Parameter
    type name summary
    ​string ​$str ​The expression to apply the trim to.
    ​int ​$mode = Doctrine\DBAL\Platforms\TrimMode::UNSPECIFIED ​The position of the trim (leading/trailing/both).
    ​string|​bool ​$char = false ​The char to trim, has to be quoted already. Defaults to space.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTrimExpression() ​Returns the SQL snippet to trim a string.

    [m] getRtrimExpression Returns the SQL snippet to trim trailing space characters from the expression.

    deprecated

    Returns the SQL snippet to trim trailing space characters from the expression. 
    public function getRtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRtrimExpression() ​Returns the SQL snippet to trim trailing space characters from the expression.

    [m] getLtrimExpression Returns the SQL snippet to trim leading space characters from the expression.

    deprecated

    Returns the SQL snippet to trim leading space characters from the expression. 
    public function getLtrimExpression(string $str): string
    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLtrimExpression() ​Returns the SQL snippet to trim leading space characters from the expression.

    [m] getUpperExpression Returns the SQL snippet to change all characters from the expression to uppercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to uppercase, 
    public function getUpperExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUpperExpression() ​Returns the SQL snippet to change all characters from the expression to uppercase,

    [m] getLowerExpression Returns the SQL snippet to change all characters from the expression to lowercase,

    deprecated

    Returns the SQL snippet to change all characters from the expression to lowercase, 
    public function getLowerExpression(string $str): string

    according to the current character set mapping.

    Parameter
    type name summary
    ​string ​$str ​Literal string or column name.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLowerExpression() ​Returns the SQL snippet to change all characters from the expression to lowercase,

    [m] getNowExpression Returns the SQL snippet to get the current system date.

    deprecated

    Returns the SQL snippet to get the current system date. 
    public function getNowExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getNowExpression() ​Returns the SQL snippet to get the current system date.

    [m] getSubstringExpression Returns a SQL snippet to get a substring inside an SQL statement.

    Returns a SQL snippet to get a substring inside an SQL statement. 
    public function getSubstringExpression(
    string $string,
    string|int $start,
    string|int|null $length = null
): string

    Note: Not SQL92, but common functionality.

    SQLite only supports the 2 parameter variant of this function.

    Parameter
    type name summary
    ​string ​$string ​An sql string literal or column name/alias.
    ​string|​int ​$start ​Where to start the substring portion.
    ​string|​int|​null ​$length = null ​The substring portion length.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSubstringExpression() ​Returns a SQL snippet to get a substring inside an SQL statement.

    [m] getNotExpression Returns the SQL for a logical not.

    deprecated

    Returns the SQL for a logical not. 
    public function getNotExpression(string $expression): string

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

    Parameter
    type name summary
    ​string ​$expression ​
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getNotExpression() ​Returns the SQL for a logical not.

    [m] getIsNullExpression Returns the SQL that checks if an expression is null.

    deprecated

    Returns the SQL that checks if an expression is null. 
    public function getIsNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNullExpression() ​Returns the SQL that checks if an expression is null.

    [m] getIsNotNullExpression Returns the SQL that checks if an expression is not null.

    deprecated

    Returns the SQL that checks if an expression is not null. 
    public function getIsNotNullExpression(string $expression): string
    Parameter
    type name summary
    ​string ​$expression ​The expression that should be compared to null.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIsNotNullExpression() ​Returns the SQL that checks if an expression is not null.

    [m] getBetweenExpression Returns the SQL that checks if an expression evaluates to a value between two values.

    deprecated

    Returns the SQL that checks if an expression evaluates to a value between two values. 
    public function getBetweenExpression(
    string $expression,
    string $value1,
    string $value2
): string

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

    Parameter
    type name summary
    ​string ​$expression ​The value to compare to.
    ​string ​$value1 ​The lower value to compare with.
    ​string ​$value2 ​The higher value to compare with.
    Return
    type summary
    ​string ​The logical expression.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBetweenExpression() ​Returns the SQL that checks if an expression evaluates to a value between two values.

    [m] getAcosExpression Returns the SQL to get the arccosine of a value.

    deprecated

    Returns the SQL to get the arccosine of a value. 
    public function getAcosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAcosExpression() ​Returns the SQL to get the arccosine of a value.

    [m] getSinExpression Returns the SQL to get the sine of a value.

    deprecated

    Returns the SQL to get the sine of a value. 
    public function getSinExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSinExpression() ​Returns the SQL to get the sine of a value.

    [m] getPiExpression Returns the SQL to get the PI value.

    deprecated

    Returns the SQL to get the PI value. 
    public function getPiExpression(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPiExpression() ​Returns the SQL to get the PI value.

    [m] getCosExpression Returns the SQL to get the cosine of a value.

    deprecated

    Returns the SQL to get the cosine of a value. 
    public function getCosExpression(string $value): string
    Parameter
    type name summary
    ​string ​$value ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCosExpression() ​Returns the SQL to get the cosine of a value.

    [m] getDateAddSecondsExpression Returns the SQL to add the number of given seconds to a date.

    Returns the SQL to add the number of given seconds to a date. 
    public function getDateAddSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddSecondsExpression() ​Returns the SQL to add the number of given seconds to a date.

    [m] getDateSubSecondsExpression Returns the SQL to subtract the number of given seconds from a date.

    Returns the SQL to subtract the number of given seconds from a date. 
    public function getDateSubSecondsExpression(
    string $date,
    int|string $seconds
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$seconds ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubSecondsExpression() ​Returns the SQL to subtract the number of given seconds from a date.

    [m] getDateAddMinutesExpression Returns the SQL to add the number of given minutes to a date.

    Returns the SQL to add the number of given minutes to a date. 
    public function getDateAddMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMinutesExpression() ​Returns the SQL to add the number of given minutes to a date.

    [m] getDateSubMinutesExpression Returns the SQL to subtract the number of given minutes from a date.

    Returns the SQL to subtract the number of given minutes from a date. 
    public function getDateSubMinutesExpression(
    string $date,
    int|string $minutes
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$minutes ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMinutesExpression() ​Returns the SQL to subtract the number of given minutes from a date.

    [m] getDateAddHourExpression Returns the SQL to add the number of given hours to a date.

    Returns the SQL to add the number of given hours to a date. 
    public function getDateAddHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddHourExpression() ​Returns the SQL to add the number of given hours to a date.

    [m] getDateSubHourExpression Returns the SQL to subtract the number of given hours to a date.

    Returns the SQL to subtract the number of given hours to a date. 
    public function getDateSubHourExpression(
    string $date,
    int|string $hours
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$hours ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubHourExpression() ​Returns the SQL to subtract the number of given hours to a date.

    [m] getDateAddDaysExpression Returns the SQL to add the number of given days to a date.

    Returns the SQL to add the number of given days to a date. 
    public function getDateAddDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddDaysExpression() ​Returns the SQL to add the number of given days to a date.

    [m] getDateSubDaysExpression Returns the SQL to subtract the number of given days to a date.

    Returns the SQL to subtract the number of given days to a date. 
    public function getDateSubDaysExpression(
    string $date,
    int|string $days
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$days ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubDaysExpression() ​Returns the SQL to subtract the number of given days to a date.

    [m] getDateAddWeeksExpression Returns the SQL to add the number of given weeks to a date.

    Returns the SQL to add the number of given weeks to a date. 
    public function getDateAddWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddWeeksExpression() ​Returns the SQL to add the number of given weeks to a date.

    [m] getDateSubWeeksExpression Returns the SQL to subtract the number of given weeks from a date.

    Returns the SQL to subtract the number of given weeks from a date. 
    public function getDateSubWeeksExpression(
    string $date,
    int|string $weeks
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$weeks ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubWeeksExpression() ​Returns the SQL to subtract the number of given weeks from a date.

    [m] getDateAddMonthExpression Returns the SQL to add the number of given months to a date.

    Returns the SQL to add the number of given months to a date. 
    public function getDateAddMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddMonthExpression() ​Returns the SQL to add the number of given months to a date.

    [m] getDateSubMonthExpression Returns the SQL to subtract the number of given months to a date.

    Returns the SQL to subtract the number of given months to a date. 
    public function getDateSubMonthExpression(
    string $date,
    int|string $months
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$months ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubMonthExpression() ​Returns the SQL to subtract the number of given months to a date.

    [m] getDateAddQuartersExpression Returns the SQL to add the number of given quarters to a date.

    Returns the SQL to add the number of given quarters to a date. 
    public function getDateAddQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddQuartersExpression() ​Returns the SQL to add the number of given quarters to a date.

    [m] getDateSubQuartersExpression Returns the SQL to subtract the number of given quarters from a date.

    Returns the SQL to subtract the number of given quarters from a date. 
    public function getDateSubQuartersExpression(
    string $date,
    int|string $quarters
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$quarters ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubQuartersExpression() ​Returns the SQL to subtract the number of given quarters from a date.

    [m] getDateAddYearsExpression Returns the SQL to add the number of given years to a date.

    Returns the SQL to add the number of given years to a date. 
    public function getDateAddYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateAddYearsExpression() ​Returns the SQL to add the number of given years to a date.

    [m] getDateSubYearsExpression Returns the SQL to subtract the number of given years from a date.

    Returns the SQL to subtract the number of given years from a date. 
    public function getDateSubYearsExpression(
    string $date,
    int|string $years
): string
    Parameter
    type name summary
    ​string ​$date ​
    ​int|​string ​$years ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateSubYearsExpression() ​Returns the SQL to subtract the number of given years from a date.

    [m] multiplyInterval Generates the SQL expression which represents the given date interval multiplied by a number

    Generates the SQL expression which represents the given date interval multiplied by a number 
    protected function multiplyInterval(
    string $interval,
    int $multiplier
): string
    Parameter
    type name summary
    ​string ​$interval ​SQL expression describing the interval value
    ​int ​$multiplier ​Interval multiplier
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::multiplyInterval() ​Generates the SQL expression which represents the given date interval multiplied by a number

    [m] getBitAndComparisonExpression Returns the SQL bit AND comparison expression.

    Returns the SQL bit AND comparison expression. 
    public function getBitAndComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitAndComparisonExpression() ​Returns the SQL bit AND comparison expression.

    [m] getBitOrComparisonExpression Returns the SQL bit OR comparison expression.

    Returns the SQL bit OR comparison expression. 
    public function getBitOrComparisonExpression(
    string $value1,
    string $value2
): string
    Parameter
    type name summary
    ​string ​$value1 ​
    ​string ​$value2 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getBitOrComparisonExpression() ​Returns the SQL bit OR comparison expression.

    [m] getForUpdateSQL Returns the FOR UPDATE expression.

    deprecated

    Returns the FOR UPDATE expression. 
    public function getForUpdateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForUpdateSQL() ​Returns the FOR UPDATE expression.

    [m] appendLockHint Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    Honors that some SQL vendors such as MsSql use table hints for locking instead of the 
    public function appendLockHint(
    string $fromClause,
    int $lockMode
): string

    ANSI SQL FOR UPDATE specification.

    Parameter
    type name summary
    ​string ​$fromClause ​The FROM clause to append the hint for the given lock mode to
    ​int ​$lockMode ​One of the Doctrine\DBAL\LockMode::* constants
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::appendLockHint() ​Honors that some SQL vendors such as MsSql use table hints for locking instead of the

    [m] getWriteLockSQL Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    deprecated

    Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows. 
    public function getWriteLockSQL(): string

    The semantics of this lock mode should equal the SELECT .. FOR UPDATE of the ANSI SQL standard.

    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getWriteLockSQL() ​Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.

    [m] getDropTableSQL Returns the SQL snippet to drop an existing table.

    Returns the SQL snippet to drop an existing table. 
    public function getDropTableSQL(Doctrine\DBAL\Schema\Table|string $table): string
    Parameter
    type name summary
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTableSQL() ​Returns the SQL snippet to drop an existing table.

    [m] getDropConstraintSQL Returns the SQL to drop a constraint.

    Returns the SQL to drop a constraint. 
    public function getDropConstraintSQL(
    Doctrine\DBAL\Schema\Constraint|string $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint|​string ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropConstraintSQL() ​Returns the SQL to drop a constraint.
    See
    type summary
    ​AbstractPlatform ​

    [m] getDropForeignKeySQL Returns the SQL to drop a foreign key.

    Returns the SQL to drop a foreign key. 
    public function getDropForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropForeignKeySQL() ​Returns the SQL to drop a foreign key.

    [m] getCreateTableSQL Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    Returns the SQL statement(s) to create a table with the specified name, columns and constraints 
    public function getCreateTableSQL(
    Doctrine\DBAL\Schema\Table $table,
    int $createFlags = self::CREATE_INDEXES
): list

    on this platform.

    Parameter
    type name summary
    ​Table ​$table ​
    ​int ​$createFlags = self::CREATE_INDEXES ​
    Return
    type summary
    ​list ​The list of SQL statements.
    Throws
    type summary
    ​Exception ​
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableSQL() ​Returns the SQL statement(s) to create a table with the specified name, columns and constraints

    [m] getCreateTableWithoutForeignKeysSQL

    final

    final protected function getCreateTableWithoutForeignKeysSQL(Doctrine\DBAL\Schema\Table $table): array|list
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTableWithoutForeignKeysSQL() ​

    [m] getDropTablesSQL 

    public function getDropTablesSQL(array|list $tables): array|list
    Parameter
    type name summary
    ​array|​list ​$tables ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropTablesSQL() ​

    [m] getCommentOnTableSQL 

    protected function getCommentOnTableSQL(
    string $tableName,
    ?string $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​?string ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnTableSQL() ​

    [m] getCommentOnColumnSQL 

    public function getCommentOnColumnSQL(
    string $tableName,
    string $columnName,
    string|null $comment
): string
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    ​string|​null ​$comment ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCommentOnColumnSQL() ​

    [m] getInlineColumnCommentSQL Returns the SQL to create inline comment on a column.

    Returns the SQL to create inline comment on a column. 
    public function getInlineColumnCommentSQL(string $comment): string
    Parameter
    type name summary
    ​string ​$comment ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getInlineColumnCommentSQL() ​Returns the SQL to create inline comment on a column.

    [m] getCreateTemporaryTableSnippetSQL 

    public function getCreateTemporaryTableSnippetSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateTemporaryTableSnippetSQL() ​

    [m] getAlterSchemaSQL Generates SQL statements that can be used to apply the diff.

    Generates SQL statements that can be used to apply the diff. 
    public function getAlterSchemaSQL(Doctrine\DBAL\Schema\SchemaDiff $diff): array|list
    Parameter
    type name summary
    ​SchemaDiff ​$diff ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAlterSchemaSQL() ​Generates SQL statements that can be used to apply the diff.

    [m] getCreateSequenceSQL Returns the SQL to create a sequence on this platform.

    Returns the SQL to create a sequence on this platform. 
    public function getCreateSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateSequenceSQL() ​Returns the SQL to create a sequence on this platform.

    [m] getAlterSequenceSQL Returns the SQL to change a sequence on this platform.

    Returns the SQL to change a sequence on this platform. 
    public function getAlterSequenceSQL(Doctrine\DBAL\Schema\Sequence $sequence): string
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getAlterSequenceSQL() ​Returns the SQL to change a sequence on this platform.

    [m] getDropSequenceSQL Returns the SQL snippet to drop an existing sequence.

    Returns the SQL snippet to drop an existing sequence. 
    public function getDropSequenceSQL(Doctrine\DBAL\Schema\Sequence|string $sequence): string
    Parameter
    type name summary
    ​Sequence|​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSequenceSQL() ​Returns the SQL snippet to drop an existing sequence.

    [m] getCreateConstraintSQL Returns the SQL to create a constraint on a table on this platform.

    deprecated

    Returns the SQL to create a constraint on a table on this platform. 
    public function getCreateConstraintSQL(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateConstraintSQL() ​Returns the SQL to create a constraint on a table on this platform.
    See
    type summary
    ​AbstractPlatform::getCreateIndexSQL() ​
    ​AbstractPlatform::getCreateForeignKeySQL() ​

    [m] getCreateIndexSQL Returns the SQL to create an index on a table on this platform.

    Returns the SQL to create an index on a table on this platform. 
    public function getCreateIndexSQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateIndexSQL() ​Returns the SQL to create an index on a table on this platform.

    [m] getPartialIndexSQL Adds condition for partial index.

    Adds condition for partial index. 
    protected function getPartialIndexSQL(Doctrine\DBAL\Schema\Index $index): string
    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getPartialIndexSQL() ​Adds condition for partial index.

    [m] getCreatePrimaryKeySQL Returns the SQL to create an unnamed primary key constraint.

    Returns the SQL to create an unnamed primary key constraint. 
    public function getCreatePrimaryKeySQL(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreatePrimaryKeySQL() ​Returns the SQL to create an unnamed primary key constraint.

    [m] getCreateSchemaSQL Returns the SQL to create a named schema.

    Returns the SQL to create a named schema. 
    public function getCreateSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateSchemaSQL() ​Returns the SQL to create a named schema.

    [m] getCreateUniqueConstraintSQL Returns the SQL to create a unique constraint on a table on this platform.

    Returns the SQL to create a unique constraint on a table on this platform. 
    public function getCreateUniqueConstraintSQL(
    Doctrine\DBAL\Schema\UniqueConstraint $constraint,
    string $tableName
): string
    Parameter
    type name summary
    ​UniqueConstraint ​$constraint ​
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateUniqueConstraintSQL() ​Returns the SQL to create a unique constraint on a table on this platform.

    [m] getDropSchemaSQL Returns the SQL snippet to drop a schema.

    Returns the SQL snippet to drop a schema. 
    public function getDropSchemaSQL(string $schemaName): string
    Parameter
    type name summary
    ​string ​$schemaName ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropSchemaSQL() ​Returns the SQL snippet to drop a schema.

    [m] quoteIdentifier Quotes a string so that it can be safely used as a table or column name,

    Quotes a string so that it can be safely used as a table or column name, 
    public function quoteIdentifier(string $str): string

    even if it is a reserved word of the platform. This also detects identifier chains separated by dot and quotes them independently.

    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.

    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteIdentifier() ​Quotes a string so that it can be safely used as a table or column name,

    [m] quoteSingleIdentifier Quotes a single identifier (no dot chain separation).

    Quotes a single identifier (no dot chain separation). 
    public function quoteSingleIdentifier(string $str): string
    Parameter
    type name summary
    ​string ​$str ​The identifier name to be quoted.
    Return
    type summary
    ​string ​The quoted identifier string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::quoteSingleIdentifier() ​Quotes a single identifier (no dot chain separation).

    [m] getCreateForeignKeySQL Returns the SQL to create a new foreign key.

    Returns the SQL to create a new foreign key. 
    public function getCreateForeignKeySQL(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): string
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The foreign key constraint.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateForeignKeySQL() ​Returns the SQL to create a new foreign key.

    [m] getRenameTableSQL 

    public function getRenameTableSQL(
    string $oldName,
    string $newName
): array|list
    Parameter
    type name summary
    ​string ​$oldName ​
    ​string ​$newName ​
    Return
    type summary
    ​array|​list ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRenameTableSQL() ​

    [m] onSchemaAlterTableAddColumn 

    protected function onSchemaAlterTableAddColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    mixed[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​mixed[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableAddColumn() ​

    [m] onSchemaAlterTableRemoveColumn 

    protected function onSchemaAlterTableRemoveColumn(
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRemoveColumn() ​

    [m] onSchemaAlterTableChangeColumn 

    protected function onSchemaAlterTableChangeColumn(
    Doctrine\DBAL\Schema\ColumnDiff $columnDiff,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​ColumnDiff ​$columnDiff ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableChangeColumn() ​

    [m] onSchemaAlterTableRenameColumn 

    protected function onSchemaAlterTableRenameColumn(
    string $oldColumnName,
    Doctrine\DBAL\Schema\Column $column,
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$columnSql
): bool
    Parameter
    type name summary
    ​string ​$oldColumnName ​
    ​Column ​$column ​
    ​TableDiff ​$diff ​
    ​string[] ​&$columnSql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTableRenameColumn() ​

    [m] onSchemaAlterTable 

    protected function onSchemaAlterTable(
    Doctrine\DBAL\Schema\TableDiff $diff,
    string[] &$sql
): bool
    Parameter
    type name summary
    ​TableDiff ​$diff ​
    ​string[] ​&$sql ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::onSchemaAlterTable() ​

    [m] getRenameIndexSQL Returns the SQL for renaming an index on a table.

    Returns the SQL for renaming an index on a table. 
    protected function getRenameIndexSQL(
    string $oldIndexName,
    Doctrine\DBAL\Schema\Index $index,
    string $tableName
): string[]
    Parameter
    type name summary
    ​string ​$oldIndexName ​The name of the index to rename from.
    ​Index ​$index ​The definition of the index to rename to.
    ​string ​$tableName ​The table to rename the given index on.
    Return
    type summary
    ​string[] ​The sequence of SQL statements for renaming the given index.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getRenameIndexSQL() ​Returns the SQL for renaming an index on a table.

    [m] getColumnDeclarationListSQL Gets declaration of a number of columns in bulk.

    Gets declaration of a number of columns in bulk. 
    public function getColumnDeclarationListSQL(array|mixed[][] $columns): string
    Parameter
    type name summary
    ​array|​mixed[][] ​$columns ​A multidimensional associative array.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationListSQL() ​Gets declaration of a number of columns in bulk.

    [m] getColumnDeclarationSQL Obtains DBMS specific SQL code portion needed to declare a generic type

    Obtains DBMS specific SQL code portion needed to declare a generic type 
    public function getColumnDeclarationSQL(
    string $name,
    array|mixed[] $column
): string

    column to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name the column to be declared.
    ​array|​mixed[] ​$column ​An associative array with the name of the properties
    Return
    type summary
    ​string ​DBMS specific SQL code portion that should be used to declare the column.
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to declare a generic type

    [m] getCheckDeclarationSQL Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    Obtains DBMS specific SQL code portion needed to set a CHECK constraint 
    public function getCheckDeclarationSQL(array|string[]|mixed[][] $definition): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​string[]|​mixed[][] ​$definition ​The check definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a CHECK constraint.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCheckDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a CHECK constraint

    [m] getUniqueConstraintDeclarationSQL Obtains DBMS specific SQL code portion needed to set a unique

    Obtains DBMS specific SQL code portion needed to set a unique 
    public function getUniqueConstraintDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\UniqueConstraint $constraint
): string

    constraint declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the unique constraint.
    ​UniqueConstraint ​$constraint ​The unique constraint definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set a constraint.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueConstraintDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set a unique

    [m] getIndexDeclarationSQL Obtains DBMS specific SQL code portion needed to set an index

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexDeclarationSQL(
    string $name,
    Doctrine\DBAL\Schema\Index $index
): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$name ​The name of the index.
    ​Index ​$index ​The index definition.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set an index.
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getCustomTypeDeclarationSQL Obtains SQL code portion needed to create a custom column,

    deprecated

    Obtains SQL code portion needed to create a custom column, 
    public function getCustomTypeDeclarationSQL(array|mixed[] $column): string

    e.g. when a column has the "columnDefinition" keyword. Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate.

    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCustomTypeDeclarationSQL() ​Obtains SQL code portion needed to create a custom column,

    [m] getIndexFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getIndexFieldDeclarationListSQL(Doctrine\DBAL\Schema\Index $index): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​Index ​$index ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIndexFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getColumnsFieldDeclarationListSQL Obtains DBMS specific SQL code portion needed to set an index

    deprecated

    Obtains DBMS specific SQL code portion needed to set an index 
    public function getColumnsFieldDeclarationListSQL(array|mixed[] $columns): string

    declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​array|​mixed[] ​$columns ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnsFieldDeclarationListSQL() ​Obtains DBMS specific SQL code portion needed to set an index

    [m] getTemporaryTableSQL Returns the required SQL string that fits between CREATE ... TABLE

    deprecated

    Returns the required SQL string that fits between CREATE ... TABLE 
    public function getTemporaryTableSQL(): string

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

    Return
    type summary
    ​string ​The string required to be placed between "CREATE" and "TABLE"
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableSQL() ​Returns the required SQL string that fits between CREATE ... TABLE

    [m] getTemporaryTableName Some vendors require temporary table names to be qualified specially.

    Some vendors require temporary table names to be qualified specially. 
    public function getTemporaryTableName(string $tableName): string
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTemporaryTableName() ​Some vendors require temporary table names to be qualified specially.

    [m] getForeignKeyDeclarationSQL Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyDeclarationSQL() ​Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getForeignKeyReferentialActionSQL Returns the given referential action in uppercase if valid, otherwise throws an exception.

    Returns the given referential action in uppercase if valid, otherwise throws an exception. 
    public function getForeignKeyReferentialActionSQL(string $action): string
    Parameter
    type name summary
    ​string ​$action ​The foreign key referential action.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​If unknown referential action given.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyReferentialActionSQL() ​Returns the given referential action in uppercase if valid, otherwise throws an exception.

    [m] getForeignKeyBaseDeclarationSQL Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint 
    public function getForeignKeyBaseDeclarationSQL(Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getForeignKeyBaseDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint

    [m] getUniqueFieldDeclarationSQL Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    deprecated

    Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint 
    public function getUniqueFieldDeclarationSQL(): string

    of a column declaration to be used in statements like CREATE TABLE.

    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the UNIQUE constraint
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getUniqueFieldDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint

    [m] getColumnCollationDeclarationSQL Obtains DBMS specific SQL code portion needed to set the COLLATION

    Obtains DBMS specific SQL code portion needed to set the COLLATION 
    public function getColumnCollationDeclarationSQL(string $collation): string

    of a column declaration to be used in statements like CREATE TABLE.

    Parameter
    type name summary
    ​string ​$collation ​The name of the collation.
    Return
    type summary
    ​string ​DBMS specific SQL code portion needed to set the COLLATION
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getColumnCollationDeclarationSQL() ​Obtains DBMS specific SQL code portion needed to set the COLLATION

    [m] convertBooleans Some platforms need the boolean values to be converted.

    Some platforms need the boolean values to be converted. 
    public function convertBooleans(mixed $item): mixed

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

    Note: if the input is not a boolean the original input might be returned.

    There are two contexts when converting booleans: Literals and Prepared Statements. This method should handle the literal case

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertBooleans() ​Some platforms need the boolean values to be converted.

    [m] convertFromBoolean Some platforms have boolean literals that needs to be correctly converted

    Some platforms have boolean literals that needs to be correctly converted 
    public function convertFromBoolean(T $item): (T

    The default conversion tries to convert value into bool "(bool)$item"

    Parameter
    type name summary
    ​T ​$item ​
    Return
    type summary
    ​(T ​is null ? null : bool)
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertFromBoolean() ​Some platforms have boolean literals that needs to be correctly converted

    [m] convertBooleansToDatabaseValue This method should handle the prepared statements case. When there is no

    This method should handle the prepared statements case. When there is no 
    public function convertBooleansToDatabaseValue(mixed $item): mixed

    distinction, it's OK to use the same method.

    Note: if the input is not a boolean the original input might be returned.

    Parameter
    type name summary
    ​mixed ​$item ​A boolean or an array of them.
    Return
    type summary
    ​mixed ​A boolean database value or an array of them.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::convertBooleansToDatabaseValue() ​This method should handle the prepared statements case. When there is no

    [m] getCurrentDateSQL Returns the SQL specific for the platform to get the current date.

    Returns the SQL specific for the platform to get the current date. 
    public function getCurrentDateSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentDateSQL() ​Returns the SQL specific for the platform to get the current date.

    [m] getCurrentTimeSQL Returns the SQL specific for the platform to get the current time.

    Returns the SQL specific for the platform to get the current time. 
    public function getCurrentTimeSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimeSQL() ​Returns the SQL specific for the platform to get the current time.

    [m] getCurrentTimestampSQL Returns the SQL specific for the platform to get the current timestamp

    Returns the SQL specific for the platform to get the current timestamp 
    public function getCurrentTimestampSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCurrentTimestampSQL() ​Returns the SQL specific for the platform to get the current timestamp

    [m] _getTransactionIsolationLevelSQL Returns the SQL for a given transaction isolation level Connection constant.

    Returns the SQL for a given transaction isolation level Connection constant. 
    protected function _getTransactionIsolationLevelSQL(int $level): string
    Parameter
    type name summary
    ​int ​$level ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​InvalidArgumentException ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::_getTransactionIsolationLevelSQL() ​Returns the SQL for a given transaction isolation level Connection constant.

    [m] getListNamespacesSQL Returns the SQL statement for retrieving the namespaces defined in the database.

    deprecated

    Returns the SQL statement for retrieving the namespaces defined in the database. 
    public function getListNamespacesSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListNamespacesSQL() ​Returns the SQL statement for retrieving the namespaces defined in the database.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] getListSequencesSQL 

    public function getListSequencesSQL(string $database): string
    Parameter
    type name summary
    ​string ​$database ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListSequencesSQL() ​
    See
    type summary
    ​AbstractSchemaManager ​

    [m] getListUsersSQL

    deprecated 

    public function getListUsersSQL(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getListUsersSQL() ​

    [m] getCreateViewSQL 

    public function getCreateViewSQL(
    string $name,
    string $sql
): string
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$sql ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateViewSQL() ​

    [m] getDropViewSQL 

    public function getDropViewSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropViewSQL() ​

    [m] getSequenceNextValSQL 

    public function getSequenceNextValSQL(string $sequence): string
    Parameter
    type name summary
    ​string ​$sequence ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getSequenceNextValSQL() ​

    [m] getCreateDatabaseSQL Returns the SQL to create a new database.

    Returns the SQL to create a new database. 
    public function getCreateDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be created.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getCreateDatabaseSQL() ​Returns the SQL to create a new database.

    [m] getDropDatabaseSQL Returns the SQL snippet to drop an existing database.

    Returns the SQL snippet to drop an existing database. 
    public function getDropDatabaseSQL(string $name): string
    Parameter
    type name summary
    ​string ​$name ​The name of the database that should be dropped.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDropDatabaseSQL() ​Returns the SQL snippet to drop an existing database.

    [m] getDateTimeTzTypeDeclarationSQL Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    Obtains DBMS specific SQL to be used to create datetime with timezone offset columns. 
    public function getDateTimeTzTypeDeclarationSQL(array|mixed[] $column): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeTzTypeDeclarationSQL() ​Obtains DBMS specific SQL to be used to create datetime with timezone offset columns.

    [m] supportsSequences Whether the platform supports sequences.

    Whether the platform supports sequences. 
    public function supportsSequences(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSequences() ​Whether the platform supports sequences.

    [m] usesSequenceEmulatedIdentityColumns Whether the platform emulates identity columns through sequences.

    deprecated

    Whether the platform emulates identity columns through sequences. 
    public function usesSequenceEmulatedIdentityColumns(): bool

    Some platforms that do not support identity columns natively but support sequences can emulate identity columns by using sequences.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::usesSequenceEmulatedIdentityColumns() ​Whether the platform emulates identity columns through sequences.

    [m] getIdentitySequenceName Returns the name of the sequence for a particular identity column in a particular table.

    deprecated

    Returns the name of the sequence for a particular identity column in a particular table. 
    public function getIdentitySequenceName(
    string $tableName,
    string $columnName
): string
    Parameter
    type name summary
    ​string ​$tableName ​The name of the table to return the sequence name for.
    ​string ​$columnName ​The name of the identity column in the table to return the sequence name for.
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getIdentitySequenceName() ​Returns the name of the sequence for a particular identity column in a particular table.
    See
    type summary
    ​usesSequenceEmulatedIdentityColumns ​

    [m] supportsIndexes Whether the platform supports indexes.

    deprecated

    Whether the platform supports indexes. 
    public function supportsIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsIndexes() ​Whether the platform supports indexes.

    [m] supportsPartialIndexes Whether the platform supports partial indexes.

    Whether the platform supports partial indexes. 
    public function supportsPartialIndexes(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPartialIndexes() ​Whether the platform supports partial indexes.

    [m] supportsAlterTable Whether the platform supports altering tables.

    deprecated

    Whether the platform supports altering tables. 
    public function supportsAlterTable(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsAlterTable() ​Whether the platform supports altering tables.

    [m] supportsTransactions Whether the platform supports transactions.

    deprecated

    Whether the platform supports transactions. 
    public function supportsTransactions(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsTransactions() ​Whether the platform supports transactions.

    [m] supportsSavepoints Whether the platform supports savepoints.

    Whether the platform supports savepoints. 
    public function supportsSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSavepoints() ​Whether the platform supports savepoints.

    [m] supportsReleaseSavepoints Whether the platform supports releasing savepoints.

    Whether the platform supports releasing savepoints. 
    public function supportsReleaseSavepoints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsReleaseSavepoints() ​Whether the platform supports releasing savepoints.

    [m] supportsPrimaryConstraints Whether the platform supports primary key constraints.

    deprecated

    Whether the platform supports primary key constraints. 
    public function supportsPrimaryConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsPrimaryConstraints() ​Whether the platform supports primary key constraints.

    [m] supportsForeignKeyConstraints Whether the platform supports foreign key constraints.

    deprecated

    Whether the platform supports foreign key constraints. 
    public function supportsForeignKeyConstraints(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsForeignKeyConstraints() ​Whether the platform supports foreign key constraints.

    [m] supportsSchemas Whether the platform supports database schemas.

    Whether the platform supports database schemas. 
    public function supportsSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsSchemas() ​Whether the platform supports database schemas.

    [m] canEmulateSchemas Whether this platform can emulate schemas.

    deprecated

    Whether this platform can emulate schemas. 
    public function canEmulateSchemas(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::canEmulateSchemas() ​Whether this platform can emulate schemas.
    See
    type summary
    ​AbstractManager::introspectSchema() ​

    [m] getDefaultSchemaName Returns the default schema name.

    deprecated

    Returns the default schema name. 
    public function getDefaultSchemaName(): string
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​If not supported on this platform.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDefaultSchemaName() ​Returns the default schema name.

    [m] supportsCreateDropDatabase Whether this platform supports create database.

    deprecated

    Whether this platform supports create database. 
    public function supportsCreateDropDatabase(): bool

    Some databases don't allow to create and drop databases at all or only with certain tools.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsCreateDropDatabase() ​Whether this platform supports create database.

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

    deprecated

    Whether the platform supports getting the affected rows of a recent update/delete type query. 
    public function supportsGettingAffectedRows(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsGettingAffectedRows() ​Whether the platform supports getting the affected rows of a recent update/delete type query.

    [m] supportsCommentOnStatement Whether this platform support the proprietary syntax "COMMENT ON asset".

    Whether this platform support the proprietary syntax "COMMENT ON asset". 
    public function supportsCommentOnStatement(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsCommentOnStatement() ​Whether this platform support the proprietary syntax "COMMENT ON asset".

    [m] hasNativeGuidType Does this platform have native guid type.

    deprecated

    Does this platform have native guid type. 
    public function hasNativeGuidType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasNativeGuidType() ​Does this platform have native guid type.

    [m] hasNativeJsonType Does this platform have native JSON type.

    deprecated

    Does this platform have native JSON type. 
    public function hasNativeJsonType(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::hasNativeJsonType() ​Does this platform have native JSON type.

    [m] supportsViews Whether this platform supports views.

    deprecated

    Whether this platform supports views. 
    public function supportsViews(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsViews() ​Whether this platform supports views.

    [m] getDateTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeFormatString(): string

    the format of a stored datetime value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateTimeTzFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateTimeTzFormatString(): string

    the format of a stored datetime with timezone value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateTimeTzFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getDateFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getDateFormatString(): string

    the format of a stored date value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDateFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] getTimeFormatString Gets the format string, as accepted by the date() function, that describes

    Gets the format string, as accepted by the date() function, that describes 
    public function getTimeFormatString(): string

    the format of a stored time value of this platform.

    Return
    type summary
    ​string ​The format string.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTimeFormatString() ​Gets the format string, as accepted by the date() function, that describes

    [m] modifyLimitQuery Adds an driver-specific LIMIT clause to the query.

    final

    Adds an driver-specific LIMIT clause to the query. 
    final public function modifyLimitQuery(
    string $query,
    int|null $limit,
    int $offset = 0
): string
    Parameter
    type name summary
    ​string ​$query ​
    ​int|​null ​$limit ​
    ​int ​$offset = 0 ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::modifyLimitQuery() ​Adds an driver-specific LIMIT clause to the query.

    [m] supportsLimitOffset Whether the database platform support offsets in modify limit clauses.

    deprecated

    Whether the database platform support offsets in modify limit clauses. 
    public function supportsLimitOffset(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::supportsLimitOffset() ​Whether the database platform support offsets in modify limit clauses.

    [m] getMaxIdentifierLength Maximum length of any given database identifier, like tables or column names.

    Maximum length of any given database identifier, like tables or column names. 
    public function getMaxIdentifierLength(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getMaxIdentifierLength() ​Maximum length of any given database identifier, like tables or column names.

    [m] getEmptyIdentityInsertSQL Returns the insert SQL for an empty insert statement.

    Returns the insert SQL for an empty insert statement. 
    public function getEmptyIdentityInsertSQL(
    string $quotedTableName,
    string $quotedIdentifierColumnName
): string
    Parameter
    type name summary
    ​string ​$quotedTableName ​
    ​string ​$quotedIdentifierColumnName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getEmptyIdentityInsertSQL() ​Returns the insert SQL for an empty insert statement.

    [m] getTruncateTableSQL Generates a Truncate Table SQL statement for a given table.

    Generates a Truncate Table SQL statement for a given table. 
    public function getTruncateTableSQL(
    string $tableName,
    bool $cascade = false
): string

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

    Parameter
    type name summary
    ​string ​$tableName ​
    ​bool ​$cascade = false ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getTruncateTableSQL() ​Generates a Truncate Table SQL statement for a given table.

    [m] getDummySelectSQL This is for test reasons, many vendors have special requirements for dummy statements.

    This is for test reasons, many vendors have special requirements for dummy statements. 
    public function getDummySelectSQL(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getDummySelectSQL() ​This is for test reasons, many vendors have special requirements for dummy statements.

    [m] createSavePoint Returns the SQL to create a new savepoint.

    Returns the SQL to create a new savepoint. 
    public function createSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSavePoint() ​Returns the SQL to create a new savepoint.

    [m] releaseSavePoint Returns the SQL to release a savepoint.

    Returns the SQL to release a savepoint. 
    public function releaseSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::releaseSavePoint() ​Returns the SQL to release a savepoint.

    [m] rollbackSavePoint Returns the SQL to rollback a savepoint.

    Returns the SQL to rollback a savepoint. 
    public function rollbackSavePoint(string $savepoint): string
    Parameter
    type name summary
    ​string ​$savepoint ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::rollbackSavePoint() ​Returns the SQL to rollback a savepoint.

    [m] getReservedKeywordsList Returns the keyword list instance of this platform.

    final

    Returns the keyword list instance of this platform. 
    final public function getReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList
    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​If no keyword list is specified.
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getReservedKeywordsList() ​Returns the keyword list instance of this platform.

    [m] createReservedKeywordsList Creates an instance of the reserved keyword list of this platform.

    Creates an instance of the reserved keyword list of this platform. 
    protected function createReservedKeywordsList(): Doctrine\DBAL\Platforms\Keywords\KeywordList

    This method will become @abstract in DBAL 4.0.0.

    Return
    type summary
    ​KeywordList ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createReservedKeywordsList() ​Creates an instance of the reserved keyword list of this platform.

    [m] getStringLiteralQuoteCharacter Gets the character used for string literal quoting.

    deprecated

    Gets the character used for string literal quoting. 
    public function getStringLiteralQuoteCharacter(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getStringLiteralQuoteCharacter() ​Gets the character used for string literal quoting.
    See
    type summary
    ​AbstractPlatform::quoteStringLiteral() ​

    [m] escapeStringForLike Escapes metacharacters in a string intended to be used with a LIKE

    final

    Escapes metacharacters in a string intended to be used with a LIKE 
    final public function escapeStringForLike(
    string $inputString,
    string $escapeChar
): string

    operator.

    Parameter
    type name summary
    ​string ​$inputString ​a literal, unquoted string
    ​string ​$escapeChar ​should be reused by the caller in the LIKE
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::escapeStringForLike() ​Escapes metacharacters in a string intended to be used with a LIKE

    [m] createSQLParser 

    public function createSQLParser(): Doctrine\DBAL\SQL\Parser
    Return
    type summary
    ​Parser ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::createSQLParser() ​

    [m] getLikeWildcardCharacters 

    protected function getLikeWildcardCharacters(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::getLikeWildcardCharacters() ​

    [m] columnsEqual Compares the definitions of the given columns in the context of this platform.

    Compares the definitions of the given columns in the context of this platform. 
    public function columnsEqual(
    Doctrine\DBAL\Schema\Column $column1,
    Doctrine\DBAL\Schema\Column $column2
): bool
    Parameter
    type name summary
    ​Column ​$column1 ​
    ​Column ​$column2 ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractPlatform::columnsEqual() ​Compares the definitions of the given columns in the context of this platform.

    [N] Doctrine\DBAL\Platforms\Keywords\

    [C] KeywordList Abstract interface for a SQL reserved keyword dictionary.

    abstract

    Abstract interface for a SQL reserved keyword dictionary.

    [m] isKeyword Checks if the given word is a keyword of this dialect/vendor platform.

    Checks if the given word is a keyword of this dialect/vendor platform. 
    public function isKeyword(string $word): bool
    Parameter
    type name summary
    ​string ​$word ​
    Return
    type summary
    ​bool ​

    [m] initializeKeywords 

    protected function initializeKeywords(): void
    Return
    type summary
    ​void ​

    [m] getKeywords Returns the list of keywords.

    abstract

    Returns the list of keywords. 
    abstract protected function getKeywords(): string[]
    Return
    type summary
    ​string[] ​

    [m] getName Returns the name of this keyword list.

    abstractdeprecated

    Returns the name of this keyword list. 
    abstract public function getName(): string
    Return
    type summary
    ​string ​

    [N] Doctrine\DBAL\Platforms\MySQL\

    [I] CollationMetadataProvider

    abstract

    Hierarchy

    [m] getCollationCharset

    abstract

    abstract public function getCollationCharset(string $collation): ?string
    Parameter
    type name summary
    ​string ​$collation ​
    Return
    type summary
    ​?string ​

    [N] Doctrine\DBAL\Platforms\MySQL\CollationMetadataProvider\

    [C] CachingCollationMetadataProvider

    final

    Implements
    type summary
    ​CollationMetadataProvider ​

    [m] __construct 

    public function __construct(Doctrine\DBAL\Platforms\MySQL\CollationMetadataProvider $collationMetadataProvider)
    Parameter
    type name summary
    ​CollationMetadataProvider ​$collationMetadataProvider ​

    [m] getCollationCharset 

    public function getCollationCharset(string $collation): ?string
    Parameter
    type name summary
    ​string ​$collation ​
    Return
    type summary
    ​?string ​
    Prototype
    kind source summary
    ​implement ​CollationMetadataProvider::getCollationCharset() ​

    [C] ConnectionCollationMetadataProvider

    final

    Implements
    type summary
    ​CollationMetadataProvider ​

    [m] __construct 

    public function __construct(Doctrine\DBAL\Connection $connection)
    Parameter
    type name summary
    ​Connection ​$connection ​

    [m] getCollationCharset 

    public function getCollationCharset(string $collation): ?string
    Parameter
    type name summary
    ​string ​$collation ​
    Return
    type summary
    ​?string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​CollationMetadataProvider::getCollationCharset() ​

    [N] Doctrine\DBAL\Platforms\SQLServer\SQL\Builder\

    [C] SQLServerSelectSQLBuilder

    final

    Implements
    type summary
    ​SelectSQLBuilder ​

    [m] __construct 

    public function __construct(Doctrine\DBAL\Platforms\SQLServerPlatform $platform)
    Parameter
    type name summary
    ​SQLServerPlatform ​$platform ​

    [m] buildSQL 

    public function buildSQL(Doctrine\DBAL\Query\SelectQuery $query): string
    Parameter
    type name summary
    ​SelectQuery ​$query ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​SelectSQLBuilder::buildSQL() ​

    [N] Doctrine\DBAL\Query\

    [C] QueryBuilder QueryBuilder class is responsible to dynamically create SQL queries.

    QueryBuilder class is responsible to dynamically create SQL queries.

    Important: Verify that every feature you use will work with your database vendor. SQL Query Builder does not attempt to validate the generated SQL at all.

    The query builder does no validation whatsoever if certain features even work with the underlying database vendor. Limit queries and joins are NOT applied to UPDATE and DELETE statements even if some vendors such as MySQL support it.

    Implements
    type summary
    ​Stringable ​

    [C] SELECT

    deprecated 

    public const int SELECT = 0

    [C] DELETE

    deprecated 

    public const int DELETE = 1

    [C] UPDATE

    deprecated 

    public const int UPDATE = 2

    [C] INSERT

    deprecated 

    public const int INSERT = 3

    [C] STATE_DIRTY

    deprecated 

    public const int STATE_DIRTY = 0

    [C] STATE_CLEAN

    deprecated 

    public const int STATE_CLEAN = 1

    [m] __construct Initializes a new <tt>QueryBuilder</tt>.

    Initializes a new QueryBuilder. 
    public function __construct(Doctrine\DBAL\Connection $connection)
    Parameter
    type name summary
    ​Connection ​$connection ​The DBAL Connection.

    [m] expr Gets an ExpressionBuilder used for object-oriented construction of query expressions.

    Gets an ExpressionBuilder used for object-oriented construction of query expressions. 
    public function expr(): Doctrine\DBAL\Query\Expression\ExpressionBuilder

    This producer method is intended for convenient inline usage. Example:

    $qb = $conn->createQueryBuilder() ->select('u') ->from('users', 'u') ->where($qb->expr()->eq('u.id', 1));

    For more complex expression construction, consider storing the expression builder object in a local variable.

    Return
    type summary
    ​ExpressionBuilder ​

    [m] getType Gets the type of the currently built query.

    deprecated

    Gets the type of the currently built query. 
    public function getType(): int
    Return
    type summary
    ​int ​

    [m] getConnection Gets the associated DBAL Connection for this query builder.

    deprecated

    Gets the associated DBAL Connection for this query builder. 
    public function getConnection(): Doctrine\DBAL\Connection
    Return
    type summary
    ​Connection ​

    [m] getState Gets the state of this query builder instance.

    deprecated

    Gets the state of this query builder instance. 
    public function getState(): int
    Return
    type summary
    ​int ​Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.

    [m] fetchAssociative Prepares and executes an SQL query and returns the first row of the result

    Prepares and executes an SQL query and returns the first row of the result 
    public function fetchAssociative(): array

    as an associative array.

    Return
    type summary
    ​array ​mixed>
    Throws
    type summary
    ​Exception ​

    [m] fetchNumeric Prepares and executes an SQL query and returns the first row of the result

    Prepares and executes an SQL query and returns the first row of the result 
    public function fetchNumeric(): array

    as a numerically indexed array.

    Return
    type summary
    ​array ​mixed>
    Throws
    type summary
    ​Exception ​

    [m] fetchOne Prepares and executes an SQL query and returns the value of a single column

    Prepares and executes an SQL query and returns the value of a single column 
    public function fetchOne(): mixed|false

    of the first row of the result.

    Return
    type summary
    ​mixed|​false ​False is returned if no rows are found.
    Throws
    type summary
    ​Exception ​

    [m] fetchAllNumeric Prepares and executes an SQL query and returns the result as an array of numeric arrays.

    Prepares and executes an SQL query and returns the result as an array of numeric arrays. 
    public function fetchAllNumeric(): array
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​

    [m] fetchAllAssociative Prepares and executes an SQL query and returns the result as an array of associative arrays.

    Prepares and executes an SQL query and returns the result as an array of associative arrays. 
    public function fetchAllAssociative(): array
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​

    [m] fetchAllKeyValue Prepares and executes an SQL query and returns the result as an associative array with the keys

    Prepares and executes an SQL query and returns the result as an associative array with the keys 
    public function fetchAllKeyValue(): array

    mapped to the first column and the values mapped to the second column.

    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​

    [m] fetchAllAssociativeIndexed Prepares and executes an SQL query and returns the result as an associative array with the keys mapped

    Prepares and executes an SQL query and returns the result as an associative array with the keys mapped 
    public function fetchAllAssociativeIndexed(): array

    to the first column and the values being an associative array representing the rest of the columns and their values.

    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​

    [m] fetchFirstColumn Prepares and executes an SQL query and returns the result as an array of the first column values.

    Prepares and executes an SQL query and returns the result as an array of the first column values. 
    public function fetchFirstColumn(): array
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​

    [m] executeQuery Executes an SQL query (SELECT) and returns a Result.

    Executes an SQL query (SELECT) and returns a Result. 
    public function executeQuery(): Doctrine\DBAL\Result
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​

    [m] executeStatement Executes an SQL statement and returns the number of affected rows.

    Executes an SQL statement and returns the number of affected rows. 
    public function executeStatement(): int

    Should be used for INSERT, UPDATE and DELETE

    Return
    type summary
    ​int ​The number of affected rows.
    Throws
    type summary
    ​Exception ​

    [m] execute Executes this query using the bound parameters and their types.

    deprecated

    Executes this query using the bound parameters and their types. 
    public function execute(): Doctrine\DBAL\Result|int|string
    Return
    type summary
    ​Result|​int|​string ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​QueryBuilder::executeQuery() ​
    ​QueryBuilder::executeStatement() ​

    [m] getSQL Gets the complete SQL string formed by the current specifications of this QueryBuilder.

    Gets the complete SQL string formed by the current specifications of this QueryBuilder. 
    public function getSQL(): string

    $qb = $em->createQueryBuilder() ->select('u') ->from('User', 'u') echo $qb->getSQL(); // SELECT u FROM User u

    Return
    type summary
    ​string ​The SQL query string.

    [m] setParameter Sets a query parameter for the query being constructed.

    Sets a query parameter for the query being constructed. 
    public function setParameter(
    int|string $key,
    mixed $value,
    int|string|Doctrine\DBAL\Types\Type|null $type = Doctrine\DBAL\ParameterType::STRING
): Doctrine\DBAL\Query\QueryBuilder

    $qb = $conn->createQueryBuilder() ->select('u') ->from('users', 'u') ->where('u.id = :user_id') ->setParameter('user_id', 1);

    Parameter
    type name summary
    ​int|​string ​$key ​Parameter position or name
    ​mixed ​$value ​Parameter value
    ​int|​string|​Type|​null ​$type = Doctrine\DBAL\ParameterType::STRING ​Parameter type
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] setParameters Sets a collection of query parameters for the query being constructed.

    Sets a collection of query parameters for the query being constructed. 
    public function setParameters(
    array $params,
    array $types = []
): Doctrine\DBAL\Query\QueryBuilder

    $qb = $conn->createQueryBuilder() ->select('u') ->from('users', 'u') ->where('u.id = :user_id1 OR u.id = :user_id2') ->setParameters(array( 'user_id1' => 1, 'user_id2' => 2 ));

    Parameter
    type name summary
    ​array ​$params ​
    ​array ​$types = [] ​
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] getParameters Gets all defined query parameters for the query being constructed indexed by parameter index or name.

    Gets all defined query parameters for the query being constructed indexed by parameter index or name. 
    public function getParameters(): list|array
    Return
    type summary
    ​list|​array ​mixed> The currently defined query parameters

    [m] getParameter Gets a (previously set) query parameter of the query being constructed.

    Gets a (previously set) query parameter of the query being constructed. 
    public function getParameter(mixed $key): mixed
    Parameter
    type name summary
    ​mixed ​$key ​The key (index or name) of the bound parameter.
    Return
    type summary
    ​mixed ​The value of the bound parameter.

    [m] getParameterTypes Gets all defined query parameter types for the query being constructed indexed by parameter index or name.

    Gets all defined query parameter types for the query being constructed indexed by parameter index or name. 
    public function getParameterTypes(): array
    Return
    type summary
    ​array ​int

    [m] getParameterType Gets a (previously set) query parameter type of the query being constructed.

    Gets a (previously set) query parameter type of the query being constructed. 
    public function getParameterType(int|string $key): int|string|Doctrine\DBAL\Types\Type
    Parameter
    type name summary
    ​int|​string ​$key ​The key of the bound parameter type
    Return
    type summary
    ​int|​string|​Type ​The value of the bound parameter type

    [m] setFirstResult Sets the position of the first result to retrieve (the "offset").

    Sets the position of the first result to retrieve (the "offset"). 
    public function setFirstResult(int $firstResult): Doctrine\DBAL\Query\QueryBuilder
    Parameter
    type name summary
    ​int ​$firstResult ​The first result to return.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] getFirstResult Gets the position of the first result the query object was set to retrieve (the "offset").

    Gets the position of the first result the query object was set to retrieve (the "offset"). 
    public function getFirstResult(): int
    Return
    type summary
    ​int ​The position of the first result.

    [m] setMaxResults Sets the maximum number of results to retrieve (the "limit").

    Sets the maximum number of results to retrieve (the "limit"). 
    public function setMaxResults(int|null $maxResults): Doctrine\DBAL\Query\QueryBuilder
    Parameter
    type name summary
    ​int|​null ​$maxResults ​The maximum number of results to retrieve or NULL to retrieve all results.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] getMaxResults Gets the maximum number of results the query object was set to retrieve (the "limit").

    Gets the maximum number of results the query object was set to retrieve (the "limit"). 
    public function getMaxResults(): int|null

    Returns NULL if all results will be returned.

    Return
    type summary
    ​int|​null ​The maximum number of results.

    [m] forUpdate Locks the queried rows for a subsequent update.

    Locks the queried rows for a subsequent update. 
    public function forUpdate(int $conflictResolutionMode = Doctrine\DBAL\Query\ForUpdate\ConflictResolutionMode::ORDINARY): Doctrine\DBAL\Query\QueryBuilder
    Parameter
    type name summary
    ​int ​$conflictResolutionMode = Doctrine\DBAL\Query\ForUpdate\ConflictResolutionMode::ORDINARY ​
    Return
    type summary
    ​QueryBuilder ​

    [m] add Either appends to or replaces a single, generic query part.

    Either appends to or replaces a single, generic query part. 
    public function add(
    string $sqlPartName,
    mixed $sqlPart,
    bool $append = false
): Doctrine\DBAL\Query\QueryBuilder

    The available parts are: 'select', 'from', 'set', 'where', 'groupBy', 'having' and 'orderBy'.

    Parameter
    type name summary
    ​string ​$sqlPartName ​
    ​mixed ​$sqlPart ​
    ​bool ​$append = false ​
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] select Specifies an item that is to be returned in the query result.

    Specifies an item that is to be returned in the query result. 
    public function select(string|string[]|null $select = null): Doctrine\DBAL\Query\QueryBuilder

    Replaces any previously specified selections, if any.

    USING AN ARRAY ARGUMENT IS DEPRECATED. Pass each value as an individual argument.

    $qb = $conn->createQueryBuilder() ->select('u.id', 'p.id') ->from('users', 'u') ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');

    Parameter
    type name summary
    ​string|​string[]|​null ​$select = null ​The selection expression. USING AN ARRAY OR NULL IS DEPRECATED.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] distinct Adds or removes DISTINCT to/from the query.

    magic

    Adds or removes DISTINCT to/from the query. 
    public function distinct(bool $distinct = true): Doctrine\DBAL\Query\QueryBuilder
    Parameter
    type name summary
    ​bool ​$distinct = true ​
    Return
    type summary
    ​QueryBuilder ​

    [m] addSelect Adds an item that is to be returned in the query result.

    Adds an item that is to be returned in the query result. 
    public function addSelect(string|string[]|null $select = null): Doctrine\DBAL\Query\QueryBuilder

    USING AN ARRAY ARGUMENT IS DEPRECATED. Pass each value as an individual argument.

    $qb = $conn->createQueryBuilder() ->select('u.id') ->addSelect('p.id') ->from('users', 'u') ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id');

    Parameter
    type name summary
    ​string|​string[]|​null ​$select = null ​The selection expression. USING AN ARRAY OR NULL IS DEPRECATED.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] delete Turns the query being built into a bulk delete query that ranges over

    Turns the query being built into a bulk delete query that ranges over 
    public function delete(
    string $delete = null,
    string $alias = null
): Doctrine\DBAL\Query\QueryBuilder

    a certain table.

    $qb = $conn->createQueryBuilder() ->delete('users', 'u') ->where('u.id = :user_id') ->setParameter(':user_id', 1);

    Parameter
    type name summary
    ​string ​$delete = null ​The table whose rows are subject to the deletion.
    ​string ​$alias = null ​The table alias used in the constructed query.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] update Turns the query being built into a bulk update query that ranges over

    Turns the query being built into a bulk update query that ranges over 
    public function update(
    string $update = null,
    string $alias = null
): Doctrine\DBAL\Query\QueryBuilder

    a certain table

    $qb = $conn->createQueryBuilder() ->update('counters', 'c') ->set('c.value', 'c.value + 1') ->where('c.id = ?');

    Parameter
    type name summary
    ​string ​$update = null ​The table whose rows are subject to the update.
    ​string ​$alias = null ​The table alias used in the constructed query.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] insert Turns the query being built into an insert query that inserts into

    Turns the query being built into an insert query that inserts into 
    public function insert(string $insert = null): Doctrine\DBAL\Query\QueryBuilder

    a certain table

    $qb = $conn->createQueryBuilder() ->insert('users') ->values( array( 'name' => '?', 'password' => '?' ) );

    Parameter
    type name summary
    ​string ​$insert = null ​The table into which the rows should be inserted.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] from Creates and adds a query root corresponding to the table identified by the

    Creates and adds a query root corresponding to the table identified by the 
    public function from(
    string $from,
    string|null $alias = null
): Doctrine\DBAL\Query\QueryBuilder

    given alias, forming a cartesian product with any existing query roots.

    $qb = $conn->createQueryBuilder() ->select('u.id') ->from('users', 'u')

    Parameter
    type name summary
    ​string ​$from ​The table.
    ​string|​null ​$alias = null ​The alias of the table.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] join Creates and adds a join to the query.

    Creates and adds a join to the query. 
    public function join(
    string $fromAlias,
    string $join,
    string $alias,
    string $condition = null
): Doctrine\DBAL\Query\QueryBuilder

    $qb = $conn->createQueryBuilder() ->select('u.name') ->from('users', 'u') ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1');

    Parameter
    type name summary
    ​string ​$fromAlias ​The alias that points to a from clause.
    ​string ​$join ​The table name to join.
    ​string ​$alias ​The alias of the join table.
    ​string ​$condition = null ​The condition for the join.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] innerJoin Creates and adds a join to the query.

    Creates and adds a join to the query. 
    public function innerJoin(
    string $fromAlias,
    string $join,
    string $alias,
    string $condition = null
): Doctrine\DBAL\Query\QueryBuilder

    $qb = $conn->createQueryBuilder() ->select('u.name') ->from('users', 'u') ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');

    Parameter
    type name summary
    ​string ​$fromAlias ​The alias that points to a from clause.
    ​string ​$join ​The table name to join.
    ​string ​$alias ​The alias of the join table.
    ​string ​$condition = null ​The condition for the join.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] leftJoin Creates and adds a left join to the query.

    Creates and adds a left join to the query. 
    public function leftJoin(
    string $fromAlias,
    string $join,
    string $alias,
    string $condition = null
): Doctrine\DBAL\Query\QueryBuilder

    $qb = $conn->createQueryBuilder() ->select('u.name') ->from('users', 'u') ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');

    Parameter
    type name summary
    ​string ​$fromAlias ​The alias that points to a from clause.
    ​string ​$join ​The table name to join.
    ​string ​$alias ​The alias of the join table.
    ​string ​$condition = null ​The condition for the join.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] rightJoin Creates and adds a right join to the query.

    Creates and adds a right join to the query. 
    public function rightJoin(
    string $fromAlias,
    string $join,
    string $alias,
    string $condition = null
): Doctrine\DBAL\Query\QueryBuilder

    $qb = $conn->createQueryBuilder() ->select('u.name') ->from('users', 'u') ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');

    Parameter
    type name summary
    ​string ​$fromAlias ​The alias that points to a from clause.
    ​string ​$join ​The table name to join.
    ​string ​$alias ​The alias of the join table.
    ​string ​$condition = null ​The condition for the join.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] set Sets a new value for a column in a bulk update query.

    Sets a new value for a column in a bulk update query. 
    public function set(
    string $key,
    string $value
): Doctrine\DBAL\Query\QueryBuilder

    $qb = $conn->createQueryBuilder() ->update('counters', 'c') ->set('c.value', 'c.value + 1') ->where('c.id = ?');

    Parameter
    type name summary
    ​string ​$key ​The column to set.
    ​string ​$value ​The value, expression, placeholder, etc.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] where Specifies one or more restrictions to the query result.

    Specifies one or more restrictions to the query result. 
    public function where(mixed $predicates): Doctrine\DBAL\Query\QueryBuilder

    Replaces any previously specified restrictions, if any.

    $qb = $conn->createQueryBuilder() ->select('c.value') ->from('counters', 'c') ->where('c.id = ?');

    // You can optionally programmatically build and/or expressions
$qb = $conn->createQueryBuilder();

$or = $qb->expr()->orx();
$or->add($qb->expr()->eq('c.id', 1));
$or->add($qb->expr()->eq('c.id', 2));

$qb->update('counters', 'c')
    ->set('c.value', 'c.value + 1')
    ->where($or);

    Parameter
    type name summary
    ​mixed ​$predicates ​The restriction predicates.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] andWhere Adds one or more restrictions to the query results, forming a logical

    Adds one or more restrictions to the query results, forming a logical 
    public function andWhere(mixed $where): Doctrine\DBAL\Query\QueryBuilder

    conjunction with any previously specified restrictions.

    $qb = $conn->createQueryBuilder() ->select('u') ->from('users', 'u') ->where('u.username LIKE ?') ->andWhere('u.is_active = 1');

    Parameter
    type name summary
    ​mixed ​$where ​The query restrictions.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.
    See
    type summary
    ​QueryBuilder::where() ​

    [m] orWhere Adds one or more restrictions to the query results, forming a logical

    Adds one or more restrictions to the query results, forming a logical 
    public function orWhere(mixed $where): Doctrine\DBAL\Query\QueryBuilder

    disjunction with any previously specified restrictions.

    $qb = $em->createQueryBuilder() ->select('u.name') ->from('users', 'u') ->where('u.id = 1') ->orWhere('u.id = 2');

    Parameter
    type name summary
    ​mixed ​$where ​The WHERE statement.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.
    See
    type summary
    ​QueryBuilder::where() ​

    [m] groupBy Specifies a grouping over the results of the query.

    Specifies a grouping over the results of the query. 
    public function groupBy(string|string[] $groupBy): Doctrine\DBAL\Query\QueryBuilder

    Replaces any previously specified groupings, if any.

    USING AN ARRAY ARGUMENT IS DEPRECATED. Pass each value as an individual argument.

    $qb = $conn->createQueryBuilder() ->select('u.name') ->from('users', 'u') ->groupBy('u.id');

    Parameter
    type name summary
    ​string|​string[] ​$groupBy ​The grouping expression. USING AN ARRAY IS DEPRECATED.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] addGroupBy Adds a grouping expression to the query.

    Adds a grouping expression to the query. 
    public function addGroupBy(string|string[] $groupBy): Doctrine\DBAL\Query\QueryBuilder

    USING AN ARRAY ARGUMENT IS DEPRECATED. Pass each value as an individual argument.

    $qb = $conn->createQueryBuilder() ->select('u.name') ->from('users', 'u') ->groupBy('u.lastLogin') ->addGroupBy('u.createdAt');

    Parameter
    type name summary
    ​string|​string[] ​$groupBy ​The grouping expression. USING AN ARRAY IS DEPRECATED.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] setValue Sets a value for a column in an insert query.

    Sets a value for a column in an insert query. 
    public function setValue(
    string $column,
    string $value
): Doctrine\DBAL\Query\QueryBuilder

    $qb = $conn->createQueryBuilder() ->insert('users') ->values( array( 'name' => '?' ) ) ->setValue('password', '?');

    Parameter
    type name summary
    ​string ​$column ​The column into which the value should be inserted.
    ​string ​$value ​The value that should be inserted into the column.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] values Specifies values for an insert query indexed by column names.

    Specifies values for an insert query indexed by column names. 
    public function values(array|mixed[] $values): Doctrine\DBAL\Query\QueryBuilder

    Replaces any previous values, if any.

    $qb = $conn->createQueryBuilder() ->insert('users') ->values( array( 'name' => '?', 'password' => '?' ) );

    Parameter
    type name summary
    ​array|​mixed[] ​$values ​The values to specify for the insert query indexed by column names.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] having Specifies a restriction over the groups of the query.

    Specifies a restriction over the groups of the query. 
    public function having(mixed $having): Doctrine\DBAL\Query\QueryBuilder

    Replaces any previous having restrictions, if any.

    Parameter
    type name summary
    ​mixed ​$having ​The restriction over the groups.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] andHaving Adds a restriction over the groups of the query, forming a logical

    Adds a restriction over the groups of the query, forming a logical 
    public function andHaving(mixed $having): Doctrine\DBAL\Query\QueryBuilder

    conjunction with any existing having restrictions.

    Parameter
    type name summary
    ​mixed ​$having ​The restriction to append.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] orHaving Adds a restriction over the groups of the query, forming a logical

    Adds a restriction over the groups of the query, forming a logical 
    public function orHaving(mixed $having): Doctrine\DBAL\Query\QueryBuilder

    disjunction with any existing having restrictions.

    Parameter
    type name summary
    ​mixed ​$having ​The restriction to add.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] orderBy Specifies an ordering for the query results.

    Specifies an ordering for the query results. 
    public function orderBy(
    string $sort,
    string $order = null
): Doctrine\DBAL\Query\QueryBuilder

    Replaces any previously specified orderings, if any.

    Parameter
    type name summary
    ​string ​$sort ​The ordering expression.
    ​string ​$order = null ​The ordering direction.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] addOrderBy Adds an ordering to the query results.

    Adds an ordering to the query results. 
    public function addOrderBy(
    string $sort,
    string $order = null
): Doctrine\DBAL\Query\QueryBuilder
    Parameter
    type name summary
    ​string ​$sort ​The ordering expression.
    ​string ​$order = null ​The ordering direction.
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] getQueryPart Gets a query part by its name.

    deprecated

    Gets a query part by its name. 
    public function getQueryPart(string $queryPartName): mixed
    Parameter
    type name summary
    ​string ​$queryPartName ​
    Return
    type summary
    ​mixed ​

    [m] getQueryParts Gets all query parts.

    deprecated

    Gets all query parts. 
    public function getQueryParts(): mixed[]
    Return
    type summary
    ​mixed[] ​

    [m] resetQueryParts Resets SQL parts.

    deprecated

    Resets SQL parts. 
    public function resetQueryParts(string[]|null $queryPartNames = null): Doctrine\DBAL\Query\QueryBuilder
    Parameter
    type name summary
    ​string[]|​null ​$queryPartNames = null ​
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] resetQueryPart Resets a single SQL part.

    deprecated

    Resets a single SQL part. 
    public function resetQueryPart(string $queryPartName): Doctrine\DBAL\Query\QueryBuilder
    Parameter
    type name summary
    ​string ​$queryPartName ​
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] resetWhere Resets the WHERE conditions for the query.

    Resets the WHERE conditions for the query. 
    public function resetWhere(): Doctrine\DBAL\Query\QueryBuilder
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] resetGroupBy Resets the grouping for the query.

    Resets the grouping for the query. 
    public function resetGroupBy(): Doctrine\DBAL\Query\QueryBuilder
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] resetHaving Resets the HAVING conditions for the query.

    Resets the HAVING conditions for the query. 
    public function resetHaving(): Doctrine\DBAL\Query\QueryBuilder
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] resetOrderBy Resets the ordering for the query.

    Resets the ordering for the query. 
    public function resetOrderBy(): Doctrine\DBAL\Query\QueryBuilder
    Return
    type summary
    ​QueryBuilder ​This QueryBuilder instance.

    [m] __toString Gets a string representation of this QueryBuilder which corresponds to

    Gets a string representation of this QueryBuilder which corresponds to 
    public function __toString(): string

    the final SQL query being constructed.

    Return
    type summary
    ​string ​The string representation of this QueryBuilder.
    Prototype
    kind source summary
    ​implement ​Stringable::__toString() ​

    [m] createNamedParameter Creates a new named parameter and bind the value $value to it.

    Creates a new named parameter and bind the value $value to it. 
    public function createNamedParameter(
    mixed $value,
    int|string|Doctrine\DBAL\Types\Type|null $type = Doctrine\DBAL\ParameterType::STRING,
    string $placeHolder = null
): string

    This method provides a shortcut for Doctrine\DBAL\Statement::bindValue() when using prepared statements.

    The parameter $value specifies the value that you want to bind. If $placeholder is not provided createNamedParameter() will automatically create a placeholder for you. An automatic placeholder will be of the name ':dcValue1', ':dcValue2' etc.

    Example: $value = 2; $q->eq( 'id', $q->createNamedParameter( $value ) ); $stmt = $q->executeQuery(); // executed with 'id = 2'

    Parameter
    type name summary
    ​mixed ​$value ​
    ​int|​string|​Type|​null ​$type = Doctrine\DBAL\ParameterType::STRING ​
    ​string ​$placeHolder = null ​The name to bind with. The string must start with a colon ':'.
    Return
    type summary
    ​string ​the placeholder name used.
    See
    type summary
    ​Statement::bindValue() ​

    [m] createPositionalParameter Creates a new positional parameter and bind the given value to it.

    Creates a new positional parameter and bind the given value to it. 
    public function createPositionalParameter(
    mixed $value,
    int|string|Doctrine\DBAL\Types\Type|null $type = Doctrine\DBAL\ParameterType::STRING
): string

    Attention: If you are using positional parameters with the query builder you have to be very careful to bind all parameters in the order they appear in the SQL statement , otherwise they get bound in the wrong order which can lead to serious bugs in your code.

    Example: $qb = $conn->createQueryBuilder(); $qb->select('u.*') ->from('users', 'u') ->where('u.username = ' . $qb->createPositionalParameter('Foo', ParameterType::STRING)) ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', ParameterType::STRING))

    Parameter
    type name summary
    ​mixed ​$value ​
    ​int|​string|​Type|​null ​$type = Doctrine\DBAL\ParameterType::STRING ​
    Return
    type summary
    ​string ​

    [m] __clone Deep clone of all expression objects in the SQL parts.

    Deep clone of all expression objects in the SQL parts. 
    public function __clone(): void
    Return
    type summary
    ​void ​

    [m] enableResultCache Enables caching of the results of this query, for given amount of seconds

    Enables caching of the results of this query, for given amount of seconds 
    public function enableResultCache(Doctrine\DBAL\Cache\QueryCacheProfile $cacheProfile): Doctrine\DBAL\Query\QueryBuilder

    and optionally specified which key to use for the cache entry.

    Parameter
    type name summary
    ​QueryCacheProfile ​$cacheProfile ​
    Return
    type summary
    ​QueryBuilder ​

    [m] disableResultCache Disables caching of the results of this query.

    Disables caching of the results of this query. 
    public function disableResultCache(): Doctrine\DBAL\Query\QueryBuilder
    Return
    type summary
    ​QueryBuilder ​

    [C] SelectQuery

    final

    [m] __construct 

    public function __construct(
    bool $distinct,
    array|string[] $columns,
    array|string[] $from,
    ?string $where,
    array|string[] $groupBy,
    ?string $having,
    array|string[] $orderBy,
    Doctrine\DBAL\Query\Limit $limit,
    ?Doctrine\DBAL\Query\ForUpdate $forUpdate
)
    Parameter
    type name summary
    ​bool ​$distinct ​
    ​array|​string[] ​$columns ​
    ​array|​string[] ​$from ​
    ​?string ​$where ​
    ​array|​string[] ​$groupBy ​
    ​?string ​$having ​
    ​array|​string[] ​$orderBy ​
    ​Limit ​$limit ​
    ​?ForUpdate ​$forUpdate ​

    [m] isDistinct 

    public function isDistinct(): bool
    Return
    type summary
    ​bool ​

    [m] getColumns 

    public function getColumns(): array|string[]
    Return
    type summary
    ​array|​string[] ​

    [m] getFrom 

    public function getFrom(): array|string[]
    Return
    type summary
    ​array|​string[] ​

    [m] getWhere 

    public function getWhere(): ?string
    Return
    type summary
    ​?string ​

    [m] getGroupBy 

    public function getGroupBy(): array|string[]
    Return
    type summary
    ​array|​string[] ​

    [m] getHaving 

    public function getHaving(): ?string
    Return
    type summary
    ​?string ​

    [m] getOrderBy 

    public function getOrderBy(): array|string[]
    Return
    type summary
    ​array|​string[] ​

    [m] getLimit 

    public function getLimit(): Doctrine\DBAL\Query\Limit
    Return
    type summary
    ​Limit ​

    [m] getForUpdate 

    public function getForUpdate(): ?Doctrine\DBAL\Query\ForUpdate
    Return
    type summary
    ​?ForUpdate ​

    [C] QueryException

    Hierarchy

    Parents
    type summary
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Stringable ​
    ​Throwable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] unknownAlias 

    public static function unknownAlias(
    string $alias,
    string[] $registeredAliases
): Doctrine\DBAL\Query\QueryException
    Parameter
    type name summary
    ​string ​$alias ​
    ​string[] ​$registeredAliases ​
    Return
    type summary
    ​QueryException ​

    [M] nonUniqueAlias 

    public static function nonUniqueAlias(
    string $alias,
    string[] $registeredAliases
): Doctrine\DBAL\Query\QueryException
    Parameter
    type name summary
    ​string ​$alias ​
    ​string[] ​$registeredAliases ​
    Return
    type summary
    ​QueryException ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] Limit

    final

    [m] __construct 

    public function __construct(
    ?int $maxResults,
    int $firstResult
)
    Parameter
    type name summary
    ​?int ​$maxResults ​
    ​int ​$firstResult ​

    [m] isDefined 

    public function isDefined(): bool
    Return
    type summary
    ​bool ​

    [m] getMaxResults 

    public function getMaxResults(): ?int
    Return
    type summary
    ​?int ​

    [m] getFirstResult 

    public function getFirstResult(): int
    Return
    type summary
    ​int ​

    [C] ForUpdate

    final

    [m] __construct 

    public function __construct(int $conflictResolutionMode)
    Parameter
    type name summary
    ​int ​$conflictResolutionMode ​

    [m] getConflictResolutionMode 

    public function getConflictResolutionMode(): int
    Return
    type summary
    ​int ​

    [N] Doctrine\DBAL\Query\Expression\

    [C] ExpressionBuilder ExpressionBuilder class is responsible to dynamically create SQL query parts.

    ExpressionBuilder class is responsible to dynamically create SQL query parts.

    [C] EQ 

    public const string EQ = "="

    [C] NEQ 

    public const string NEQ = "<>"

    [C] LT 

    public const string LT = "<"

    [C] LTE 

    public const string LTE = "<="

    [C] GT 

    public const string GT = ">"

    [C] GTE 

    public const string GTE = ">="

    [m] __construct Initializes a new <tt>ExpressionBuilder</tt>.

    Initializes a new ExpressionBuilder. 
    public function __construct(Doctrine\DBAL\Connection $connection)
    Parameter
    type name summary
    ​Connection ​$connection ​The DBAL Connection.

    [m] and Creates a conjunction of the given expressions.

    Creates a conjunction of the given expressions. 
    public function and(
    string|Doctrine\DBAL\Query\Expression\CompositeExpression $expression,
    string|Doctrine\DBAL\Query\Expression\CompositeExpression ...$expressions
): Doctrine\DBAL\Query\Expression\CompositeExpression
    Parameter
    type name summary
    ​string|​CompositeExpression ​$expression ​
    ​string|​CompositeExpression ​...$expressions ​
    Return
    type summary
    ​CompositeExpression ​

    [m] or Creates a disjunction of the given expressions.

    Creates a disjunction of the given expressions. 
    public function or(
    string|Doctrine\DBAL\Query\Expression\CompositeExpression $expression,
    string|Doctrine\DBAL\Query\Expression\CompositeExpression ...$expressions
): Doctrine\DBAL\Query\Expression\CompositeExpression
    Parameter
    type name summary
    ​string|​CompositeExpression ​$expression ​
    ​string|​CompositeExpression ​...$expressions ​
    Return
    type summary
    ​CompositeExpression ​

    [m] andX

    deprecated 

    public function andX(mixed $x = null): Doctrine\DBAL\Query\Expression\CompositeExpression
    Parameter
    type name summary
    ​mixed ​$x = null ​Optional clause. Defaults = null, but requires
    Return
    type summary
    ​CompositeExpression ​

    [m] orX

    deprecated 

    public function orX(mixed $x = null): Doctrine\DBAL\Query\Expression\CompositeExpression
    Parameter
    type name summary
    ​mixed ​$x = null ​Optional clause. Defaults = null, but requires
    Return
    type summary
    ​CompositeExpression ​

    [m] comparison Creates a comparison expression.

    Creates a comparison expression. 
    public function comparison(
    mixed $x,
    string $operator,
    mixed $y
): string
    Parameter
    type name summary
    ​mixed ​$x ​The left expression.
    ​string ​$operator ​One of the ExpressionBuilder::* constants.
    ​mixed ​$y ​The right expression.
    Return
    type summary
    ​string ​

    [m] eq Creates an equality comparison expression with the given arguments.

    Creates an equality comparison expression with the given arguments. 
    public function eq(
    mixed $x,
    mixed $y
): string

    First argument is considered the left expression and the second is the right expression. When converted to string, it will generated a = . Example:

    [php]
// u.id = ?
$expr->eq('u.id', '?');
    Parameter
    type name summary
    ​mixed ​$x ​The left expression.
    ​mixed ​$y ​The right expression.
    Return
    type summary
    ​string ​

    [m] neq Creates a non equality comparison expression with the given arguments.

    Creates a non equality comparison expression with the given arguments. 
    public function neq(
    mixed $x,
    mixed $y
): string

    First argument is considered the left expression and the second is the right expression. When converted to string, it will generated a <> . Example:

    [php]
// u.id <> 1
$q->where($q->expr()->neq('u.id', '1'));
    Parameter
    type name summary
    ​mixed ​$x ​The left expression.
    ​mixed ​$y ​The right expression.
    Return
    type summary
    ​string ​

    [m] lt Creates a lower-than comparison expression with the given arguments.

    Creates a lower-than comparison expression with the given arguments. 
    public function lt(
    mixed $x,
    mixed $y
): string

    First argument is considered the left expression and the second is the right expression. When converted to string, it will generated a < . Example:

    [php]
// u.id < ?
$q->where($q->expr()->lt('u.id', '?'));
    Parameter
    type name summary
    ​mixed ​$x ​The left expression.
    ​mixed ​$y ​The right expression.
    Return
    type summary
    ​string ​

    [m] lte Creates a lower-than-equal comparison expression with the given arguments.

    Creates a lower-than-equal comparison expression with the given arguments. 
    public function lte(
    mixed $x,
    mixed $y
): string

    First argument is considered the left expression and the second is the right expression. When converted to string, it will generated a <= . Example:

    [php]
// u.id <= ?
$q->where($q->expr()->lte('u.id', '?'));
    Parameter
    type name summary
    ​mixed ​$x ​The left expression.
    ​mixed ​$y ​The right expression.
    Return
    type summary
    ​string ​

    [m] gt Creates a greater-than comparison expression with the given arguments.

    Creates a greater-than comparison expression with the given arguments. 
    public function gt(
    mixed $x,
    mixed $y
): string

    First argument is considered the left expression and the second is the right expression. When converted to string, it will generated a > . Example:

    [php]
// u.id > ?
$q->where($q->expr()->gt('u.id', '?'));
    Parameter
    type name summary
    ​mixed ​$x ​The left expression.
    ​mixed ​$y ​The right expression.
    Return
    type summary
    ​string ​

    [m] gte Creates a greater-than-equal comparison expression with the given arguments.

    Creates a greater-than-equal comparison expression with the given arguments. 
    public function gte(
    mixed $x,
    mixed $y
): string

    First argument is considered the left expression and the second is the right expression. When converted to string, it will generated a >= . Example:

    [php]
// u.id >= ?
$q->where($q->expr()->gte('u.id', '?'));
    Parameter
    type name summary
    ​mixed ​$x ​The left expression.
    ​mixed ​$y ​The right expression.
    Return
    type summary
    ​string ​

    [m] isNull Creates an IS NULL expression with the given arguments.

    Creates an IS NULL expression with the given arguments. 
    public function isNull(string $x): string
    Parameter
    type name summary
    ​string ​$x ​The expression to be restricted by IS NULL.
    Return
    type summary
    ​string ​

    [m] isNotNull Creates an IS NOT NULL expression with the given arguments.

    Creates an IS NOT NULL expression with the given arguments. 
    public function isNotNull(string $x): string
    Parameter
    type name summary
    ​string ​$x ​The expression to be restricted by IS NOT NULL.
    Return
    type summary
    ​string ​

    [m] like Creates a LIKE() comparison expression with the given arguments.

    Creates a LIKE() comparison expression with the given arguments. 
    public function like(
    string $x,
    mixed $y
): string
    Parameter
    type name summary
    ​string ​$x ​The expression to be inspected by the LIKE comparison
    ​mixed ​$y ​The pattern to compare against
    Return
    type summary
    ​string ​

    [m] notLike Creates a NOT LIKE() comparison expression with the given arguments.

    Creates a NOT LIKE() comparison expression with the given arguments. 
    public function notLike(
    string $x,
    mixed $y
): string
    Parameter
    type name summary
    ​string ​$x ​The expression to be inspected by the NOT LIKE comparison
    ​mixed ​$y ​The pattern to compare against
    Return
    type summary
    ​string ​

    [m] in Creates an IN () comparison expression with the given arguments.

    Creates an IN () comparison expression with the given arguments. 
    public function in(
    string $x,
    string|string[] $y
): string
    Parameter
    type name summary
    ​string ​$x ​The SQL expression to be matched against the set.
    ​string|​string[] ​$y ​The SQL expression or an array of SQL expressions representing the set.
    Return
    type summary
    ​string ​

    [m] notIn Creates a NOT IN () comparison expression with the given arguments.

    Creates a NOT IN () comparison expression with the given arguments. 
    public function notIn(
    string $x,
    string|string[] $y
): string
    Parameter
    type name summary
    ​string ​$x ​The SQL expression to be matched against the set.
    ​string|​string[] ​$y ​The SQL expression or an array of SQL expressions representing the set.
    Return
    type summary
    ​string ​

    [m] literal Builds an SQL literal from a given input parameter.

    Builds an SQL literal from a given input parameter. 
    public function literal(
    mixed $input,
    int|null $type = null
): string

    The usage of this method is discouraged. Use prepared statements or AbstractPlatform::quoteStringLiteral() instead.

    Parameter
    type name summary
    ​mixed ​$input ​The parameter to be quoted.
    ​int|​null ​$type = null ​The type of the parameter.
    Return
    type summary
    ​string ​
    See
    type summary
    ​AbstractPlatform::quoteStringLiteral() ​

    [C] CompositeExpression Composite expression is responsible to build a group of similar expression.

    Composite expression is responsible to build a group of similar expression.

    Implements
    type summary
    ​Countable ​
    ​Stringable ​

    [C] TYPE_AND Constant that represents an AND composite expression.

    Constant that represents an AND composite expression. 
    public const string TYPE_AND = "AND"

    [C] TYPE_OR Constant that represents an OR composite expression.

    Constant that represents an OR composite expression. 
    public const string TYPE_OR = "OR"

    [m] __construct 

    public function __construct(
    string $type,
    array|Doctrine\DBAL\Query\Expression\CompositeExpression[]|string[] $parts = []
)
    Parameter
    type name summary
    ​string ​$type ​Instance type of composite expression.
    ​array|​CompositeExpression[]|​string[] ​$parts = [] ​Composition of expressions to be joined on composite expression.

    [M] and 

    public static function and(
    Doctrine\DBAL\Query\Expression\CompositeExpression|string $part,
    Doctrine\DBAL\Query\Expression\CompositeExpression|string ...$parts
): Doctrine\DBAL\Query\Expression\CompositeExpression
    Parameter
    type name summary
    ​CompositeExpression|​string ​$part ​
    ​CompositeExpression|​string ​...$parts ​
    Return
    type summary
    ​CompositeExpression ​

    [M] or 

    public static function or(
    Doctrine\DBAL\Query\Expression\CompositeExpression|string $part,
    Doctrine\DBAL\Query\Expression\CompositeExpression|string ...$parts
): Doctrine\DBAL\Query\Expression\CompositeExpression
    Parameter
    type name summary
    ​CompositeExpression|​string ​$part ​
    ​CompositeExpression|​string ​...$parts ​
    Return
    type summary
    ​CompositeExpression ​

    [m] addMultiple Adds multiple parts to composite expression.

    deprecated

    Adds multiple parts to composite expression. 
    public function addMultiple(array|Doctrine\DBAL\Query\Expression\CompositeExpression[]|string[] $parts = []): Doctrine\DBAL\Query\Expression\CompositeExpression
    Parameter
    type name summary
    ​array|​CompositeExpression[]|​string[] ​$parts = [] ​
    Return
    type summary
    ​CompositeExpression ​

    [m] add Adds an expression to composite expression.

    deprecated

    Adds an expression to composite expression. 
    public function add(mixed $part): Doctrine\DBAL\Query\Expression\CompositeExpression
    Parameter
    type name summary
    ​mixed ​$part ​
    Return
    type summary
    ​CompositeExpression ​

    [m] with Returns a new CompositeExpression with the given parts added.

    Returns a new CompositeExpression with the given parts added. 
    public function with(
    Doctrine\DBAL\Query\Expression\CompositeExpression|string $part,
    Doctrine\DBAL\Query\Expression\CompositeExpression|string ...$parts
): Doctrine\DBAL\Query\Expression\CompositeExpression
    Parameter
    type name summary
    ​CompositeExpression|​string ​$part ​
    ​CompositeExpression|​string ​...$parts ​
    Return
    type summary
    ​CompositeExpression ​

    [m] count Retrieves the amount of expressions on composite expression.

    Retrieves the amount of expressions on composite expression. 
    public function count(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​implement ​Countable::count() ​

    [m] __toString Retrieves the string representation of this composite expression.

    Retrieves the string representation of this composite expression. 
    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​implement ​Stringable::__toString() ​

    [m] getType Returns the type of this composite expression (AND/OR).

    Returns the type of this composite expression (AND/OR). 
    public function getType(): string
    Return
    type summary
    ​string ​

    [N] Doctrine\DBAL\Query\ForUpdate\

    [C] ConflictResolutionMode

    final

    [C] ORDINARY Wait for the row to be unlocked

    Wait for the row to be unlocked 
    public const int ORDINARY = 0

    [C] SKIP_LOCKED Skip the row if it is locked

    Skip the row if it is locked 
    public const int SKIP_LOCKED = 1

    [N] Doctrine\DBAL\SQL\

    [C] Parser The SQL parser that focuses on identifying prepared statement parameters. It implements parsing other tokens like

    final

    The SQL parser that focuses on identifying prepared statement parameters. It implements parsing other tokens like string literals and comments only as a way to not confuse their contents with the the parameter placeholders.

    The parsing logic and the implementation is inspired by the PHP PDO parser.

    See
    type summary
    ​https://github.com/php/php-src/blob/php-7.4.12/ext/pdo/pdo_sql_parser.re#L49-L69 ​

    [m] __construct 

    public function __construct(bool $mySQLStringEscaping)
    Parameter
    type name summary
    ​bool ​$mySQLStringEscaping ​

    [m] parse Parses the given SQL statement

    Parses the given SQL statement 
    public function parse(
    string $sql,
    Doctrine\DBAL\SQL\Parser\Visitor $visitor
)
    Parameter
    type name summary
    ​string ​$sql ​
    ​Visitor ​$visitor ​
    Throws
    type summary
    ​Exception ​

    [N] Doctrine\DBAL\SQL\Builder\

    [C] CreateSchemaObjectsSQLBuilder

    final

    [m] __construct 

    public function __construct(Doctrine\DBAL\Platforms\AbstractPlatform $platform)
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​

    [m] buildSQL 

    public function buildSQL(Doctrine\DBAL\Schema\Schema $schema): array|list
    Parameter
    type name summary
    ​Schema ​$schema ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [C] DropSchemaObjectsSQLBuilder

    final

    [m] __construct 

    public function __construct(Doctrine\DBAL\Platforms\AbstractPlatform $platform)
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​

    [m] buildSQL 

    public function buildSQL(Doctrine\DBAL\Schema\Schema $schema): array|list
    Parameter
    type name summary
    ​Schema ​$schema ​
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [C] DefaultSelectSQLBuilder

    final

    Implements
    type summary
    ​SelectSQLBuilder ​

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Platforms\AbstractPlatform $platform,
    ?string $forUpdateSQL,
    ?string $skipLockedSQL
)
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    ​?string ​$forUpdateSQL ​
    ​?string ​$skipLockedSQL ​

    [m] buildSQL 

    public function buildSQL(Doctrine\DBAL\Query\SelectQuery $query): string
    Parameter
    type name summary
    ​SelectQuery ​$query ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​implement ​SelectSQLBuilder::buildSQL() ​

    [I] SelectSQLBuilder

    abstract

    Hierarchy

    [m] buildSQL

    abstract

    abstract public function buildSQL(Doctrine\DBAL\Query\SelectQuery $query): string
    Parameter
    type name summary
    ​SelectQuery ​$query ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​

    [N] Doctrine\DBAL\SQL\Parser\

    [I] Exception

    abstract

    Hierarchy

    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [m] getMessage

    abstract

    abstract public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getMessage() ​

    [m] getCode

    abstract

    abstract public function getCode()
    Prototype
    kind source summary
    ​inherit ​Throwable::getCode() ​

    [m] getFile

    abstract

    abstract public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getFile() ​

    [m] getLine

    abstract

    abstract public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getLine() ​

    [m] getTrace

    abstract

    abstract public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getTrace() ​

    [m] getPrevious

    abstract

    abstract public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getPrevious() ​

    [m] getTraceAsString

    abstract

    abstract public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Throwable::getTraceAsString() ​

    [m] __toString

    abstract

    abstract public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Stringable::__toString() ​

    [I] Visitor SQL parser visitor

    abstract

    SQL parser visitor

    [m] acceptPositionalParameter Accepts an SQL fragment containing a positional parameter

    abstract

    Accepts an SQL fragment containing a positional parameter 
    abstract public function acceptPositionalParameter(string $sql)
    Parameter
    type name summary
    ​string ​$sql ​

    [m] acceptNamedParameter Accepts an SQL fragment containing a named parameter

    abstract

    Accepts an SQL fragment containing a named parameter 
    abstract public function acceptNamedParameter(string $sql)
    Parameter
    type name summary
    ​string ​$sql ​

    [m] acceptOther Accepts other SQL fragments

    abstract

    Accepts other SQL fragments 
    abstract public function acceptOther(string $sql)
    Parameter
    type name summary
    ​string ​$sql ​

    [N] Doctrine\DBAL\SQL\Parser\Exception\

    [C] RegularExpressionError

    Hierarchy

    Parents
    type summary
    ​RuntimeException ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​
    ​Exception ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(): Doctrine\DBAL\SQL\Parser\Exception\RegularExpressionError
    Return
    type summary
    ​RegularExpressionError ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [N] Doctrine\DBAL\Schema\

    [C] AbstractSchemaManager Base class for schema managers. Schema managers are used to inspect and/or

    abstract

    Base class for schema managers. Schema managers are used to inspect and/or modify the database schema/structure.

    Hierarchy

    [p] $_conn Holds instance of the Doctrine connection for this schema manager.

    Holds instance of the Doctrine connection for this schema manager. 
    protected Doctrine\DBAL\Connection $_conn = null

    Type: Connection

    [p] $_platform Holds instance of the database platform used for this schema manager.

    Holds instance of the database platform used for this schema manager. 
    protected T $_platform = null

    Type: T

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Connection $connection,
    Doctrine\DBAL\Platforms\AbstractPlatform|T $platform
)
    Parameter
    type name summary
    ​Connection ​$connection ​
    ​AbstractPlatform|​T ​$platform ​

    [m] getDatabasePlatform Returns the associated platform.

    deprecated

    Returns the associated platform. 
    public function getDatabasePlatform(): T
    Return
    type summary
    ​T ​

    [m] tryMethod Tries any method on the schema manager. Normally a method throws an

    deprecated

    Tries any method on the schema manager. Normally a method throws an 
    public function tryMethod(): mixed

    exception when your DBMS doesn't support it or if an error occurs. This method allows you to try and method on your SchemaManager instance and will return false if it does not work or is not supported.

    $result = $sm->tryMethod('dropView', 'view_name');

    Return
    type summary
    ​mixed ​

    [m] listDatabases Lists the available databases for this connection.

    Lists the available databases for this connection. 
    public function listDatabases(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​

    [m] listNamespaceNames Returns a list of all namespaces in the current database.

    deprecated

    Returns a list of all namespaces in the current database. 
    public function listNamespaceNames(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] listSchemaNames Returns a list of the names of all schemata in the current database.

    Returns a list of the names of all schemata in the current database. 
    public function listSchemaNames(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [m] listSequences Lists the available sequences for this connection.

    Lists the available sequences for this connection. 
    public function listSequences(string|null $database = null): Doctrine\DBAL\Schema\Sequence[]
    Parameter
    type name summary
    ​string|​null ​$database = null ​
    Return
    type summary
    ​Sequence[] ​
    Throws
    type summary
    ​Exception ​

    [m] listTableColumns Lists the columns for a given table.

    Lists the columns for a given table. 
    public function listTableColumns(
    string $table,
    string|null $database = null
): Doctrine\DBAL\Schema\Column[]

    In contrast to other libraries and to the old version of Doctrine, this column definition does try to contain the 'primary' column for the reason that it is not portable across different RDBMS. Use listTableIndexes($tableName) to retrieve the primary key of a table. Where a RDBMS specifies more details, these are held in the platformDetails array.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string|​null ​$database = null ​
    Return
    type summary
    ​Column[] ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​listTableIndexes($tableName) ​

    [m] doListTableColumns 

    protected function doListTableColumns(
    string $table,
    string|null $database = null
): array|Doctrine\DBAL\Schema\Column[]
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​array|​Column[] ​
    Throws
    type summary
    ​Exception ​

    [m] listTableIndexes Lists the indexes for a given table returning an array of Index instances.

    Lists the indexes for a given table returning an array of Index instances. 
    public function listTableIndexes(string $table): Doctrine\DBAL\Schema\Index[]

    Keys of the portable indexes list are all lower-cased.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    Return
    type summary
    ​Index[] ​
    Throws
    type summary
    ​Exception ​

    [m] doListTableIndexes 

    protected function doListTableIndexes(string $table): array|Doctrine\DBAL\Schema\Index[]
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​array|​Index[] ​
    Throws
    type summary
    ​Exception ​

    [m] tablesExist Returns true if all the given tables exist.

    Returns true if all the given tables exist. 
    public function tablesExist(string|string[] $names): bool

    The usage of a string $tableNames is deprecated. Pass a one-element array instead.

    Parameter
    type name summary
    ​string|​string[] ​$names ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​

    [m] listTableNames Returns a list of all tables in the current database.

    Returns a list of all tables in the current database. 
    public function listTableNames(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​

    [m] doListTableNames 

    protected function doListTableNames(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [m] filterAssetNames Filters asset names if they are configured to return only a subset of all

    Filters asset names if they are configured to return only a subset of all 
    protected function filterAssetNames(mixed[] $assetNames): mixed[]

    the found elements.

    Parameter
    type name summary
    ​mixed[] ​$assetNames ​
    Return
    type summary
    ​mixed[] ​

    [m] listTables Lists the tables for this connection.

    Lists the tables for this connection. 
    public function listTables(): list
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​

    [m] doListTables 

    protected function doListTables(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​

    [m] listTableDetails

    deprecated 

    public function listTableDetails(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​AbstractSchemaManager::introspectTable() ​

    [m] doListTableDetails 

    protected function doListTableDetails(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​

    [m] normalizeName An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted.

    An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted. 
    protected function normalizeName(string $name): string

    Such platforms should convert a possibly quoted name into a value of the corresponding case.

    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​

    [m] selectTableNames Selects names of tables in the specified database.

    Selects names of tables in the specified database. 
    protected function selectTableNames(string $databaseName): Doctrine\DBAL\Result
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​

    [m] selectTableColumns Selects definitions of table columns in the specified database. If the table name is specified, narrows down

    Selects definitions of table columns in the specified database. If the table name is specified, narrows down 
    protected function selectTableColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​

    [m] selectIndexColumns Selects definitions of index columns in the specified database. If the table name is specified, narrows down

    Selects definitions of index columns in the specified database. If the table name is specified, narrows down 
    protected function selectIndexColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​

    [m] selectForeignKeyColumns Selects definitions of foreign key columns in the specified database. If the table name is specified,

    Selects definitions of foreign key columns in the specified database. If the table name is specified, 
    protected function selectForeignKeyColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    narrows down the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​

    [m] fetchTableColumnsByTable Fetches definitions of table columns in the specified database and returns them grouped by table name.

    Fetches definitions of table columns in the specified database and returns them grouped by table name. 
    protected function fetchTableColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​

    [m] fetchIndexColumnsByTable Fetches definitions of index columns in the specified database and returns them grouped by table name.

    Fetches definitions of index columns in the specified database and returns them grouped by table name. 
    protected function fetchIndexColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​

    [m] fetchForeignKeyColumnsByTable Fetches definitions of foreign key columns in the specified database and returns them grouped by table name.

    Fetches definitions of foreign key columns in the specified database and returns them grouped by table name. 
    protected function fetchForeignKeyColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​list<array<string, mixed>>>
    Throws
    type summary
    ​Exception ​

    [m] fetchTableOptionsByTable Fetches table options for the tables in the specified database and returns them grouped by table name.

    Fetches table options for the tables in the specified database and returns them grouped by table name. 
    protected function fetchTableOptionsByTable(
    string $databaseName,
    ?string $tableName = null
): array

    If the table name is specified, narrows down the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​

    [m] introspectTable Introspects the table with the given name.

    Introspects the table with the given name. 
    public function introspectTable(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​

    [m] listViews Lists the views this connection has.

    Lists the views this connection has. 
    public function listViews(): Doctrine\DBAL\Schema\View[]
    Return
    type summary
    ​View[] ​
    Throws
    type summary
    ​Exception ​

    [m] listTableForeignKeys Lists the foreign keys for the given table.

    Lists the foreign keys for the given table. 
    public function listTableForeignKeys(
    string $table,
    string|null $database = null
): Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string|​null ​$database = null ​
    Return
    type summary
    ​ForeignKeyConstraint[] ​
    Throws
    type summary
    ​Exception ​

    [m] doListTableForeignKeys 

    protected function doListTableForeignKeys(
    string $table,
    string|null $database = null
): array|Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​array|​ForeignKeyConstraint[] ​
    Throws
    type summary
    ​Exception ​

    [m] dropDatabase Drops a database.

    Drops a database. 
    public function dropDatabase(string $database): void

    NOTE: You can not drop the database this SchemaManager is currently connected to.

    Parameter
    type name summary
    ​string ​$database ​The name of the database to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] dropSchema Drops a schema.

    Drops a schema. 
    public function dropSchema(string $schemaName)
    Parameter
    type name summary
    ​string ​$schemaName ​
    Throws
    type summary
    ​Exception ​

    [m] dropTable Drops the given table.

    Drops the given table. 
    public function dropTable(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the table to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] dropIndex Drops the index from the given table.

    Drops the index from the given table. 
    public function dropIndex(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index|​string ​$index ​The name of the index.
    ​Table|​string ​$table ​The name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] dropConstraint Drops the constraint from the given table.

    deprecated

    Drops the constraint from the given table. 
    public function dropConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​The name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::dropForeignKey() ​
    ​AbstractSchemaManager::dropUniqueConstraint() ​

    [m] dropForeignKey Drops a foreign key from a table.

    Drops a foreign key from a table. 
    public function dropForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​The name of the foreign key.
    ​Table|​string ​$table ​The name of the table with the foreign key.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] dropSequence Drops a sequence with a given name.

    Drops a sequence with a given name. 
    public function dropSequence(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the sequence to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] dropUniqueConstraint Drops the unique constraint from the given table.

    Drops the unique constraint from the given table. 
    public function dropUniqueConstraint(
    string $name,
    string $tableName
)
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Throws
    type summary
    ​Exception ​

    [m] dropView Drops a view.

    Drops a view. 
    public function dropView(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the view.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] createSchemaObjects 

    public function createSchemaObjects(Doctrine\DBAL\Schema\Schema $schema)
    Parameter
    type name summary
    ​Schema ​$schema ​
    Throws
    type summary
    ​Exception ​

    [m] createDatabase Creates a new database.

    Creates a new database. 
    public function createDatabase(string $database): void
    Parameter
    type name summary
    ​string ​$database ​The name of the database to create.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] createTable Creates a new table.

    Creates a new table. 
    public function createTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] createSequence Creates a new sequence.

    Creates a new sequence. 
    public function createSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] createConstraint Creates a constraint on a table.

    deprecated

    Creates a constraint on a table. 
    public function createConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​AbstractSchemaManager::createIndex() ​
    ​AbstractSchemaManager::createForeignKey() ​
    ​AbstractSchemaManager::createUniqueConstraint() ​

    [m] createIndex Creates a new index on a table.

    Creates a new index on a table. 
    public function createIndex(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] createForeignKey Creates a new foreign key.

    Creates a new foreign key. 
    public function createForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The ForeignKey instance.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] createUniqueConstraint Creates a unique constraint on a table.

    Creates a unique constraint on a table. 
    public function createUniqueConstraint(
    Doctrine\DBAL\Schema\UniqueConstraint $uniqueConstraint,
    string $tableName
)
    Parameter
    type name summary
    ​UniqueConstraint ​$uniqueConstraint ​
    ​string ​$tableName ​
    Throws
    type summary
    ​Exception ​

    [m] createView Creates a new view.

    Creates a new view. 
    public function createView(Doctrine\DBAL\Schema\View $view): void
    Parameter
    type name summary
    ​View ​$view ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] dropSchemaObjects 

    public function dropSchemaObjects(Doctrine\DBAL\Schema\Schema $schema)
    Parameter
    type name summary
    ​Schema ​$schema ​
    Throws
    type summary
    ​Exception ​

    [m] dropAndCreateConstraint Drops and creates a constraint.

    deprecated

    Drops and creates a constraint. 
    public function dropAndCreateConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::createIndex() ​
    ​AbstractSchemaManager::createForeignKey() ​
    ​AbstractSchemaManager::createUniqueConstraint() ​
    ​AbstractSchemaManager::dropConstraint() ​
    ​AbstractSchemaManager::createConstraint() ​

    [m] dropAndCreateIndex Drops and creates a new index on a table.

    deprecated

    Drops and creates a new index on a table. 
    public function dropAndCreateIndex(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::createIndex() ​

    [m] dropAndCreateForeignKey Drops and creates a new foreign key.

    deprecated

    Drops and creates a new foreign key. 
    public function dropAndCreateForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​An associative array that defines properties
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​AbstractSchemaManager::dropForeignKey() ​
    ​AbstractSchemaManager::createForeignKey() ​

    [m] dropAndCreateSequence Drops and create a new sequence.

    deprecated

    Drops and create a new sequence. 
    public function dropAndCreateSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​AbstractSchemaManager::dropSequence() ​
    ​AbstractSchemaManager::createSequence() ​

    [m] dropAndCreateTable Drops and creates a new table.

    deprecated

    Drops and creates a new table. 
    public function dropAndCreateTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​AbstractSchemaManager::dropTable() ​
    ​AbstractSchemaManager::createTable() ​

    [m] dropAndCreateDatabase Drops and creates a new database.

    deprecated

    Drops and creates a new database. 
    public function dropAndCreateDatabase(string $database): void
    Parameter
    type name summary
    ​string ​$database ​The name of the database to create.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​AbstractSchemaManager::dropDatabase() ​
    ​AbstractSchemaManager::createDatabase() ​

    [m] dropAndCreateView Drops and creates a new view.

    deprecated

    Drops and creates a new view. 
    public function dropAndCreateView(Doctrine\DBAL\Schema\View $view): void
    Parameter
    type name summary
    ​View ​$view ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​AbstractSchemaManager::dropView() ​
    ​AbstractSchemaManager::createView() ​

    [m] alterSchema Alters an existing schema.

    Alters an existing schema. 
    public function alterSchema(Doctrine\DBAL\Schema\SchemaDiff $schemaDiff)
    Parameter
    type name summary
    ​SchemaDiff ​$schemaDiff ​
    Throws
    type summary
    ​Exception ​

    [m] migrateSchema Migrates an existing schema to a new schema.

    Migrates an existing schema to a new schema. 
    public function migrateSchema(Doctrine\DBAL\Schema\Schema $toSchema)
    Parameter
    type name summary
    ​Schema ​$toSchema ​
    Throws
    type summary
    ​Exception ​

    [m] alterTable Alters an existing tables schema.

    Alters an existing tables schema. 
    public function alterTable(Doctrine\DBAL\Schema\TableDiff $tableDiff): void
    Parameter
    type name summary
    ​TableDiff ​$tableDiff ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] renameTable Renames a given table to another name.

    Renames a given table to another name. 
    public function renameTable(
    string $name,
    string $newName
): void
    Parameter
    type name summary
    ​string ​$name ​The current name of the table.
    ​string ​$newName ​The new name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] _getPortableDatabasesList 

    protected function _getPortableDatabasesList(mixed[] $databases): string[]
    Parameter
    type name summary
    ​mixed[] ​$databases ​
    Return
    type summary
    ​string[] ​

    [m] getPortableNamespacesList Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition.

    deprecated

    Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition. 
    protected function getPortableNamespacesList(array $namespaces): string[]
    Parameter
    type name summary
    ​array ​$namespaces ​
    Return
    type summary
    ​string[] ​
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] _getPortableDatabaseDefinition 

    protected function _getPortableDatabaseDefinition(mixed $database): mixed
    Parameter
    type name summary
    ​mixed ​$database ​
    Return
    type summary
    ​mixed ​

    [m] getPortableNamespaceDefinition Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition.

    deprecated

    Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition. 
    protected function getPortableNamespaceDefinition(array $namespace): mixed
    Parameter
    type name summary
    ​array ​$namespace ​
    Return
    type summary
    ​mixed ​
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] _getPortableSequencesList 

    protected function _getPortableSequencesList(mixed[][] $sequences): Doctrine\DBAL\Schema\Sequence[]
    Parameter
    type name summary
    ​mixed[][] ​$sequences ​
    Return
    type summary
    ​Sequence[] ​
    Throws
    type summary
    ​Exception ​

    [m] _getPortableSequenceDefinition 

    protected function _getPortableSequenceDefinition(mixed[] $sequence): Doctrine\DBAL\Schema\Sequence
    Parameter
    type name summary
    ​mixed[] ​$sequence ​
    Return
    type summary
    ​Sequence ​
    Throws
    type summary
    ​Exception ​

    [m] _getPortableTableColumnList Independent of the database the keys of the column list result are lowercased.

    Independent of the database the keys of the column list result are lowercased. 
    protected function _getPortableTableColumnList(
    string $table,
    string $database,
    mixed[][] $tableColumns
): Doctrine\DBAL\Schema\Column[]

    The name of the created column instance however is kept in its case.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string ​$database ​
    ​mixed[][] ​$tableColumns ​
    Return
    type summary
    ​Column[] ​
    Throws
    type summary
    ​Exception ​

    [m] _getPortableTableColumnDefinition Gets Table Column Definition.

    abstract

    Gets Table Column Definition. 
    abstract protected function _getPortableTableColumnDefinition(mixed[] $tableColumn): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​mixed[] ​$tableColumn ​
    Return
    type summary
    ​Column ​
    Throws
    type summary
    ​Exception ​

    [m] _getPortableTableIndexesList Aggregates and groups the index results according to the required data result.

    Aggregates and groups the index results according to the required data result. 
    protected function _getPortableTableIndexesList(
    mixed[][] $tableIndexes,
    string|null $tableName = null
): Doctrine\DBAL\Schema\Index[]
    Parameter
    type name summary
    ​mixed[][] ​$tableIndexes ​
    ​string|​null ​$tableName = null ​
    Return
    type summary
    ​Index[] ​
    Throws
    type summary
    ​Exception ​

    [m] _getPortableTablesList 

    protected function _getPortableTablesList(mixed[][] $tables): string[]
    Parameter
    type name summary
    ​mixed[][] ​$tables ​
    Return
    type summary
    ​string[] ​

    [m] _getPortableTableDefinition 

    protected function _getPortableTableDefinition(mixed $table): string
    Parameter
    type name summary
    ​mixed ​$table ​
    Return
    type summary
    ​string ​

    [m] _getPortableViewsList 

    protected function _getPortableViewsList(mixed[][] $views): Doctrine\DBAL\Schema\View[]
    Parameter
    type name summary
    ​mixed[][] ​$views ​
    Return
    type summary
    ​View[] ​

    [m] _getPortableViewDefinition 

    protected function _getPortableViewDefinition(mixed[] $view): Doctrine\DBAL\Schema\View|false
    Parameter
    type name summary
    ​mixed[] ​$view ​
    Return
    type summary
    ​View|​false ​

    [m] _getPortableTableForeignKeysList 

    protected function _getPortableTableForeignKeysList(mixed[][] $tableForeignKeys): Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​mixed[][] ​$tableForeignKeys ​
    Return
    type summary
    ​ForeignKeyConstraint[] ​

    [m] _getPortableTableForeignKeyDefinition 

    protected function _getPortableTableForeignKeyDefinition(mixed $tableForeignKey): Doctrine\DBAL\Schema\ForeignKeyConstraint
    Parameter
    type name summary
    ​mixed ​$tableForeignKey ​
    Return
    type summary
    ​ForeignKeyConstraint ​

    [m] _execSql 

    protected function _execSql(string[]|string $sql): void
    Parameter
    type name summary
    ​string[]|​string ​$sql ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] createSchema Creates a schema instance for the current database.

    deprecated

    Creates a schema instance for the current database. 
    public function createSchema(): Doctrine\DBAL\Schema\Schema
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​Exception ​

    [m] introspectSchema Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema.

    Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema. 
    public function introspectSchema(): Doctrine\DBAL\Schema\Schema
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​Schema ​

    [m] createSchemaConfig Creates the configuration for this schema.

    Creates the configuration for this schema. 
    public function createSchemaConfig(): Doctrine\DBAL\Schema\SchemaConfig
    Return
    type summary
    ​SchemaConfig ​
    Throws
    type summary
    ​Exception ​

    [m] getSchemaSearchPaths The search path for namespaces in the currently connected database.

    deprecated

    The search path for namespaces in the currently connected database. 
    public function getSchemaSearchPaths(): string[]

    The first entry is usually the default namespace in the Schema. All further namespaces contain tables/sequences which can also be addressed with a short, not full-qualified name.

    For databases that don't support subschema/namespaces this method returns the name of the currently connected database.

    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​

    [m] extractDoctrineTypeFromComment Given a table comment this method tries to extract a typehint for Doctrine Type, or returns

    Given a table comment this method tries to extract a typehint for Doctrine Type, or returns 
    public function extractDoctrineTypeFromComment(
    string|null $comment,
    string $currentType
): string

    the type given as default.

    Parameter
    type name summary
    ​string|​null ​$comment ​
    ​string ​$currentType ​
    Return
    type summary
    ​string ​

    [m] removeDoctrineTypeFromComment 

    public function removeDoctrineTypeFromComment(
    string|null $comment,
    string|null $type
): string|null
    Parameter
    type name summary
    ​string|​null ​$comment ​
    ​string|​null ​$type ​
    Return
    type summary
    ​string|​null ​

    [m] createComparator 

    public function createComparator(): Doctrine\DBAL\Schema\Comparator
    Return
    type summary
    ​Comparator ​

    [C] Column Object representation of a database column.

    Object representation of a database column.

    Hierarchy

    Parents
    type summary
    ​AbstractAsset ​The abstract asset allows to reset the name of all assets without publishing this to the public userland.

    [p] $_type 

    protected Doctrine\DBAL\Types\Type $_type = null

    Type: Type

    [p] $_length 

    protected int|null $_length = null

    Type: int|​null

    [p] $_precision 

    protected int $_precision = 10

    Type: int

    [p] $_scale 

    protected int $_scale = 0

    Type: int

    [p] $_unsigned 

    protected bool $_unsigned = false

    Type: bool

    [p] $_fixed 

    protected bool $_fixed = false

    Type: bool

    [p] $_notnull 

    protected bool $_notnull = true

    Type: bool

    [p] $_default 

    protected mixed $_default = null

    Type: mixed

    [p] $_autoincrement 

    protected bool $_autoincrement = false

    Type: bool

    [p] $_platformOptions 

    protected mixed[] $_platformOptions = []

    Type: mixed[]

    [p] $_columnDefinition 

    protected string|null $_columnDefinition = null

    Type: string|​null

    [p] $_comment 

    protected string|null $_comment = null

    Type: string|​null

    [p] $_customSchemaOptions

    deprecated 

    protected mixed[] $_customSchemaOptions = []

    Type: mixed[]

    [p] $_name 

    protected string $_name = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_name ​

    [p] $_namespace Namespace of the asset. If none isset the default namespace is assumed.

    Namespace of the asset. If none isset the default namespace is assumed. 
    protected string|null $_namespace = null

    Type: string|​null

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_namespace ​Namespace of the asset. If none isset the default namespace is assumed.

    [p] $_quoted 

    protected bool $_quoted = false

    Type: bool

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_quoted ​

    [m] __construct Creates a new Column.

    Creates a new Column. 
    public function __construct(
    string $name,
    Doctrine\DBAL\Types\Type $type,
    array|mixed[] $options = []
)
    Parameter
    type name summary
    ​string ​$name ​
    ​Type ​$type ​
    ​array|​mixed[] ​$options = [] ​
    Throws
    type summary
    ​SchemaException ​

    [m] setOptions 

    public function setOptions(array|mixed[] $options): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​array|​mixed[] ​$options ​
    Return
    type summary
    ​Column ​
    Throws
    type summary
    ​SchemaException ​

    [m] setType 

    public function setType(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Column ​

    [m] setLength 

    public function setLength(int|null $length): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​int|​null ​$length ​
    Return
    type summary
    ​Column ​

    [m] setPrecision 

    public function setPrecision(int $precision): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​int ​$precision ​
    Return
    type summary
    ​Column ​

    [m] setScale 

    public function setScale(int $scale): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​int ​$scale ​
    Return
    type summary
    ​Column ​

    [m] setUnsigned 

    public function setUnsigned(bool $unsigned): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​bool ​$unsigned ​
    Return
    type summary
    ​Column ​

    [m] setFixed 

    public function setFixed(bool $fixed): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​bool ​$fixed ​
    Return
    type summary
    ​Column ​

    [m] setNotnull 

    public function setNotnull(bool $notnull): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​bool ​$notnull ​
    Return
    type summary
    ​Column ​

    [m] setDefault 

    public function setDefault(mixed $default): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​mixed ​$default ​
    Return
    type summary
    ​Column ​

    [m] setPlatformOptions 

    public function setPlatformOptions(array|mixed[] $platformOptions): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​array|​mixed[] ​$platformOptions ​
    Return
    type summary
    ​Column ​

    [m] setPlatformOption 

    public function setPlatformOption(
    string $name,
    mixed $value
): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​string ​$name ​
    ​mixed ​$value ​
    Return
    type summary
    ​Column ​

    [m] setColumnDefinition 

    public function setColumnDefinition(string|null $value): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​string|​null ​$value ​
    Return
    type summary
    ​Column ​

    [m] getType 

    public function getType(): Doctrine\DBAL\Types\Type
    Return
    type summary
    ​Type ​

    [m] getLength 

    public function getLength(): int|null
    Return
    type summary
    ​int|​null ​

    [m] getPrecision 

    public function getPrecision(): int
    Return
    type summary
    ​int ​

    [m] getScale 

    public function getScale(): int
    Return
    type summary
    ​int ​

    [m] getUnsigned 

    public function getUnsigned(): bool
    Return
    type summary
    ​bool ​

    [m] getFixed 

    public function getFixed(): bool
    Return
    type summary
    ​bool ​

    [m] getNotnull 

    public function getNotnull(): bool
    Return
    type summary
    ​bool ​

    [m] getDefault 

    public function getDefault(): mixed
    Return
    type summary
    ​mixed ​

    [m] getPlatformOptions 

    public function getPlatformOptions(): mixed[]
    Return
    type summary
    ​mixed[] ​

    [m] hasPlatformOption 

    public function hasPlatformOption(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​bool ​

    [m] getPlatformOption 

    public function getPlatformOption(string $name): mixed
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​mixed ​

    [m] getColumnDefinition 

    public function getColumnDefinition(): string|null
    Return
    type summary
    ​string|​null ​

    [m] getAutoincrement 

    public function getAutoincrement(): bool
    Return
    type summary
    ​bool ​

    [m] setAutoincrement 

    public function setAutoincrement(bool $flag): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​bool ​$flag ​
    Return
    type summary
    ​Column ​

    [m] setComment 

    public function setComment(string|null $comment): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​string|​null ​$comment ​
    Return
    type summary
    ​Column ​

    [m] getComment 

    public function getComment(): string|null
    Return
    type summary
    ​string|​null ​

    [m] setCustomSchemaOption

    deprecated 

    public function setCustomSchemaOption(
    string $name,
    mixed $value
): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​string ​$name ​
    ​mixed ​$value ​
    Return
    type summary
    ​Column ​

    [m] hasCustomSchemaOption

    deprecated 

    public function hasCustomSchemaOption(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​bool ​

    [m] getCustomSchemaOption

    deprecated 

    public function getCustomSchemaOption(string $name): mixed
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​mixed ​

    [m] setCustomSchemaOptions

    deprecated 

    public function setCustomSchemaOptions(array|mixed[] $customSchemaOptions): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​array|​mixed[] ​$customSchemaOptions ​
    Return
    type summary
    ​Column ​

    [m] getCustomSchemaOptions

    deprecated 

    public function getCustomSchemaOptions(): mixed[]
    Return
    type summary
    ​mixed[] ​

    [m] toArray 

    public function toArray(): mixed[]
    Return
    type summary
    ​mixed[] ​

    [m] _setName Sets the name of this asset.

    Sets the name of this asset. 
    protected function _setName(string $name): void
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_setName() ​Sets the name of this asset.

    [m] isInDefaultNamespace Is this asset in the default namespace?

    Is this asset in the default namespace? 
    public function isInDefaultNamespace(string $defaultNamespaceName): bool
    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isInDefaultNamespace() ​Is this asset in the default namespace?

    [m] getNamespaceName Gets the namespace name of this asset.

    Gets the namespace name of this asset. 
    public function getNamespaceName(): string|null

    If NULL is returned this means the default namespace is used.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getNamespaceName() ​Gets the namespace name of this asset.

    [m] getShortestName The shortest name is stripped of the default namespace. All other

    The shortest name is stripped of the default namespace. All other 
    public function getShortestName(string|null $defaultNamespaceName): string

    namespaced elements are returned as full-qualified names.

    Parameter
    type name summary
    ​string|​null ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getShortestName() ​The shortest name is stripped of the default namespace. All other

    [m] getFullQualifiedName The normalized name is full-qualified and lower-cased. Lower-casing is

    deprecated

    The normalized name is full-qualified and lower-cased. Lower-casing is 
    public function getFullQualifiedName(string $defaultNamespaceName): string

    actually wrong, but we have to do it to keep our sanity. If you are using database objects that only differentiate in the casing (FOO vs Foo) then you will NOT be able to use Doctrine Schema abstraction.

    Every non-namespaced element is prefixed with the default namespace name which is passed as argument to this method.

    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getFullQualifiedName() ​The normalized name is full-qualified and lower-cased. Lower-casing is
    See
    type summary
    ​AbstractAsset::getNamespaceName() ​
    ​AbstractAsset::getName() ​

    [m] isQuoted Checks if this asset's name is quoted.

    Checks if this asset's name is quoted. 
    public function isQuoted(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isQuoted() ​Checks if this asset's name is quoted.

    [m] isIdentifierQuoted Checks if this identifier is quoted.

    Checks if this identifier is quoted. 
    protected function isIdentifierQuoted(string $identifier): bool
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isIdentifierQuoted() ​Checks if this identifier is quoted.

    [m] trimQuotes Trim quotes from the identifier.

    Trim quotes from the identifier. 
    protected function trimQuotes(string $identifier): string
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::trimQuotes() ​Trim quotes from the identifier.

    [m] getName Returns the name of this schema asset.

    Returns the name of this schema asset. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getName() ​Returns the name of this schema asset.

    [m] getQuotedName Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    Gets the quoted representation of this asset but only if it was defined with one. Otherwise 
    public function getQuotedName(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string

    return the plain unquoted value as inserted.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getQuotedName() ​Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    [m] _generateIdentifierName Generates an identifier from a list of column names obeying a certain string length.

    Generates an identifier from a list of column names obeying a certain string length. 
    protected function _generateIdentifierName(
    string[] $columnNames,
    string $prefix = "",
    int $maxSize = 30
): string

    This is especially important for Oracle, since it does not allow identifiers larger than 30 chars, however building idents automatically for foreign keys, composite keys or such can easily create very long names.

    Parameter
    type name summary
    ​string[] ​$columnNames ​
    ​string ​$prefix = "" ​
    ​int ​$maxSize = 30 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_generateIdentifierName() ​Generates an identifier from a list of column names obeying a certain string length.

    [C] AbstractAsset The abstract asset allows to reset the name of all assets without publishing this to the public userland.

    abstract

    The abstract asset allows to reset the name of all assets without publishing this to the public userland.

    This encapsulation hack is necessary to keep a consistent state of the database schema. Say we have a list of tables array($tableName => Table($tableName)); if you want to rename the table, you have to make sure this does not get recreated during schema migration.

    Hierarchy

    [p] $_name 

    protected string $_name = ""

    Type: string

    [p] $_namespace Namespace of the asset. If none isset the default namespace is assumed.

    Namespace of the asset. If none isset the default namespace is assumed. 
    protected string|null $_namespace = null

    Type: string|​null

    [p] $_quoted 

    protected bool $_quoted = false

    Type: bool

    [m] _setName Sets the name of this asset.

    Sets the name of this asset. 
    protected function _setName(string $name): void
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​void ​

    [m] isInDefaultNamespace Is this asset in the default namespace?

    Is this asset in the default namespace? 
    public function isInDefaultNamespace(string $defaultNamespaceName): bool
    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​bool ​

    [m] getNamespaceName Gets the namespace name of this asset.

    Gets the namespace name of this asset. 
    public function getNamespaceName(): string|null

    If NULL is returned this means the default namespace is used.

    Return
    type summary
    ​string|​null ​

    [m] getShortestName The shortest name is stripped of the default namespace. All other

    The shortest name is stripped of the default namespace. All other 
    public function getShortestName(string|null $defaultNamespaceName): string

    namespaced elements are returned as full-qualified names.

    Parameter
    type name summary
    ​string|​null ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​

    [m] getFullQualifiedName The normalized name is full-qualified and lower-cased. Lower-casing is

    deprecated

    The normalized name is full-qualified and lower-cased. Lower-casing is 
    public function getFullQualifiedName(string $defaultNamespaceName): string

    actually wrong, but we have to do it to keep our sanity. If you are using database objects that only differentiate in the casing (FOO vs Foo) then you will NOT be able to use Doctrine Schema abstraction.

    Every non-namespaced element is prefixed with the default namespace name which is passed as argument to this method.

    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    See
    type summary
    ​AbstractAsset::getNamespaceName() ​
    ​AbstractAsset::getName() ​

    [m] isQuoted Checks if this asset's name is quoted.

    Checks if this asset's name is quoted. 
    public function isQuoted(): bool
    Return
    type summary
    ​bool ​

    [m] isIdentifierQuoted Checks if this identifier is quoted.

    Checks if this identifier is quoted. 
    protected function isIdentifierQuoted(string $identifier): bool
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​bool ​

    [m] trimQuotes Trim quotes from the identifier.

    Trim quotes from the identifier. 
    protected function trimQuotes(string $identifier): string
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​string ​

    [m] getName Returns the name of this schema asset.

    Returns the name of this schema asset. 
    public function getName(): string
    Return
    type summary
    ​string ​

    [m] getQuotedName Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    Gets the quoted representation of this asset but only if it was defined with one. Otherwise 
    public function getQuotedName(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string

    return the plain unquoted value as inserted.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​

    [m] _generateIdentifierName Generates an identifier from a list of column names obeying a certain string length.

    Generates an identifier from a list of column names obeying a certain string length. 
    protected function _generateIdentifierName(
    string[] $columnNames,
    string $prefix = "",
    int $maxSize = 30
): string

    This is especially important for Oracle, since it does not allow identifiers larger than 30 chars, however building idents automatically for foreign keys, composite keys or such can easily create very long names.

    Parameter
    type name summary
    ​string[] ​$columnNames ​
    ​string ​$prefix = "" ​
    ​int ​$maxSize = 30 ​
    Return
    type summary
    ​string ​

    [C] SchemaException

    Hierarchy

    Parents
    type summary
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Stringable ​
    ​Throwable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] ForeignKeyConstraint An abstraction class for a foreign key constraint.

    An abstraction class for a foreign key constraint.

    Hierarchy

    Parents
    type summary
    ​AbstractAsset ​The abstract asset allows to reset the name of all assets without publishing this to the public userland.
    Implements
    type summary
    ​Constraint ​Marker interface for constraints.

    [p] $_localTable Instance of the referencing table the foreign key constraint is associated with.

    Instance of the referencing table the foreign key constraint is associated with. 
    protected Doctrine\DBAL\Schema\Table $_localTable = null

    Type: Table

    [p] $_localColumnNames Asset identifier instances of the referencing table column names the foreign key constraint is associated with.

    Asset identifier instances of the referencing table column names the foreign key constraint is associated with. 
    protected Doctrine\DBAL\Schema\Identifier[] $_localColumnNames = null

    array($columnName => Identifier)

    Type: Identifier[]

    [p] $_foreignTableName Table or asset identifier instance of the referenced table name the foreign key constraint is associated with.

    Table or asset identifier instance of the referenced table name the foreign key constraint is associated with. 
    protected Doctrine\DBAL\Schema\Table|Doctrine\DBAL\Schema\Identifier $_foreignTableName = null

    Type: Table|​Identifier

    [p] $_foreignColumnNames Asset identifier instances of the referenced table column names the foreign key constraint is associated with.

    Asset identifier instances of the referenced table column names the foreign key constraint is associated with. 
    protected Doctrine\DBAL\Schema\Identifier[] $_foreignColumnNames = null

    array($columnName => Identifier)

    Type: Identifier[]

    [p] $_options Options associated with the foreign key constraint.

    Options associated with the foreign key constraint. 
    protected mixed[] $_options = null

    Type: mixed[]

    [p] $_name 

    protected string $_name = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_name ​

    [p] $_namespace Namespace of the asset. If none isset the default namespace is assumed.

    Namespace of the asset. If none isset the default namespace is assumed. 
    protected string|null $_namespace = null

    Type: string|​null

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_namespace ​Namespace of the asset. If none isset the default namespace is assumed.

    [p] $_quoted 

    protected bool $_quoted = false

    Type: bool

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_quoted ​

    [m] __construct Initializes the foreign key constraint.

    Initializes the foreign key constraint. 
    public function __construct(
    array|string[] $localColumnNames,
    Doctrine\DBAL\Schema\Table|string $foreignTableName,
    array|string[] $foreignColumnNames,
    string|null $name = null,
    array|mixed[] $options = []
)
    Parameter
    type name summary
    ​array|​string[] ​$localColumnNames ​Names of the referencing table columns.
    ​Table|​string ​$foreignTableName ​Referenced table.
    ​array|​string[] ​$foreignColumnNames ​Names of the referenced table columns.
    ​string|​null ​$name = null ​Name of the foreign key constraint.
    ​array|​mixed[] ​$options = [] ​Options associated with the foreign key constraint.

    [m] getLocalTableName Returns the name of the referencing table

    deprecated

    Returns the name of the referencing table 
    public function getLocalTableName(): string

    the foreign key constraint is associated with.

    Return
    type summary
    ​string ​
    See
    type summary
    ​Table::$_fkConstraints ​

    [m] setLocalTable Sets the Table instance of the referencing table

    deprecated

    Sets the Table instance of the referencing table 
    public function setLocalTable(Doctrine\DBAL\Schema\Table $table): void

    the foreign key constraint is associated with.

    Parameter
    type name summary
    ​Table ​$table ​Instance of the referencing table.
    Return
    type summary
    ​void ​
    See
    type summary
    ​Table::$_fkConstraints ​

    [m] getLocalTable

    deprecated 

    public function getLocalTable(): Doctrine\DBAL\Schema\Table
    Return
    type summary
    ​Table ​
    See
    type summary
    ​Table::$_fkConstraints ​

    [m] getLocalColumns Returns the names of the referencing table columns

    Returns the names of the referencing table columns 
    public function getLocalColumns(): string[]

    the foreign key constraint is associated with.

    Return
    type summary
    ​string[] ​

    [m] getQuotedLocalColumns Returns the quoted representation of the referencing table column names

    Returns the quoted representation of the referencing table column names 
    public function getQuotedLocalColumns(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string[]

    the foreign key constraint is associated with.

    But only if they were defined with one or the referencing table column name is a keyword reserved by the platform. Otherwise the plain unquoted value as inserted is returned.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​The platform to use for quotation.
    Return
    type summary
    ​string[] ​

    [m] getUnquotedLocalColumns Returns unquoted representation of local table column names for comparison with other FK

    Returns unquoted representation of local table column names for comparison with other FK 
    public function getUnquotedLocalColumns(): string[]
    Return
    type summary
    ​string[] ​

    [m] getUnquotedForeignColumns Returns unquoted representation of foreign table column names for comparison with other FK

    Returns unquoted representation of foreign table column names for comparison with other FK 
    public function getUnquotedForeignColumns(): string[]
    Return
    type summary
    ​string[] ​

    [m] getColumns <tag_inheritdoc data-type='' data-description=''>Returns the names of the referencing table columns

    deprecated

    Returns the names of the referencing table columns 
    public function getColumns(): string[]

    the constraint is associated with.

    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​implement ​Constraint::getColumns() ​Returns the names of the referencing table columns
    See
    type summary
    ​ForeignKeyConstraint::getLocalColumns() ​
    ​getLocalColumns ​

    [m] getQuotedColumns Returns the quoted representation of the referencing table column names

    deprecated

    Returns the quoted representation of the referencing table column names 
    public function getQuotedColumns(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string[]

    the foreign key constraint is associated with.

    But only if they were defined with one or the referencing table column name is a keyword reserved by the platform. Otherwise the plain unquoted value as inserted is returned.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​The platform to use for quotation.
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​implement ​Constraint::getQuotedColumns() ​Returns the quoted representation of the column names
    See
    type summary
    ​ForeignKeyConstraint::getQuotedLocalColumns() ​
    ​getQuotedLocalColumns ​

    [m] getForeignTableName Returns the name of the referenced table

    Returns the name of the referenced table 
    public function getForeignTableName(): string

    the foreign key constraint is associated with.

    Return
    type summary
    ​string ​

    [m] getUnqualifiedForeignTableName Returns the non-schema qualified foreign table name.

    Returns the non-schema qualified foreign table name. 
    public function getUnqualifiedForeignTableName(): string
    Return
    type summary
    ​string ​

    [m] getQuotedForeignTableName Returns the quoted representation of the referenced table name

    Returns the quoted representation of the referenced table name 
    public function getQuotedForeignTableName(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string

    the foreign key constraint is associated with.

    But only if it was defined with one or the referenced table name is a keyword reserved by the platform. Otherwise the plain unquoted value as inserted is returned.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​The platform to use for quotation.
    Return
    type summary
    ​string ​

    [m] getForeignColumns Returns the names of the referenced table columns

    Returns the names of the referenced table columns 
    public function getForeignColumns(): string[]

    the foreign key constraint is associated with.

    Return
    type summary
    ​string[] ​

    [m] getQuotedForeignColumns Returns the quoted representation of the referenced table column names

    Returns the quoted representation of the referenced table column names 
    public function getQuotedForeignColumns(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string[]

    the foreign key constraint is associated with.

    But only if they were defined with one or the referenced table column name is a keyword reserved by the platform. Otherwise the plain unquoted value as inserted is returned.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​The platform to use for quotation.
    Return
    type summary
    ​string[] ​

    [m] hasOption Returns whether or not a given option

    Returns whether or not a given option 
    public function hasOption(string $name): bool

    is associated with the foreign key constraint.

    Parameter
    type name summary
    ​string ​$name ​Name of the option to check.
    Return
    type summary
    ​bool ​

    [m] getOption Returns an option associated with the foreign key constraint.

    Returns an option associated with the foreign key constraint. 
    public function getOption(string $name): mixed
    Parameter
    type name summary
    ​string ​$name ​Name of the option the foreign key constraint is associated with.
    Return
    type summary
    ​mixed ​

    [m] getOptions Returns the options associated with the foreign key constraint.

    Returns the options associated with the foreign key constraint. 
    public function getOptions(): mixed[]
    Return
    type summary
    ​mixed[] ​

    [m] onUpdate Returns the referential action for UPDATE operations

    Returns the referential action for UPDATE operations 
    public function onUpdate(): string|null

    on the referenced table the foreign key constraint is associated with.

    Return
    type summary
    ​string|​null ​

    [m] onDelete Returns the referential action for DELETE operations

    Returns the referential action for DELETE operations 
    public function onDelete(): string|null

    on the referenced table the foreign key constraint is associated with.

    Return
    type summary
    ​string|​null ​

    [m] intersectsIndexColumns Checks whether this foreign key constraint intersects the given index columns.

    Checks whether this foreign key constraint intersects the given index columns. 
    public function intersectsIndexColumns(Doctrine\DBAL\Schema\Index $index): bool

    Returns true if at least one of this foreign key's local columns matches one of the given index's columns, false otherwise.

    Parameter
    type name summary
    ​Index ​$index ​The index to be checked against.
    Return
    type summary
    ​bool ​

    [m] _setName Sets the name of this asset.

    Sets the name of this asset. 
    protected function _setName(string $name): void
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_setName() ​Sets the name of this asset.

    [m] isInDefaultNamespace Is this asset in the default namespace?

    Is this asset in the default namespace? 
    public function isInDefaultNamespace(string $defaultNamespaceName): bool
    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isInDefaultNamespace() ​Is this asset in the default namespace?

    [m] getNamespaceName Gets the namespace name of this asset.

    Gets the namespace name of this asset. 
    public function getNamespaceName(): string|null

    If NULL is returned this means the default namespace is used.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getNamespaceName() ​Gets the namespace name of this asset.

    [m] getShortestName The shortest name is stripped of the default namespace. All other

    The shortest name is stripped of the default namespace. All other 
    public function getShortestName(string|null $defaultNamespaceName): string

    namespaced elements are returned as full-qualified names.

    Parameter
    type name summary
    ​string|​null ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getShortestName() ​The shortest name is stripped of the default namespace. All other

    [m] getFullQualifiedName The normalized name is full-qualified and lower-cased. Lower-casing is

    deprecated

    The normalized name is full-qualified and lower-cased. Lower-casing is 
    public function getFullQualifiedName(string $defaultNamespaceName): string

    actually wrong, but we have to do it to keep our sanity. If you are using database objects that only differentiate in the casing (FOO vs Foo) then you will NOT be able to use Doctrine Schema abstraction.

    Every non-namespaced element is prefixed with the default namespace name which is passed as argument to this method.

    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getFullQualifiedName() ​The normalized name is full-qualified and lower-cased. Lower-casing is
    See
    type summary
    ​AbstractAsset::getNamespaceName() ​
    ​AbstractAsset::getName() ​

    [m] isQuoted Checks if this asset's name is quoted.

    Checks if this asset's name is quoted. 
    public function isQuoted(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isQuoted() ​Checks if this asset's name is quoted.

    [m] isIdentifierQuoted Checks if this identifier is quoted.

    Checks if this identifier is quoted. 
    protected function isIdentifierQuoted(string $identifier): bool
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isIdentifierQuoted() ​Checks if this identifier is quoted.

    [m] trimQuotes Trim quotes from the identifier.

    Trim quotes from the identifier. 
    protected function trimQuotes(string $identifier): string
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::trimQuotes() ​Trim quotes from the identifier.

    [m] getName Returns the name of this schema asset.

    Returns the name of this schema asset. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getName() ​Returns the name of this schema asset.

    [m] getQuotedName Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    Gets the quoted representation of this asset but only if it was defined with one. Otherwise 
    public function getQuotedName(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string

    return the plain unquoted value as inserted.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getQuotedName() ​Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    [m] _generateIdentifierName Generates an identifier from a list of column names obeying a certain string length.

    Generates an identifier from a list of column names obeying a certain string length. 
    protected function _generateIdentifierName(
    string[] $columnNames,
    string $prefix = "",
    int $maxSize = 30
): string

    This is especially important for Oracle, since it does not allow identifiers larger than 30 chars, however building idents automatically for foreign keys, composite keys or such can easily create very long names.

    Parameter
    type name summary
    ​string[] ​$columnNames ​
    ​string ​$prefix = "" ​
    ​int ​$maxSize = 30 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_generateIdentifierName() ​Generates an identifier from a list of column names obeying a certain string length.

    [C] Table Object Representation of a table.

    Object Representation of a table.

    Hierarchy

    Parents
    type summary
    ​AbstractAsset ​The abstract asset allows to reset the name of all assets without publishing this to the public userland.

    [p] $_columns 

    protected Doctrine\DBAL\Schema\Column[] $_columns = []

    Type: Column[]

    [p] $_indexes 

    protected Doctrine\DBAL\Schema\Index[] $_indexes = []

    Type: Index[]

    [p] $_primaryKeyName 

    protected string|null $_primaryKeyName = null

    Type: string|​null

    [p] $uniqueConstraints 

    protected Doctrine\DBAL\Schema\UniqueConstraint[] $uniqueConstraints = []

    Type: UniqueConstraint[]

    [p] $_fkConstraints 

    protected Doctrine\DBAL\Schema\ForeignKeyConstraint[] $_fkConstraints = []

    Type: ForeignKeyConstraint[]

    [p] $_options 

    protected mixed[] $_options = [
    "create_options" => [],
]

    Type: mixed[]

    [p] $_schemaConfig 

    protected Doctrine\DBAL\Schema\SchemaConfig|null $_schemaConfig = null

    Type: SchemaConfig|​null

    [p] $_name 

    protected string $_name = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_name ​

    [p] $_namespace Namespace of the asset. If none isset the default namespace is assumed.

    Namespace of the asset. If none isset the default namespace is assumed. 
    protected string|null $_namespace = null

    Type: string|​null

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_namespace ​Namespace of the asset. If none isset the default namespace is assumed.

    [p] $_quoted 

    protected bool $_quoted = false

    Type: bool

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_quoted ​

    [m] __construct 

    public function __construct(
    string $name,
    array|Doctrine\DBAL\Schema\Column[] $columns = [],
    array|Doctrine\DBAL\Schema\Index[] $indexes = [],
    array|Doctrine\DBAL\Schema\UniqueConstraint[] $uniqueConstraints = [],
    array|Doctrine\DBAL\Schema\ForeignKeyConstraint[] $fkConstraints = [],
    array|mixed[] $options = []
)
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​Column[] ​$columns = [] ​
    ​array|​Index[] ​$indexes = [] ​
    ​array|​UniqueConstraint[] ​$uniqueConstraints = [] ​
    ​array|​ForeignKeyConstraint[] ​$fkConstraints = [] ​
    ​array|​mixed[] ​$options = [] ​
    Throws
    type summary
    ​SchemaException ​
    ​Exception ​

    [m] setSchemaConfig 

    public function setSchemaConfig(Doctrine\DBAL\Schema\SchemaConfig $schemaConfig): void
    Parameter
    type name summary
    ​SchemaConfig ​$schemaConfig ​
    Return
    type summary
    ​void ​

    [m] _getMaxIdentifierLength 

    protected function _getMaxIdentifierLength(): int
    Return
    type summary
    ​int ​

    [m] setPrimaryKey Sets the Primary Key.

    Sets the Primary Key. 
    public function setPrimaryKey(
    array|string[] $columnNames,
    string|false $indexName = false
): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​array|​string[] ​$columnNames ​
    ​string|​false ​$indexName = false ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​SchemaException ​

    [m] addIndex 

    public function addIndex(
    array|string[] $columnNames,
    ?string $indexName = null,
    array|string[] $flags = [],
    array|mixed[] $options = []
): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​array|​string[] ​$columnNames ​
    ​?string ​$indexName = null ​
    ​array|​string[] ​$flags = [] ​
    ​array|​mixed[] ​$options = [] ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​SchemaException ​

    [m] addUniqueConstraint 

    public function addUniqueConstraint(
    array|string[] $columnNames,
    ?string $indexName = null,
    array|string[] $flags = [],
    array|mixed[] $options = []
): Doctrine\DBAL\Schema\Table|Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​array|​string[] ​$columnNames ​
    ​?string ​$indexName = null ​
    ​array|​string[] ​$flags = [] ​
    ​array|​mixed[] ​$options = [] ​
    Return
    type summary
    ​Table|​Table ​

    [m] dropPrimaryKey Drops the primary key from this table.

    Drops the primary key from this table. 
    public function dropPrimaryKey(): void
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​SchemaException ​

    [m] dropIndex Drops an index from this table.

    Drops an index from this table. 
    public function dropIndex(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The index name.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​SchemaException ​If the index does not exist.

    [m] addUniqueIndex 

    public function addUniqueIndex(
    array|string[] $columnNames,
    string|null $indexName = null,
    array|mixed[] $options = []
): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​array|​string[] ​$columnNames ​
    ​string|​null ​$indexName = null ​
    ​array|​mixed[] ​$options = [] ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​SchemaException ​

    [m] renameIndex Renames an index.

    Renames an index. 
    public function renameIndex(
    string $oldName,
    string|null $newName = null
): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$oldName ​The name of the index to rename from.
    ​string|​null ​$newName = null ​The name of the index to rename to.
    Return
    type summary
    ​Table ​This table instance.
    Throws
    type summary
    ​SchemaException ​If no index exists for the given current name

    [m] columnsAreIndexed Checks if an index begins in the order of the given columns.

    Checks if an index begins in the order of the given columns. 
    public function columnsAreIndexed(array|string[] $columnNames): bool
    Parameter
    type name summary
    ​array|​string[] ​$columnNames ​
    Return
    type summary
    ​bool ​

    [m] addColumn 

    public function addColumn(
    string $name,
    string $typeName,
    array|mixed[] $options = []
): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$typeName ​
    ​array|​mixed[] ​$options = [] ​
    Return
    type summary
    ​Column ​
    Throws
    type summary
    ​SchemaException ​

    [m] changeColumn Change Column Details.

    deprecated

    Change Column Details. 
    public function changeColumn(
    string $name,
    array|mixed[] $options
): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​mixed[] ​$options ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​SchemaException ​

    [m] modifyColumn 

    public function modifyColumn(
    string $name,
    array|mixed[] $options
): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​mixed[] ​$options ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​SchemaException ​

    [m] dropColumn Drops a Column from the Table.

    Drops a Column from the Table. 
    public function dropColumn(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​

    [m] addForeignKeyConstraint Adds a foreign key constraint.

    Adds a foreign key constraint. 
    public function addForeignKeyConstraint(
    Doctrine\DBAL\Schema\Table|string $foreignTable,
    array|string[] $localColumnNames,
    array|string[] $foreignColumnNames,
    array|mixed[] $options = [],
    string|null $name = null
): Doctrine\DBAL\Schema\Table

    Name is inferred from the local columns.

    Parameter
    type name summary
    ​Table|​string ​$foreignTable ​Table schema instance or table name
    ​array|​string[] ​$localColumnNames ​
    ​array|​string[] ​$foreignColumnNames ​
    ​array|​mixed[] ​$options = [] ​
    ​string|​null ​$name = null ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​SchemaException ​

    [m] addOption 

    public function addOption(
    string $name,
    mixed $value
): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    ​mixed ​$value ​
    Return
    type summary
    ​Table ​

    [m] _addColumn 

    protected function _addColumn(Doctrine\DBAL\Schema\Column $column): void
    Parameter
    type name summary
    ​Column ​$column ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​SchemaException ​

    [m] _addIndex Adds an index to the table.

    Adds an index to the table. 
    protected function _addIndex(Doctrine\DBAL\Schema\Index $indexCandidate): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​Index ​$indexCandidate ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​SchemaException ​

    [m] _addUniqueConstraint 

    protected function _addUniqueConstraint(Doctrine\DBAL\Schema\UniqueConstraint $constraint): Doctrine\DBAL\Schema\Table|Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​UniqueConstraint ​$constraint ​
    Return
    type summary
    ​Table|​Table ​

    [m] _addForeignKeyConstraint 

    protected function _addForeignKeyConstraint(Doctrine\DBAL\Schema\ForeignKeyConstraint $constraint): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$constraint ​
    Return
    type summary
    ​Table ​

    [m] hasForeignKey Returns whether this table has a foreign key constraint with the given name.

    Returns whether this table has a foreign key constraint with the given name. 
    public function hasForeignKey(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​bool ​

    [m] getForeignKey Returns the foreign key constraint with the given name.

    Returns the foreign key constraint with the given name. 
    public function getForeignKey(string $name): Doctrine\DBAL\Schema\ForeignKeyConstraint
    Parameter
    type name summary
    ​string ​$name ​The constraint name.
    Return
    type summary
    ​ForeignKeyConstraint ​
    Throws
    type summary
    ​SchemaException ​If the foreign key does not exist.

    [m] removeForeignKey Removes the foreign key constraint with the given name.

    Removes the foreign key constraint with the given name. 
    public function removeForeignKey(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The constraint name.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​SchemaException ​

    [m] hasUniqueConstraint Returns whether this table has a unique constraint with the given name.

    Returns whether this table has a unique constraint with the given name. 
    public function hasUniqueConstraint(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​bool ​

    [m] getUniqueConstraint Returns the unique constraint with the given name.

    Returns the unique constraint with the given name. 
    public function getUniqueConstraint(string $name): Doctrine\DBAL\Schema\UniqueConstraint
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​UniqueConstraint ​
    Throws
    type summary
    ​SchemaException ​If the unique constraint does not exist.

    [m] removeUniqueConstraint Removes the unique constraint with the given name.

    Removes the unique constraint with the given name. 
    public function removeUniqueConstraint(string $name)
    Parameter
    type name summary
    ​string ​$name ​
    Throws
    type summary
    ​SchemaException ​If the unique constraint does not exist.

    [m] getColumns Returns ordered list of columns (primary keys are first, then foreign keys, then the rest)

    Returns ordered list of columns (primary keys are first, then foreign keys, then the rest) 
    public function getColumns(): Doctrine\DBAL\Schema\Column[]
    Return
    type summary
    ​Column[] ​

    [m] getForeignKeyColumns Returns the foreign key columns

    deprecated

    Returns the foreign key columns 
    public function getForeignKeyColumns(): Doctrine\DBAL\Schema\Column[]
    Return
    type summary
    ​Column[] ​
    See
    type summary
    ​Table::getForeignKey() ​
    ​ForeignKeyConstraint::getLocalColumns() ​

    [m] hasColumn Returns whether this table has a Column with the given name.

    Returns whether this table has a Column with the given name. 
    public function hasColumn(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​The column name.
    Return
    type summary
    ​bool ​

    [m] getColumn Returns the Column with the given name.

    Returns the Column with the given name. 
    public function getColumn(string $name): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​string ​$name ​The column name.
    Return
    type summary
    ​Column ​
    Throws
    type summary
    ​SchemaException ​If the column does not exist.

    [m] getPrimaryKey Returns the primary key.

    Returns the primary key. 
    public function getPrimaryKey(): Doctrine\DBAL\Schema\Index|null
    Return
    type summary
    ​Index|​null ​The primary key, or null if this Table has no primary key.

    [m] getPrimaryKeyColumns Returns the primary key columns.

    deprecated

    Returns the primary key columns. 
    public function getPrimaryKeyColumns(): Doctrine\DBAL\Schema\Column[]
    Return
    type summary
    ​Column[] ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​Table::getPrimaryKey() ​
    ​Index::getColumns() ​

    [m] hasPrimaryKey Returns whether this table has a primary key.

    deprecated

    Returns whether this table has a primary key. 
    public function hasPrimaryKey(): bool
    Return
    type summary
    ​bool ​
    See
    type summary
    ​Table::getPrimaryKey() ​

    [m] hasIndex Returns whether this table has an Index with the given name.

    Returns whether this table has an Index with the given name. 
    public function hasIndex(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​The index name.
    Return
    type summary
    ​bool ​

    [m] getIndex Returns the Index with the given name.

    Returns the Index with the given name. 
    public function getIndex(string $name): Doctrine\DBAL\Schema\Index
    Parameter
    type name summary
    ​string ​$name ​The index name.
    Return
    type summary
    ​Index ​
    Throws
    type summary
    ​SchemaException ​If the index does not exist.

    [m] getIndexes 

    public function getIndexes(): Doctrine\DBAL\Schema\Index[]
    Return
    type summary
    ​Index[] ​

    [m] getUniqueConstraints Returns the unique constraints.

    Returns the unique constraints. 
    public function getUniqueConstraints(): array|Doctrine\DBAL\Schema\UniqueConstraint[]
    Return
    type summary
    ​array|​UniqueConstraint[] ​

    [m] getForeignKeys Returns the foreign key constraints.

    Returns the foreign key constraints. 
    public function getForeignKeys(): Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Return
    type summary
    ​ForeignKeyConstraint[] ​

    [m] hasOption 

    public function hasOption(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​bool ​

    [m] getOption 

    public function getOption(string $name): mixed
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​mixed ​

    [m] getOptions 

    public function getOptions(): mixed[]
    Return
    type summary
    ​mixed[] ​

    [m] visit

    deprecated 

    public function visit(Doctrine\DBAL\Schema\Visitor\Visitor $visitor): void
    Parameter
    type name summary
    ​Visitor ​$visitor ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​SchemaException ​

    [m] __clone Clone of a Table triggers a deep clone of all affected assets.

    Clone of a Table triggers a deep clone of all affected assets. 
    public function __clone(): void
    Return
    type summary
    ​void ​

    [m] setComment 

    public function setComment(?string $comment): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​?string ​$comment ​
    Return
    type summary
    ​Table ​

    [m] getComment 

    public function getComment(): ?string
    Return
    type summary
    ​?string ​

    [m] _setName Sets the name of this asset.

    Sets the name of this asset. 
    protected function _setName(string $name): void
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_setName() ​Sets the name of this asset.

    [m] isInDefaultNamespace Is this asset in the default namespace?

    Is this asset in the default namespace? 
    public function isInDefaultNamespace(string $defaultNamespaceName): bool
    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isInDefaultNamespace() ​Is this asset in the default namespace?

    [m] getNamespaceName Gets the namespace name of this asset.

    Gets the namespace name of this asset. 
    public function getNamespaceName(): string|null

    If NULL is returned this means the default namespace is used.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getNamespaceName() ​Gets the namespace name of this asset.

    [m] getShortestName The shortest name is stripped of the default namespace. All other

    The shortest name is stripped of the default namespace. All other 
    public function getShortestName(string|null $defaultNamespaceName): string

    namespaced elements are returned as full-qualified names.

    Parameter
    type name summary
    ​string|​null ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getShortestName() ​The shortest name is stripped of the default namespace. All other

    [m] getFullQualifiedName The normalized name is full-qualified and lower-cased. Lower-casing is

    deprecated

    The normalized name is full-qualified and lower-cased. Lower-casing is 
    public function getFullQualifiedName(string $defaultNamespaceName): string

    actually wrong, but we have to do it to keep our sanity. If you are using database objects that only differentiate in the casing (FOO vs Foo) then you will NOT be able to use Doctrine Schema abstraction.

    Every non-namespaced element is prefixed with the default namespace name which is passed as argument to this method.

    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getFullQualifiedName() ​The normalized name is full-qualified and lower-cased. Lower-casing is
    See
    type summary
    ​AbstractAsset::getNamespaceName() ​
    ​AbstractAsset::getName() ​

    [m] isQuoted Checks if this asset's name is quoted.

    Checks if this asset's name is quoted. 
    public function isQuoted(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isQuoted() ​Checks if this asset's name is quoted.

    [m] isIdentifierQuoted Checks if this identifier is quoted.

    Checks if this identifier is quoted. 
    protected function isIdentifierQuoted(string $identifier): bool
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isIdentifierQuoted() ​Checks if this identifier is quoted.

    [m] trimQuotes Trim quotes from the identifier.

    Trim quotes from the identifier. 
    protected function trimQuotes(string $identifier): string
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::trimQuotes() ​Trim quotes from the identifier.

    [m] getName Returns the name of this schema asset.

    Returns the name of this schema asset. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getName() ​Returns the name of this schema asset.

    [m] getQuotedName Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    Gets the quoted representation of this asset but only if it was defined with one. Otherwise 
    public function getQuotedName(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string

    return the plain unquoted value as inserted.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getQuotedName() ​Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    [m] _generateIdentifierName Generates an identifier from a list of column names obeying a certain string length.

    Generates an identifier from a list of column names obeying a certain string length. 
    protected function _generateIdentifierName(
    string[] $columnNames,
    string $prefix = "",
    int $maxSize = 30
): string

    This is especially important for Oracle, since it does not allow identifiers larger than 30 chars, however building idents automatically for foreign keys, composite keys or such can easily create very long names.

    Parameter
    type name summary
    ​string[] ​$columnNames ​
    ​string ​$prefix = "" ​
    ​int ​$maxSize = 30 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_generateIdentifierName() ​Generates an identifier from a list of column names obeying a certain string length.

    [C] Index

    Hierarchy

    Parents
    type summary
    ​AbstractAsset ​The abstract asset allows to reset the name of all assets without publishing this to the public userland.
    Implements
    type summary
    ​Constraint ​Marker interface for constraints.

    [p] $_columns Asset identifier instances of the column names the index is associated with.

    Asset identifier instances of the column names the index is associated with. 
    protected Doctrine\DBAL\Schema\Identifier[] $_columns = []

    array($columnName => Identifier)

    Type: Identifier[]

    [p] $_isUnique 

    protected bool $_isUnique = false

    Type: bool

    [p] $_isPrimary 

    protected bool $_isPrimary = false

    Type: bool

    [p] $_flags Platform specific flags for indexes.

    Platform specific flags for indexes. 
    protected true[] $_flags = []

    array($flagName => true)

    Type: true[]

    [p] $_name 

    protected string $_name = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_name ​

    [p] $_namespace Namespace of the asset. If none isset the default namespace is assumed.

    Namespace of the asset. If none isset the default namespace is assumed. 
    protected string|null $_namespace = null

    Type: string|​null

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_namespace ​Namespace of the asset. If none isset the default namespace is assumed.

    [p] $_quoted 

    protected bool $_quoted = false

    Type: bool

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_quoted ​

    [m] __construct 

    public function __construct(
    string $name,
    array|string[] $columns,
    bool $isUnique = false,
    bool $isPrimary = false,
    array|string[] $flags = [],
    array|mixed[] $options = []
)
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​string[] ​$columns ​
    ​bool ​$isUnique = false ​
    ​bool ​$isPrimary = false ​
    ​array|​string[] ​$flags = [] ​
    ​array|​mixed[] ​$options = [] ​

    [m] _addColumn 

    protected function _addColumn(string $column)
    Parameter
    type name summary
    ​string ​$column ​
    Throws
    type summary
    ​InvalidArgumentException ​

    [m] getColumns <tag_inheritdoc data-type='' data-description=''>Returns the names of the referencing table columns

    Returns the names of the referencing table columns 
    public function getColumns(): string[]

    the constraint is associated with.

    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​implement ​Constraint::getColumns() ​Returns the names of the referencing table columns

    [m] getQuotedColumns <tag_inheritdoc data-type='' data-description=''>Returns the quoted representation of the column names

    Returns the quoted representation of the column names 
    public function getQuotedColumns(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string[]

    the constraint is associated with.

    But only if they were defined with one or a column name is a keyword reserved by the platform. Otherwise the plain unquoted value as inserted is returned.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​The platform to use for quotation.
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​implement ​Constraint::getQuotedColumns() ​Returns the quoted representation of the column names

    [m] getUnquotedColumns 

    public function getUnquotedColumns(): string[]
    Return
    type summary
    ​string[] ​

    [m] isSimpleIndex Is the index neither unique nor primary key?

    Is the index neither unique nor primary key? 
    public function isSimpleIndex(): bool
    Return
    type summary
    ​bool ​

    [m] isUnique 

    public function isUnique(): bool
    Return
    type summary
    ​bool ​

    [m] isPrimary 

    public function isPrimary(): bool
    Return
    type summary
    ​bool ​

    [m] hasColumnAtPosition 

    public function hasColumnAtPosition(
    string $name,
    int $pos = 0
): bool
    Parameter
    type name summary
    ​string ​$name ​
    ​int ​$pos = 0 ​
    Return
    type summary
    ​bool ​

    [m] spansColumns Checks if this index exactly spans the given column names in the correct order.

    Checks if this index exactly spans the given column names in the correct order. 
    public function spansColumns(array|string[] $columnNames): bool
    Parameter
    type name summary
    ​array|​string[] ​$columnNames ​
    Return
    type summary
    ​bool ​

    [m] isFullfilledBy Keeping misspelled function name for backwards compatibility

    deprecated

    Keeping misspelled function name for backwards compatibility 
    public function isFullfilledBy(Doctrine\DBAL\Schema\Index $other): bool
    Parameter
    type name summary
    ​Index ​$other ​
    Return
    type summary
    ​bool ​
    See
    type summary
    ​Index::isFulfilledBy() ​

    [m] isFulfilledBy Checks if the other index already fulfills all the indexing and constraint needs of the current one.

    Checks if the other index already fulfills all the indexing and constraint needs of the current one. 
    public function isFulfilledBy(Doctrine\DBAL\Schema\Index $other): bool
    Parameter
    type name summary
    ​Index ​$other ​
    Return
    type summary
    ​bool ​

    [m] overrules Detects if the other index is a non-unique, non primary index that can be overwritten by this one.

    Detects if the other index is a non-unique, non primary index that can be overwritten by this one. 
    public function overrules(Doctrine\DBAL\Schema\Index $other): bool
    Parameter
    type name summary
    ​Index ​$other ​
    Return
    type summary
    ​bool ​

    [m] getFlags Returns platform specific flags for indexes.

    Returns platform specific flags for indexes. 
    public function getFlags(): string[]
    Return
    type summary
    ​string[] ​

    [m] addFlag Adds Flag for an index that translates to platform specific handling.

    Adds Flag for an index that translates to platform specific handling. 
    public function addFlag(string $flag): Doctrine\DBAL\Schema\Index
    Parameter
    type name summary
    ​string ​$flag ​
    Return
    type summary
    ​Index ​

    [m] hasFlag Does this index have a specific flag?

    Does this index have a specific flag? 
    public function hasFlag(string $flag): bool
    Parameter
    type name summary
    ​string ​$flag ​
    Return
    type summary
    ​bool ​

    [m] removeFlag Removes a flag.

    Removes a flag. 
    public function removeFlag(string $flag): void
    Parameter
    type name summary
    ​string ​$flag ​
    Return
    type summary
    ​void ​

    [m] hasOption 

    public function hasOption(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​bool ​

    [m] getOption 

    public function getOption(string $name): mixed
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​mixed ​

    [m] getOptions 

    public function getOptions(): mixed[]
    Return
    type summary
    ​mixed[] ​

    [m] _setName Sets the name of this asset.

    Sets the name of this asset. 
    protected function _setName(string $name): void
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_setName() ​Sets the name of this asset.

    [m] isInDefaultNamespace Is this asset in the default namespace?

    Is this asset in the default namespace? 
    public function isInDefaultNamespace(string $defaultNamespaceName): bool
    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isInDefaultNamespace() ​Is this asset in the default namespace?

    [m] getNamespaceName Gets the namespace name of this asset.

    Gets the namespace name of this asset. 
    public function getNamespaceName(): string|null

    If NULL is returned this means the default namespace is used.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getNamespaceName() ​Gets the namespace name of this asset.

    [m] getShortestName The shortest name is stripped of the default namespace. All other

    The shortest name is stripped of the default namespace. All other 
    public function getShortestName(string|null $defaultNamespaceName): string

    namespaced elements are returned as full-qualified names.

    Parameter
    type name summary
    ​string|​null ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getShortestName() ​The shortest name is stripped of the default namespace. All other

    [m] getFullQualifiedName The normalized name is full-qualified and lower-cased. Lower-casing is

    deprecated

    The normalized name is full-qualified and lower-cased. Lower-casing is 
    public function getFullQualifiedName(string $defaultNamespaceName): string

    actually wrong, but we have to do it to keep our sanity. If you are using database objects that only differentiate in the casing (FOO vs Foo) then you will NOT be able to use Doctrine Schema abstraction.

    Every non-namespaced element is prefixed with the default namespace name which is passed as argument to this method.

    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getFullQualifiedName() ​The normalized name is full-qualified and lower-cased. Lower-casing is
    See
    type summary
    ​AbstractAsset::getNamespaceName() ​
    ​AbstractAsset::getName() ​

    [m] isQuoted Checks if this asset's name is quoted.

    Checks if this asset's name is quoted. 
    public function isQuoted(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isQuoted() ​Checks if this asset's name is quoted.

    [m] isIdentifierQuoted Checks if this identifier is quoted.

    Checks if this identifier is quoted. 
    protected function isIdentifierQuoted(string $identifier): bool
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isIdentifierQuoted() ​Checks if this identifier is quoted.

    [m] trimQuotes Trim quotes from the identifier.

    Trim quotes from the identifier. 
    protected function trimQuotes(string $identifier): string
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::trimQuotes() ​Trim quotes from the identifier.

    [m] getName Returns the name of this schema asset.

    Returns the name of this schema asset. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getName() ​Returns the name of this schema asset.

    [m] getQuotedName Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    Gets the quoted representation of this asset but only if it was defined with one. Otherwise 
    public function getQuotedName(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string

    return the plain unquoted value as inserted.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getQuotedName() ​Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    [m] _generateIdentifierName Generates an identifier from a list of column names obeying a certain string length.

    Generates an identifier from a list of column names obeying a certain string length. 
    protected function _generateIdentifierName(
    string[] $columnNames,
    string $prefix = "",
    int $maxSize = 30
): string

    This is especially important for Oracle, since it does not allow identifiers larger than 30 chars, however building idents automatically for foreign keys, composite keys or such can easily create very long names.

    Parameter
    type name summary
    ​string[] ​$columnNames ​
    ​string ​$prefix = "" ​
    ​int ​$maxSize = 30 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_generateIdentifierName() ​Generates an identifier from a list of column names obeying a certain string length.

    [C] Schema Object representation of a database schema.

    Object representation of a database schema.

    Different vendors have very inconsistent naming with regard to the concept of a "schema". Doctrine understands a schema as the entity that conceptually wraps a set of database objects such as tables, sequences, indexes and foreign keys that belong to each other into a namespace. A Doctrine Schema has nothing to do with the "SCHEMA" defined as in PostgreSQL, it is more related to the concept of "DATABASE" that exists in MySQL and PostgreSQL.

    Every asset in the doctrine schema has a name. A name consists of either a namespace.local name pair or just a local unqualified name.

    The abstraction layer that covers a PostgreSQL schema is the namespace of an database object (asset). A schema can have a name, which will be used as default namespace for the unqualified database objects that are created in the schema.

    In the case of MySQL where cross-database queries are allowed this leads to databases being "misinterpreted" as namespaces. This is intentional, however the CREATE/DROP SQL visitors will just filter this queries and do not execute them. Only the queries for the currently connected database are executed.

    Hierarchy

    Parents
    type summary
    ​AbstractAsset ​The abstract asset allows to reset the name of all assets without publishing this to the public userland.

    [p] $_tables 

    protected Doctrine\DBAL\Schema\Table[] $_tables = []

    Type: Table[]

    [p] $_sequences 

    protected Doctrine\DBAL\Schema\Sequence[] $_sequences = []

    Type: Sequence[]

    [p] $_schemaConfig 

    protected Doctrine\DBAL\Schema\SchemaConfig $_schemaConfig = null

    Type: SchemaConfig

    [p] $_name 

    protected string $_name = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_name ​

    [p] $_namespace Namespace of the asset. If none isset the default namespace is assumed.

    Namespace of the asset. If none isset the default namespace is assumed. 
    protected string|null $_namespace = null

    Type: string|​null

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_namespace ​Namespace of the asset. If none isset the default namespace is assumed.

    [p] $_quoted 

    protected bool $_quoted = false

    Type: bool

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_quoted ​

    [m] __construct 

    public function __construct(
    array|Doctrine\DBAL\Schema\Table[] $tables = [],
    array|Doctrine\DBAL\Schema\Sequence[] $sequences = [],
    ?Doctrine\DBAL\Schema\SchemaConfig $schemaConfig = null,
    array|string[] $namespaces = []
)
    Parameter
    type name summary
    ​array|​Table[] ​$tables = [] ​
    ​array|​Sequence[] ​$sequences = [] ​
    ​?SchemaConfig ​$schemaConfig = null ​
    ​array|​string[] ​$namespaces = [] ​
    Throws
    type summary
    ​SchemaException ​

    [m] hasExplicitForeignKeyIndexes

    deprecated 

    public function hasExplicitForeignKeyIndexes(): bool
    Return
    type summary
    ​bool ​

    [m] _addTable 

    protected function _addTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​SchemaException ​

    [m] _addSequence 

    protected function _addSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​SchemaException ​

    [m] getNamespaces Returns the namespaces of this schema.

    Returns the namespaces of this schema. 
    public function getNamespaces(): string[]
    Return
    type summary
    ​string[] ​A list of namespace names.

    [m] getTables Gets all tables of this schema.

    Gets all tables of this schema. 
    public function getTables(): Doctrine\DBAL\Schema\Table[]
    Return
    type summary
    ​Table[] ​

    [m] getTable 

    public function getTable(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​SchemaException ​

    [m] hasNamespace Does this schema have a namespace with the given name?

    Does this schema have a namespace with the given name? 
    public function hasNamespace(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​bool ​

    [m] hasTable Does this schema have a table with the given name?

    Does this schema have a table with the given name? 
    public function hasTable(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​bool ​

    [m] getTableNames Gets all table names, prefixed with a schema name, even the default one if present.

    deprecated

    Gets all table names, prefixed with a schema name, even the default one if present. 
    public function getTableNames(): string[]
    Return
    type summary
    ​string[] ​
    See
    type summary
    ​Schema::getTables() ​
    ​Table::getName() ​

    [m] hasSequence 

    public function hasSequence(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​bool ​

    [m] getSequence 

    public function getSequence(string $name): Doctrine\DBAL\Schema\Sequence
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Sequence ​
    Throws
    type summary
    ​SchemaException ​

    [m] getSequences 

    public function getSequences(): Doctrine\DBAL\Schema\Sequence[]
    Return
    type summary
    ​Sequence[] ​

    [m] createNamespace Creates a new namespace.

    Creates a new namespace. 
    public function createNamespace(string $name): Doctrine\DBAL\Schema\Schema
    Parameter
    type name summary
    ​string ​$name ​The name of the namespace to create.
    Return
    type summary
    ​Schema ​This schema instance.
    Throws
    type summary
    ​SchemaException ​

    [m] createTable Creates a new table.

    Creates a new table. 
    public function createTable(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​SchemaException ​

    [m] renameTable Renames a table.

    Renames a table. 
    public function renameTable(
    string $oldName,
    string $newName
): Doctrine\DBAL\Schema\Schema
    Parameter
    type name summary
    ​string ​$oldName ​
    ​string ​$newName ​
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​SchemaException ​

    [m] dropTable Drops a table from the schema.

    Drops a table from the schema. 
    public function dropTable(string $name): Doctrine\DBAL\Schema\Schema
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​SchemaException ​

    [m] createSequence Creates a new sequence.

    Creates a new sequence. 
    public function createSequence(
    string $name,
    int $allocationSize = 1,
    int $initialValue = 1
): Doctrine\DBAL\Schema\Sequence
    Parameter
    type name summary
    ​string ​$name ​
    ​int ​$allocationSize = 1 ​
    ​int ​$initialValue = 1 ​
    Return
    type summary
    ​Sequence ​
    Throws
    type summary
    ​SchemaException ​

    [m] dropSequence 

    public function dropSequence(string $name): Doctrine\DBAL\Schema\Schema
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Schema ​

    [m] toSql Returns an array of necessary SQL queries to create the schema on the given platform.

    Returns an array of necessary SQL queries to create the schema on the given platform. 
    public function toSql(Doctrine\DBAL\Platforms\AbstractPlatform $platform): list
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​

    [m] toDropSql Return an array of necessary SQL queries to drop the schema on the given platform.

    Return an array of necessary SQL queries to drop the schema on the given platform. 
    public function toDropSql(Doctrine\DBAL\Platforms\AbstractPlatform $platform): list
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​

    [m] getMigrateToSql

    deprecated 

    public function getMigrateToSql(
    Doctrine\DBAL\Schema\Schema $toSchema,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string[]
    Parameter
    type name summary
    ​Schema ​$toSchema ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​SchemaException ​

    [m] getMigrateFromSql

    deprecated 

    public function getMigrateFromSql(
    Doctrine\DBAL\Schema\Schema $fromSchema,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string[]
    Parameter
    type name summary
    ​Schema ​$fromSchema ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​SchemaException ​

    [m] visit

    deprecated 

    public function visit(Doctrine\DBAL\Schema\Visitor\Visitor $visitor): void
    Parameter
    type name summary
    ​Visitor ​$visitor ​
    Return
    type summary
    ​void ​

    [m] __clone Cloning a Schema triggers a deep clone of all related assets.

    Cloning a Schema triggers a deep clone of all related assets. 
    public function __clone(): void
    Return
    type summary
    ​void ​

    [m] _setName Sets the name of this asset.

    Sets the name of this asset. 
    protected function _setName(string $name): void
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_setName() ​Sets the name of this asset.

    [m] isInDefaultNamespace Is this asset in the default namespace?

    Is this asset in the default namespace? 
    public function isInDefaultNamespace(string $defaultNamespaceName): bool
    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isInDefaultNamespace() ​Is this asset in the default namespace?

    [m] getNamespaceName Gets the namespace name of this asset.

    Gets the namespace name of this asset. 
    public function getNamespaceName(): string|null

    If NULL is returned this means the default namespace is used.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getNamespaceName() ​Gets the namespace name of this asset.

    [m] getShortestName The shortest name is stripped of the default namespace. All other

    The shortest name is stripped of the default namespace. All other 
    public function getShortestName(string|null $defaultNamespaceName): string

    namespaced elements are returned as full-qualified names.

    Parameter
    type name summary
    ​string|​null ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getShortestName() ​The shortest name is stripped of the default namespace. All other

    [m] getFullQualifiedName The normalized name is full-qualified and lower-cased. Lower-casing is

    deprecated

    The normalized name is full-qualified and lower-cased. Lower-casing is 
    public function getFullQualifiedName(string $defaultNamespaceName): string

    actually wrong, but we have to do it to keep our sanity. If you are using database objects that only differentiate in the casing (FOO vs Foo) then you will NOT be able to use Doctrine Schema abstraction.

    Every non-namespaced element is prefixed with the default namespace name which is passed as argument to this method.

    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getFullQualifiedName() ​The normalized name is full-qualified and lower-cased. Lower-casing is
    See
    type summary
    ​AbstractAsset::getNamespaceName() ​
    ​AbstractAsset::getName() ​

    [m] isQuoted Checks if this asset's name is quoted.

    Checks if this asset's name is quoted. 
    public function isQuoted(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isQuoted() ​Checks if this asset's name is quoted.

    [m] isIdentifierQuoted Checks if this identifier is quoted.

    Checks if this identifier is quoted. 
    protected function isIdentifierQuoted(string $identifier): bool
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isIdentifierQuoted() ​Checks if this identifier is quoted.

    [m] trimQuotes Trim quotes from the identifier.

    Trim quotes from the identifier. 
    protected function trimQuotes(string $identifier): string
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::trimQuotes() ​Trim quotes from the identifier.

    [m] getName Returns the name of this schema asset.

    Returns the name of this schema asset. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getName() ​Returns the name of this schema asset.

    [m] getQuotedName Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    Gets the quoted representation of this asset but only if it was defined with one. Otherwise 
    public function getQuotedName(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string

    return the plain unquoted value as inserted.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getQuotedName() ​Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    [m] _generateIdentifierName Generates an identifier from a list of column names obeying a certain string length.

    Generates an identifier from a list of column names obeying a certain string length. 
    protected function _generateIdentifierName(
    string[] $columnNames,
    string $prefix = "",
    int $maxSize = 30
): string

    This is especially important for Oracle, since it does not allow identifiers larger than 30 chars, however building idents automatically for foreign keys, composite keys or such can easily create very long names.

    Parameter
    type name summary
    ​string[] ​$columnNames ​
    ​string ​$prefix = "" ​
    ​int ​$maxSize = 30 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_generateIdentifierName() ​Generates an identifier from a list of column names obeying a certain string length.

    [C] Sequence Sequence structure.

    Sequence structure.

    Hierarchy

    Parents
    type summary
    ​AbstractAsset ​The abstract asset allows to reset the name of all assets without publishing this to the public userland.

    [p] $allocationSize 

    protected int $allocationSize = 1

    Type: int

    [p] $initialValue 

    protected int $initialValue = 1

    Type: int

    [p] $cache 

    protected int|null $cache = null

    Type: int|​null

    [p] $_name 

    protected string $_name = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_name ​

    [p] $_namespace Namespace of the asset. If none isset the default namespace is assumed.

    Namespace of the asset. If none isset the default namespace is assumed. 
    protected string|null $_namespace = null

    Type: string|​null

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_namespace ​Namespace of the asset. If none isset the default namespace is assumed.

    [p] $_quoted 

    protected bool $_quoted = false

    Type: bool

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_quoted ​

    [m] __construct 

    public function __construct(
    string $name,
    int $allocationSize = 1,
    int $initialValue = 1,
    int|null $cache = null
)
    Parameter
    type name summary
    ​string ​$name ​
    ​int ​$allocationSize = 1 ​
    ​int ​$initialValue = 1 ​
    ​int|​null ​$cache = null ​

    [m] getAllocationSize 

    public function getAllocationSize(): int
    Return
    type summary
    ​int ​

    [m] getInitialValue 

    public function getInitialValue(): int
    Return
    type summary
    ​int ​

    [m] getCache 

    public function getCache(): int|null
    Return
    type summary
    ​int|​null ​

    [m] setAllocationSize 

    public function setAllocationSize(int $allocationSize): Doctrine\DBAL\Schema\Sequence
    Parameter
    type name summary
    ​int ​$allocationSize ​
    Return
    type summary
    ​Sequence ​

    [m] setInitialValue 

    public function setInitialValue(int $initialValue): Doctrine\DBAL\Schema\Sequence
    Parameter
    type name summary
    ​int ​$initialValue ​
    Return
    type summary
    ​Sequence ​

    [m] setCache 

    public function setCache(int $cache): Doctrine\DBAL\Schema\Sequence
    Parameter
    type name summary
    ​int ​$cache ​
    Return
    type summary
    ​Sequence ​

    [m] isAutoIncrementsFor Checks if this sequence is an autoincrement sequence for a given table.

    Checks if this sequence is an autoincrement sequence for a given table. 
    public function isAutoIncrementsFor(Doctrine\DBAL\Schema\Table $table): bool

    This is used inside the comparator to not report sequences as missing, when the "from" schema implicitly creates the sequences.

    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​bool ​

    [m] visit

    deprecated 

    public function visit(Doctrine\DBAL\Schema\Visitor\Visitor $visitor): void
    Parameter
    type name summary
    ​Visitor ​$visitor ​
    Return
    type summary
    ​void ​

    [m] _setName Sets the name of this asset.

    Sets the name of this asset. 
    protected function _setName(string $name): void
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_setName() ​Sets the name of this asset.

    [m] isInDefaultNamespace Is this asset in the default namespace?

    Is this asset in the default namespace? 
    public function isInDefaultNamespace(string $defaultNamespaceName): bool
    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isInDefaultNamespace() ​Is this asset in the default namespace?

    [m] getNamespaceName Gets the namespace name of this asset.

    Gets the namespace name of this asset. 
    public function getNamespaceName(): string|null

    If NULL is returned this means the default namespace is used.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getNamespaceName() ​Gets the namespace name of this asset.

    [m] getShortestName The shortest name is stripped of the default namespace. All other

    The shortest name is stripped of the default namespace. All other 
    public function getShortestName(string|null $defaultNamespaceName): string

    namespaced elements are returned as full-qualified names.

    Parameter
    type name summary
    ​string|​null ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getShortestName() ​The shortest name is stripped of the default namespace. All other

    [m] getFullQualifiedName The normalized name is full-qualified and lower-cased. Lower-casing is

    deprecated

    The normalized name is full-qualified and lower-cased. Lower-casing is 
    public function getFullQualifiedName(string $defaultNamespaceName): string

    actually wrong, but we have to do it to keep our sanity. If you are using database objects that only differentiate in the casing (FOO vs Foo) then you will NOT be able to use Doctrine Schema abstraction.

    Every non-namespaced element is prefixed with the default namespace name which is passed as argument to this method.

    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getFullQualifiedName() ​The normalized name is full-qualified and lower-cased. Lower-casing is
    See
    type summary
    ​AbstractAsset::getNamespaceName() ​
    ​AbstractAsset::getName() ​

    [m] isQuoted Checks if this asset's name is quoted.

    Checks if this asset's name is quoted. 
    public function isQuoted(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isQuoted() ​Checks if this asset's name is quoted.

    [m] isIdentifierQuoted Checks if this identifier is quoted.

    Checks if this identifier is quoted. 
    protected function isIdentifierQuoted(string $identifier): bool
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isIdentifierQuoted() ​Checks if this identifier is quoted.

    [m] trimQuotes Trim quotes from the identifier.

    Trim quotes from the identifier. 
    protected function trimQuotes(string $identifier): string
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::trimQuotes() ​Trim quotes from the identifier.

    [m] getName Returns the name of this schema asset.

    Returns the name of this schema asset. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getName() ​Returns the name of this schema asset.

    [m] getQuotedName Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    Gets the quoted representation of this asset but only if it was defined with one. Otherwise 
    public function getQuotedName(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string

    return the plain unquoted value as inserted.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getQuotedName() ​Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    [m] _generateIdentifierName Generates an identifier from a list of column names obeying a certain string length.

    Generates an identifier from a list of column names obeying a certain string length. 
    protected function _generateIdentifierName(
    string[] $columnNames,
    string $prefix = "",
    int $maxSize = 30
): string

    This is especially important for Oracle, since it does not allow identifiers larger than 30 chars, however building idents automatically for foreign keys, composite keys or such can easily create very long names.

    Parameter
    type name summary
    ​string[] ​$columnNames ​
    ​string ​$prefix = "" ​
    ​int ​$maxSize = 30 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_generateIdentifierName() ​Generates an identifier from a list of column names obeying a certain string length.

    [C] DefaultSchemaManagerFactory A schema manager factory that returns the default schema manager for the given platform.

    final

    A schema manager factory that returns the default schema manager for the given platform.

    Implements
    type summary
    ​SchemaManagerFactory ​Creates a schema manager for the given connection.

    [m] createSchemaManager 

    public function createSchemaManager(Doctrine\DBAL\Connection $connection): Doctrine\DBAL\Schema\AbstractSchemaManager
    Parameter
    type name summary
    ​Connection ​$connection ​
    Return
    type summary
    ​AbstractSchemaManager ​
    Throws
    type summary
    ​Exception ​If the platform does not support creating schema managers yet.
    Prototype
    kind source summary
    ​implement ​SchemaManagerFactory::createSchemaManager() ​

    [C] LegacySchemaManagerFactory

    final

    Implements
    type summary
    ​SchemaManagerFactory ​Creates a schema manager for the given connection.

    [m] createSchemaManager 

    public function createSchemaManager(Doctrine\DBAL\Connection $connection): Doctrine\DBAL\Schema\AbstractSchemaManager
    Parameter
    type name summary
    ​Connection ​$connection ​
    Return
    type summary
    ​AbstractSchemaManager ​
    Prototype
    kind source summary
    ​implement ​SchemaManagerFactory::createSchemaManager() ​

    [C] TableDiff Table Diff.

    Table Diff.

    [p] $name

    deprecated 

    public string $name = null

    Type: string

    See
    type summary
    ​TableDiff::getOldTable() ​

    [p] $newName

    deprecated 

    public string|false $newName = false

    Type: string|​false

    [p] $addedColumns All added columns

    All added columns 
    public Doctrine\DBAL\Schema\Column[] $addedColumns = null

    Type: Column[]

    See
    type summary
    ​TableDiff::getAddedColumns() ​

    [p] $changedColumns All modified columns

    All modified columns 
    public Doctrine\DBAL\Schema\ColumnDiff[] $changedColumns = []

    Type: ColumnDiff[]

    See
    type summary
    ​TableDiff::getModifiedColumns() ​

    [p] $removedColumns All dropped columns

    All dropped columns 
    public Doctrine\DBAL\Schema\Column[] $removedColumns = []

    Type: Column[]

    See
    type summary
    ​TableDiff::getDroppedColumns() ​

    [p] $renamedColumns Columns that are only renamed from key to column instance name.

    Columns that are only renamed from key to column instance name. 
    public Doctrine\DBAL\Schema\Column[] $renamedColumns = []

    Type: Column[]

    See
    type summary
    ​TableDiff::getRenamedColumns() ​

    [p] $addedIndexes All added indexes.

    All added indexes. 
    public Doctrine\DBAL\Schema\Index[] $addedIndexes = []

    Type: Index[]

    See
    type summary
    ​TableDiff::getAddedIndexes() ​

    [p] $changedIndexes All changed indexes.

    All changed indexes. 
    public Doctrine\DBAL\Schema\Index[] $changedIndexes = []

    Type: Index[]

    See
    type summary
    ​TableDiff::getModifiedIndexes() ​

    [p] $removedIndexes All removed indexes

    All removed indexes 
    public Doctrine\DBAL\Schema\Index[] $removedIndexes = []

    Type: Index[]

    See
    type summary
    ​TableDiff::getDroppedIndexes() ​

    [p] $renamedIndexes Indexes that are only renamed but are identical otherwise.

    Indexes that are only renamed but are identical otherwise. 
    public Doctrine\DBAL\Schema\Index[] $renamedIndexes = []

    Type: Index[]

    See
    type summary
    ​TableDiff::getRenamedIndexes() ​

    [p] $addedForeignKeys All added foreign key definitions

    All added foreign key definitions 
    public Doctrine\DBAL\Schema\ForeignKeyConstraint[] $addedForeignKeys = []

    Type: ForeignKeyConstraint[]

    See
    type summary
    ​TableDiff::getAddedForeignKeys() ​

    [p] $changedForeignKeys All changed foreign keys

    All changed foreign keys 
    public Doctrine\DBAL\Schema\ForeignKeyConstraint[] $changedForeignKeys = []

    Type: ForeignKeyConstraint[]

    See
    type summary
    ​TableDiff::getModifiedForeignKeys() ​

    [p] $removedForeignKeys All removed foreign keys

    All removed foreign keys 
    public (ForeignKeyConstraint|string)[] $removedForeignKeys = []

    Type: (ForeignKeyConstraint|​string)[]

    See
    type summary
    ​TableDiff::getDroppedForeignKeys() ​

    [p] $fromTable 

    public Doctrine\DBAL\Schema\Table|null $fromTable = null

    Type: Table|​null

    See
    type summary
    ​TableDiff::getOldTable() ​

    [m] __construct Constructs a TableDiff object.

    Constructs a TableDiff object. 
    public function __construct(
    string $tableName,
    array $addedColumns = [],
    array $modifiedColumns = [],
    array $droppedColumns = [],
    array $addedIndexes = [],
    array $changedIndexes = [],
    array $removedIndexes = [],
    ?Doctrine\DBAL\Schema\Table $fromTable = null,
    list $addedForeignKeys = [],
    list $changedForeignKeys = [],
    list $removedForeignKeys = [],
    array $renamedColumns = [],
    array $renamedIndexes = []
)
    Parameter
    type name summary
    ​string ​$tableName ​
    ​array ​$addedColumns = [] ​
    ​array ​$modifiedColumns = [] ​
    ​array ​$droppedColumns = [] ​
    ​array ​$addedIndexes = [] ​
    ​array ​$changedIndexes = [] ​
    ​array ​$removedIndexes = [] ​
    ​?Table ​$fromTable = null ​
    ​list ​$addedForeignKeys = [] ​
    ​list ​$changedForeignKeys = [] ​
    ​list ​$removedForeignKeys = [] ​
    ​array ​$renamedColumns = [] ​
    ​array ​$renamedIndexes = [] ​
    See
    type summary
    ​Comparator ​

    [m] getName

    deprecated 

    public function getName(Doctrine\DBAL\Platforms\AbstractPlatform $platform): Doctrine\DBAL\Schema\Identifier
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​The platform to use for retrieving this table diff's name.
    Return
    type summary
    ​Identifier ​
    See
    type summary
    ​TableDiff::getOldTable() ​

    [m] getNewName

    deprecated 

    public function getNewName(): Doctrine\DBAL\Schema\Identifier|false
    Return
    type summary
    ​Identifier|​false ​

    [m] getOldTable 

    public function getOldTable(): ?Doctrine\DBAL\Schema\Table
    Return
    type summary
    ​?Table ​

    [m] getAddedColumns 

    public function getAddedColumns(): array|list
    Return
    type summary
    ​array|​list ​

    [m] getModifiedColumns 

    public function getModifiedColumns(): array|list
    Return
    type summary
    ​array|​list ​

    [m] getDroppedColumns 

    public function getDroppedColumns(): array|list
    Return
    type summary
    ​array|​list ​

    [m] getRenamedColumns 

    public function getRenamedColumns(): array
    Return
    type summary
    ​array ​

    [m] getAddedIndexes 

    public function getAddedIndexes(): array|list
    Return
    type summary
    ​array|​list ​

    [m] unsetAddedIndex 

    public function unsetAddedIndex(Doctrine\DBAL\Schema\Index $index)
    Parameter
    type name summary
    ​Index ​$index ​

    [m] getModifiedIndexes 

    public function getModifiedIndexes(): array
    Return
    type summary
    ​array ​

    [m] getDroppedIndexes 

    public function getDroppedIndexes(): array|list
    Return
    type summary
    ​array|​list ​

    [m] unsetDroppedIndex 

    public function unsetDroppedIndex(Doctrine\DBAL\Schema\Index $index)
    Parameter
    type name summary
    ​Index ​$index ​

    [m] getRenamedIndexes 

    public function getRenamedIndexes(): array
    Return
    type summary
    ​array ​

    [m] getAddedForeignKeys 

    public function getAddedForeignKeys(): array|list
    Return
    type summary
    ​array|​list ​

    [m] getModifiedForeignKeys 

    public function getModifiedForeignKeys(): array|list
    Return
    type summary
    ​array|​list ​

    [m] getDroppedForeignKeys 

    public function getDroppedForeignKeys(): array|list
    Return
    type summary
    ​array|​list ​

    [m] unsetDroppedForeignKey 

    public function unsetDroppedForeignKey(Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey)
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​

    [m] isEmpty Returns whether the diff is empty (contains no changes).

    Returns whether the diff is empty (contains no changes). 
    public function isEmpty(): bool
    Return
    type summary
    ​bool ​

    [C] ColumnDiff Represents the change of a column.

    Represents the change of a column.

    [p] $oldColumnName

    deprecated 

    public string $oldColumnName = null

    Type: string

    See
    type summary
    ​ColumnDiff::$fromColumn ​
    ​Column::getName() ​

    [p] $column 

    public Doctrine\DBAL\Schema\Column $column = null

    Type: Column

    See
    type summary
    ​ColumnDiff::getNewColumn() ​

    [p] $changedProperties

    deprecated 

    public string[] $changedProperties = []

    Type: string[]

    See
    type summary
    ​ColumnDiff::hasTypeChanged() ​
    ​ColumnDiff::hasLengthChanged() ​
    ​ColumnDiff::hasPrecisionChanged() ​
    ​ColumnDiff::hasScaleChanged() ​
    ​ColumnDiff::hasUnsignedChanged() ​
    ​ColumnDiff::hasFixedChanged() ​
    ​ColumnDiff::hasNotNullChanged() ​
    ​ColumnDiff::hasDefaultChanged() ​
    ​ColumnDiff::hasAutoIncrementChanged() ​
    ​ColumnDiff::hasCommentChanged() ​

    [p] $fromColumn 

    public Doctrine\DBAL\Schema\Column|null $fromColumn = null

    Type: Column|​null

    See
    type summary
    ​ColumnDiff::getOldColumn() ​

    [m] __construct 

    public function __construct(
    string $oldColumnName,
    Doctrine\DBAL\Schema\Column $column,
    array|string[] $changedProperties = [],
    ?Doctrine\DBAL\Schema\Column $fromColumn = null
)
    Parameter
    type name summary
    ​string ​$oldColumnName ​
    ​Column ​$column ​
    ​array|​string[] ​$changedProperties = [] ​
    ​?Column ​$fromColumn = null ​
    See
    type summary
    ​Comparator ​

    [m] getOldColumn 

    public function getOldColumn(): ?Doctrine\DBAL\Schema\Column
    Return
    type summary
    ​?Column ​

    [m] getNewColumn 

    public function getNewColumn(): Doctrine\DBAL\Schema\Column
    Return
    type summary
    ​Column ​

    [m] hasTypeChanged 

    public function hasTypeChanged(): bool
    Return
    type summary
    ​bool ​

    [m] hasLengthChanged 

    public function hasLengthChanged(): bool
    Return
    type summary
    ​bool ​

    [m] hasPrecisionChanged 

    public function hasPrecisionChanged(): bool
    Return
    type summary
    ​bool ​

    [m] hasScaleChanged 

    public function hasScaleChanged(): bool
    Return
    type summary
    ​bool ​

    [m] hasUnsignedChanged 

    public function hasUnsignedChanged(): bool
    Return
    type summary
    ​bool ​

    [m] hasFixedChanged 

    public function hasFixedChanged(): bool
    Return
    type summary
    ​bool ​

    [m] hasNotNullChanged 

    public function hasNotNullChanged(): bool
    Return
    type summary
    ​bool ​

    [m] hasDefaultChanged 

    public function hasDefaultChanged(): bool
    Return
    type summary
    ​bool ​

    [m] hasAutoIncrementChanged 

    public function hasAutoIncrementChanged(): bool
    Return
    type summary
    ​bool ​

    [m] hasCommentChanged 

    public function hasCommentChanged(): bool
    Return
    type summary
    ​bool ​

    [m] hasChanged

    deprecated 

    public function hasChanged(string $propertyName): bool
    Parameter
    type name summary
    ​string ​$propertyName ​
    Return
    type summary
    ​bool ​
    See
    type summary
    ​ColumnDiff::hasTypeChanged() ​
    ​ColumnDiff::hasLengthChanged() ​
    ​ColumnDiff::hasPrecisionChanged() ​
    ​ColumnDiff::hasScaleChanged() ​
    ​ColumnDiff::hasUnsignedChanged() ​
    ​ColumnDiff::hasFixedChanged() ​
    ​ColumnDiff::hasNotNullChanged() ​
    ​ColumnDiff::hasDefaultChanged() ​
    ​ColumnDiff::hasAutoIncrementChanged() ​
    ​ColumnDiff::hasCommentChanged() ​

    [m] getOldColumnName

    deprecated 

    public function getOldColumnName(): Doctrine\DBAL\Schema\Identifier
    Return
    type summary
    ​Identifier ​
    See
    type summary
    ​ColumnDiff::$fromColumn ​

    [C] Identifier An abstraction class for an asset identifier.

    An abstraction class for an asset identifier.

    Wraps identifier names like column names in indexes / foreign keys in an abstract class for proper quotation capabilities.

    Hierarchy

    Parents
    type summary
    ​AbstractAsset ​The abstract asset allows to reset the name of all assets without publishing this to the public userland.

    [p] $_name 

    protected string $_name = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_name ​

    [p] $_namespace Namespace of the asset. If none isset the default namespace is assumed.

    Namespace of the asset. If none isset the default namespace is assumed. 
    protected string|null $_namespace = null

    Type: string|​null

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_namespace ​Namespace of the asset. If none isset the default namespace is assumed.

    [p] $_quoted 

    protected bool $_quoted = false

    Type: bool

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_quoted ​

    [m] __construct 

    public function __construct(
    string $identifier,
    bool $quote = false
)
    Parameter
    type name summary
    ​string ​$identifier ​Identifier name to wrap.
    ​bool ​$quote = false ​Whether to force quoting the given identifier.

    [m] _setName Sets the name of this asset.

    Sets the name of this asset. 
    protected function _setName(string $name): void
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_setName() ​Sets the name of this asset.

    [m] isInDefaultNamespace Is this asset in the default namespace?

    Is this asset in the default namespace? 
    public function isInDefaultNamespace(string $defaultNamespaceName): bool
    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isInDefaultNamespace() ​Is this asset in the default namespace?

    [m] getNamespaceName Gets the namespace name of this asset.

    Gets the namespace name of this asset. 
    public function getNamespaceName(): string|null

    If NULL is returned this means the default namespace is used.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getNamespaceName() ​Gets the namespace name of this asset.

    [m] getShortestName The shortest name is stripped of the default namespace. All other

    The shortest name is stripped of the default namespace. All other 
    public function getShortestName(string|null $defaultNamespaceName): string

    namespaced elements are returned as full-qualified names.

    Parameter
    type name summary
    ​string|​null ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getShortestName() ​The shortest name is stripped of the default namespace. All other

    [m] getFullQualifiedName The normalized name is full-qualified and lower-cased. Lower-casing is

    deprecated

    The normalized name is full-qualified and lower-cased. Lower-casing is 
    public function getFullQualifiedName(string $defaultNamespaceName): string

    actually wrong, but we have to do it to keep our sanity. If you are using database objects that only differentiate in the casing (FOO vs Foo) then you will NOT be able to use Doctrine Schema abstraction.

    Every non-namespaced element is prefixed with the default namespace name which is passed as argument to this method.

    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getFullQualifiedName() ​The normalized name is full-qualified and lower-cased. Lower-casing is
    See
    type summary
    ​AbstractAsset::getNamespaceName() ​
    ​AbstractAsset::getName() ​

    [m] isQuoted Checks if this asset's name is quoted.

    Checks if this asset's name is quoted. 
    public function isQuoted(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isQuoted() ​Checks if this asset's name is quoted.

    [m] isIdentifierQuoted Checks if this identifier is quoted.

    Checks if this identifier is quoted. 
    protected function isIdentifierQuoted(string $identifier): bool
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isIdentifierQuoted() ​Checks if this identifier is quoted.

    [m] trimQuotes Trim quotes from the identifier.

    Trim quotes from the identifier. 
    protected function trimQuotes(string $identifier): string
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::trimQuotes() ​Trim quotes from the identifier.

    [m] getName Returns the name of this schema asset.

    Returns the name of this schema asset. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getName() ​Returns the name of this schema asset.

    [m] getQuotedName Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    Gets the quoted representation of this asset but only if it was defined with one. Otherwise 
    public function getQuotedName(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string

    return the plain unquoted value as inserted.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getQuotedName() ​Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    [m] _generateIdentifierName Generates an identifier from a list of column names obeying a certain string length.

    Generates an identifier from a list of column names obeying a certain string length. 
    protected function _generateIdentifierName(
    string[] $columnNames,
    string $prefix = "",
    int $maxSize = 30
): string

    This is especially important for Oracle, since it does not allow identifiers larger than 30 chars, however building idents automatically for foreign keys, composite keys or such can easily create very long names.

    Parameter
    type name summary
    ​string[] ​$columnNames ​
    ​string ​$prefix = "" ​
    ​int ​$maxSize = 30 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_generateIdentifierName() ​Generates an identifier from a list of column names obeying a certain string length.

    [C] SchemaDiff Differences between two schemas.

    Differences between two schemas.

    The object contains the operations to change the schema stored in $fromSchema to a target schema.

    [p] $fromSchema

    deprecated 

    public Doctrine\DBAL\Schema\Schema|null $fromSchema = null

    Type: Schema|​null

    [p] $newNamespaces All added namespaces.

    All added namespaces. 
    public string[] $newNamespaces = []

    Type: string[]

    [p] $removedNamespaces All removed namespaces.

    All removed namespaces. 
    public string[] $removedNamespaces = []

    Type: string[]

    [p] $newTables All added tables.

    All added tables. 
    public Doctrine\DBAL\Schema\Table[] $newTables = []

    Type: Table[]

    [p] $changedTables All changed tables.

    All changed tables. 
    public Doctrine\DBAL\Schema\TableDiff[] $changedTables = []

    Type: TableDiff[]

    [p] $removedTables All removed tables.

    All removed tables. 
    public Doctrine\DBAL\Schema\Table[] $removedTables = []

    Type: Table[]

    [p] $newSequences 

    public Doctrine\DBAL\Schema\Sequence[] $newSequences = []

    Type: Sequence[]

    [p] $changedSequences 

    public Doctrine\DBAL\Schema\Sequence[] $changedSequences = []

    Type: Sequence[]

    [p] $removedSequences 

    public Doctrine\DBAL\Schema\Sequence[] $removedSequences = []

    Type: Sequence[]

    [p] $orphanedForeignKeys

    deprecated 

    public Doctrine\DBAL\Schema\ForeignKeyConstraint[] $orphanedForeignKeys = []

    Type: ForeignKeyConstraint[]

    [m] __construct Constructs an SchemaDiff object.

    Constructs an SchemaDiff object. 
    public function __construct(
    Doctrine\DBAL\Schema\Table[] $newTables = [],
    Doctrine\DBAL\Schema\TableDiff[] $changedTables = [],
    Doctrine\DBAL\Schema\Table[] $removedTables = [],
    ?Doctrine\DBAL\Schema\Schema $fromSchema = null,
    array $createdSchemas = [],
    array $droppedSchemas = [],
    array $createdSequences = [],
    array $alteredSequences = [],
    array $droppedSequences = []
)
    Parameter
    type name summary
    ​Table[] ​$newTables = [] ​
    ​TableDiff[] ​$changedTables = [] ​
    ​Table[] ​$removedTables = [] ​
    ​?Schema ​$fromSchema = null ​
    ​array ​$createdSchemas = [] ​
    ​array ​$droppedSchemas = [] ​
    ​array ​$createdSequences = [] ​
    ​array ​$alteredSequences = [] ​
    ​array ​$droppedSequences = [] ​
    See
    type summary
    ​Comparator ​

    [m] getCreatedSchemas 

    public function getCreatedSchemas(): array
    Return
    type summary
    ​array ​

    [m] getDroppedSchemas 

    public function getDroppedSchemas(): array
    Return
    type summary
    ​array ​

    [m] getCreatedTables 

    public function getCreatedTables(): array
    Return
    type summary
    ​array ​

    [m] getAlteredTables 

    public function getAlteredTables(): array
    Return
    type summary
    ​array ​

    [m] getDroppedTables 

    public function getDroppedTables(): array
    Return
    type summary
    ​array ​

    [m] getCreatedSequences 

    public function getCreatedSequences(): array
    Return
    type summary
    ​array ​

    [m] getAlteredSequences 

    public function getAlteredSequences(): array
    Return
    type summary
    ​array ​

    [m] getDroppedSequences 

    public function getDroppedSequences(): array
    Return
    type summary
    ​array ​

    [m] isEmpty Returns whether the diff is empty (contains no changes).

    Returns whether the diff is empty (contains no changes). 
    public function isEmpty(): bool
    Return
    type summary
    ​bool ​

    [m] toSaveSql The to save sql mode ensures that the following things don't happen:

    deprecated

    The to save sql mode ensures that the following things don't happen: 
    public function toSaveSql(Doctrine\DBAL\Platforms\AbstractPlatform $platform): list
    1. Tables are deleted
    2. Sequences are deleted
    3. Foreign Keys which reference tables that would otherwise be deleted.

    This way it is ensured that assets are deleted which might not be relevant to the metadata schema at all.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​list ​

    [m] toSql

    deprecated 

    public function toSql(Doctrine\DBAL\Platforms\AbstractPlatform $platform): list
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​list ​

    [m] _toSql 

    protected function _toSql(
    Doctrine\DBAL\Platforms\AbstractPlatform $platform,
    bool $saveMode = false
): list
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    ​bool ​$saveMode = false ​
    Return
    type summary
    ​list ​

    [C] UniqueConstraint Class for a unique constraint.

    Class for a unique constraint.

    Hierarchy

    Parents
    type summary
    ​AbstractAsset ​The abstract asset allows to reset the name of all assets without publishing this to the public userland.
    Implements
    type summary
    ​Constraint ​Marker interface for constraints.

    [p] $columns Asset identifier instances of the column names the unique constraint is associated with.

    Asset identifier instances of the column names the unique constraint is associated with. 
    protected Doctrine\DBAL\Schema\Identifier[] $columns = []

    array($columnName => Identifier)

    Type: Identifier[]

    [p] $flags Platform specific flags.

    Platform specific flags. 
    protected true[] $flags = []

    array($flagName => true)

    Type: true[]

    [p] $_name 

    protected string $_name = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_name ​

    [p] $_namespace Namespace of the asset. If none isset the default namespace is assumed.

    Namespace of the asset. If none isset the default namespace is assumed. 
    protected string|null $_namespace = null

    Type: string|​null

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_namespace ​Namespace of the asset. If none isset the default namespace is assumed.

    [p] $_quoted 

    protected bool $_quoted = false

    Type: bool

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_quoted ​

    [m] __construct 

    public function __construct(
    string $name,
    array|string[] $columns,
    array|string[] $flags = [],
    array|mixed[] $options = []
)
    Parameter
    type name summary
    ​string ​$name ​
    ​array|​string[] ​$columns ​
    ​array|​string[] ​$flags = [] ​
    ​array|​mixed[] ​$options = [] ​

    [m] getColumns <tag_inheritdoc data-type='' data-description=''>Returns the names of the referencing table columns

    Returns the names of the referencing table columns 
    public function getColumns(): string[]

    the constraint is associated with.

    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​implement ​Constraint::getColumns() ​Returns the names of the referencing table columns

    [m] getQuotedColumns <tag_inheritdoc data-type='' data-description=''>Returns the quoted representation of the column names

    Returns the quoted representation of the column names 
    public function getQuotedColumns(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string[]

    the constraint is associated with.

    But only if they were defined with one or a column name is a keyword reserved by the platform. Otherwise the plain unquoted value as inserted is returned.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​The platform to use for quotation.
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​implement ​Constraint::getQuotedColumns() ​Returns the quoted representation of the column names

    [m] getUnquotedColumns 

    public function getUnquotedColumns(): array|string[]
    Return
    type summary
    ​array|​string[] ​

    [m] getFlags Returns platform specific flags for unique constraint.

    Returns platform specific flags for unique constraint. 
    public function getFlags(): array|string[]
    Return
    type summary
    ​array|​string[] ​

    [m] addFlag Adds flag for a unique constraint that translates to platform specific handling.

    Adds flag for a unique constraint that translates to platform specific handling. 
    public function addFlag(string $flag): Doctrine\DBAL\Schema\UniqueConstraint|Doctrine\DBAL\Schema\UniqueConstraint
    Parameter
    type name summary
    ​string ​$flag ​
    Return
    type summary
    ​UniqueConstraint|​UniqueConstraint ​

    [m] hasFlag Does this unique constraint have a specific flag?

    Does this unique constraint have a specific flag? 
    public function hasFlag(string $flag): bool
    Parameter
    type name summary
    ​string ​$flag ​
    Return
    type summary
    ​bool ​

    [m] removeFlag Removes a flag.

    Removes a flag. 
    public function removeFlag(string $flag)
    Parameter
    type name summary
    ​string ​$flag ​

    [m] hasOption Does this unique constraint have a specific option?

    Does this unique constraint have a specific option? 
    public function hasOption(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​bool ​

    [m] getOption 

    public function getOption(string $name): mixed
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​mixed ​

    [m] getOptions 

    public function getOptions(): array|mixed[]
    Return
    type summary
    ​array|​mixed[] ​

    [m] addColumn Adds a new column to the unique constraint.

    Adds a new column to the unique constraint. 
    protected function addColumn(string $column)
    Parameter
    type name summary
    ​string ​$column ​

    [m] _setName Sets the name of this asset.

    Sets the name of this asset. 
    protected function _setName(string $name): void
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_setName() ​Sets the name of this asset.

    [m] isInDefaultNamespace Is this asset in the default namespace?

    Is this asset in the default namespace? 
    public function isInDefaultNamespace(string $defaultNamespaceName): bool
    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isInDefaultNamespace() ​Is this asset in the default namespace?

    [m] getNamespaceName Gets the namespace name of this asset.

    Gets the namespace name of this asset. 
    public function getNamespaceName(): string|null

    If NULL is returned this means the default namespace is used.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getNamespaceName() ​Gets the namespace name of this asset.

    [m] getShortestName The shortest name is stripped of the default namespace. All other

    The shortest name is stripped of the default namespace. All other 
    public function getShortestName(string|null $defaultNamespaceName): string

    namespaced elements are returned as full-qualified names.

    Parameter
    type name summary
    ​string|​null ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getShortestName() ​The shortest name is stripped of the default namespace. All other

    [m] getFullQualifiedName The normalized name is full-qualified and lower-cased. Lower-casing is

    deprecated

    The normalized name is full-qualified and lower-cased. Lower-casing is 
    public function getFullQualifiedName(string $defaultNamespaceName): string

    actually wrong, but we have to do it to keep our sanity. If you are using database objects that only differentiate in the casing (FOO vs Foo) then you will NOT be able to use Doctrine Schema abstraction.

    Every non-namespaced element is prefixed with the default namespace name which is passed as argument to this method.

    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getFullQualifiedName() ​The normalized name is full-qualified and lower-cased. Lower-casing is
    See
    type summary
    ​AbstractAsset::getNamespaceName() ​
    ​AbstractAsset::getName() ​

    [m] isQuoted Checks if this asset's name is quoted.

    Checks if this asset's name is quoted. 
    public function isQuoted(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isQuoted() ​Checks if this asset's name is quoted.

    [m] isIdentifierQuoted Checks if this identifier is quoted.

    Checks if this identifier is quoted. 
    protected function isIdentifierQuoted(string $identifier): bool
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isIdentifierQuoted() ​Checks if this identifier is quoted.

    [m] trimQuotes Trim quotes from the identifier.

    Trim quotes from the identifier. 
    protected function trimQuotes(string $identifier): string
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::trimQuotes() ​Trim quotes from the identifier.

    [m] getName Returns the name of this schema asset.

    Returns the name of this schema asset. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getName() ​Returns the name of this schema asset.

    [m] getQuotedName Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    Gets the quoted representation of this asset but only if it was defined with one. Otherwise 
    public function getQuotedName(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string

    return the plain unquoted value as inserted.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getQuotedName() ​Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    [m] _generateIdentifierName Generates an identifier from a list of column names obeying a certain string length.

    Generates an identifier from a list of column names obeying a certain string length. 
    protected function _generateIdentifierName(
    string[] $columnNames,
    string $prefix = "",
    int $maxSize = 30
): string

    This is especially important for Oracle, since it does not allow identifiers larger than 30 chars, however building idents automatically for foreign keys, composite keys or such can easily create very long names.

    Parameter
    type name summary
    ​string[] ​$columnNames ​
    ​string ​$prefix = "" ​
    ​int ​$maxSize = 30 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_generateIdentifierName() ​Generates an identifier from a list of column names obeying a certain string length.

    [C] MySQLSchemaManager Schema manager for the MySQL RDBMS.

    Schema manager for the MySQL RDBMS.

    Hierarchy

    Parents
    type summary
    ​AbstractSchemaManager ​Base class for schema managers. Schema managers are used to inspect and/or

    [p] $_conn Holds instance of the Doctrine connection for this schema manager.

    Holds instance of the Doctrine connection for this schema manager. 
    protected Doctrine\DBAL\Connection $_conn = null

    Type: Connection

    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::$_conn ​Holds instance of the Doctrine connection for this schema manager.

    [p] $_platform Holds instance of the database platform used for this schema manager.

    Holds instance of the database platform used for this schema manager. 
    protected T $_platform = null

    Type: T

    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::$_platform ​Holds instance of the database platform used for this schema manager.

    [m] listTableNames Returns a list of all tables in the current database.

    Returns a list of all tables in the current database. 
    public function listTableNames(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableNames() ​Returns a list of all tables in the current database.

    [m] listTables Lists the tables for this connection.

    Lists the tables for this connection. 
    public function listTables(): list
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTables() ​Lists the tables for this connection.

    [m] listTableDetails

    deprecated 

    public function listTableDetails(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableDetails() ​
    See
    type summary
    ​MySQLSchemaManager::introspectTable() ​
    ​AbstractSchemaManager::introspectTable() ​

    [m] listTableColumns <tag_inheritdoc data-type='' data-description=''>Lists the columns for a given table.

    Lists the columns for a given table. 
    public function listTableColumns(
    string $table,
    string|null $database = null
): Doctrine\DBAL\Schema\Column[]

    In contrast to other libraries and to the old version of Doctrine, this column definition does try to contain the 'primary' column for the reason that it is not portable across different RDBMS. Use listTableIndexes($tableName) to retrieve the primary key of a table. Where a RDBMS specifies more details, these are held in the platformDetails array.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string|​null ​$database = null ​
    Return
    type summary
    ​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableColumns() ​Lists the columns for a given table.
    See
    type summary
    ​listTableIndexes($tableName) ​

    [m] listTableIndexes <tag_inheritdoc data-type='' data-description=''>Lists the indexes for a given table returning an array of Index instances.

    Lists the indexes for a given table returning an array of Index instances. 
    public function listTableIndexes(string $table): Doctrine\DBAL\Schema\Index[]

    Keys of the portable indexes list are all lower-cased.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    Return
    type summary
    ​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableIndexes() ​Lists the indexes for a given table returning an array of Index instances.

    [m] listTableForeignKeys Lists the foreign keys for the given table.

    Lists the foreign keys for the given table. 
    public function listTableForeignKeys(
    string $table,
    string|null $database = null
): Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string|​null ​$database = null ​
    Return
    type summary
    ​ForeignKeyConstraint[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableForeignKeys() ​Lists the foreign keys for the given table.

    [m] _getPortableViewDefinition 

    protected function _getPortableViewDefinition(mixed[] $view): Doctrine\DBAL\Schema\View|false
    Parameter
    type name summary
    ​mixed[] ​$view ​
    Return
    type summary
    ​View|​false ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableViewDefinition() ​

    [m] _getPortableTableDefinition 

    protected function _getPortableTableDefinition(mixed $table): string
    Parameter
    type name summary
    ​mixed ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableDefinition() ​

    [m] _getPortableTableIndexesList Aggregates and groups the index results according to the required data result.

    Aggregates and groups the index results according to the required data result. 
    protected function _getPortableTableIndexesList(
    mixed[][] $tableIndexes,
    string|null $tableName = null
): Doctrine\DBAL\Schema\Index[]
    Parameter
    type name summary
    ​mixed[][] ​$tableIndexes ​
    ​string|​null ​$tableName = null ​
    Return
    type summary
    ​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableIndexesList() ​Aggregates and groups the index results according to the required data result.

    [m] _getPortableDatabaseDefinition 

    protected function _getPortableDatabaseDefinition(mixed $database): mixed
    Parameter
    type name summary
    ​mixed ​$database ​
    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableDatabaseDefinition() ​

    [m] _getPortableTableColumnDefinition Gets Table Column Definition.

    Gets Table Column Definition. 
    protected function _getPortableTableColumnDefinition(mixed[] $tableColumn): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​mixed[] ​$tableColumn ​
    Return
    type summary
    ​Column ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableColumnDefinition() ​Gets Table Column Definition.

    [m] _getPortableTableForeignKeysList 

    protected function _getPortableTableForeignKeysList(mixed[][] $tableForeignKeys): Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​mixed[][] ​$tableForeignKeys ​
    Return
    type summary
    ​ForeignKeyConstraint[] ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableForeignKeysList() ​

    [m] _getPortableTableForeignKeyDefinition 

    protected function _getPortableTableForeignKeyDefinition(mixed $tableForeignKey): Doctrine\DBAL\Schema\ForeignKeyConstraint
    Parameter
    type name summary
    ​mixed ​$tableForeignKey ​
    Return
    type summary
    ​ForeignKeyConstraint ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableForeignKeyDefinition() ​

    [m] createComparator 

    public function createComparator(): Doctrine\DBAL\Schema\Comparator
    Return
    type summary
    ​Comparator ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::createComparator() ​

    [m] selectTableNames Selects names of tables in the specified database.

    Selects names of tables in the specified database. 
    protected function selectTableNames(string $databaseName): Doctrine\DBAL\Result
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectTableNames() ​Selects names of tables in the specified database.

    [m] selectTableColumns Selects definitions of table columns in the specified database. If the table name is specified, narrows down

    Selects definitions of table columns in the specified database. If the table name is specified, narrows down 
    protected function selectTableColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectTableColumns() ​Selects definitions of table columns in the specified database. If the table name is specified, narrows down

    [m] selectIndexColumns Selects definitions of index columns in the specified database. If the table name is specified, narrows down

    Selects definitions of index columns in the specified database. If the table name is specified, narrows down 
    protected function selectIndexColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectIndexColumns() ​Selects definitions of index columns in the specified database. If the table name is specified, narrows down

    [m] selectForeignKeyColumns Selects definitions of foreign key columns in the specified database. If the table name is specified,

    Selects definitions of foreign key columns in the specified database. If the table name is specified, 
    protected function selectForeignKeyColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    narrows down the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectForeignKeyColumns() ​Selects definitions of foreign key columns in the specified database. If the table name is specified,

    [m] fetchTableOptionsByTable <tag_inheritdoc data-type='' data-description=''>Fetches table options for the tables in the specified database and returns them grouped by table name.

    Fetches table options for the tables in the specified database and returns them grouped by table name. 
    protected function fetchTableOptionsByTable(
    string $databaseName,
    ?string $tableName = null
): array

    If the table name is specified, narrows down the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::fetchTableOptionsByTable() ​Fetches table options for the tables in the specified database and returns them grouped by table name.

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Connection $connection,
    Doctrine\DBAL\Platforms\AbstractPlatform|T $platform
)
    Parameter
    type name summary
    ​Connection ​$connection ​
    ​AbstractPlatform|​T ​$platform ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::__construct() ​

    [m] getDatabasePlatform Returns the associated platform.

    deprecated

    Returns the associated platform. 
    public function getDatabasePlatform(): T
    Return
    type summary
    ​T ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getDatabasePlatform() ​Returns the associated platform.

    [m] tryMethod Tries any method on the schema manager. Normally a method throws an

    deprecated

    Tries any method on the schema manager. Normally a method throws an 
    public function tryMethod(): mixed

    exception when your DBMS doesn't support it or if an error occurs. This method allows you to try and method on your SchemaManager instance and will return false if it does not work or is not supported.

    $result = $sm->tryMethod('dropView', 'view_name');

    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::tryMethod() ​Tries any method on the schema manager. Normally a method throws an

    [m] listDatabases Lists the available databases for this connection.

    Lists the available databases for this connection. 
    public function listDatabases(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listDatabases() ​Lists the available databases for this connection.

    [m] listNamespaceNames Returns a list of all namespaces in the current database.

    deprecated

    Returns a list of all namespaces in the current database. 
    public function listNamespaceNames(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listNamespaceNames() ​Returns a list of all namespaces in the current database.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] listSchemaNames Returns a list of the names of all schemata in the current database.

    Returns a list of the names of all schemata in the current database. 
    public function listSchemaNames(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listSchemaNames() ​Returns a list of the names of all schemata in the current database.

    [m] listSequences Lists the available sequences for this connection.

    Lists the available sequences for this connection. 
    public function listSequences(string|null $database = null): Doctrine\DBAL\Schema\Sequence[]
    Parameter
    type name summary
    ​string|​null ​$database = null ​
    Return
    type summary
    ​Sequence[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listSequences() ​Lists the available sequences for this connection.

    [m] doListTableColumns 

    protected function doListTableColumns(
    string $table,
    string|null $database = null
): array|Doctrine\DBAL\Schema\Column[]
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​array|​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableColumns() ​

    [m] doListTableIndexes 

    protected function doListTableIndexes(string $table): array|Doctrine\DBAL\Schema\Index[]
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​array|​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableIndexes() ​

    [m] tablesExist Returns true if all the given tables exist.

    Returns true if all the given tables exist. 
    public function tablesExist(string|string[] $names): bool

    The usage of a string $tableNames is deprecated. Pass a one-element array instead.

    Parameter
    type name summary
    ​string|​string[] ​$names ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::tablesExist() ​Returns true if all the given tables exist.

    [m] doListTableNames 

    protected function doListTableNames(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableNames() ​

    [m] filterAssetNames Filters asset names if they are configured to return only a subset of all

    Filters asset names if they are configured to return only a subset of all 
    protected function filterAssetNames(mixed[] $assetNames): mixed[]

    the found elements.

    Parameter
    type name summary
    ​mixed[] ​$assetNames ​
    Return
    type summary
    ​mixed[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::filterAssetNames() ​Filters asset names if they are configured to return only a subset of all

    [m] doListTables 

    protected function doListTables(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTables() ​

    [m] doListTableDetails 

    protected function doListTableDetails(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableDetails() ​

    [m] normalizeName An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted.

    An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted. 
    protected function normalizeName(string $name): string

    Such platforms should convert a possibly quoted name into a value of the corresponding case.

    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::normalizeName() ​An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted.

    [m] fetchTableColumnsByTable Fetches definitions of table columns in the specified database and returns them grouped by table name.

    Fetches definitions of table columns in the specified database and returns them grouped by table name. 
    protected function fetchTableColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchTableColumnsByTable() ​Fetches definitions of table columns in the specified database and returns them grouped by table name.

    [m] fetchIndexColumnsByTable Fetches definitions of index columns in the specified database and returns them grouped by table name.

    Fetches definitions of index columns in the specified database and returns them grouped by table name. 
    protected function fetchIndexColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchIndexColumnsByTable() ​Fetches definitions of index columns in the specified database and returns them grouped by table name.

    [m] fetchForeignKeyColumnsByTable Fetches definitions of foreign key columns in the specified database and returns them grouped by table name.

    Fetches definitions of foreign key columns in the specified database and returns them grouped by table name. 
    protected function fetchForeignKeyColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​list<array<string, mixed>>>
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchForeignKeyColumnsByTable() ​Fetches definitions of foreign key columns in the specified database and returns them grouped by table name.

    [m] introspectTable Introspects the table with the given name.

    Introspects the table with the given name. 
    public function introspectTable(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::introspectTable() ​Introspects the table with the given name.

    [m] listViews Lists the views this connection has.

    Lists the views this connection has. 
    public function listViews(): Doctrine\DBAL\Schema\View[]
    Return
    type summary
    ​View[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listViews() ​Lists the views this connection has.

    [m] doListTableForeignKeys 

    protected function doListTableForeignKeys(
    string $table,
    string|null $database = null
): array|Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​array|​ForeignKeyConstraint[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableForeignKeys() ​

    [m] dropDatabase Drops a database.

    Drops a database. 
    public function dropDatabase(string $database): void

    NOTE: You can not drop the database this SchemaManager is currently connected to.

    Parameter
    type name summary
    ​string ​$database ​The name of the database to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropDatabase() ​Drops a database.

    [m] dropSchema Drops a schema.

    Drops a schema. 
    public function dropSchema(string $schemaName)
    Parameter
    type name summary
    ​string ​$schemaName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSchema() ​Drops a schema.

    [m] dropTable Drops the given table.

    Drops the given table. 
    public function dropTable(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the table to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropTable() ​Drops the given table.

    [m] dropIndex Drops the index from the given table.

    Drops the index from the given table. 
    public function dropIndex(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index|​string ​$index ​The name of the index.
    ​Table|​string ​$table ​The name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropIndex() ​Drops the index from the given table.

    [m] dropConstraint Drops the constraint from the given table.

    deprecated

    Drops the constraint from the given table. 
    public function dropConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​The name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropConstraint() ​Drops the constraint from the given table.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::dropForeignKey() ​
    ​AbstractSchemaManager::dropUniqueConstraint() ​

    [m] dropForeignKey Drops a foreign key from a table.

    Drops a foreign key from a table. 
    public function dropForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​The name of the foreign key.
    ​Table|​string ​$table ​The name of the table with the foreign key.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropForeignKey() ​Drops a foreign key from a table.

    [m] dropSequence Drops a sequence with a given name.

    Drops a sequence with a given name. 
    public function dropSequence(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the sequence to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSequence() ​Drops a sequence with a given name.

    [m] dropUniqueConstraint Drops the unique constraint from the given table.

    Drops the unique constraint from the given table. 
    public function dropUniqueConstraint(
    string $name,
    string $tableName
)
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropUniqueConstraint() ​Drops the unique constraint from the given table.

    [m] dropView Drops a view.

    Drops a view. 
    public function dropView(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the view.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropView() ​Drops a view.

    [m] createSchemaObjects 

    public function createSchemaObjects(Doctrine\DBAL\Schema\Schema $schema)
    Parameter
    type name summary
    ​Schema ​$schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchemaObjects() ​

    [m] createDatabase Creates a new database.

    Creates a new database. 
    public function createDatabase(string $database): void
    Parameter
    type name summary
    ​string ​$database ​The name of the database to create.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createDatabase() ​Creates a new database.

    [m] createTable Creates a new table.

    Creates a new table. 
    public function createTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createTable() ​Creates a new table.

    [m] createSequence Creates a new sequence.

    Creates a new sequence. 
    public function createSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSequence() ​Creates a new sequence.

    [m] createConstraint Creates a constraint on a table.

    deprecated

    Creates a constraint on a table. 
    public function createConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createConstraint() ​Creates a constraint on a table.
    See
    type summary
    ​AbstractSchemaManager::createIndex() ​
    ​AbstractSchemaManager::createForeignKey() ​
    ​AbstractSchemaManager::createUniqueConstraint() ​

    [m] createIndex Creates a new index on a table.

    Creates a new index on a table. 
    public function createIndex(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createIndex() ​Creates a new index on a table.

    [m] createForeignKey Creates a new foreign key.

    Creates a new foreign key. 
    public function createForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The ForeignKey instance.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createForeignKey() ​Creates a new foreign key.

    [m] createUniqueConstraint Creates a unique constraint on a table.

    Creates a unique constraint on a table. 
    public function createUniqueConstraint(
    Doctrine\DBAL\Schema\UniqueConstraint $uniqueConstraint,
    string $tableName
)
    Parameter
    type name summary
    ​UniqueConstraint ​$uniqueConstraint ​
    ​string ​$tableName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createUniqueConstraint() ​Creates a unique constraint on a table.

    [m] createView Creates a new view.

    Creates a new view. 
    public function createView(Doctrine\DBAL\Schema\View $view): void
    Parameter
    type name summary
    ​View ​$view ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createView() ​Creates a new view.

    [m] dropSchemaObjects 

    public function dropSchemaObjects(Doctrine\DBAL\Schema\Schema $schema)
    Parameter
    type name summary
    ​Schema ​$schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSchemaObjects() ​

    [m] dropAndCreateConstraint Drops and creates a constraint.

    deprecated

    Drops and creates a constraint. 
    public function dropAndCreateConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateConstraint() ​Drops and creates a constraint.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::createIndex() ​
    ​AbstractSchemaManager::createForeignKey() ​
    ​AbstractSchemaManager::createUniqueConstraint() ​
    ​AbstractSchemaManager::dropConstraint() ​
    ​AbstractSchemaManager::createConstraint() ​

    [m] dropAndCreateIndex Drops and creates a new index on a table.

    deprecated

    Drops and creates a new index on a table. 
    public function dropAndCreateIndex(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateIndex() ​Drops and creates a new index on a table.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::createIndex() ​

    [m] dropAndCreateForeignKey Drops and creates a new foreign key.

    deprecated

    Drops and creates a new foreign key. 
    public function dropAndCreateForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​An associative array that defines properties
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateForeignKey() ​Drops and creates a new foreign key.
    See
    type summary
    ​AbstractSchemaManager::dropForeignKey() ​
    ​AbstractSchemaManager::createForeignKey() ​

    [m] dropAndCreateSequence Drops and create a new sequence.

    deprecated

    Drops and create a new sequence. 
    public function dropAndCreateSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateSequence() ​Drops and create a new sequence.
    See
    type summary
    ​AbstractSchemaManager::dropSequence() ​
    ​AbstractSchemaManager::createSequence() ​

    [m] dropAndCreateTable Drops and creates a new table.

    deprecated

    Drops and creates a new table. 
    public function dropAndCreateTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateTable() ​Drops and creates a new table.
    See
    type summary
    ​AbstractSchemaManager::dropTable() ​
    ​AbstractSchemaManager::createTable() ​

    [m] dropAndCreateDatabase Drops and creates a new database.

    deprecated

    Drops and creates a new database. 
    public function dropAndCreateDatabase(string $database): void
    Parameter
    type name summary
    ​string ​$database ​The name of the database to create.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateDatabase() ​Drops and creates a new database.
    See
    type summary
    ​AbstractSchemaManager::dropDatabase() ​
    ​AbstractSchemaManager::createDatabase() ​

    [m] dropAndCreateView Drops and creates a new view.

    deprecated

    Drops and creates a new view. 
    public function dropAndCreateView(Doctrine\DBAL\Schema\View $view): void
    Parameter
    type name summary
    ​View ​$view ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateView() ​Drops and creates a new view.
    See
    type summary
    ​AbstractSchemaManager::dropView() ​
    ​AbstractSchemaManager::createView() ​

    [m] alterSchema Alters an existing schema.

    Alters an existing schema. 
    public function alterSchema(Doctrine\DBAL\Schema\SchemaDiff $schemaDiff)
    Parameter
    type name summary
    ​SchemaDiff ​$schemaDiff ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::alterSchema() ​Alters an existing schema.

    [m] migrateSchema Migrates an existing schema to a new schema.

    Migrates an existing schema to a new schema. 
    public function migrateSchema(Doctrine\DBAL\Schema\Schema $toSchema)
    Parameter
    type name summary
    ​Schema ​$toSchema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::migrateSchema() ​Migrates an existing schema to a new schema.

    [m] alterTable Alters an existing tables schema.

    Alters an existing tables schema. 
    public function alterTable(Doctrine\DBAL\Schema\TableDiff $tableDiff): void
    Parameter
    type name summary
    ​TableDiff ​$tableDiff ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::alterTable() ​Alters an existing tables schema.

    [m] renameTable Renames a given table to another name.

    Renames a given table to another name. 
    public function renameTable(
    string $name,
    string $newName
): void
    Parameter
    type name summary
    ​string ​$name ​The current name of the table.
    ​string ​$newName ​The new name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::renameTable() ​Renames a given table to another name.

    [m] _getPortableDatabasesList 

    protected function _getPortableDatabasesList(mixed[] $databases): string[]
    Parameter
    type name summary
    ​mixed[] ​$databases ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableDatabasesList() ​

    [m] getPortableNamespacesList Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition.

    deprecated

    Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition. 
    protected function getPortableNamespacesList(array $namespaces): string[]
    Parameter
    type name summary
    ​array ​$namespaces ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getPortableNamespacesList() ​Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] getPortableNamespaceDefinition Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition.

    deprecated

    Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition. 
    protected function getPortableNamespaceDefinition(array $namespace): mixed
    Parameter
    type name summary
    ​array ​$namespace ​
    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getPortableNamespaceDefinition() ​Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] _getPortableSequencesList 

    protected function _getPortableSequencesList(mixed[][] $sequences): Doctrine\DBAL\Schema\Sequence[]
    Parameter
    type name summary
    ​mixed[][] ​$sequences ​
    Return
    type summary
    ​Sequence[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableSequencesList() ​

    [m] _getPortableSequenceDefinition 

    protected function _getPortableSequenceDefinition(mixed[] $sequence): Doctrine\DBAL\Schema\Sequence
    Parameter
    type name summary
    ​mixed[] ​$sequence ​
    Return
    type summary
    ​Sequence ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableSequenceDefinition() ​

    [m] _getPortableTableColumnList Independent of the database the keys of the column list result are lowercased.

    Independent of the database the keys of the column list result are lowercased. 
    protected function _getPortableTableColumnList(
    string $table,
    string $database,
    mixed[][] $tableColumns
): Doctrine\DBAL\Schema\Column[]

    The name of the created column instance however is kept in its case.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string ​$database ​
    ​mixed[][] ​$tableColumns ​
    Return
    type summary
    ​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableTableColumnList() ​Independent of the database the keys of the column list result are lowercased.

    [m] _getPortableTablesList 

    protected function _getPortableTablesList(mixed[][] $tables): string[]
    Parameter
    type name summary
    ​mixed[][] ​$tables ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableTablesList() ​

    [m] _getPortableViewsList 

    protected function _getPortableViewsList(mixed[][] $views): Doctrine\DBAL\Schema\View[]
    Parameter
    type name summary
    ​mixed[][] ​$views ​
    Return
    type summary
    ​View[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableViewsList() ​

    [m] _execSql 

    protected function _execSql(string[]|string $sql): void
    Parameter
    type name summary
    ​string[]|​string ​$sql ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_execSql() ​

    [m] createSchema Creates a schema instance for the current database.

    deprecated

    Creates a schema instance for the current database. 
    public function createSchema(): Doctrine\DBAL\Schema\Schema
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchema() ​Creates a schema instance for the current database.

    [m] introspectSchema Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema.

    Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema. 
    public function introspectSchema(): Doctrine\DBAL\Schema\Schema
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::introspectSchema() ​Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema.
    See
    type summary
    ​Schema ​

    [m] createSchemaConfig Creates the configuration for this schema.

    Creates the configuration for this schema. 
    public function createSchemaConfig(): Doctrine\DBAL\Schema\SchemaConfig
    Return
    type summary
    ​SchemaConfig ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchemaConfig() ​Creates the configuration for this schema.

    [m] getSchemaSearchPaths The search path for namespaces in the currently connected database.

    deprecated

    The search path for namespaces in the currently connected database. 
    public function getSchemaSearchPaths(): string[]

    The first entry is usually the default namespace in the Schema. All further namespaces contain tables/sequences which can also be addressed with a short, not full-qualified name.

    For databases that don't support subschema/namespaces this method returns the name of the currently connected database.

    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getSchemaSearchPaths() ​The search path for namespaces in the currently connected database.

    [m] extractDoctrineTypeFromComment Given a table comment this method tries to extract a typehint for Doctrine Type, or returns

    Given a table comment this method tries to extract a typehint for Doctrine Type, or returns 
    public function extractDoctrineTypeFromComment(
    string|null $comment,
    string $currentType
): string

    the type given as default.

    Parameter
    type name summary
    ​string|​null ​$comment ​
    ​string ​$currentType ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::extractDoctrineTypeFromComment() ​Given a table comment this method tries to extract a typehint for Doctrine Type, or returns

    [m] removeDoctrineTypeFromComment 

    public function removeDoctrineTypeFromComment(
    string|null $comment,
    string|null $type
): string|null
    Parameter
    type name summary
    ​string|​null ​$comment ​
    ​string|​null ​$type ​
    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::removeDoctrineTypeFromComment() ​

    [C] OracleSchemaManager Oracle Schema Manager.

    Oracle Schema Manager.

    Hierarchy

    Parents
    type summary
    ​AbstractSchemaManager ​Base class for schema managers. Schema managers are used to inspect and/or

    [p] $_conn Holds instance of the Doctrine connection for this schema manager.

    Holds instance of the Doctrine connection for this schema manager. 
    protected Doctrine\DBAL\Connection $_conn = null

    Type: Connection

    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::$_conn ​Holds instance of the Doctrine connection for this schema manager.

    [p] $_platform Holds instance of the database platform used for this schema manager.

    Holds instance of the database platform used for this schema manager. 
    protected T $_platform = null

    Type: T

    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::$_platform ​Holds instance of the database platform used for this schema manager.

    [m] listTableNames Returns a list of all tables in the current database.

    Returns a list of all tables in the current database. 
    public function listTableNames(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableNames() ​Returns a list of all tables in the current database.

    [m] listTables Lists the tables for this connection.

    Lists the tables for this connection. 
    public function listTables(): list
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTables() ​Lists the tables for this connection.

    [m] listTableDetails

    deprecated 

    public function listTableDetails(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableDetails() ​
    See
    type summary
    ​OracleSchemaManager::introspectTable() ​
    ​AbstractSchemaManager::introspectTable() ​

    [m] listTableColumns <tag_inheritdoc data-type='' data-description=''>Lists the columns for a given table.

    Lists the columns for a given table. 
    public function listTableColumns(
    string $table,
    string|null $database = null
): Doctrine\DBAL\Schema\Column[]

    In contrast to other libraries and to the old version of Doctrine, this column definition does try to contain the 'primary' column for the reason that it is not portable across different RDBMS. Use listTableIndexes($tableName) to retrieve the primary key of a table. Where a RDBMS specifies more details, these are held in the platformDetails array.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string|​null ​$database = null ​
    Return
    type summary
    ​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableColumns() ​Lists the columns for a given table.
    See
    type summary
    ​listTableIndexes($tableName) ​

    [m] listTableIndexes <tag_inheritdoc data-type='' data-description=''>Lists the indexes for a given table returning an array of Index instances.

    Lists the indexes for a given table returning an array of Index instances. 
    public function listTableIndexes(string $table): Doctrine\DBAL\Schema\Index[]

    Keys of the portable indexes list are all lower-cased.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    Return
    type summary
    ​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableIndexes() ​Lists the indexes for a given table returning an array of Index instances.

    [m] listTableForeignKeys Lists the foreign keys for the given table.

    Lists the foreign keys for the given table. 
    public function listTableForeignKeys(
    string $table,
    string|null $database = null
): Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string|​null ​$database = null ​
    Return
    type summary
    ​ForeignKeyConstraint[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableForeignKeys() ​Lists the foreign keys for the given table.

    [m] _getPortableViewDefinition 

    protected function _getPortableViewDefinition(mixed[] $view): Doctrine\DBAL\Schema\View|false
    Parameter
    type name summary
    ​mixed[] ​$view ​
    Return
    type summary
    ​View|​false ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableViewDefinition() ​

    [m] _getPortableTableDefinition 

    protected function _getPortableTableDefinition(mixed $table): string
    Parameter
    type name summary
    ​mixed ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableDefinition() ​

    [m] _getPortableTableIndexesList Aggregates and groups the index results according to the required data result.

    Aggregates and groups the index results according to the required data result. 
    protected function _getPortableTableIndexesList(
    mixed[][] $tableIndexes,
    string|null $tableName = null
): Doctrine\DBAL\Schema\Index[]
    Parameter
    type name summary
    ​mixed[][] ​$tableIndexes ​
    ​string|​null ​$tableName = null ​
    Return
    type summary
    ​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableIndexesList() ​Aggregates and groups the index results according to the required data result.

    [m] _getPortableTableColumnDefinition Gets Table Column Definition.

    Gets Table Column Definition. 
    protected function _getPortableTableColumnDefinition(mixed[] $tableColumn): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​mixed[] ​$tableColumn ​
    Return
    type summary
    ​Column ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableColumnDefinition() ​Gets Table Column Definition.

    [m] _getPortableTableForeignKeysList 

    protected function _getPortableTableForeignKeysList(mixed[][] $tableForeignKeys): Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​mixed[][] ​$tableForeignKeys ​
    Return
    type summary
    ​ForeignKeyConstraint[] ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableForeignKeysList() ​

    [m] _getPortableTableForeignKeyDefinition 

    protected function _getPortableTableForeignKeyDefinition(mixed $tableForeignKey): Doctrine\DBAL\Schema\ForeignKeyConstraint
    Parameter
    type name summary
    ​mixed ​$tableForeignKey ​
    Return
    type summary
    ​ForeignKeyConstraint ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableForeignKeyDefinition() ​

    [m] _getPortableSequenceDefinition 

    protected function _getPortableSequenceDefinition(mixed[] $sequence): Doctrine\DBAL\Schema\Sequence
    Parameter
    type name summary
    ​mixed[] ​$sequence ​
    Return
    type summary
    ​Sequence ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableSequenceDefinition() ​

    [m] _getPortableDatabaseDefinition 

    protected function _getPortableDatabaseDefinition(mixed $database): mixed
    Parameter
    type name summary
    ​mixed ​$database ​
    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableDatabaseDefinition() ​

    [m] createDatabase Creates a new database.

    Creates a new database. 
    public function createDatabase(string $database): void
    Parameter
    type name summary
    ​string ​$database ​The name of the database to create.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::createDatabase() ​Creates a new database.

    [m] dropAutoincrement 

    public function dropAutoincrement(string $table): bool
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​

    [m] dropTable Drops the given table.

    Drops the given table. 
    public function dropTable(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the table to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::dropTable() ​Drops the given table.

    [m] selectTableNames Selects names of tables in the specified database.

    Selects names of tables in the specified database. 
    protected function selectTableNames(string $databaseName): Doctrine\DBAL\Result
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectTableNames() ​Selects names of tables in the specified database.

    [m] selectTableColumns Selects definitions of table columns in the specified database. If the table name is specified, narrows down

    Selects definitions of table columns in the specified database. If the table name is specified, narrows down 
    protected function selectTableColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectTableColumns() ​Selects definitions of table columns in the specified database. If the table name is specified, narrows down

    [m] selectIndexColumns Selects definitions of index columns in the specified database. If the table name is specified, narrows down

    Selects definitions of index columns in the specified database. If the table name is specified, narrows down 
    protected function selectIndexColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectIndexColumns() ​Selects definitions of index columns in the specified database. If the table name is specified, narrows down

    [m] selectForeignKeyColumns Selects definitions of foreign key columns in the specified database. If the table name is specified,

    Selects definitions of foreign key columns in the specified database. If the table name is specified, 
    protected function selectForeignKeyColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    narrows down the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectForeignKeyColumns() ​Selects definitions of foreign key columns in the specified database. If the table name is specified,

    [m] fetchTableOptionsByTable <tag_inheritdoc data-type='' data-description=''>Fetches table options for the tables in the specified database and returns them grouped by table name.

    Fetches table options for the tables in the specified database and returns them grouped by table name. 
    protected function fetchTableOptionsByTable(
    string $databaseName,
    ?string $tableName = null
): array

    If the table name is specified, narrows down the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::fetchTableOptionsByTable() ​Fetches table options for the tables in the specified database and returns them grouped by table name.

    [m] normalizeName An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted.

    An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted. 
    protected function normalizeName(string $name): string

    Such platforms should convert a possibly quoted name into a value of the corresponding case.

    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::normalizeName() ​An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted.

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Connection $connection,
    Doctrine\DBAL\Platforms\AbstractPlatform|T $platform
)
    Parameter
    type name summary
    ​Connection ​$connection ​
    ​AbstractPlatform|​T ​$platform ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::__construct() ​

    [m] getDatabasePlatform Returns the associated platform.

    deprecated

    Returns the associated platform. 
    public function getDatabasePlatform(): T
    Return
    type summary
    ​T ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getDatabasePlatform() ​Returns the associated platform.

    [m] tryMethod Tries any method on the schema manager. Normally a method throws an

    deprecated

    Tries any method on the schema manager. Normally a method throws an 
    public function tryMethod(): mixed

    exception when your DBMS doesn't support it or if an error occurs. This method allows you to try and method on your SchemaManager instance and will return false if it does not work or is not supported.

    $result = $sm->tryMethod('dropView', 'view_name');

    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::tryMethod() ​Tries any method on the schema manager. Normally a method throws an

    [m] listDatabases Lists the available databases for this connection.

    Lists the available databases for this connection. 
    public function listDatabases(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listDatabases() ​Lists the available databases for this connection.

    [m] listNamespaceNames Returns a list of all namespaces in the current database.

    deprecated

    Returns a list of all namespaces in the current database. 
    public function listNamespaceNames(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listNamespaceNames() ​Returns a list of all namespaces in the current database.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] listSchemaNames Returns a list of the names of all schemata in the current database.

    Returns a list of the names of all schemata in the current database. 
    public function listSchemaNames(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listSchemaNames() ​Returns a list of the names of all schemata in the current database.

    [m] listSequences Lists the available sequences for this connection.

    Lists the available sequences for this connection. 
    public function listSequences(string|null $database = null): Doctrine\DBAL\Schema\Sequence[]
    Parameter
    type name summary
    ​string|​null ​$database = null ​
    Return
    type summary
    ​Sequence[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listSequences() ​Lists the available sequences for this connection.

    [m] doListTableColumns 

    protected function doListTableColumns(
    string $table,
    string|null $database = null
): array|Doctrine\DBAL\Schema\Column[]
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​array|​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableColumns() ​

    [m] doListTableIndexes 

    protected function doListTableIndexes(string $table): array|Doctrine\DBAL\Schema\Index[]
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​array|​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableIndexes() ​

    [m] tablesExist Returns true if all the given tables exist.

    Returns true if all the given tables exist. 
    public function tablesExist(string|string[] $names): bool

    The usage of a string $tableNames is deprecated. Pass a one-element array instead.

    Parameter
    type name summary
    ​string|​string[] ​$names ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::tablesExist() ​Returns true if all the given tables exist.

    [m] doListTableNames 

    protected function doListTableNames(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableNames() ​

    [m] filterAssetNames Filters asset names if they are configured to return only a subset of all

    Filters asset names if they are configured to return only a subset of all 
    protected function filterAssetNames(mixed[] $assetNames): mixed[]

    the found elements.

    Parameter
    type name summary
    ​mixed[] ​$assetNames ​
    Return
    type summary
    ​mixed[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::filterAssetNames() ​Filters asset names if they are configured to return only a subset of all

    [m] doListTables 

    protected function doListTables(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTables() ​

    [m] doListTableDetails 

    protected function doListTableDetails(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableDetails() ​

    [m] fetchTableColumnsByTable Fetches definitions of table columns in the specified database and returns them grouped by table name.

    Fetches definitions of table columns in the specified database and returns them grouped by table name. 
    protected function fetchTableColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchTableColumnsByTable() ​Fetches definitions of table columns in the specified database and returns them grouped by table name.

    [m] fetchIndexColumnsByTable Fetches definitions of index columns in the specified database and returns them grouped by table name.

    Fetches definitions of index columns in the specified database and returns them grouped by table name. 
    protected function fetchIndexColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchIndexColumnsByTable() ​Fetches definitions of index columns in the specified database and returns them grouped by table name.

    [m] fetchForeignKeyColumnsByTable Fetches definitions of foreign key columns in the specified database and returns them grouped by table name.

    Fetches definitions of foreign key columns in the specified database and returns them grouped by table name. 
    protected function fetchForeignKeyColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​list<array<string, mixed>>>
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchForeignKeyColumnsByTable() ​Fetches definitions of foreign key columns in the specified database and returns them grouped by table name.

    [m] introspectTable Introspects the table with the given name.

    Introspects the table with the given name. 
    public function introspectTable(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::introspectTable() ​Introspects the table with the given name.

    [m] listViews Lists the views this connection has.

    Lists the views this connection has. 
    public function listViews(): Doctrine\DBAL\Schema\View[]
    Return
    type summary
    ​View[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listViews() ​Lists the views this connection has.

    [m] doListTableForeignKeys 

    protected function doListTableForeignKeys(
    string $table,
    string|null $database = null
): array|Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​array|​ForeignKeyConstraint[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableForeignKeys() ​

    [m] dropDatabase Drops a database.

    Drops a database. 
    public function dropDatabase(string $database): void

    NOTE: You can not drop the database this SchemaManager is currently connected to.

    Parameter
    type name summary
    ​string ​$database ​The name of the database to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropDatabase() ​Drops a database.

    [m] dropSchema Drops a schema.

    Drops a schema. 
    public function dropSchema(string $schemaName)
    Parameter
    type name summary
    ​string ​$schemaName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSchema() ​Drops a schema.

    [m] dropIndex Drops the index from the given table.

    Drops the index from the given table. 
    public function dropIndex(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index|​string ​$index ​The name of the index.
    ​Table|​string ​$table ​The name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropIndex() ​Drops the index from the given table.

    [m] dropConstraint Drops the constraint from the given table.

    deprecated

    Drops the constraint from the given table. 
    public function dropConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​The name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropConstraint() ​Drops the constraint from the given table.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::dropForeignKey() ​
    ​AbstractSchemaManager::dropUniqueConstraint() ​

    [m] dropForeignKey Drops a foreign key from a table.

    Drops a foreign key from a table. 
    public function dropForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​The name of the foreign key.
    ​Table|​string ​$table ​The name of the table with the foreign key.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropForeignKey() ​Drops a foreign key from a table.

    [m] dropSequence Drops a sequence with a given name.

    Drops a sequence with a given name. 
    public function dropSequence(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the sequence to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSequence() ​Drops a sequence with a given name.

    [m] dropUniqueConstraint Drops the unique constraint from the given table.

    Drops the unique constraint from the given table. 
    public function dropUniqueConstraint(
    string $name,
    string $tableName
)
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropUniqueConstraint() ​Drops the unique constraint from the given table.

    [m] dropView Drops a view.

    Drops a view. 
    public function dropView(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the view.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropView() ​Drops a view.

    [m] createSchemaObjects 

    public function createSchemaObjects(Doctrine\DBAL\Schema\Schema $schema)
    Parameter
    type name summary
    ​Schema ​$schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchemaObjects() ​

    [m] createTable Creates a new table.

    Creates a new table. 
    public function createTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createTable() ​Creates a new table.

    [m] createSequence Creates a new sequence.

    Creates a new sequence. 
    public function createSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSequence() ​Creates a new sequence.

    [m] createConstraint Creates a constraint on a table.

    deprecated

    Creates a constraint on a table. 
    public function createConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createConstraint() ​Creates a constraint on a table.
    See
    type summary
    ​AbstractSchemaManager::createIndex() ​
    ​AbstractSchemaManager::createForeignKey() ​
    ​AbstractSchemaManager::createUniqueConstraint() ​

    [m] createIndex Creates a new index on a table.

    Creates a new index on a table. 
    public function createIndex(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createIndex() ​Creates a new index on a table.

    [m] createForeignKey Creates a new foreign key.

    Creates a new foreign key. 
    public function createForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The ForeignKey instance.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createForeignKey() ​Creates a new foreign key.

    [m] createUniqueConstraint Creates a unique constraint on a table.

    Creates a unique constraint on a table. 
    public function createUniqueConstraint(
    Doctrine\DBAL\Schema\UniqueConstraint $uniqueConstraint,
    string $tableName
)
    Parameter
    type name summary
    ​UniqueConstraint ​$uniqueConstraint ​
    ​string ​$tableName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createUniqueConstraint() ​Creates a unique constraint on a table.

    [m] createView Creates a new view.

    Creates a new view. 
    public function createView(Doctrine\DBAL\Schema\View $view): void
    Parameter
    type name summary
    ​View ​$view ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createView() ​Creates a new view.

    [m] dropSchemaObjects 

    public function dropSchemaObjects(Doctrine\DBAL\Schema\Schema $schema)
    Parameter
    type name summary
    ​Schema ​$schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSchemaObjects() ​

    [m] dropAndCreateConstraint Drops and creates a constraint.

    deprecated

    Drops and creates a constraint. 
    public function dropAndCreateConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateConstraint() ​Drops and creates a constraint.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::createIndex() ​
    ​AbstractSchemaManager::createForeignKey() ​
    ​AbstractSchemaManager::createUniqueConstraint() ​
    ​AbstractSchemaManager::dropConstraint() ​
    ​AbstractSchemaManager::createConstraint() ​

    [m] dropAndCreateIndex Drops and creates a new index on a table.

    deprecated

    Drops and creates a new index on a table. 
    public function dropAndCreateIndex(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateIndex() ​Drops and creates a new index on a table.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::createIndex() ​

    [m] dropAndCreateForeignKey Drops and creates a new foreign key.

    deprecated

    Drops and creates a new foreign key. 
    public function dropAndCreateForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​An associative array that defines properties
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateForeignKey() ​Drops and creates a new foreign key.
    See
    type summary
    ​AbstractSchemaManager::dropForeignKey() ​
    ​AbstractSchemaManager::createForeignKey() ​

    [m] dropAndCreateSequence Drops and create a new sequence.

    deprecated

    Drops and create a new sequence. 
    public function dropAndCreateSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateSequence() ​Drops and create a new sequence.
    See
    type summary
    ​AbstractSchemaManager::dropSequence() ​
    ​AbstractSchemaManager::createSequence() ​

    [m] dropAndCreateTable Drops and creates a new table.

    deprecated

    Drops and creates a new table. 
    public function dropAndCreateTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateTable() ​Drops and creates a new table.
    See
    type summary
    ​AbstractSchemaManager::dropTable() ​
    ​AbstractSchemaManager::createTable() ​

    [m] dropAndCreateDatabase Drops and creates a new database.

    deprecated

    Drops and creates a new database. 
    public function dropAndCreateDatabase(string $database): void
    Parameter
    type name summary
    ​string ​$database ​The name of the database to create.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateDatabase() ​Drops and creates a new database.
    See
    type summary
    ​AbstractSchemaManager::dropDatabase() ​
    ​AbstractSchemaManager::createDatabase() ​

    [m] dropAndCreateView Drops and creates a new view.

    deprecated

    Drops and creates a new view. 
    public function dropAndCreateView(Doctrine\DBAL\Schema\View $view): void
    Parameter
    type name summary
    ​View ​$view ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateView() ​Drops and creates a new view.
    See
    type summary
    ​AbstractSchemaManager::dropView() ​
    ​AbstractSchemaManager::createView() ​

    [m] alterSchema Alters an existing schema.

    Alters an existing schema. 
    public function alterSchema(Doctrine\DBAL\Schema\SchemaDiff $schemaDiff)
    Parameter
    type name summary
    ​SchemaDiff ​$schemaDiff ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::alterSchema() ​Alters an existing schema.

    [m] migrateSchema Migrates an existing schema to a new schema.

    Migrates an existing schema to a new schema. 
    public function migrateSchema(Doctrine\DBAL\Schema\Schema $toSchema)
    Parameter
    type name summary
    ​Schema ​$toSchema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::migrateSchema() ​Migrates an existing schema to a new schema.

    [m] alterTable Alters an existing tables schema.

    Alters an existing tables schema. 
    public function alterTable(Doctrine\DBAL\Schema\TableDiff $tableDiff): void
    Parameter
    type name summary
    ​TableDiff ​$tableDiff ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::alterTable() ​Alters an existing tables schema.

    [m] renameTable Renames a given table to another name.

    Renames a given table to another name. 
    public function renameTable(
    string $name,
    string $newName
): void
    Parameter
    type name summary
    ​string ​$name ​The current name of the table.
    ​string ​$newName ​The new name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::renameTable() ​Renames a given table to another name.

    [m] _getPortableDatabasesList 

    protected function _getPortableDatabasesList(mixed[] $databases): string[]
    Parameter
    type name summary
    ​mixed[] ​$databases ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableDatabasesList() ​

    [m] getPortableNamespacesList Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition.

    deprecated

    Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition. 
    protected function getPortableNamespacesList(array $namespaces): string[]
    Parameter
    type name summary
    ​array ​$namespaces ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getPortableNamespacesList() ​Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] getPortableNamespaceDefinition Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition.

    deprecated

    Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition. 
    protected function getPortableNamespaceDefinition(array $namespace): mixed
    Parameter
    type name summary
    ​array ​$namespace ​
    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getPortableNamespaceDefinition() ​Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] _getPortableSequencesList 

    protected function _getPortableSequencesList(mixed[][] $sequences): Doctrine\DBAL\Schema\Sequence[]
    Parameter
    type name summary
    ​mixed[][] ​$sequences ​
    Return
    type summary
    ​Sequence[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableSequencesList() ​

    [m] _getPortableTableColumnList Independent of the database the keys of the column list result are lowercased.

    Independent of the database the keys of the column list result are lowercased. 
    protected function _getPortableTableColumnList(
    string $table,
    string $database,
    mixed[][] $tableColumns
): Doctrine\DBAL\Schema\Column[]

    The name of the created column instance however is kept in its case.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string ​$database ​
    ​mixed[][] ​$tableColumns ​
    Return
    type summary
    ​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableTableColumnList() ​Independent of the database the keys of the column list result are lowercased.

    [m] _getPortableTablesList 

    protected function _getPortableTablesList(mixed[][] $tables): string[]
    Parameter
    type name summary
    ​mixed[][] ​$tables ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableTablesList() ​

    [m] _getPortableViewsList 

    protected function _getPortableViewsList(mixed[][] $views): Doctrine\DBAL\Schema\View[]
    Parameter
    type name summary
    ​mixed[][] ​$views ​
    Return
    type summary
    ​View[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableViewsList() ​

    [m] _execSql 

    protected function _execSql(string[]|string $sql): void
    Parameter
    type name summary
    ​string[]|​string ​$sql ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_execSql() ​

    [m] createSchema Creates a schema instance for the current database.

    deprecated

    Creates a schema instance for the current database. 
    public function createSchema(): Doctrine\DBAL\Schema\Schema
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchema() ​Creates a schema instance for the current database.

    [m] introspectSchema Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema.

    Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema. 
    public function introspectSchema(): Doctrine\DBAL\Schema\Schema
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::introspectSchema() ​Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema.
    See
    type summary
    ​Schema ​

    [m] createSchemaConfig Creates the configuration for this schema.

    Creates the configuration for this schema. 
    public function createSchemaConfig(): Doctrine\DBAL\Schema\SchemaConfig
    Return
    type summary
    ​SchemaConfig ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchemaConfig() ​Creates the configuration for this schema.

    [m] getSchemaSearchPaths The search path for namespaces in the currently connected database.

    deprecated

    The search path for namespaces in the currently connected database. 
    public function getSchemaSearchPaths(): string[]

    The first entry is usually the default namespace in the Schema. All further namespaces contain tables/sequences which can also be addressed with a short, not full-qualified name.

    For databases that don't support subschema/namespaces this method returns the name of the currently connected database.

    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getSchemaSearchPaths() ​The search path for namespaces in the currently connected database.

    [m] extractDoctrineTypeFromComment Given a table comment this method tries to extract a typehint for Doctrine Type, or returns

    Given a table comment this method tries to extract a typehint for Doctrine Type, or returns 
    public function extractDoctrineTypeFromComment(
    string|null $comment,
    string $currentType
): string

    the type given as default.

    Parameter
    type name summary
    ​string|​null ​$comment ​
    ​string ​$currentType ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::extractDoctrineTypeFromComment() ​Given a table comment this method tries to extract a typehint for Doctrine Type, or returns

    [m] removeDoctrineTypeFromComment 

    public function removeDoctrineTypeFromComment(
    string|null $comment,
    string|null $type
): string|null
    Parameter
    type name summary
    ​string|​null ​$comment ​
    ​string|​null ​$type ​
    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::removeDoctrineTypeFromComment() ​

    [m] createComparator 

    public function createComparator(): Doctrine\DBAL\Schema\Comparator
    Return
    type summary
    ​Comparator ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createComparator() ​

    [C] PostgreSQLSchemaManager PostgreSQL Schema Manager.

    PostgreSQL Schema Manager.

    Hierarchy

    Parents
    type summary
    ​AbstractSchemaManager ​Base class for schema managers. Schema managers are used to inspect and/or

    [p] $_conn Holds instance of the Doctrine connection for this schema manager.

    Holds instance of the Doctrine connection for this schema manager. 
    protected Doctrine\DBAL\Connection $_conn = null

    Type: Connection

    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::$_conn ​Holds instance of the Doctrine connection for this schema manager.

    [p] $_platform Holds instance of the database platform used for this schema manager.

    Holds instance of the database platform used for this schema manager. 
    protected T $_platform = null

    Type: T

    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::$_platform ​Holds instance of the database platform used for this schema manager.

    [m] listTableNames Returns a list of all tables in the current database.

    Returns a list of all tables in the current database. 
    public function listTableNames(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableNames() ​Returns a list of all tables in the current database.

    [m] listTables Lists the tables for this connection.

    Lists the tables for this connection. 
    public function listTables(): list
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTables() ​Lists the tables for this connection.

    [m] listTableDetails

    deprecated 

    public function listTableDetails(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableDetails() ​
    See
    type summary
    ​PostgreSQLSchemaManager::introspectTable() ​
    ​AbstractSchemaManager::introspectTable() ​

    [m] listTableColumns <tag_inheritdoc data-type='' data-description=''>Lists the columns for a given table.

    Lists the columns for a given table. 
    public function listTableColumns(
    string $table,
    string|null $database = null
): Doctrine\DBAL\Schema\Column[]

    In contrast to other libraries and to the old version of Doctrine, this column definition does try to contain the 'primary' column for the reason that it is not portable across different RDBMS. Use listTableIndexes($tableName) to retrieve the primary key of a table. Where a RDBMS specifies more details, these are held in the platformDetails array.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string|​null ​$database = null ​
    Return
    type summary
    ​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableColumns() ​Lists the columns for a given table.
    See
    type summary
    ​listTableIndexes($tableName) ​

    [m] listTableIndexes <tag_inheritdoc data-type='' data-description=''>Lists the indexes for a given table returning an array of Index instances.

    Lists the indexes for a given table returning an array of Index instances. 
    public function listTableIndexes(string $table): Doctrine\DBAL\Schema\Index[]

    Keys of the portable indexes list are all lower-cased.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    Return
    type summary
    ​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableIndexes() ​Lists the indexes for a given table returning an array of Index instances.

    [m] listTableForeignKeys Lists the foreign keys for the given table.

    Lists the foreign keys for the given table. 
    public function listTableForeignKeys(
    string $table,
    string|null $database = null
): Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string|​null ​$database = null ​
    Return
    type summary
    ​ForeignKeyConstraint[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableForeignKeys() ​Lists the foreign keys for the given table.

    [m] getSchemaNames Gets all the existing schema names.

    deprecated

    Gets all the existing schema names. 
    public function getSchemaNames(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​PostgreSQLSchemaManager::listSchemaNames() ​

    [m] listSchemaNames Returns a list of the names of all schemata in the current database.

    Returns a list of the names of all schemata in the current database. 
    public function listSchemaNames(): array
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listSchemaNames() ​Returns a list of the names of all schemata in the current database.

    [m] getSchemaSearchPaths <tag_inheritdoc data-type='' data-description=''>The search path for namespaces in the currently connected database.

    deprecated

    The search path for namespaces in the currently connected database. 
    public function getSchemaSearchPaths(): string[]

    The first entry is usually the default namespace in the Schema. All further namespaces contain tables/sequences which can also be addressed with a short, not full-qualified name.

    For databases that don't support subschema/namespaces this method returns the name of the currently connected database.

    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::getSchemaSearchPaths() ​The search path for namespaces in the currently connected database.

    [m] getExistingSchemaSearchPaths Gets names of all existing schemas in the current users search path.

    Gets names of all existing schemas in the current users search path. 
    public function getExistingSchemaSearchPaths(): string[]

    This is a PostgreSQL only function.

    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​

    [m] getCurrentSchema Returns the name of the current schema.

    Returns the name of the current schema. 
    protected function getCurrentSchema(): string|null
    Return
    type summary
    ​string|​null ​
    Throws
    type summary
    ​Exception ​

    [m] determineExistingSchemaSearchPaths Sets or resets the order of the existing schemas in the current search path of the user.

    Sets or resets the order of the existing schemas in the current search path of the user. 
    public function determineExistingSchemaSearchPaths(): void

    This is a PostgreSQL only function.

    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] _getPortableTableForeignKeyDefinition 

    protected function _getPortableTableForeignKeyDefinition(mixed $tableForeignKey): Doctrine\DBAL\Schema\ForeignKeyConstraint
    Parameter
    type name summary
    ​mixed ​$tableForeignKey ​
    Return
    type summary
    ​ForeignKeyConstraint ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableForeignKeyDefinition() ​

    [m] _getPortableViewDefinition 

    protected function _getPortableViewDefinition(mixed[] $view): Doctrine\DBAL\Schema\View|false
    Parameter
    type name summary
    ​mixed[] ​$view ​
    Return
    type summary
    ​View|​false ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableViewDefinition() ​

    [m] _getPortableTableDefinition 

    protected function _getPortableTableDefinition(mixed $table): string
    Parameter
    type name summary
    ​mixed ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableDefinition() ​

    [m] _getPortableTableIndexesList Aggregates and groups the index results according to the required data result.

    Aggregates and groups the index results according to the required data result. 
    protected function _getPortableTableIndexesList(
    mixed[][] $tableIndexes,
    string|null $tableName = null
): Doctrine\DBAL\Schema\Index[]
    Parameter
    type name summary
    ​mixed[][] ​$tableIndexes ​
    ​string|​null ​$tableName = null ​
    Return
    type summary
    ​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableIndexesList() ​Aggregates and groups the index results according to the required data result.

    [m] _getPortableDatabaseDefinition 

    protected function _getPortableDatabaseDefinition(mixed $database): mixed
    Parameter
    type name summary
    ​mixed ​$database ​
    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableDatabaseDefinition() ​

    [m] getPortableNamespaceDefinition Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition.

    deprecated

    Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition. 
    protected function getPortableNamespaceDefinition(array $namespace): mixed
    Parameter
    type name summary
    ​array ​$namespace ​
    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::getPortableNamespaceDefinition() ​Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition.
    See
    type summary
    ​PostgreSQLSchemaManager::listSchemaNames() ​
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] _getPortableSequenceDefinition 

    protected function _getPortableSequenceDefinition(mixed[] $sequence): Doctrine\DBAL\Schema\Sequence
    Parameter
    type name summary
    ​mixed[] ​$sequence ​
    Return
    type summary
    ​Sequence ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableSequenceDefinition() ​

    [m] _getPortableTableColumnDefinition Gets Table Column Definition.

    Gets Table Column Definition. 
    protected function _getPortableTableColumnDefinition(mixed[] $tableColumn): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​mixed[] ​$tableColumn ​
    Return
    type summary
    ​Column ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableColumnDefinition() ​Gets Table Column Definition.

    [m] selectTableNames Selects names of tables in the specified database.

    Selects names of tables in the specified database. 
    protected function selectTableNames(string $databaseName): Doctrine\DBAL\Result
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectTableNames() ​Selects names of tables in the specified database.

    [m] selectTableColumns Selects definitions of table columns in the specified database. If the table name is specified, narrows down

    Selects definitions of table columns in the specified database. If the table name is specified, narrows down 
    protected function selectTableColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectTableColumns() ​Selects definitions of table columns in the specified database. If the table name is specified, narrows down

    [m] selectIndexColumns Selects definitions of index columns in the specified database. If the table name is specified, narrows down

    Selects definitions of index columns in the specified database. If the table name is specified, narrows down 
    protected function selectIndexColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectIndexColumns() ​Selects definitions of index columns in the specified database. If the table name is specified, narrows down

    [m] selectForeignKeyColumns Selects definitions of foreign key columns in the specified database. If the table name is specified,

    Selects definitions of foreign key columns in the specified database. If the table name is specified, 
    protected function selectForeignKeyColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    narrows down the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectForeignKeyColumns() ​Selects definitions of foreign key columns in the specified database. If the table name is specified,

    [m] fetchTableOptionsByTable <tag_inheritdoc data-type='' data-description=''>Fetches table options for the tables in the specified database and returns them grouped by table name.

    Fetches table options for the tables in the specified database and returns them grouped by table name. 
    protected function fetchTableOptionsByTable(
    string $databaseName,
    ?string $tableName = null
): array

    If the table name is specified, narrows down the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::fetchTableOptionsByTable() ​Fetches table options for the tables in the specified database and returns them grouped by table name.

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Connection $connection,
    Doctrine\DBAL\Platforms\AbstractPlatform|T $platform
)
    Parameter
    type name summary
    ​Connection ​$connection ​
    ​AbstractPlatform|​T ​$platform ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::__construct() ​

    [m] getDatabasePlatform Returns the associated platform.

    deprecated

    Returns the associated platform. 
    public function getDatabasePlatform(): T
    Return
    type summary
    ​T ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getDatabasePlatform() ​Returns the associated platform.

    [m] tryMethod Tries any method on the schema manager. Normally a method throws an

    deprecated

    Tries any method on the schema manager. Normally a method throws an 
    public function tryMethod(): mixed

    exception when your DBMS doesn't support it or if an error occurs. This method allows you to try and method on your SchemaManager instance and will return false if it does not work or is not supported.

    $result = $sm->tryMethod('dropView', 'view_name');

    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::tryMethod() ​Tries any method on the schema manager. Normally a method throws an

    [m] listDatabases Lists the available databases for this connection.

    Lists the available databases for this connection. 
    public function listDatabases(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listDatabases() ​Lists the available databases for this connection.

    [m] listNamespaceNames Returns a list of all namespaces in the current database.

    deprecated

    Returns a list of all namespaces in the current database. 
    public function listNamespaceNames(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listNamespaceNames() ​Returns a list of all namespaces in the current database.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] listSequences Lists the available sequences for this connection.

    Lists the available sequences for this connection. 
    public function listSequences(string|null $database = null): Doctrine\DBAL\Schema\Sequence[]
    Parameter
    type name summary
    ​string|​null ​$database = null ​
    Return
    type summary
    ​Sequence[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listSequences() ​Lists the available sequences for this connection.

    [m] doListTableColumns 

    protected function doListTableColumns(
    string $table,
    string|null $database = null
): array|Doctrine\DBAL\Schema\Column[]
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​array|​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableColumns() ​

    [m] doListTableIndexes 

    protected function doListTableIndexes(string $table): array|Doctrine\DBAL\Schema\Index[]
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​array|​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableIndexes() ​

    [m] tablesExist Returns true if all the given tables exist.

    Returns true if all the given tables exist. 
    public function tablesExist(string|string[] $names): bool

    The usage of a string $tableNames is deprecated. Pass a one-element array instead.

    Parameter
    type name summary
    ​string|​string[] ​$names ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::tablesExist() ​Returns true if all the given tables exist.

    [m] doListTableNames 

    protected function doListTableNames(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableNames() ​

    [m] filterAssetNames Filters asset names if they are configured to return only a subset of all

    Filters asset names if they are configured to return only a subset of all 
    protected function filterAssetNames(mixed[] $assetNames): mixed[]

    the found elements.

    Parameter
    type name summary
    ​mixed[] ​$assetNames ​
    Return
    type summary
    ​mixed[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::filterAssetNames() ​Filters asset names if they are configured to return only a subset of all

    [m] doListTables 

    protected function doListTables(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTables() ​

    [m] doListTableDetails 

    protected function doListTableDetails(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableDetails() ​

    [m] normalizeName An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted.

    An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted. 
    protected function normalizeName(string $name): string

    Such platforms should convert a possibly quoted name into a value of the corresponding case.

    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::normalizeName() ​An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted.

    [m] fetchTableColumnsByTable Fetches definitions of table columns in the specified database and returns them grouped by table name.

    Fetches definitions of table columns in the specified database and returns them grouped by table name. 
    protected function fetchTableColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchTableColumnsByTable() ​Fetches definitions of table columns in the specified database and returns them grouped by table name.

    [m] fetchIndexColumnsByTable Fetches definitions of index columns in the specified database and returns them grouped by table name.

    Fetches definitions of index columns in the specified database and returns them grouped by table name. 
    protected function fetchIndexColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchIndexColumnsByTable() ​Fetches definitions of index columns in the specified database and returns them grouped by table name.

    [m] fetchForeignKeyColumnsByTable Fetches definitions of foreign key columns in the specified database and returns them grouped by table name.

    Fetches definitions of foreign key columns in the specified database and returns them grouped by table name. 
    protected function fetchForeignKeyColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​list<array<string, mixed>>>
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchForeignKeyColumnsByTable() ​Fetches definitions of foreign key columns in the specified database and returns them grouped by table name.

    [m] introspectTable Introspects the table with the given name.

    Introspects the table with the given name. 
    public function introspectTable(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::introspectTable() ​Introspects the table with the given name.

    [m] listViews Lists the views this connection has.

    Lists the views this connection has. 
    public function listViews(): Doctrine\DBAL\Schema\View[]
    Return
    type summary
    ​View[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listViews() ​Lists the views this connection has.

    [m] doListTableForeignKeys 

    protected function doListTableForeignKeys(
    string $table,
    string|null $database = null
): array|Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​array|​ForeignKeyConstraint[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableForeignKeys() ​

    [m] dropDatabase Drops a database.

    Drops a database. 
    public function dropDatabase(string $database): void

    NOTE: You can not drop the database this SchemaManager is currently connected to.

    Parameter
    type name summary
    ​string ​$database ​The name of the database to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropDatabase() ​Drops a database.

    [m] dropSchema Drops a schema.

    Drops a schema. 
    public function dropSchema(string $schemaName)
    Parameter
    type name summary
    ​string ​$schemaName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSchema() ​Drops a schema.

    [m] dropTable Drops the given table.

    Drops the given table. 
    public function dropTable(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the table to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropTable() ​Drops the given table.

    [m] dropIndex Drops the index from the given table.

    Drops the index from the given table. 
    public function dropIndex(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index|​string ​$index ​The name of the index.
    ​Table|​string ​$table ​The name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropIndex() ​Drops the index from the given table.

    [m] dropConstraint Drops the constraint from the given table.

    deprecated

    Drops the constraint from the given table. 
    public function dropConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​The name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropConstraint() ​Drops the constraint from the given table.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::dropForeignKey() ​
    ​AbstractSchemaManager::dropUniqueConstraint() ​

    [m] dropForeignKey Drops a foreign key from a table.

    Drops a foreign key from a table. 
    public function dropForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​The name of the foreign key.
    ​Table|​string ​$table ​The name of the table with the foreign key.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropForeignKey() ​Drops a foreign key from a table.

    [m] dropSequence Drops a sequence with a given name.

    Drops a sequence with a given name. 
    public function dropSequence(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the sequence to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSequence() ​Drops a sequence with a given name.

    [m] dropUniqueConstraint Drops the unique constraint from the given table.

    Drops the unique constraint from the given table. 
    public function dropUniqueConstraint(
    string $name,
    string $tableName
)
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropUniqueConstraint() ​Drops the unique constraint from the given table.

    [m] dropView Drops a view.

    Drops a view. 
    public function dropView(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the view.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropView() ​Drops a view.

    [m] createSchemaObjects 

    public function createSchemaObjects(Doctrine\DBAL\Schema\Schema $schema)
    Parameter
    type name summary
    ​Schema ​$schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchemaObjects() ​

    [m] createDatabase Creates a new database.

    Creates a new database. 
    public function createDatabase(string $database): void
    Parameter
    type name summary
    ​string ​$database ​The name of the database to create.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createDatabase() ​Creates a new database.

    [m] createTable Creates a new table.

    Creates a new table. 
    public function createTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createTable() ​Creates a new table.

    [m] createSequence Creates a new sequence.

    Creates a new sequence. 
    public function createSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSequence() ​Creates a new sequence.

    [m] createConstraint Creates a constraint on a table.

    deprecated

    Creates a constraint on a table. 
    public function createConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createConstraint() ​Creates a constraint on a table.
    See
    type summary
    ​AbstractSchemaManager::createIndex() ​
    ​AbstractSchemaManager::createForeignKey() ​
    ​AbstractSchemaManager::createUniqueConstraint() ​

    [m] createIndex Creates a new index on a table.

    Creates a new index on a table. 
    public function createIndex(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createIndex() ​Creates a new index on a table.

    [m] createForeignKey Creates a new foreign key.

    Creates a new foreign key. 
    public function createForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The ForeignKey instance.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createForeignKey() ​Creates a new foreign key.

    [m] createUniqueConstraint Creates a unique constraint on a table.

    Creates a unique constraint on a table. 
    public function createUniqueConstraint(
    Doctrine\DBAL\Schema\UniqueConstraint $uniqueConstraint,
    string $tableName
)
    Parameter
    type name summary
    ​UniqueConstraint ​$uniqueConstraint ​
    ​string ​$tableName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createUniqueConstraint() ​Creates a unique constraint on a table.

    [m] createView Creates a new view.

    Creates a new view. 
    public function createView(Doctrine\DBAL\Schema\View $view): void
    Parameter
    type name summary
    ​View ​$view ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createView() ​Creates a new view.

    [m] dropSchemaObjects 

    public function dropSchemaObjects(Doctrine\DBAL\Schema\Schema $schema)
    Parameter
    type name summary
    ​Schema ​$schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSchemaObjects() ​

    [m] dropAndCreateConstraint Drops and creates a constraint.

    deprecated

    Drops and creates a constraint. 
    public function dropAndCreateConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateConstraint() ​Drops and creates a constraint.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::createIndex() ​
    ​AbstractSchemaManager::createForeignKey() ​
    ​AbstractSchemaManager::createUniqueConstraint() ​
    ​AbstractSchemaManager::dropConstraint() ​
    ​AbstractSchemaManager::createConstraint() ​

    [m] dropAndCreateIndex Drops and creates a new index on a table.

    deprecated

    Drops and creates a new index on a table. 
    public function dropAndCreateIndex(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateIndex() ​Drops and creates a new index on a table.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::createIndex() ​

    [m] dropAndCreateForeignKey Drops and creates a new foreign key.

    deprecated

    Drops and creates a new foreign key. 
    public function dropAndCreateForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​An associative array that defines properties
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateForeignKey() ​Drops and creates a new foreign key.
    See
    type summary
    ​AbstractSchemaManager::dropForeignKey() ​
    ​AbstractSchemaManager::createForeignKey() ​

    [m] dropAndCreateSequence Drops and create a new sequence.

    deprecated

    Drops and create a new sequence. 
    public function dropAndCreateSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateSequence() ​Drops and create a new sequence.
    See
    type summary
    ​AbstractSchemaManager::dropSequence() ​
    ​AbstractSchemaManager::createSequence() ​

    [m] dropAndCreateTable Drops and creates a new table.

    deprecated

    Drops and creates a new table. 
    public function dropAndCreateTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateTable() ​Drops and creates a new table.
    See
    type summary
    ​AbstractSchemaManager::dropTable() ​
    ​AbstractSchemaManager::createTable() ​

    [m] dropAndCreateDatabase Drops and creates a new database.

    deprecated

    Drops and creates a new database. 
    public function dropAndCreateDatabase(string $database): void
    Parameter
    type name summary
    ​string ​$database ​The name of the database to create.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateDatabase() ​Drops and creates a new database.
    See
    type summary
    ​AbstractSchemaManager::dropDatabase() ​
    ​AbstractSchemaManager::createDatabase() ​

    [m] dropAndCreateView Drops and creates a new view.

    deprecated

    Drops and creates a new view. 
    public function dropAndCreateView(Doctrine\DBAL\Schema\View $view): void
    Parameter
    type name summary
    ​View ​$view ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateView() ​Drops and creates a new view.
    See
    type summary
    ​AbstractSchemaManager::dropView() ​
    ​AbstractSchemaManager::createView() ​

    [m] alterSchema Alters an existing schema.

    Alters an existing schema. 
    public function alterSchema(Doctrine\DBAL\Schema\SchemaDiff $schemaDiff)
    Parameter
    type name summary
    ​SchemaDiff ​$schemaDiff ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::alterSchema() ​Alters an existing schema.

    [m] migrateSchema Migrates an existing schema to a new schema.

    Migrates an existing schema to a new schema. 
    public function migrateSchema(Doctrine\DBAL\Schema\Schema $toSchema)
    Parameter
    type name summary
    ​Schema ​$toSchema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::migrateSchema() ​Migrates an existing schema to a new schema.

    [m] alterTable Alters an existing tables schema.

    Alters an existing tables schema. 
    public function alterTable(Doctrine\DBAL\Schema\TableDiff $tableDiff): void
    Parameter
    type name summary
    ​TableDiff ​$tableDiff ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::alterTable() ​Alters an existing tables schema.

    [m] renameTable Renames a given table to another name.

    Renames a given table to another name. 
    public function renameTable(
    string $name,
    string $newName
): void
    Parameter
    type name summary
    ​string ​$name ​The current name of the table.
    ​string ​$newName ​The new name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::renameTable() ​Renames a given table to another name.

    [m] _getPortableDatabasesList 

    protected function _getPortableDatabasesList(mixed[] $databases): string[]
    Parameter
    type name summary
    ​mixed[] ​$databases ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableDatabasesList() ​

    [m] getPortableNamespacesList Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition.

    deprecated

    Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition. 
    protected function getPortableNamespacesList(array $namespaces): string[]
    Parameter
    type name summary
    ​array ​$namespaces ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getPortableNamespacesList() ​Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] _getPortableSequencesList 

    protected function _getPortableSequencesList(mixed[][] $sequences): Doctrine\DBAL\Schema\Sequence[]
    Parameter
    type name summary
    ​mixed[][] ​$sequences ​
    Return
    type summary
    ​Sequence[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableSequencesList() ​

    [m] _getPortableTableColumnList Independent of the database the keys of the column list result are lowercased.

    Independent of the database the keys of the column list result are lowercased. 
    protected function _getPortableTableColumnList(
    string $table,
    string $database,
    mixed[][] $tableColumns
): Doctrine\DBAL\Schema\Column[]

    The name of the created column instance however is kept in its case.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string ​$database ​
    ​mixed[][] ​$tableColumns ​
    Return
    type summary
    ​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableTableColumnList() ​Independent of the database the keys of the column list result are lowercased.

    [m] _getPortableTablesList 

    protected function _getPortableTablesList(mixed[][] $tables): string[]
    Parameter
    type name summary
    ​mixed[][] ​$tables ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableTablesList() ​

    [m] _getPortableViewsList 

    protected function _getPortableViewsList(mixed[][] $views): Doctrine\DBAL\Schema\View[]
    Parameter
    type name summary
    ​mixed[][] ​$views ​
    Return
    type summary
    ​View[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableViewsList() ​

    [m] _getPortableTableForeignKeysList 

    protected function _getPortableTableForeignKeysList(mixed[][] $tableForeignKeys): Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​mixed[][] ​$tableForeignKeys ​
    Return
    type summary
    ​ForeignKeyConstraint[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableTableForeignKeysList() ​

    [m] _execSql 

    protected function _execSql(string[]|string $sql): void
    Parameter
    type name summary
    ​string[]|​string ​$sql ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_execSql() ​

    [m] createSchema Creates a schema instance for the current database.

    deprecated

    Creates a schema instance for the current database. 
    public function createSchema(): Doctrine\DBAL\Schema\Schema
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchema() ​Creates a schema instance for the current database.

    [m] introspectSchema Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema.

    Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema. 
    public function introspectSchema(): Doctrine\DBAL\Schema\Schema
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::introspectSchema() ​Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema.
    See
    type summary
    ​Schema ​

    [m] createSchemaConfig Creates the configuration for this schema.

    Creates the configuration for this schema. 
    public function createSchemaConfig(): Doctrine\DBAL\Schema\SchemaConfig
    Return
    type summary
    ​SchemaConfig ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchemaConfig() ​Creates the configuration for this schema.

    [m] extractDoctrineTypeFromComment Given a table comment this method tries to extract a typehint for Doctrine Type, or returns

    Given a table comment this method tries to extract a typehint for Doctrine Type, or returns 
    public function extractDoctrineTypeFromComment(
    string|null $comment,
    string $currentType
): string

    the type given as default.

    Parameter
    type name summary
    ​string|​null ​$comment ​
    ​string ​$currentType ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::extractDoctrineTypeFromComment() ​Given a table comment this method tries to extract a typehint for Doctrine Type, or returns

    [m] removeDoctrineTypeFromComment 

    public function removeDoctrineTypeFromComment(
    string|null $comment,
    string|null $type
): string|null
    Parameter
    type name summary
    ​string|​null ​$comment ​
    ​string|​null ​$type ​
    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::removeDoctrineTypeFromComment() ​

    [m] createComparator 

    public function createComparator(): Doctrine\DBAL\Schema\Comparator
    Return
    type summary
    ​Comparator ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createComparator() ​

    [C] SqliteSchemaManager Sqlite SchemaManager.

    Sqlite SchemaManager.

    Hierarchy

    Parents
    type summary
    ​AbstractSchemaManager ​Base class for schema managers. Schema managers are used to inspect and/or

    [p] $_conn Holds instance of the Doctrine connection for this schema manager.

    Holds instance of the Doctrine connection for this schema manager. 
    protected Doctrine\DBAL\Connection $_conn = null

    Type: Connection

    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::$_conn ​Holds instance of the Doctrine connection for this schema manager.

    [p] $_platform Holds instance of the database platform used for this schema manager.

    Holds instance of the database platform used for this schema manager. 
    protected T $_platform = null

    Type: T

    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::$_platform ​Holds instance of the database platform used for this schema manager.

    [m] listTableNames Returns a list of all tables in the current database.

    Returns a list of all tables in the current database. 
    public function listTableNames(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableNames() ​Returns a list of all tables in the current database.

    [m] listTables Lists the tables for this connection.

    Lists the tables for this connection. 
    public function listTables(): list
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTables() ​Lists the tables for this connection.

    [m] listTableDetails

    deprecated 

    public function listTableDetails(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableDetails() ​
    See
    type summary
    ​SqliteSchemaManager::introspectTable() ​
    ​AbstractSchemaManager::introspectTable() ​

    [m] listTableColumns <tag_inheritdoc data-type='' data-description=''>Lists the columns for a given table.

    Lists the columns for a given table. 
    public function listTableColumns(
    string $table,
    string|null $database = null
): Doctrine\DBAL\Schema\Column[]

    In contrast to other libraries and to the old version of Doctrine, this column definition does try to contain the 'primary' column for the reason that it is not portable across different RDBMS. Use listTableIndexes($tableName) to retrieve the primary key of a table. Where a RDBMS specifies more details, these are held in the platformDetails array.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string|​null ​$database = null ​
    Return
    type summary
    ​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableColumns() ​Lists the columns for a given table.
    See
    type summary
    ​listTableIndexes($tableName) ​

    [m] listTableIndexes <tag_inheritdoc data-type='' data-description=''>Lists the indexes for a given table returning an array of Index instances.

    Lists the indexes for a given table returning an array of Index instances. 
    public function listTableIndexes(string $table): Doctrine\DBAL\Schema\Index[]

    Keys of the portable indexes list are all lower-cased.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    Return
    type summary
    ​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableIndexes() ​Lists the indexes for a given table returning an array of Index instances.

    [m] fetchForeignKeyColumnsByTable Fetches definitions of foreign key columns in the specified database and returns them grouped by table name.

    Fetches definitions of foreign key columns in the specified database and returns them grouped by table name. 
    protected function fetchForeignKeyColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::fetchForeignKeyColumnsByTable() ​Fetches definitions of foreign key columns in the specified database and returns them grouped by table name.

    [m] dropDatabase <tag_inheritdoc data-type='' data-description=''>Drops a database.

    deprecated

    Drops a database. 
    public function dropDatabase(string $database): void

    NOTE: You can not drop the database this SchemaManager is currently connected to.

    Parameter
    type name summary
    ​string ​$database ​The name of the database to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::dropDatabase() ​Drops a database.

    [m] createDatabase Creates a new database.

    deprecated

    Creates a new database. 
    public function createDatabase(string $database): void
    Parameter
    type name summary
    ​string ​$database ​The name of the database to create.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::createDatabase() ​Creates a new database.

    [m] createForeignKey Creates a new foreign key.

    Creates a new foreign key. 
    public function createForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The ForeignKey instance.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::createForeignKey() ​Creates a new foreign key.

    [m] dropAndCreateForeignKey Drops and creates a new foreign key.

    deprecated

    Drops and creates a new foreign key. 
    public function dropAndCreateForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​An associative array that defines properties
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::dropAndCreateForeignKey() ​Drops and creates a new foreign key.
    See
    type summary
    ​SqliteSchemaManager::dropForeignKey() ​
    ​SqliteSchemaManager::createForeignKey() ​
    ​AbstractSchemaManager::dropForeignKey() ​
    ​AbstractSchemaManager::createForeignKey() ​

    [m] dropForeignKey Drops a foreign key from a table.

    Drops a foreign key from a table. 
    public function dropForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​The name of the foreign key.
    ​Table|​string ​$table ​The name of the table with the foreign key.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::dropForeignKey() ​Drops a foreign key from a table.

    [m] listTableForeignKeys Lists the foreign keys for the given table.

    Lists the foreign keys for the given table. 
    public function listTableForeignKeys(
    string $table,
    string|null $database = null
): Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string|​null ​$database = null ​
    Return
    type summary
    ​ForeignKeyConstraint[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableForeignKeys() ​Lists the foreign keys for the given table.

    [m] _getPortableTableDefinition 

    protected function _getPortableTableDefinition(mixed $table): string
    Parameter
    type name summary
    ​mixed ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableDefinition() ​

    [m] _getPortableTableIndexesList Aggregates and groups the index results according to the required data result.

    Aggregates and groups the index results according to the required data result. 
    protected function _getPortableTableIndexesList(
    mixed[][] $tableIndexes,
    string|null $tableName = null
): Doctrine\DBAL\Schema\Index[]
    Parameter
    type name summary
    ​mixed[][] ​$tableIndexes ​
    ​string|​null ​$tableName = null ​
    Return
    type summary
    ​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableIndexesList() ​Aggregates and groups the index results according to the required data result.

    [m] _getPortableTableColumnList <tag_inheritdoc data-type='' data-description=''>Independent of the database the keys of the column list result are lowercased.

    Independent of the database the keys of the column list result are lowercased. 
    protected function _getPortableTableColumnList(
    string $table,
    string $database,
    mixed[][] $tableColumns
): Doctrine\DBAL\Schema\Column[]

    The name of the created column instance however is kept in its case.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string ​$database ​
    ​mixed[][] ​$tableColumns ​
    Return
    type summary
    ​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableColumnList() ​Independent of the database the keys of the column list result are lowercased.

    [m] _getPortableTableColumnDefinition Gets Table Column Definition.

    Gets Table Column Definition. 
    protected function _getPortableTableColumnDefinition(mixed[] $tableColumn): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​mixed[] ​$tableColumn ​
    Return
    type summary
    ​Column ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableColumnDefinition() ​Gets Table Column Definition.

    [m] _getPortableViewDefinition 

    protected function _getPortableViewDefinition(mixed[] $view): Doctrine\DBAL\Schema\View|false
    Parameter
    type name summary
    ​mixed[] ​$view ​
    Return
    type summary
    ​View|​false ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableViewDefinition() ​

    [m] _getPortableTableForeignKeysList 

    protected function _getPortableTableForeignKeysList(mixed[][] $tableForeignKeys): Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​mixed[][] ​$tableForeignKeys ​
    Return
    type summary
    ​ForeignKeyConstraint[] ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableForeignKeysList() ​

    [m] _getPortableTableForeignKeyDefinition 

    protected function _getPortableTableForeignKeyDefinition(mixed $tableForeignKey): Doctrine\DBAL\Schema\ForeignKeyConstraint
    Parameter
    type name summary
    ​mixed ​$tableForeignKey ​
    Return
    type summary
    ​ForeignKeyConstraint ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableForeignKeyDefinition() ​

    [m] createComparator 

    public function createComparator(): Doctrine\DBAL\Schema\Comparator
    Return
    type summary
    ​Comparator ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::createComparator() ​

    [m] getSchemaSearchPaths <tag_inheritdoc data-type='' data-description=''>The search path for namespaces in the currently connected database.

    deprecated

    The search path for namespaces in the currently connected database. 
    public function getSchemaSearchPaths(): string[]

    The first entry is usually the default namespace in the Schema. All further namespaces contain tables/sequences which can also be addressed with a short, not full-qualified name.

    For databases that don't support subschema/namespaces this method returns the name of the currently connected database.

    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::getSchemaSearchPaths() ​The search path for namespaces in the currently connected database.

    [m] selectTableNames Selects names of tables in the specified database.

    Selects names of tables in the specified database. 
    protected function selectTableNames(string $databaseName): Doctrine\DBAL\Result
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectTableNames() ​Selects names of tables in the specified database.

    [m] selectTableColumns Selects definitions of table columns in the specified database. If the table name is specified, narrows down

    Selects definitions of table columns in the specified database. If the table name is specified, narrows down 
    protected function selectTableColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectTableColumns() ​Selects definitions of table columns in the specified database. If the table name is specified, narrows down

    [m] selectIndexColumns Selects definitions of index columns in the specified database. If the table name is specified, narrows down

    Selects definitions of index columns in the specified database. If the table name is specified, narrows down 
    protected function selectIndexColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectIndexColumns() ​Selects definitions of index columns in the specified database. If the table name is specified, narrows down

    [m] selectForeignKeyColumns Selects definitions of foreign key columns in the specified database. If the table name is specified,

    Selects definitions of foreign key columns in the specified database. If the table name is specified, 
    protected function selectForeignKeyColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    narrows down the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectForeignKeyColumns() ​Selects definitions of foreign key columns in the specified database. If the table name is specified,

    [m] fetchTableOptionsByTable <tag_inheritdoc data-type='' data-description=''>Fetches table options for the tables in the specified database and returns them grouped by table name.

    Fetches table options for the tables in the specified database and returns them grouped by table name. 
    protected function fetchTableOptionsByTable(
    string $databaseName,
    ?string $tableName = null
): array

    If the table name is specified, narrows down the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::fetchTableOptionsByTable() ​Fetches table options for the tables in the specified database and returns them grouped by table name.

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Connection $connection,
    Doctrine\DBAL\Platforms\AbstractPlatform|T $platform
)
    Parameter
    type name summary
    ​Connection ​$connection ​
    ​AbstractPlatform|​T ​$platform ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::__construct() ​

    [m] getDatabasePlatform Returns the associated platform.

    deprecated

    Returns the associated platform. 
    public function getDatabasePlatform(): T
    Return
    type summary
    ​T ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getDatabasePlatform() ​Returns the associated platform.

    [m] tryMethod Tries any method on the schema manager. Normally a method throws an

    deprecated

    Tries any method on the schema manager. Normally a method throws an 
    public function tryMethod(): mixed

    exception when your DBMS doesn't support it or if an error occurs. This method allows you to try and method on your SchemaManager instance and will return false if it does not work or is not supported.

    $result = $sm->tryMethod('dropView', 'view_name');

    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::tryMethod() ​Tries any method on the schema manager. Normally a method throws an

    [m] listDatabases Lists the available databases for this connection.

    Lists the available databases for this connection. 
    public function listDatabases(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listDatabases() ​Lists the available databases for this connection.

    [m] listNamespaceNames Returns a list of all namespaces in the current database.

    deprecated

    Returns a list of all namespaces in the current database. 
    public function listNamespaceNames(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listNamespaceNames() ​Returns a list of all namespaces in the current database.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] listSchemaNames Returns a list of the names of all schemata in the current database.

    Returns a list of the names of all schemata in the current database. 
    public function listSchemaNames(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listSchemaNames() ​Returns a list of the names of all schemata in the current database.

    [m] listSequences Lists the available sequences for this connection.

    Lists the available sequences for this connection. 
    public function listSequences(string|null $database = null): Doctrine\DBAL\Schema\Sequence[]
    Parameter
    type name summary
    ​string|​null ​$database = null ​
    Return
    type summary
    ​Sequence[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listSequences() ​Lists the available sequences for this connection.

    [m] doListTableColumns 

    protected function doListTableColumns(
    string $table,
    string|null $database = null
): array|Doctrine\DBAL\Schema\Column[]
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​array|​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableColumns() ​

    [m] doListTableIndexes 

    protected function doListTableIndexes(string $table): array|Doctrine\DBAL\Schema\Index[]
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​array|​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableIndexes() ​

    [m] tablesExist Returns true if all the given tables exist.

    Returns true if all the given tables exist. 
    public function tablesExist(string|string[] $names): bool

    The usage of a string $tableNames is deprecated. Pass a one-element array instead.

    Parameter
    type name summary
    ​string|​string[] ​$names ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::tablesExist() ​Returns true if all the given tables exist.

    [m] doListTableNames 

    protected function doListTableNames(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableNames() ​

    [m] filterAssetNames Filters asset names if they are configured to return only a subset of all

    Filters asset names if they are configured to return only a subset of all 
    protected function filterAssetNames(mixed[] $assetNames): mixed[]

    the found elements.

    Parameter
    type name summary
    ​mixed[] ​$assetNames ​
    Return
    type summary
    ​mixed[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::filterAssetNames() ​Filters asset names if they are configured to return only a subset of all

    [m] doListTables 

    protected function doListTables(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTables() ​

    [m] doListTableDetails 

    protected function doListTableDetails(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableDetails() ​

    [m] normalizeName An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted.

    An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted. 
    protected function normalizeName(string $name): string

    Such platforms should convert a possibly quoted name into a value of the corresponding case.

    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::normalizeName() ​An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted.

    [m] fetchTableColumnsByTable Fetches definitions of table columns in the specified database and returns them grouped by table name.

    Fetches definitions of table columns in the specified database and returns them grouped by table name. 
    protected function fetchTableColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchTableColumnsByTable() ​Fetches definitions of table columns in the specified database and returns them grouped by table name.

    [m] fetchIndexColumnsByTable Fetches definitions of index columns in the specified database and returns them grouped by table name.

    Fetches definitions of index columns in the specified database and returns them grouped by table name. 
    protected function fetchIndexColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchIndexColumnsByTable() ​Fetches definitions of index columns in the specified database and returns them grouped by table name.

    [m] introspectTable Introspects the table with the given name.

    Introspects the table with the given name. 
    public function introspectTable(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::introspectTable() ​Introspects the table with the given name.

    [m] listViews Lists the views this connection has.

    Lists the views this connection has. 
    public function listViews(): Doctrine\DBAL\Schema\View[]
    Return
    type summary
    ​View[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listViews() ​Lists the views this connection has.

    [m] doListTableForeignKeys 

    protected function doListTableForeignKeys(
    string $table,
    string|null $database = null
): array|Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​array|​ForeignKeyConstraint[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableForeignKeys() ​

    [m] dropSchema Drops a schema.

    Drops a schema. 
    public function dropSchema(string $schemaName)
    Parameter
    type name summary
    ​string ​$schemaName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSchema() ​Drops a schema.

    [m] dropTable Drops the given table.

    Drops the given table. 
    public function dropTable(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the table to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropTable() ​Drops the given table.

    [m] dropIndex Drops the index from the given table.

    Drops the index from the given table. 
    public function dropIndex(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index|​string ​$index ​The name of the index.
    ​Table|​string ​$table ​The name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropIndex() ​Drops the index from the given table.

    [m] dropConstraint Drops the constraint from the given table.

    deprecated

    Drops the constraint from the given table. 
    public function dropConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​The name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropConstraint() ​Drops the constraint from the given table.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::dropForeignKey() ​
    ​AbstractSchemaManager::dropUniqueConstraint() ​

    [m] dropSequence Drops a sequence with a given name.

    Drops a sequence with a given name. 
    public function dropSequence(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the sequence to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSequence() ​Drops a sequence with a given name.

    [m] dropUniqueConstraint Drops the unique constraint from the given table.

    Drops the unique constraint from the given table. 
    public function dropUniqueConstraint(
    string $name,
    string $tableName
)
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropUniqueConstraint() ​Drops the unique constraint from the given table.

    [m] dropView Drops a view.

    Drops a view. 
    public function dropView(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the view.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropView() ​Drops a view.

    [m] createSchemaObjects 

    public function createSchemaObjects(Doctrine\DBAL\Schema\Schema $schema)
    Parameter
    type name summary
    ​Schema ​$schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchemaObjects() ​

    [m] createTable Creates a new table.

    Creates a new table. 
    public function createTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createTable() ​Creates a new table.

    [m] createSequence Creates a new sequence.

    Creates a new sequence. 
    public function createSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSequence() ​Creates a new sequence.

    [m] createConstraint Creates a constraint on a table.

    deprecated

    Creates a constraint on a table. 
    public function createConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createConstraint() ​Creates a constraint on a table.
    See
    type summary
    ​AbstractSchemaManager::createIndex() ​
    ​AbstractSchemaManager::createForeignKey() ​
    ​AbstractSchemaManager::createUniqueConstraint() ​

    [m] createIndex Creates a new index on a table.

    Creates a new index on a table. 
    public function createIndex(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createIndex() ​Creates a new index on a table.

    [m] createUniqueConstraint Creates a unique constraint on a table.

    Creates a unique constraint on a table. 
    public function createUniqueConstraint(
    Doctrine\DBAL\Schema\UniqueConstraint $uniqueConstraint,
    string $tableName
)
    Parameter
    type name summary
    ​UniqueConstraint ​$uniqueConstraint ​
    ​string ​$tableName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createUniqueConstraint() ​Creates a unique constraint on a table.

    [m] createView Creates a new view.

    Creates a new view. 
    public function createView(Doctrine\DBAL\Schema\View $view): void
    Parameter
    type name summary
    ​View ​$view ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createView() ​Creates a new view.

    [m] dropSchemaObjects 

    public function dropSchemaObjects(Doctrine\DBAL\Schema\Schema $schema)
    Parameter
    type name summary
    ​Schema ​$schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSchemaObjects() ​

    [m] dropAndCreateConstraint Drops and creates a constraint.

    deprecated

    Drops and creates a constraint. 
    public function dropAndCreateConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateConstraint() ​Drops and creates a constraint.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::createIndex() ​
    ​AbstractSchemaManager::createForeignKey() ​
    ​AbstractSchemaManager::createUniqueConstraint() ​
    ​AbstractSchemaManager::dropConstraint() ​
    ​AbstractSchemaManager::createConstraint() ​

    [m] dropAndCreateIndex Drops and creates a new index on a table.

    deprecated

    Drops and creates a new index on a table. 
    public function dropAndCreateIndex(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateIndex() ​Drops and creates a new index on a table.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::createIndex() ​

    [m] dropAndCreateSequence Drops and create a new sequence.

    deprecated

    Drops and create a new sequence. 
    public function dropAndCreateSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateSequence() ​Drops and create a new sequence.
    See
    type summary
    ​AbstractSchemaManager::dropSequence() ​
    ​AbstractSchemaManager::createSequence() ​

    [m] dropAndCreateTable Drops and creates a new table.

    deprecated

    Drops and creates a new table. 
    public function dropAndCreateTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateTable() ​Drops and creates a new table.
    See
    type summary
    ​AbstractSchemaManager::dropTable() ​
    ​AbstractSchemaManager::createTable() ​

    [m] dropAndCreateDatabase Drops and creates a new database.

    deprecated

    Drops and creates a new database. 
    public function dropAndCreateDatabase(string $database): void
    Parameter
    type name summary
    ​string ​$database ​The name of the database to create.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateDatabase() ​Drops and creates a new database.
    See
    type summary
    ​AbstractSchemaManager::dropDatabase() ​
    ​AbstractSchemaManager::createDatabase() ​

    [m] dropAndCreateView Drops and creates a new view.

    deprecated

    Drops and creates a new view. 
    public function dropAndCreateView(Doctrine\DBAL\Schema\View $view): void
    Parameter
    type name summary
    ​View ​$view ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateView() ​Drops and creates a new view.
    See
    type summary
    ​AbstractSchemaManager::dropView() ​
    ​AbstractSchemaManager::createView() ​

    [m] alterSchema Alters an existing schema.

    Alters an existing schema. 
    public function alterSchema(Doctrine\DBAL\Schema\SchemaDiff $schemaDiff)
    Parameter
    type name summary
    ​SchemaDiff ​$schemaDiff ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::alterSchema() ​Alters an existing schema.

    [m] migrateSchema Migrates an existing schema to a new schema.

    Migrates an existing schema to a new schema. 
    public function migrateSchema(Doctrine\DBAL\Schema\Schema $toSchema)
    Parameter
    type name summary
    ​Schema ​$toSchema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::migrateSchema() ​Migrates an existing schema to a new schema.

    [m] alterTable Alters an existing tables schema.

    Alters an existing tables schema. 
    public function alterTable(Doctrine\DBAL\Schema\TableDiff $tableDiff): void
    Parameter
    type name summary
    ​TableDiff ​$tableDiff ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::alterTable() ​Alters an existing tables schema.

    [m] renameTable Renames a given table to another name.

    Renames a given table to another name. 
    public function renameTable(
    string $name,
    string $newName
): void
    Parameter
    type name summary
    ​string ​$name ​The current name of the table.
    ​string ​$newName ​The new name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::renameTable() ​Renames a given table to another name.

    [m] _getPortableDatabasesList 

    protected function _getPortableDatabasesList(mixed[] $databases): string[]
    Parameter
    type name summary
    ​mixed[] ​$databases ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableDatabasesList() ​

    [m] getPortableNamespacesList Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition.

    deprecated

    Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition. 
    protected function getPortableNamespacesList(array $namespaces): string[]
    Parameter
    type name summary
    ​array ​$namespaces ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getPortableNamespacesList() ​Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] _getPortableDatabaseDefinition 

    protected function _getPortableDatabaseDefinition(mixed $database): mixed
    Parameter
    type name summary
    ​mixed ​$database ​
    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableDatabaseDefinition() ​

    [m] getPortableNamespaceDefinition Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition.

    deprecated

    Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition. 
    protected function getPortableNamespaceDefinition(array $namespace): mixed
    Parameter
    type name summary
    ​array ​$namespace ​
    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getPortableNamespaceDefinition() ​Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] _getPortableSequencesList 

    protected function _getPortableSequencesList(mixed[][] $sequences): Doctrine\DBAL\Schema\Sequence[]
    Parameter
    type name summary
    ​mixed[][] ​$sequences ​
    Return
    type summary
    ​Sequence[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableSequencesList() ​

    [m] _getPortableSequenceDefinition 

    protected function _getPortableSequenceDefinition(mixed[] $sequence): Doctrine\DBAL\Schema\Sequence
    Parameter
    type name summary
    ​mixed[] ​$sequence ​
    Return
    type summary
    ​Sequence ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableSequenceDefinition() ​

    [m] _getPortableTablesList 

    protected function _getPortableTablesList(mixed[][] $tables): string[]
    Parameter
    type name summary
    ​mixed[][] ​$tables ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableTablesList() ​

    [m] _getPortableViewsList 

    protected function _getPortableViewsList(mixed[][] $views): Doctrine\DBAL\Schema\View[]
    Parameter
    type name summary
    ​mixed[][] ​$views ​
    Return
    type summary
    ​View[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableViewsList() ​

    [m] _execSql 

    protected function _execSql(string[]|string $sql): void
    Parameter
    type name summary
    ​string[]|​string ​$sql ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_execSql() ​

    [m] createSchema Creates a schema instance for the current database.

    deprecated

    Creates a schema instance for the current database. 
    public function createSchema(): Doctrine\DBAL\Schema\Schema
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchema() ​Creates a schema instance for the current database.

    [m] introspectSchema Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema.

    Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema. 
    public function introspectSchema(): Doctrine\DBAL\Schema\Schema
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::introspectSchema() ​Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema.
    See
    type summary
    ​Schema ​

    [m] createSchemaConfig Creates the configuration for this schema.

    Creates the configuration for this schema. 
    public function createSchemaConfig(): Doctrine\DBAL\Schema\SchemaConfig
    Return
    type summary
    ​SchemaConfig ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchemaConfig() ​Creates the configuration for this schema.

    [m] extractDoctrineTypeFromComment Given a table comment this method tries to extract a typehint for Doctrine Type, or returns

    Given a table comment this method tries to extract a typehint for Doctrine Type, or returns 
    public function extractDoctrineTypeFromComment(
    string|null $comment,
    string $currentType
): string

    the type given as default.

    Parameter
    type name summary
    ​string|​null ​$comment ​
    ​string ​$currentType ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::extractDoctrineTypeFromComment() ​Given a table comment this method tries to extract a typehint for Doctrine Type, or returns

    [m] removeDoctrineTypeFromComment 

    public function removeDoctrineTypeFromComment(
    string|null $comment,
    string|null $type
): string|null
    Parameter
    type name summary
    ​string|​null ​$comment ​
    ​string|​null ​$type ​
    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::removeDoctrineTypeFromComment() ​

    [C] SQLServerSchemaManager SQL Server Schema Manager.

    SQL Server Schema Manager.

    Hierarchy

    Parents
    type summary
    ​AbstractSchemaManager ​Base class for schema managers. Schema managers are used to inspect and/or

    [p] $_conn Holds instance of the Doctrine connection for this schema manager.

    Holds instance of the Doctrine connection for this schema manager. 
    protected Doctrine\DBAL\Connection $_conn = null

    Type: Connection

    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::$_conn ​Holds instance of the Doctrine connection for this schema manager.

    [p] $_platform Holds instance of the database platform used for this schema manager.

    Holds instance of the database platform used for this schema manager. 
    protected T $_platform = null

    Type: T

    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::$_platform ​Holds instance of the database platform used for this schema manager.

    [m] listTableNames Returns a list of all tables in the current database.

    Returns a list of all tables in the current database. 
    public function listTableNames(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableNames() ​Returns a list of all tables in the current database.

    [m] listTables Lists the tables for this connection.

    Lists the tables for this connection. 
    public function listTables(): list
    Return
    type summary
    ​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTables() ​Lists the tables for this connection.

    [m] listTableDetails

    deprecated 

    public function listTableDetails(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableDetails() ​
    See
    type summary
    ​SQLServerSchemaManager::introspectTable() ​
    ​AbstractSchemaManager::introspectTable() ​

    [m] listTableColumns <tag_inheritdoc data-type='' data-description=''>Lists the columns for a given table.

    Lists the columns for a given table. 
    public function listTableColumns(
    string $table,
    string|null $database = null
): Doctrine\DBAL\Schema\Column[]

    In contrast to other libraries and to the old version of Doctrine, this column definition does try to contain the 'primary' column for the reason that it is not portable across different RDBMS. Use listTableIndexes($tableName) to retrieve the primary key of a table. Where a RDBMS specifies more details, these are held in the platformDetails array.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string|​null ​$database = null ​
    Return
    type summary
    ​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableColumns() ​Lists the columns for a given table.
    See
    type summary
    ​listTableIndexes($tableName) ​

    [m] listTableIndexes <tag_inheritdoc data-type='' data-description=''>Lists the indexes for a given table returning an array of Index instances.

    Lists the indexes for a given table returning an array of Index instances. 
    public function listTableIndexes(string $table): Doctrine\DBAL\Schema\Index[]

    Keys of the portable indexes list are all lower-cased.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    Return
    type summary
    ​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableIndexes() ​Lists the indexes for a given table returning an array of Index instances.

    [m] listTableForeignKeys Lists the foreign keys for the given table.

    Lists the foreign keys for the given table. 
    public function listTableForeignKeys(
    string $table,
    string|null $database = null
): Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string|​null ​$database = null ​
    Return
    type summary
    ​ForeignKeyConstraint[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listTableForeignKeys() ​Lists the foreign keys for the given table.

    [m] listSchemaNames Returns a list of the names of all schemata in the current database.

    Returns a list of the names of all schemata in the current database. 
    public function listSchemaNames(): array
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::listSchemaNames() ​Returns a list of the names of all schemata in the current database.

    [m] _getPortableSequenceDefinition 

    protected function _getPortableSequenceDefinition(mixed[] $sequence): Doctrine\DBAL\Schema\Sequence
    Parameter
    type name summary
    ​mixed[] ​$sequence ​
    Return
    type summary
    ​Sequence ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableSequenceDefinition() ​

    [m] _getPortableTableColumnDefinition Gets Table Column Definition.

    Gets Table Column Definition. 
    protected function _getPortableTableColumnDefinition(mixed[] $tableColumn): Doctrine\DBAL\Schema\Column
    Parameter
    type name summary
    ​mixed[] ​$tableColumn ​
    Return
    type summary
    ​Column ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableColumnDefinition() ​Gets Table Column Definition.

    [m] _getPortableTableForeignKeysList 

    protected function _getPortableTableForeignKeysList(mixed[][] $tableForeignKeys): Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​mixed[][] ​$tableForeignKeys ​
    Return
    type summary
    ​ForeignKeyConstraint[] ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableForeignKeysList() ​

    [m] _getPortableTableIndexesList Aggregates and groups the index results according to the required data result.

    Aggregates and groups the index results according to the required data result. 
    protected function _getPortableTableIndexesList(
    mixed[][] $tableIndexes,
    string|null $tableName = null
): Doctrine\DBAL\Schema\Index[]
    Parameter
    type name summary
    ​mixed[][] ​$tableIndexes ​
    ​string|​null ​$tableName = null ​
    Return
    type summary
    ​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableIndexesList() ​Aggregates and groups the index results according to the required data result.

    [m] _getPortableTableForeignKeyDefinition 

    protected function _getPortableTableForeignKeyDefinition(mixed $tableForeignKey): Doctrine\DBAL\Schema\ForeignKeyConstraint
    Parameter
    type name summary
    ​mixed ​$tableForeignKey ​
    Return
    type summary
    ​ForeignKeyConstraint ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableForeignKeyDefinition() ​

    [m] _getPortableTableDefinition 

    protected function _getPortableTableDefinition(mixed $table): string
    Parameter
    type name summary
    ​mixed ​$table ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableTableDefinition() ​

    [m] _getPortableDatabaseDefinition 

    protected function _getPortableDatabaseDefinition(mixed $database): mixed
    Parameter
    type name summary
    ​mixed ​$database ​
    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableDatabaseDefinition() ​

    [m] getPortableNamespaceDefinition Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition.

    deprecated

    Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition. 
    protected function getPortableNamespaceDefinition(array $namespace): mixed
    Parameter
    type name summary
    ​array ​$namespace ​
    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::getPortableNamespaceDefinition() ​Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition.
    See
    type summary
    ​SQLServerSchemaManager::listSchemaNames() ​
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] _getPortableViewDefinition 

    protected function _getPortableViewDefinition(mixed[] $view): Doctrine\DBAL\Schema\View|false
    Parameter
    type name summary
    ​mixed[] ​$view ​
    Return
    type summary
    ​View|​false ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::_getPortableViewDefinition() ​

    [m] alterTable Alters an existing tables schema.

    Alters an existing tables schema. 
    public function alterTable(Doctrine\DBAL\Schema\TableDiff $tableDiff): void
    Parameter
    type name summary
    ​TableDiff ​$tableDiff ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::alterTable() ​Alters an existing tables schema.

    [m] createComparator 

    public function createComparator(): Doctrine\DBAL\Schema\Comparator
    Return
    type summary
    ​Comparator ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::createComparator() ​

    [m] selectTableNames Selects names of tables in the specified database.

    Selects names of tables in the specified database. 
    protected function selectTableNames(string $databaseName): Doctrine\DBAL\Result
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectTableNames() ​Selects names of tables in the specified database.

    [m] selectTableColumns Selects definitions of table columns in the specified database. If the table name is specified, narrows down

    Selects definitions of table columns in the specified database. If the table name is specified, narrows down 
    protected function selectTableColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectTableColumns() ​Selects definitions of table columns in the specified database. If the table name is specified, narrows down

    [m] selectIndexColumns Selects definitions of index columns in the specified database. If the table name is specified, narrows down

    Selects definitions of index columns in the specified database. If the table name is specified, narrows down 
    protected function selectIndexColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectIndexColumns() ​Selects definitions of index columns in the specified database. If the table name is specified, narrows down

    [m] selectForeignKeyColumns Selects definitions of foreign key columns in the specified database. If the table name is specified,

    Selects definitions of foreign key columns in the specified database. If the table name is specified, 
    protected function selectForeignKeyColumns(
    string $databaseName,
    ?string $tableName = null
): Doctrine\DBAL\Result

    narrows down the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​Result ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::selectForeignKeyColumns() ​Selects definitions of foreign key columns in the specified database. If the table name is specified,

    [m] fetchTableOptionsByTable <tag_inheritdoc data-type='' data-description=''>Fetches table options for the tables in the specified database and returns them grouped by table name.

    Fetches table options for the tables in the specified database and returns them grouped by table name. 
    protected function fetchTableOptionsByTable(
    string $databaseName,
    ?string $tableName = null
): array

    If the table name is specified, narrows down the selection to this table.

    Parameter
    type name summary
    ​string ​$databaseName ​
    ​?string ​$tableName = null ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​override ​AbstractSchemaManager::fetchTableOptionsByTable() ​Fetches table options for the tables in the specified database and returns them grouped by table name.

    [m] __construct 

    public function __construct(
    Doctrine\DBAL\Connection $connection,
    Doctrine\DBAL\Platforms\AbstractPlatform|T $platform
)
    Parameter
    type name summary
    ​Connection ​$connection ​
    ​AbstractPlatform|​T ​$platform ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::__construct() ​

    [m] getDatabasePlatform Returns the associated platform.

    deprecated

    Returns the associated platform. 
    public function getDatabasePlatform(): T
    Return
    type summary
    ​T ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getDatabasePlatform() ​Returns the associated platform.

    [m] tryMethod Tries any method on the schema manager. Normally a method throws an

    deprecated

    Tries any method on the schema manager. Normally a method throws an 
    public function tryMethod(): mixed

    exception when your DBMS doesn't support it or if an error occurs. This method allows you to try and method on your SchemaManager instance and will return false if it does not work or is not supported.

    $result = $sm->tryMethod('dropView', 'view_name');

    Return
    type summary
    ​mixed ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::tryMethod() ​Tries any method on the schema manager. Normally a method throws an

    [m] listDatabases Lists the available databases for this connection.

    Lists the available databases for this connection. 
    public function listDatabases(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listDatabases() ​Lists the available databases for this connection.

    [m] listNamespaceNames Returns a list of all namespaces in the current database.

    deprecated

    Returns a list of all namespaces in the current database. 
    public function listNamespaceNames(): string[]
    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listNamespaceNames() ​Returns a list of all namespaces in the current database.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] listSequences Lists the available sequences for this connection.

    Lists the available sequences for this connection. 
    public function listSequences(string|null $database = null): Doctrine\DBAL\Schema\Sequence[]
    Parameter
    type name summary
    ​string|​null ​$database = null ​
    Return
    type summary
    ​Sequence[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listSequences() ​Lists the available sequences for this connection.

    [m] doListTableColumns 

    protected function doListTableColumns(
    string $table,
    string|null $database = null
): array|Doctrine\DBAL\Schema\Column[]
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​array|​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableColumns() ​

    [m] doListTableIndexes 

    protected function doListTableIndexes(string $table): array|Doctrine\DBAL\Schema\Index[]
    Parameter
    type name summary
    ​string ​$table ​
    Return
    type summary
    ​array|​Index[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableIndexes() ​

    [m] tablesExist Returns true if all the given tables exist.

    Returns true if all the given tables exist. 
    public function tablesExist(string|string[] $names): bool

    The usage of a string $tableNames is deprecated. Pass a one-element array instead.

    Parameter
    type name summary
    ​string|​string[] ​$names ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::tablesExist() ​Returns true if all the given tables exist.

    [m] doListTableNames 

    protected function doListTableNames(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableNames() ​

    [m] filterAssetNames Filters asset names if they are configured to return only a subset of all

    Filters asset names if they are configured to return only a subset of all 
    protected function filterAssetNames(mixed[] $assetNames): mixed[]

    the found elements.

    Parameter
    type name summary
    ​mixed[] ​$assetNames ​
    Return
    type summary
    ​mixed[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::filterAssetNames() ​Filters asset names if they are configured to return only a subset of all

    [m] doListTables 

    protected function doListTables(): array|list
    Return
    type summary
    ​array|​list ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTables() ​

    [m] doListTableDetails 

    protected function doListTableDetails(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableDetails() ​

    [m] normalizeName An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted.

    An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted. 
    protected function normalizeName(string $name): string

    Such platforms should convert a possibly quoted name into a value of the corresponding case.

    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::normalizeName() ​An extension point for those platforms where case sensitivity of the object name depends on whether it's quoted.

    [m] fetchTableColumnsByTable Fetches definitions of table columns in the specified database and returns them grouped by table name.

    Fetches definitions of table columns in the specified database and returns them grouped by table name. 
    protected function fetchTableColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchTableColumnsByTable() ​Fetches definitions of table columns in the specified database and returns them grouped by table name.

    [m] fetchIndexColumnsByTable Fetches definitions of index columns in the specified database and returns them grouped by table name.

    Fetches definitions of index columns in the specified database and returns them grouped by table name. 
    protected function fetchIndexColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchIndexColumnsByTable() ​Fetches definitions of index columns in the specified database and returns them grouped by table name.

    [m] fetchForeignKeyColumnsByTable Fetches definitions of foreign key columns in the specified database and returns them grouped by table name.

    Fetches definitions of foreign key columns in the specified database and returns them grouped by table name. 
    protected function fetchForeignKeyColumnsByTable(string $databaseName): array
    Parameter
    type name summary
    ​string ​$databaseName ​
    Return
    type summary
    ​array ​list<array<string, mixed>>>
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::fetchForeignKeyColumnsByTable() ​Fetches definitions of foreign key columns in the specified database and returns them grouped by table name.

    [m] introspectTable Introspects the table with the given name.

    Introspects the table with the given name. 
    public function introspectTable(string $name): Doctrine\DBAL\Schema\Table
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Table ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::introspectTable() ​Introspects the table with the given name.

    [m] listViews Lists the views this connection has.

    Lists the views this connection has. 
    public function listViews(): Doctrine\DBAL\Schema\View[]
    Return
    type summary
    ​View[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::listViews() ​Lists the views this connection has.

    [m] doListTableForeignKeys 

    protected function doListTableForeignKeys(
    string $table,
    string|null $database = null
): array|Doctrine\DBAL\Schema\ForeignKeyConstraint[]
    Parameter
    type name summary
    ​string ​$table ​
    ​string|​null ​$database = null ​
    Return
    type summary
    ​array|​ForeignKeyConstraint[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::doListTableForeignKeys() ​

    [m] dropDatabase Drops a database.

    Drops a database. 
    public function dropDatabase(string $database): void

    NOTE: You can not drop the database this SchemaManager is currently connected to.

    Parameter
    type name summary
    ​string ​$database ​The name of the database to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropDatabase() ​Drops a database.

    [m] dropSchema Drops a schema.

    Drops a schema. 
    public function dropSchema(string $schemaName)
    Parameter
    type name summary
    ​string ​$schemaName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSchema() ​Drops a schema.

    [m] dropTable Drops the given table.

    Drops the given table. 
    public function dropTable(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the table to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropTable() ​Drops the given table.

    [m] dropIndex Drops the index from the given table.

    Drops the index from the given table. 
    public function dropIndex(
    Doctrine\DBAL\Schema\Index|string $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index|​string ​$index ​The name of the index.
    ​Table|​string ​$table ​The name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropIndex() ​Drops the index from the given table.

    [m] dropConstraint Drops the constraint from the given table.

    deprecated

    Drops the constraint from the given table. 
    public function dropConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​The name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropConstraint() ​Drops the constraint from the given table.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::dropForeignKey() ​
    ​AbstractSchemaManager::dropUniqueConstraint() ​

    [m] dropForeignKey Drops a foreign key from a table.

    Drops a foreign key from a table. 
    public function dropForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint|string $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint|​string ​$foreignKey ​The name of the foreign key.
    ​Table|​string ​$table ​The name of the table with the foreign key.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropForeignKey() ​Drops a foreign key from a table.

    [m] dropSequence Drops a sequence with a given name.

    Drops a sequence with a given name. 
    public function dropSequence(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the sequence to drop.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSequence() ​Drops a sequence with a given name.

    [m] dropUniqueConstraint Drops the unique constraint from the given table.

    Drops the unique constraint from the given table. 
    public function dropUniqueConstraint(
    string $name,
    string $tableName
)
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$tableName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropUniqueConstraint() ​Drops the unique constraint from the given table.

    [m] dropView Drops a view.

    Drops a view. 
    public function dropView(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The name of the view.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropView() ​Drops a view.

    [m] createSchemaObjects 

    public function createSchemaObjects(Doctrine\DBAL\Schema\Schema $schema)
    Parameter
    type name summary
    ​Schema ​$schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchemaObjects() ​

    [m] createDatabase Creates a new database.

    Creates a new database. 
    public function createDatabase(string $database): void
    Parameter
    type name summary
    ​string ​$database ​The name of the database to create.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createDatabase() ​Creates a new database.

    [m] createTable Creates a new table.

    Creates a new table. 
    public function createTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createTable() ​Creates a new table.

    [m] createSequence Creates a new sequence.

    Creates a new sequence. 
    public function createSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSequence() ​Creates a new sequence.

    [m] createConstraint Creates a constraint on a table.

    deprecated

    Creates a constraint on a table. 
    public function createConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createConstraint() ​Creates a constraint on a table.
    See
    type summary
    ​AbstractSchemaManager::createIndex() ​
    ​AbstractSchemaManager::createForeignKey() ​
    ​AbstractSchemaManager::createUniqueConstraint() ​

    [m] createIndex Creates a new index on a table.

    Creates a new index on a table. 
    public function createIndex(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createIndex() ​Creates a new index on a table.

    [m] createForeignKey Creates a new foreign key.

    Creates a new foreign key. 
    public function createForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​The ForeignKey instance.
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createForeignKey() ​Creates a new foreign key.

    [m] createUniqueConstraint Creates a unique constraint on a table.

    Creates a unique constraint on a table. 
    public function createUniqueConstraint(
    Doctrine\DBAL\Schema\UniqueConstraint $uniqueConstraint,
    string $tableName
)
    Parameter
    type name summary
    ​UniqueConstraint ​$uniqueConstraint ​
    ​string ​$tableName ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createUniqueConstraint() ​Creates a unique constraint on a table.

    [m] createView Creates a new view.

    Creates a new view. 
    public function createView(Doctrine\DBAL\Schema\View $view): void
    Parameter
    type name summary
    ​View ​$view ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createView() ​Creates a new view.

    [m] dropSchemaObjects 

    public function dropSchemaObjects(Doctrine\DBAL\Schema\Schema $schema)
    Parameter
    type name summary
    ​Schema ​$schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropSchemaObjects() ​

    [m] dropAndCreateConstraint Drops and creates a constraint.

    deprecated

    Drops and creates a constraint. 
    public function dropAndCreateConstraint(
    Doctrine\DBAL\Schema\Constraint $constraint,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Constraint ​$constraint ​
    ​Table|​string ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateConstraint() ​Drops and creates a constraint.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::createIndex() ​
    ​AbstractSchemaManager::createForeignKey() ​
    ​AbstractSchemaManager::createUniqueConstraint() ​
    ​AbstractSchemaManager::dropConstraint() ​
    ​AbstractSchemaManager::createConstraint() ​

    [m] dropAndCreateIndex Drops and creates a new index on a table.

    deprecated

    Drops and creates a new index on a table. 
    public function dropAndCreateIndex(
    Doctrine\DBAL\Schema\Index $index,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​Index ​$index ​
    ​Table|​string ​$table ​The name of the table on which the index is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateIndex() ​Drops and creates a new index on a table.
    See
    type summary
    ​AbstractSchemaManager::dropIndex() ​
    ​AbstractSchemaManager::createIndex() ​

    [m] dropAndCreateForeignKey Drops and creates a new foreign key.

    deprecated

    Drops and creates a new foreign key. 
    public function dropAndCreateForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey,
    Doctrine\DBAL\Schema\Table|string $table
): void
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$foreignKey ​An associative array that defines properties
    ​Table|​string ​$table ​The name of the table on which the foreign key is to be created.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateForeignKey() ​Drops and creates a new foreign key.
    See
    type summary
    ​AbstractSchemaManager::dropForeignKey() ​
    ​AbstractSchemaManager::createForeignKey() ​

    [m] dropAndCreateSequence Drops and create a new sequence.

    deprecated

    Drops and create a new sequence. 
    public function dropAndCreateSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateSequence() ​Drops and create a new sequence.
    See
    type summary
    ​AbstractSchemaManager::dropSequence() ​
    ​AbstractSchemaManager::createSequence() ​

    [m] dropAndCreateTable Drops and creates a new table.

    deprecated

    Drops and creates a new table. 
    public function dropAndCreateTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateTable() ​Drops and creates a new table.
    See
    type summary
    ​AbstractSchemaManager::dropTable() ​
    ​AbstractSchemaManager::createTable() ​

    [m] dropAndCreateDatabase Drops and creates a new database.

    deprecated

    Drops and creates a new database. 
    public function dropAndCreateDatabase(string $database): void
    Parameter
    type name summary
    ​string ​$database ​The name of the database to create.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateDatabase() ​Drops and creates a new database.
    See
    type summary
    ​AbstractSchemaManager::dropDatabase() ​
    ​AbstractSchemaManager::createDatabase() ​

    [m] dropAndCreateView Drops and creates a new view.

    deprecated

    Drops and creates a new view. 
    public function dropAndCreateView(Doctrine\DBAL\Schema\View $view): void
    Parameter
    type name summary
    ​View ​$view ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::dropAndCreateView() ​Drops and creates a new view.
    See
    type summary
    ​AbstractSchemaManager::dropView() ​
    ​AbstractSchemaManager::createView() ​

    [m] alterSchema Alters an existing schema.

    Alters an existing schema. 
    public function alterSchema(Doctrine\DBAL\Schema\SchemaDiff $schemaDiff)
    Parameter
    type name summary
    ​SchemaDiff ​$schemaDiff ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::alterSchema() ​Alters an existing schema.

    [m] migrateSchema Migrates an existing schema to a new schema.

    Migrates an existing schema to a new schema. 
    public function migrateSchema(Doctrine\DBAL\Schema\Schema $toSchema)
    Parameter
    type name summary
    ​Schema ​$toSchema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::migrateSchema() ​Migrates an existing schema to a new schema.

    [m] renameTable Renames a given table to another name.

    Renames a given table to another name. 
    public function renameTable(
    string $name,
    string $newName
): void
    Parameter
    type name summary
    ​string ​$name ​The current name of the table.
    ​string ​$newName ​The new name of the table.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::renameTable() ​Renames a given table to another name.

    [m] _getPortableDatabasesList 

    protected function _getPortableDatabasesList(mixed[] $databases): string[]
    Parameter
    type name summary
    ​mixed[] ​$databases ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableDatabasesList() ​

    [m] getPortableNamespacesList Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition.

    deprecated

    Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition. 
    protected function getPortableNamespacesList(array $namespaces): string[]
    Parameter
    type name summary
    ​array ​$namespaces ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getPortableNamespacesList() ​Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition.
    See
    type summary
    ​AbstractSchemaManager::listSchemaNames() ​

    [m] _getPortableSequencesList 

    protected function _getPortableSequencesList(mixed[][] $sequences): Doctrine\DBAL\Schema\Sequence[]
    Parameter
    type name summary
    ​mixed[][] ​$sequences ​
    Return
    type summary
    ​Sequence[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableSequencesList() ​

    [m] _getPortableTableColumnList Independent of the database the keys of the column list result are lowercased.

    Independent of the database the keys of the column list result are lowercased. 
    protected function _getPortableTableColumnList(
    string $table,
    string $database,
    mixed[][] $tableColumns
): Doctrine\DBAL\Schema\Column[]

    The name of the created column instance however is kept in its case.

    Parameter
    type name summary
    ​string ​$table ​The name of the table.
    ​string ​$database ​
    ​mixed[][] ​$tableColumns ​
    Return
    type summary
    ​Column[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableTableColumnList() ​Independent of the database the keys of the column list result are lowercased.

    [m] _getPortableTablesList 

    protected function _getPortableTablesList(mixed[][] $tables): string[]
    Parameter
    type name summary
    ​mixed[][] ​$tables ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableTablesList() ​

    [m] _getPortableViewsList 

    protected function _getPortableViewsList(mixed[][] $views): Doctrine\DBAL\Schema\View[]
    Parameter
    type name summary
    ​mixed[][] ​$views ​
    Return
    type summary
    ​View[] ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_getPortableViewsList() ​

    [m] _execSql 

    protected function _execSql(string[]|string $sql): void
    Parameter
    type name summary
    ​string[]|​string ​$sql ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::_execSql() ​

    [m] createSchema Creates a schema instance for the current database.

    deprecated

    Creates a schema instance for the current database. 
    public function createSchema(): Doctrine\DBAL\Schema\Schema
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchema() ​Creates a schema instance for the current database.

    [m] introspectSchema Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema.

    Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema. 
    public function introspectSchema(): Doctrine\DBAL\Schema\Schema
    Return
    type summary
    ​Schema ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::introspectSchema() ​Returns a Doctrine\DBAL\Schema\Schema instance representing the current database schema.
    See
    type summary
    ​Schema ​

    [m] createSchemaConfig Creates the configuration for this schema.

    Creates the configuration for this schema. 
    public function createSchemaConfig(): Doctrine\DBAL\Schema\SchemaConfig
    Return
    type summary
    ​SchemaConfig ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::createSchemaConfig() ​Creates the configuration for this schema.

    [m] getSchemaSearchPaths The search path for namespaces in the currently connected database.

    deprecated

    The search path for namespaces in the currently connected database. 
    public function getSchemaSearchPaths(): string[]

    The first entry is usually the default namespace in the Schema. All further namespaces contain tables/sequences which can also be addressed with a short, not full-qualified name.

    For databases that don't support subschema/namespaces this method returns the name of the currently connected database.

    Return
    type summary
    ​string[] ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::getSchemaSearchPaths() ​The search path for namespaces in the currently connected database.

    [m] extractDoctrineTypeFromComment Given a table comment this method tries to extract a typehint for Doctrine Type, or returns

    Given a table comment this method tries to extract a typehint for Doctrine Type, or returns 
    public function extractDoctrineTypeFromComment(
    string|null $comment,
    string $currentType
): string

    the type given as default.

    Parameter
    type name summary
    ​string|​null ​$comment ​
    ​string ​$currentType ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::extractDoctrineTypeFromComment() ​Given a table comment this method tries to extract a typehint for Doctrine Type, or returns

    [m] removeDoctrineTypeFromComment 

    public function removeDoctrineTypeFromComment(
    string|null $comment,
    string|null $type
): string|null
    Parameter
    type name summary
    ​string|​null ​$comment ​
    ​string|​null ​$type ​
    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractSchemaManager::removeDoctrineTypeFromComment() ​

    [C] View Representation of a Database View.

    Representation of a Database View.

    Hierarchy

    Parents
    type summary
    ​AbstractAsset ​The abstract asset allows to reset the name of all assets without publishing this to the public userland.

    [p] $_name 

    protected string $_name = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_name ​

    [p] $_namespace Namespace of the asset. If none isset the default namespace is assumed.

    Namespace of the asset. If none isset the default namespace is assumed. 
    protected string|null $_namespace = null

    Type: string|​null

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_namespace ​Namespace of the asset. If none isset the default namespace is assumed.

    [p] $_quoted 

    protected bool $_quoted = false

    Type: bool

    Prototype
    kind source summary
    ​inherit ​AbstractAsset::$_quoted ​

    [m] __construct 

    public function __construct(
    string $name,
    string $sql
)
    Parameter
    type name summary
    ​string ​$name ​
    ​string ​$sql ​

    [m] getSql 

    public function getSql(): string
    Return
    type summary
    ​string ​

    [m] _setName Sets the name of this asset.

    Sets the name of this asset. 
    protected function _setName(string $name): void
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​void ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_setName() ​Sets the name of this asset.

    [m] isInDefaultNamespace Is this asset in the default namespace?

    Is this asset in the default namespace? 
    public function isInDefaultNamespace(string $defaultNamespaceName): bool
    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isInDefaultNamespace() ​Is this asset in the default namespace?

    [m] getNamespaceName Gets the namespace name of this asset.

    Gets the namespace name of this asset. 
    public function getNamespaceName(): string|null

    If NULL is returned this means the default namespace is used.

    Return
    type summary
    ​string|​null ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getNamespaceName() ​Gets the namespace name of this asset.

    [m] getShortestName The shortest name is stripped of the default namespace. All other

    The shortest name is stripped of the default namespace. All other 
    public function getShortestName(string|null $defaultNamespaceName): string

    namespaced elements are returned as full-qualified names.

    Parameter
    type name summary
    ​string|​null ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getShortestName() ​The shortest name is stripped of the default namespace. All other

    [m] getFullQualifiedName The normalized name is full-qualified and lower-cased. Lower-casing is

    deprecated

    The normalized name is full-qualified and lower-cased. Lower-casing is 
    public function getFullQualifiedName(string $defaultNamespaceName): string

    actually wrong, but we have to do it to keep our sanity. If you are using database objects that only differentiate in the casing (FOO vs Foo) then you will NOT be able to use Doctrine Schema abstraction.

    Every non-namespaced element is prefixed with the default namespace name which is passed as argument to this method.

    Parameter
    type name summary
    ​string ​$defaultNamespaceName ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getFullQualifiedName() ​The normalized name is full-qualified and lower-cased. Lower-casing is
    See
    type summary
    ​AbstractAsset::getNamespaceName() ​
    ​AbstractAsset::getName() ​

    [m] isQuoted Checks if this asset's name is quoted.

    Checks if this asset's name is quoted. 
    public function isQuoted(): bool
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isQuoted() ​Checks if this asset's name is quoted.

    [m] isIdentifierQuoted Checks if this identifier is quoted.

    Checks if this identifier is quoted. 
    protected function isIdentifierQuoted(string $identifier): bool
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::isIdentifierQuoted() ​Checks if this identifier is quoted.

    [m] trimQuotes Trim quotes from the identifier.

    Trim quotes from the identifier. 
    protected function trimQuotes(string $identifier): string
    Parameter
    type name summary
    ​string ​$identifier ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::trimQuotes() ​Trim quotes from the identifier.

    [m] getName Returns the name of this schema asset.

    Returns the name of this schema asset. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getName() ​Returns the name of this schema asset.

    [m] getQuotedName Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    Gets the quoted representation of this asset but only if it was defined with one. Otherwise 
    public function getQuotedName(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string

    return the plain unquoted value as inserted.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::getQuotedName() ​Gets the quoted representation of this asset but only if it was defined with one. Otherwise

    [m] _generateIdentifierName Generates an identifier from a list of column names obeying a certain string length.

    Generates an identifier from a list of column names obeying a certain string length. 
    protected function _generateIdentifierName(
    string[] $columnNames,
    string $prefix = "",
    int $maxSize = 30
): string

    This is especially important for Oracle, since it does not allow identifiers larger than 30 chars, however building idents automatically for foreign keys, composite keys or such can easily create very long names.

    Parameter
    type name summary
    ​string[] ​$columnNames ​
    ​string ​$prefix = "" ​
    ​int ​$maxSize = 30 ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​AbstractAsset::_generateIdentifierName() ​Generates an identifier from a list of column names obeying a certain string length.

    [C] SchemaConfig Configuration for a Schema.

    Configuration for a Schema.

    [p] $hasExplicitForeignKeyIndexes

    deprecated 

    protected bool $hasExplicitForeignKeyIndexes = false

    Type: bool

    [p] $maxIdentifierLength 

    protected int $maxIdentifierLength = 63

    Type: int

    [p] $name 

    protected string|null $name = null

    Type: string|​null

    [p] $defaultTableOptions 

    protected mixed[] $defaultTableOptions = []

    Type: mixed[]

    [m] hasExplicitForeignKeyIndexes

    deprecated 

    public function hasExplicitForeignKeyIndexes(): bool
    Return
    type summary
    ​bool ​

    [m] setExplicitForeignKeyIndexes

    deprecated 

    public function setExplicitForeignKeyIndexes(bool $flag): void
    Parameter
    type name summary
    ​bool ​$flag ​
    Return
    type summary
    ​void ​

    [m] setMaxIdentifierLength 

    public function setMaxIdentifierLength(int $length): void
    Parameter
    type name summary
    ​int ​$length ​
    Return
    type summary
    ​void ​

    [m] getMaxIdentifierLength 

    public function getMaxIdentifierLength(): int
    Return
    type summary
    ​int ​

    [m] getName Gets the default namespace of schema objects.

    Gets the default namespace of schema objects. 
    public function getName(): string|null
    Return
    type summary
    ​string|​null ​

    [m] setName Sets the default namespace name of schema objects.

    Sets the default namespace name of schema objects. 
    public function setName(string $name): void
    Parameter
    type name summary
    ​string ​$name ​The value to set.
    Return
    type summary
    ​void ​

    [m] getDefaultTableOptions Gets the default options that are passed to Table instances created with

    Gets the default options that are passed to Table instances created with 
    public function getDefaultTableOptions(): mixed[]

    Schema#createTable().

    Return
    type summary
    ​mixed[] ​

    [m] setDefaultTableOptions 

    public function setDefaultTableOptions(array|mixed[] $defaultTableOptions): void
    Parameter
    type name summary
    ​array|​mixed[] ​$defaultTableOptions ​
    Return
    type summary
    ​void ​

    [C] Comparator Compares two Schemas and return an instance of SchemaDiff.

    Compares two Schemas and return an instance of SchemaDiff.

    [m] __construct 

    public function __construct(?Doctrine\DBAL\Platforms\AbstractPlatform $platform = null)
    Parameter
    type name summary
    ​?AbstractPlatform ​$platform = null ​

    [m] __call 

    public function __call(
    string $method,
    array|list $args
): Doctrine\DBAL\Schema\SchemaDiff
    Parameter
    type name summary
    ​string ​$method ​
    ​array|​list ​$args ​
    Return
    type summary
    ​SchemaDiff ​

    [M] __callStatic 

    public static function __callStatic(
    string $method,
    array|list $args
): Doctrine\DBAL\Schema\SchemaDiff
    Parameter
    type name summary
    ​string ​$method ​
    ​array|​list ​$args ​
    Return
    type summary
    ​SchemaDiff ​

    [m] compare

    deprecated 

    public function compare(
    Doctrine\DBAL\Schema\Schema $fromSchema,
    Doctrine\DBAL\Schema\Schema $toSchema
): Doctrine\DBAL\Schema\SchemaDiff
    Parameter
    type name summary
    ​Schema ​$fromSchema ​
    ​Schema ​$toSchema ​
    Return
    type summary
    ​SchemaDiff ​
    Throws
    type summary
    ​SchemaException ​
    See
    type summary
    ​Comparator::compareSchemas() ​

    [m] diffSequence 

    public function diffSequence(
    Doctrine\DBAL\Schema\Sequence $sequence1,
    Doctrine\DBAL\Schema\Sequence $sequence2
): bool
    Parameter
    type name summary
    ​Sequence ​$sequence1 ​
    ​Sequence ​$sequence2 ​
    Return
    type summary
    ​bool ​

    [m] diffTable Returns the difference between the tables $fromTable and $toTable.

    deprecated

    Returns the difference between the tables $fromTable and $toTable. 
    public function diffTable(
    Doctrine\DBAL\Schema\Table $fromTable,
    Doctrine\DBAL\Schema\Table $toTable
): Doctrine\DBAL\Schema\TableDiff|false

    If there are no differences this method returns the boolean false.

    Parameter
    type name summary
    ​Table ​$fromTable ​
    ​Table ​$toTable ​
    Return
    type summary
    ​TableDiff|​false ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​Comparator::compareTables() ​
    ​TableDiff::isEmpty() ​

    [m] compareTables Compares the tables and returns the difference between them.

    Compares the tables and returns the difference between them. 
    public function compareTables(
    Doctrine\DBAL\Schema\Table $fromTable,
    Doctrine\DBAL\Schema\Table $toTable
): Doctrine\DBAL\Schema\TableDiff
    Parameter
    type name summary
    ​Table ​$fromTable ​
    ​Table ​$toTable ​
    Return
    type summary
    ​TableDiff ​
    Throws
    type summary
    ​Exception ​

    [m] diffForeignKey 

    public function diffForeignKey(
    Doctrine\DBAL\Schema\ForeignKeyConstraint $key1,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $key2
): bool
    Parameter
    type name summary
    ​ForeignKeyConstraint ​$key1 ​
    ​ForeignKeyConstraint ​$key2 ​
    Return
    type summary
    ​bool ​
    See
    type summary
    ​Comparator ​

    [m] columnsEqual Compares the definitions of the given columns

    Compares the definitions of the given columns 
    public function columnsEqual(
    Doctrine\DBAL\Schema\Column $column1,
    Doctrine\DBAL\Schema\Column $column2
): bool
    Parameter
    type name summary
    ​Column ​$column1 ​
    ​Column ​$column2 ​
    Return
    type summary
    ​bool ​
    Throws
    type summary
    ​Exception ​
    See
    type summary
    ​Comparator ​

    [m] diffColumn Returns the difference between the columns

    deprecated

    Returns the difference between the columns 
    public function diffColumn(
    Doctrine\DBAL\Schema\Column $column1,
    Doctrine\DBAL\Schema\Column $column2
): string[]

    If there are differences this method returns the changed properties as a string array, otherwise an empty array gets returned.

    Parameter
    type name summary
    ​Column ​$column1 ​
    ​Column ​$column2 ​
    Return
    type summary
    ​string[] ​
    See
    type summary
    ​Comparator::columnsEqual() ​

    [m] diffIndex Finds the difference between the indexes $index1 and $index2.

    Finds the difference between the indexes $index1 and $index2. 
    public function diffIndex(
    Doctrine\DBAL\Schema\Index $index1,
    Doctrine\DBAL\Schema\Index $index2
): bool

    Compares $index1 with $index2 and returns true if there are any differences or false in case there are no differences.

    Parameter
    type name summary
    ​Index ​$index1 ​
    ​Index ​$index2 ​
    Return
    type summary
    ​bool ​
    See
    type summary
    ​Comparator ​

    [m] compareSchemas

    magic

    public function compareSchemas(
    Doctrine\DBAL\Schema\Schema $fromSchema,
    Doctrine\DBAL\Schema\Schema $toSchema
): Doctrine\DBAL\Schema\SchemaDiff
    Parameter
    type name summary
    ​Schema ​$fromSchema ​
    ​Schema ​$toSchema ​
    Return
    type summary
    ​SchemaDiff ​

    [I] Constraint Marker interface for constraints.

    abstractdeprecated

    Marker interface for constraints.

    See
    type summary
    ​ForeignKeyConstraint ​
    ​Index ​
    ​UniqueConstraint ​

    Hierarchy

    [m] getName

    abstract

    abstract public function getName(): string
    Return
    type summary
    ​string ​

    [m] getQuotedName

    abstract

    abstract public function getQuotedName(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​

    [m] getColumns Returns the names of the referencing table columns

    abstract

    Returns the names of the referencing table columns 
    abstract public function getColumns(): string[]

    the constraint is associated with.

    Return
    type summary
    ​string[] ​

    [m] getQuotedColumns Returns the quoted representation of the column names

    abstract

    Returns the quoted representation of the column names 
    abstract public function getQuotedColumns(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string[]

    the constraint is associated with.

    But only if they were defined with one or a column name is a keyword reserved by the platform. Otherwise the plain unquoted value as inserted is returned.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​The platform to use for quotation.
    Return
    type summary
    ​string[] ​

    [I] SchemaManagerFactory Creates a schema manager for the given connection.

    abstract

    Creates a schema manager for the given connection.

    This interface is an extension point for applications that need to override schema managers.

    Hierarchy

    [m] createSchemaManager

    abstract

    abstract public function createSchemaManager(Doctrine\DBAL\Connection $connection): Doctrine\DBAL\Schema\AbstractSchemaManager
    Parameter
    type name summary
    ​Connection ​$connection ​
    Return
    type summary
    ​AbstractSchemaManager ​

    [N] Doctrine\DBAL\Schema\Exception\

    [C] UnknownColumnOption

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(string $name): Doctrine\DBAL\Schema\Exception\UnknownColumnOption
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​UnknownColumnOption ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] ColumnAlreadyExists

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\Exception\ColumnAlreadyExists
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​ColumnAlreadyExists ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] ColumnDoesNotExist

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\Exception\ColumnDoesNotExist
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​ColumnDoesNotExist ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] ForeignKeyDoesNotExist

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(
    string $foreignKeyName,
    string $table
): Doctrine\DBAL\Schema\Exception\ForeignKeyDoesNotExist
    Parameter
    type name summary
    ​string ​$foreignKeyName ​
    ​string ​$table ​
    Return
    type summary
    ​ForeignKeyDoesNotExist ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] IndexAlreadyExists

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\Exception\IndexAlreadyExists
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​IndexAlreadyExists ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] IndexDoesNotExist

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\Exception\IndexDoesNotExist
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​IndexDoesNotExist ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] IndexNameInvalid

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(string $indexName): Doctrine\DBAL\Schema\Exception\IndexNameInvalid
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​IndexNameInvalid ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] NamedForeignKeyRequired

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\Exception\NamedForeignKeyRequired
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​NamedForeignKeyRequired ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] InvalidTableName

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(string $tableName): Doctrine\DBAL\Schema\Exception\InvalidTableName
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​InvalidTableName ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] NamespaceAlreadyExists

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(string $namespaceName): Doctrine\DBAL\Schema\Exception\NamespaceAlreadyExists
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​NamespaceAlreadyExists ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] SequenceAlreadyExists

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(string $sequenceName): Doctrine\DBAL\Schema\Exception\SequenceAlreadyExists
    Parameter
    type name summary
    ​string ​$sequenceName ​
    Return
    type summary
    ​SequenceAlreadyExists ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] SequenceDoesNotExist

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(string $sequenceName): Doctrine\DBAL\Schema\Exception\SequenceDoesNotExist
    Parameter
    type name summary
    ​string ​$sequenceName ​
    Return
    type summary
    ​SequenceDoesNotExist ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] TableAlreadyExists

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(string $tableName): Doctrine\DBAL\Schema\Exception\TableAlreadyExists
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​TableAlreadyExists ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] TableDoesNotExist

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(string $tableName): Doctrine\DBAL\Schema\Exception\TableDoesNotExist
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​TableDoesNotExist ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [C] UniqueConstraintDoesNotExist

    final

    Hierarchy

    Parents
    type summary
    ​SchemaException ​
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Throwable ​
    ​Stringable ​

    [C] TABLE_DOESNT_EXIST

    deprecated 

    public const int TABLE_DOESNT_EXIST = 10
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_DOESNT_EXIST ​
    See
    type summary
    ​TableDoesNotExist ​

    [C] TABLE_ALREADY_EXISTS

    deprecated 

    public const int TABLE_ALREADY_EXISTS = 20
    Prototype
    kind source summary
    ​inherit ​SchemaException::TABLE_ALREADY_EXISTS ​
    See
    type summary
    ​TableAlreadyExists ​

    [C] COLUMN_DOESNT_EXIST

    deprecated 

    public const int COLUMN_DOESNT_EXIST = 30
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_DOESNT_EXIST ​
    See
    type summary
    ​ColumnDoesNotExist ​

    [C] COLUMN_ALREADY_EXISTS

    deprecated 

    public const int COLUMN_ALREADY_EXISTS = 40
    Prototype
    kind source summary
    ​inherit ​SchemaException::COLUMN_ALREADY_EXISTS ​
    See
    type summary
    ​ColumnAlreadyExists ​

    [C] INDEX_DOESNT_EXIST

    deprecated 

    public const int INDEX_DOESNT_EXIST = 50
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_DOESNT_EXIST ​
    See
    type summary
    ​IndexDoesNotExist ​

    [C] INDEX_ALREADY_EXISTS

    deprecated 

    public const int INDEX_ALREADY_EXISTS = 60
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_ALREADY_EXISTS ​
    See
    type summary
    ​IndexAlreadyExists ​

    [C] SEQUENCE_DOENST_EXIST

    deprecated 

    public const int SEQUENCE_DOENST_EXIST = 70
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_DOENST_EXIST ​
    See
    type summary
    ​SequenceDoesNotExist ​

    [C] SEQUENCE_ALREADY_EXISTS

    deprecated 

    public const int SEQUENCE_ALREADY_EXISTS = 80
    Prototype
    kind source summary
    ​inherit ​SchemaException::SEQUENCE_ALREADY_EXISTS ​
    See
    type summary
    ​SequenceAlreadyExists ​

    [C] INDEX_INVALID_NAME

    deprecated 

    public const int INDEX_INVALID_NAME = 90
    Prototype
    kind source summary
    ​inherit ​SchemaException::INDEX_INVALID_NAME ​
    See
    type summary
    ​IndexNameInvalid ​

    [C] FOREIGNKEY_DOESNT_EXIST

    deprecated 

    public const int FOREIGNKEY_DOESNT_EXIST = 100
    Prototype
    kind source summary
    ​inherit ​SchemaException::FOREIGNKEY_DOESNT_EXIST ​
    See
    type summary
    ​ForeignKeyDoesNotExist ​

    [C] CONSTRAINT_DOESNT_EXIST

    deprecated 

    public const int CONSTRAINT_DOESNT_EXIST = 110
    Prototype
    kind source summary
    ​inherit ​SchemaException::CONSTRAINT_DOESNT_EXIST ​
    See
    type summary
    ​UniqueConstraintDoesNotExist ​

    [C] NAMESPACE_ALREADY_EXISTS

    deprecated 

    public const int NAMESPACE_ALREADY_EXISTS = 120
    Prototype
    kind source summary
    ​inherit ​SchemaException::NAMESPACE_ALREADY_EXISTS ​
    See
    type summary
    ​NamespaceAlreadyExists ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] new 

    public static function new(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\Exception\UniqueConstraintDoesNotExist
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​UniqueConstraintDoesNotExist ​

    [M] tableDoesNotExist 

    public static function tableDoesNotExist(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableDoesNotExist() ​

    [M] indexNameInvalid 

    public static function indexNameInvalid(string $indexName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexNameInvalid() ​

    [M] indexDoesNotExist 

    public static function indexDoesNotExist(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexDoesNotExist() ​

    [M] indexAlreadyExists 

    public static function indexAlreadyExists(
    string $indexName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$indexName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::indexAlreadyExists() ​

    [M] columnDoesNotExist 

    public static function columnDoesNotExist(
    string $columnName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$columnName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnDoesNotExist() ​

    [M] namespaceAlreadyExists 

    public static function namespaceAlreadyExists(string $namespaceName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$namespaceName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namespaceAlreadyExists() ​

    [M] tableAlreadyExists 

    public static function tableAlreadyExists(string $tableName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::tableAlreadyExists() ​

    [M] columnAlreadyExists 

    public static function columnAlreadyExists(
    string $tableName,
    string $columnName
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$tableName ​
    ​string ​$columnName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::columnAlreadyExists() ​

    [M] sequenceAlreadyExists 

    public static function sequenceAlreadyExists(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceAlreadyExists() ​

    [M] sequenceDoesNotExist 

    public static function sequenceDoesNotExist(string $name): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::sequenceDoesNotExist() ​

    [M] uniqueConstraintDoesNotExist 

    public static function uniqueConstraintDoesNotExist(
    string $constraintName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$constraintName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::uniqueConstraintDoesNotExist() ​

    [M] foreignKeyDoesNotExist 

    public static function foreignKeyDoesNotExist(
    string $fkName,
    string $table
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$fkName ​
    ​string ​$table ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::foreignKeyDoesNotExist() ​

    [M] namedForeignKeyRequired 

    public static function namedForeignKeyRequired(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey
): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$foreignKey ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::namedForeignKeyRequired() ​

    [M] alterTableChangeNotSupported 

    public static function alterTableChangeNotSupported(string $changeName): Doctrine\DBAL\Schema\SchemaException
    Parameter
    type name summary
    ​string ​$changeName ​
    Return
    type summary
    ​SchemaException ​
    Prototype
    kind source summary
    ​inherit ​SchemaException::alterTableChangeNotSupported() ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [N] Doctrine\DBAL\Schema\Visitor\

    [I] Visitor Schema Visitor used for Validation or Generation purposes.

    abstractdeprecated

    Schema Visitor used for Validation or Generation purposes.

    [m] acceptSchema

    abstract

    abstract public function acceptSchema(Doctrine\DBAL\Schema\Schema $schema): void
    Parameter
    type name summary
    ​Schema ​$schema ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​SchemaException ​

    [m] acceptTable

    abstract

    abstract public function acceptTable(Doctrine\DBAL\Schema\Table $table): void
    Parameter
    type name summary
    ​Table ​$table ​
    Return
    type summary
    ​void ​

    [m] acceptColumn

    abstract

    abstract public function acceptColumn(
    Doctrine\DBAL\Schema\Table $table,
    Doctrine\DBAL\Schema\Column $column
): void
    Parameter
    type name summary
    ​Table ​$table ​
    ​Column ​$column ​
    Return
    type summary
    ​void ​

    [m] acceptForeignKey

    abstract

    abstract public function acceptForeignKey(
    Doctrine\DBAL\Schema\Table $localTable,
    Doctrine\DBAL\Schema\ForeignKeyConstraint $fkConstraint
): void
    Parameter
    type name summary
    ​Table ​$localTable ​
    ​ForeignKeyConstraint ​$fkConstraint ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​SchemaException ​

    [m] acceptIndex

    abstract

    abstract public function acceptIndex(
    Doctrine\DBAL\Schema\Table $table,
    Doctrine\DBAL\Schema\Index $index
): void
    Parameter
    type name summary
    ​Table ​$table ​
    ​Index ​$index ​
    Return
    type summary
    ​void ​

    [m] acceptSequence

    abstract

    abstract public function acceptSequence(Doctrine\DBAL\Schema\Sequence $sequence): void
    Parameter
    type name summary
    ​Sequence ​$sequence ​
    Return
    type summary
    ​void ​

    [I] NamespaceVisitor Visitor that can visit schema namespaces.

    abstractdeprecated

    Visitor that can visit schema namespaces.

    [m] acceptNamespace Accepts a schema namespace name.

    abstract

    Accepts a schema namespace name. 
    abstract public function acceptNamespace(string $namespaceName): void
    Parameter
    type name summary
    ​string ​$namespaceName ​The schema namespace name to accept.
    Return
    type summary
    ​void ​

    [N] Doctrine\DBAL\Tools\

    [C] DsnParser

    final

    [m] __construct 

    public function __construct(array $schemeMapping = [])
    Parameter
    type name summary
    ​array ​$schemeMapping = [] ​

    [m] parse 

    public function parse(string $dsn): array
    Parameter
    type name summary
    ​
    string    		 ​$dsn ​
    Return
    type summary
    ​array ​
    Throws
    type summary
    ​MalformedDsnException ​

    [N] Doctrine\DBAL\Types\

    [C] Type The base class for so-called Doctrine mapping types.

    abstract

    The base class for so-called Doctrine mapping types.

    A Type object is obtained by calling the static Doctrine\DBAL\Types\Type::getType() method.

    See
    type summary
    ​Type::getType() ​

    Hierarchy

    [m] __construct

    final

    final public function __construct()
    See
    type summary
    ​Type::addType() ​

    [m] convertToDatabaseValue Converts a value from its PHP representation to its database representation

    Converts a value from its PHP representation to its database representation 
    public function convertToDatabaseValue(
    mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): mixed

    of this type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​mixed ​The database representation of the value.
    Throws
    type summary
    ​ConversionException ​

    [m] convertToPHPValue Converts a value from its database representation to its PHP representation

    Converts a value from its database representation to its PHP representation 
    public function convertToPHPValue(
    mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): mixed

    of this type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​mixed ​The PHP representation of the value.
    Throws
    type summary
    ​ConversionException ​

    [m] getSQLDeclaration Gets the SQL declaration snippet for a column of this type.

    abstract

    Gets the SQL declaration snippet for a column of this type. 
    abstract public function getSQLDeclaration(
    array|mixed[] $column,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​string ​

    [m] getName Gets the name of this type.

    abstractdeprecated

    Gets the name of this type. 
    abstract public function getName(): string
    Return
    type summary
    ​string ​

    [M] getTypeRegistry

    final

    final public static function getTypeRegistry(): Doctrine\DBAL\Types\TypeRegistry
    Return
    type summary
    ​TypeRegistry ​

    [M] getType Factory method to create type instances.

    Factory method to create type instances. 
    public static function getType(string $name): Doctrine\DBAL\Types\Type

    Type instances are implemented as flyweights.

    Parameter
    type name summary
    ​string ​$name ​The name of the type (as returned by getName()).
    Return
    type summary
    ​Type ​
    Throws
    type summary
    ​Exception ​

    [M] lookupName Finds a name for the given type.

    Finds a name for the given type. 
    public static function lookupName(Doctrine\DBAL\Types\Type $type): string
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​

    [M] addType Adds a custom type to the type map.

    Adds a custom type to the type map. 
    public static function addType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​The name of the type. This should correspond to what getName() returns.
    ​class-string ​$className ​The class name of the custom type.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [M] hasType Checks if exists support for a type.

    Checks if exists support for a type. 
    public static function hasType(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​The name of the type.
    Return
    type summary
    ​bool ​TRUE if type is supported; FALSE otherwise.

    [M] overrideType Overrides an already defined type to use a different implementation.

    Overrides an already defined type to use a different implementation. 
    public static function overrideType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​
    ​class-string ​$className ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​

    [m] getBindingType Gets the (preferred) binding type for values of this type that

    Gets the (preferred) binding type for values of this type that 
    public function getBindingType(): int

    can be used when binding parameters to prepared statements.

    This method should return one of the Doctrine\DBAL\ParameterType constants.

    Return
    type summary
    ​int ​
    See
    type summary
    ​ParameterType ​

    [M] getTypesMap Gets the types array map which holds all registered types and the corresponding

    Gets the types array map which holds all registered types and the corresponding 
    public static function getTypesMap(): array

    type class

    Return
    type summary
    ​array ​string>

    [m] canRequireSQLConversion Does working with this column require SQL conversion functions?

    deprecated

    Does working with this column require SQL conversion functions? 
    public function canRequireSQLConversion(): bool

    This is a metadata function that is required for example in the ORM. Usage of convertToDatabaseValueSQL and convertToPHPValueSQL works for any type and mostly does nothing. This method can additionally be used for optimization purposes.

    Return
    type summary
    ​bool ​
    See
    type summary
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​

    [m] convertToDatabaseValueSQL Modifies the SQL expression (identifier, parameter) to convert to a database value.

    Modifies the SQL expression (identifier, parameter) to convert to a database value. 
    public function convertToDatabaseValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​

    [m] convertToPHPValueSQL Modifies the SQL expression (identifier, parameter) to convert to a PHP value.

    Modifies the SQL expression (identifier, parameter) to convert to a PHP value. 
    public function convertToPHPValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​

    [m] getMappedDatabaseTypes Gets an array of database types that map to this Doctrine type.

    Gets an array of database types that map to this Doctrine type. 
    public function getMappedDatabaseTypes(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string[]
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string[] ​

    [m] requiresSQLCommentHint If this Doctrine Type maps to an already mapped database type,

    deprecated

    If this Doctrine Type maps to an already mapped database type, 
    public function requiresSQLCommentHint(Doctrine\DBAL\Platforms\AbstractPlatform $platform): bool

    reverse schema engineering can't tell them apart. You need to mark one of those types as commented, which will have Doctrine use an SQL comment to typehint the actual Doctrine Type.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​bool ​

    [C] Types Default built-in types provided by Doctrine DBAL.

    final

    Default built-in types provided by Doctrine DBAL.

    [C] ARRAY

    deprecated 

    public const string ARRAY = "array"

    [C] ASCII_STRING 

    public const string ASCII_STRING = "ascii_string"

    [C] BIGINT 

    public const string BIGINT = "bigint"

    [C] BINARY 

    public const string BINARY = "binary"

    [C] BLOB 

    public const string BLOB = "blob"

    [C] BOOLEAN 

    public const string BOOLEAN = "boolean"

    [C] DATE_MUTABLE 

    public const string DATE_MUTABLE = "date"

    [C] DATE_IMMUTABLE 

    public const string DATE_IMMUTABLE = "date_immutable"

    [C] DATEINTERVAL 

    public const string DATEINTERVAL = "dateinterval"

    [C] DATETIME_MUTABLE 

    public const string DATETIME_MUTABLE = "datetime"

    [C] DATETIME_IMMUTABLE 

    public const string DATETIME_IMMUTABLE = "datetime_immutable"

    [C] DATETIMETZ_MUTABLE 

    public const string DATETIMETZ_MUTABLE = "datetimetz"

    [C] DATETIMETZ_IMMUTABLE 

    public const string DATETIMETZ_IMMUTABLE = "datetimetz_immutable"

    [C] DECIMAL 

    public const string DECIMAL = "decimal"

    [C] FLOAT 

    public const string FLOAT = "float"

    [C] GUID 

    public const string GUID = "guid"

    [C] INTEGER 

    public const string INTEGER = "integer"

    [C] JSON 

    public const string JSON = "json"

    [C] OBJECT

    deprecated 

    public const string OBJECT = "object"

    [C] SIMPLE_ARRAY 

    public const string SIMPLE_ARRAY = "simple_array"

    [C] SMALLINT 

    public const string SMALLINT = "smallint"

    [C] STRING 

    public const string STRING = "string"

    [C] TEXT 

    public const string TEXT = "text"

    [C] TIME_MUTABLE 

    public const string TIME_MUTABLE = "time"

    [C] TIME_IMMUTABLE 

    public const string TIME_IMMUTABLE = "time_immutable"

    [C] BinaryType Type that maps ab SQL BINARY/VARBINARY to a PHP resource stream.

    Type that maps ab SQL BINARY/VARBINARY to a PHP resource stream.

    Hierarchy

    Parents
    type summary
    ​Type ​The base class for so-called Doctrine mapping types.

    [m] getSQLDeclaration Gets the SQL declaration snippet for a column of this type.

    Gets the SQL declaration snippet for a column of this type. 
    public function getSQLDeclaration(
    array|mixed[] $column,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​Type::getSQLDeclaration() ​Gets the SQL declaration snippet for a column of this type.

    [m] convertToPHPValue <tag_inheritdoc data-type='' data-description=''>Converts a value from its database representation to its PHP representation

    Converts a value from its database representation to its PHP representation 
    public function convertToPHPValue(
    mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): mixed

    of this type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​mixed ​The PHP representation of the value.
    Throws
    type summary
    ​ConversionException ​
    Prototype
    kind source summary
    ​override ​Type::convertToPHPValue() ​Converts a value from its database representation to its PHP representation

    [m] getName Gets the name of this type.

    deprecated

    Gets the name of this type. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​Type::getName() ​Gets the name of this type.

    [m] getBindingType <tag_inheritdoc data-type='' data-description=''>Gets the (preferred) binding type for values of this type that

    Gets the (preferred) binding type for values of this type that 
    public function getBindingType(): int

    can be used when binding parameters to prepared statements.

    This method should return one of the Doctrine\DBAL\ParameterType constants.

    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​override ​Type::getBindingType() ​Gets the (preferred) binding type for values of this type that
    See
    type summary
    ​ParameterType ​

    [m] __construct

    final

    final public function __construct()
    Prototype
    kind source summary
    ​inherit ​Type::__construct() ​
    See
    type summary
    ​Type::addType() ​

    [m] convertToDatabaseValue Converts a value from its PHP representation to its database representation

    Converts a value from its PHP representation to its database representation 
    public function convertToDatabaseValue(
    mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): mixed

    of this type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​mixed ​The database representation of the value.
    Throws
    type summary
    ​ConversionException ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToDatabaseValue() ​Converts a value from its PHP representation to its database representation

    [M] getTypeRegistry

    final

    final public static function getTypeRegistry(): Doctrine\DBAL\Types\TypeRegistry
    Return
    type summary
    ​TypeRegistry ​
    Prototype
    kind source summary
    ​inherit ​Type::getTypeRegistry() ​

    [M] getType Factory method to create type instances.

    Factory method to create type instances. 
    public static function getType(string $name): Doctrine\DBAL\Types\Type

    Type instances are implemented as flyweights.

    Parameter
    type name summary
    ​string ​$name ​The name of the type (as returned by getName()).
    Return
    type summary
    ​Type ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::getType() ​Factory method to create type instances.

    [M] lookupName Finds a name for the given type.

    Finds a name for the given type. 
    public static function lookupName(Doctrine\DBAL\Types\Type $type): string
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::lookupName() ​Finds a name for the given type.

    [M] addType Adds a custom type to the type map.

    Adds a custom type to the type map. 
    public static function addType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​The name of the type. This should correspond to what getName() returns.
    ​class-string ​$className ​The class name of the custom type.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::addType() ​Adds a custom type to the type map.

    [M] hasType Checks if exists support for a type.

    Checks if exists support for a type. 
    public static function hasType(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​The name of the type.
    Return
    type summary
    ​bool ​TRUE if type is supported; FALSE otherwise.
    Prototype
    kind source summary
    ​inherit ​Type::hasType() ​Checks if exists support for a type.

    [M] overrideType Overrides an already defined type to use a different implementation.

    Overrides an already defined type to use a different implementation. 
    public static function overrideType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​
    ​class-string ​$className ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::overrideType() ​Overrides an already defined type to use a different implementation.

    [M] getTypesMap Gets the types array map which holds all registered types and the corresponding

    Gets the types array map which holds all registered types and the corresponding 
    public static function getTypesMap(): array

    type class

    Return
    type summary
    ​array ​string>
    Prototype
    kind source summary
    ​inherit ​Type::getTypesMap() ​Gets the types array map which holds all registered types and the corresponding

    [m] canRequireSQLConversion Does working with this column require SQL conversion functions?

    deprecated

    Does working with this column require SQL conversion functions? 
    public function canRequireSQLConversion(): bool

    This is a metadata function that is required for example in the ORM. Usage of convertToDatabaseValueSQL and convertToPHPValueSQL works for any type and mostly does nothing. This method can additionally be used for optimization purposes.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​Type::canRequireSQLConversion() ​Does working with this column require SQL conversion functions?
    See
    type summary
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​

    [m] convertToDatabaseValueSQL Modifies the SQL expression (identifier, parameter) to convert to a database value.

    Modifies the SQL expression (identifier, parameter) to convert to a database value. 
    public function convertToDatabaseValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToDatabaseValueSQL() ​Modifies the SQL expression (identifier, parameter) to convert to a database value.

    [m] convertToPHPValueSQL Modifies the SQL expression (identifier, parameter) to convert to a PHP value.

    Modifies the SQL expression (identifier, parameter) to convert to a PHP value. 
    public function convertToPHPValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToPHPValueSQL() ​Modifies the SQL expression (identifier, parameter) to convert to a PHP value.

    [m] getMappedDatabaseTypes Gets an array of database types that map to this Doctrine type.

    Gets an array of database types that map to this Doctrine type. 
    public function getMappedDatabaseTypes(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string[]
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​Type::getMappedDatabaseTypes() ​Gets an array of database types that map to this Doctrine type.

    [m] requiresSQLCommentHint If this Doctrine Type maps to an already mapped database type,

    deprecated

    If this Doctrine Type maps to an already mapped database type, 
    public function requiresSQLCommentHint(Doctrine\DBAL\Platforms\AbstractPlatform $platform): bool

    reverse schema engineering can't tell them apart. You need to mark one of those types as commented, which will have Doctrine use an SQL comment to typehint the actual Doctrine Type.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​Type::requiresSQLCommentHint() ​If this Doctrine Type maps to an already mapped database type,

    [C] JsonType Type generating json objects values

    Type generating json objects values

    Hierarchy

    Parents
    type summary
    ​Type ​The base class for so-called Doctrine mapping types.

    [m] getSQLDeclaration Gets the SQL declaration snippet for a column of this type.

    Gets the SQL declaration snippet for a column of this type. 
    public function getSQLDeclaration(
    array|mixed[] $column,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​Type::getSQLDeclaration() ​Gets the SQL declaration snippet for a column of this type.

    [m] convertToDatabaseValue <tag_inheritdoc data-type='' data-description=''>Converts a value from its PHP representation to its database representation

    Converts a value from its PHP representation to its database representation 
    public function convertToDatabaseValue(
    T|mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): (T

    of this type.

    Parameter
    type name summary
    ​T|​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​(T ​is null ? null : string)
    Throws
    type summary
    ​ConversionException ​
    Prototype
    kind source summary
    ​override ​Type::convertToDatabaseValue() ​Converts a value from its PHP representation to its database representation

    [m] convertToPHPValue <tag_inheritdoc data-type='' data-description=''>Converts a value from its database representation to its PHP representation

    Converts a value from its database representation to its PHP representation 
    public function convertToPHPValue(
    mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): mixed

    of this type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​mixed ​The PHP representation of the value.
    Throws
    type summary
    ​ConversionException ​
    Prototype
    kind source summary
    ​override ​Type::convertToPHPValue() ​Converts a value from its database representation to its PHP representation

    [m] getName Gets the name of this type.

    deprecated

    Gets the name of this type. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​Type::getName() ​Gets the name of this type.

    [m] requiresSQLCommentHint <tag_inheritdoc data-type='' data-description=''>If this Doctrine Type maps to an already mapped database type,

    deprecated

    If this Doctrine Type maps to an already mapped database type, 
    public function requiresSQLCommentHint(Doctrine\DBAL\Platforms\AbstractPlatform $platform): bool

    reverse schema engineering can't tell them apart. You need to mark one of those types as commented, which will have Doctrine use an SQL comment to typehint the actual Doctrine Type.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​override ​Type::requiresSQLCommentHint() ​If this Doctrine Type maps to an already mapped database type,

    [m] __construct

    final

    final public function __construct()
    Prototype
    kind source summary
    ​inherit ​Type::__construct() ​
    See
    type summary
    ​Type::addType() ​

    [M] getTypeRegistry

    final

    final public static function getTypeRegistry(): Doctrine\DBAL\Types\TypeRegistry
    Return
    type summary
    ​TypeRegistry ​
    Prototype
    kind source summary
    ​inherit ​Type::getTypeRegistry() ​

    [M] getType Factory method to create type instances.

    Factory method to create type instances. 
    public static function getType(string $name): Doctrine\DBAL\Types\Type

    Type instances are implemented as flyweights.

    Parameter
    type name summary
    ​string ​$name ​The name of the type (as returned by getName()).
    Return
    type summary
    ​Type ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::getType() ​Factory method to create type instances.

    [M] lookupName Finds a name for the given type.

    Finds a name for the given type. 
    public static function lookupName(Doctrine\DBAL\Types\Type $type): string
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::lookupName() ​Finds a name for the given type.

    [M] addType Adds a custom type to the type map.

    Adds a custom type to the type map. 
    public static function addType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​The name of the type. This should correspond to what getName() returns.
    ​class-string ​$className ​The class name of the custom type.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::addType() ​Adds a custom type to the type map.

    [M] hasType Checks if exists support for a type.

    Checks if exists support for a type. 
    public static function hasType(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​The name of the type.
    Return
    type summary
    ​bool ​TRUE if type is supported; FALSE otherwise.
    Prototype
    kind source summary
    ​inherit ​Type::hasType() ​Checks if exists support for a type.

    [M] overrideType Overrides an already defined type to use a different implementation.

    Overrides an already defined type to use a different implementation. 
    public static function overrideType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​
    ​class-string ​$className ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::overrideType() ​Overrides an already defined type to use a different implementation.

    [m] getBindingType Gets the (preferred) binding type for values of this type that

    Gets the (preferred) binding type for values of this type that 
    public function getBindingType(): int

    can be used when binding parameters to prepared statements.

    This method should return one of the Doctrine\DBAL\ParameterType constants.

    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Type::getBindingType() ​Gets the (preferred) binding type for values of this type that
    See
    type summary
    ​ParameterType ​

    [M] getTypesMap Gets the types array map which holds all registered types and the corresponding

    Gets the types array map which holds all registered types and the corresponding 
    public static function getTypesMap(): array

    type class

    Return
    type summary
    ​array ​string>
    Prototype
    kind source summary
    ​inherit ​Type::getTypesMap() ​Gets the types array map which holds all registered types and the corresponding

    [m] canRequireSQLConversion Does working with this column require SQL conversion functions?

    deprecated

    Does working with this column require SQL conversion functions? 
    public function canRequireSQLConversion(): bool

    This is a metadata function that is required for example in the ORM. Usage of convertToDatabaseValueSQL and convertToPHPValueSQL works for any type and mostly does nothing. This method can additionally be used for optimization purposes.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​Type::canRequireSQLConversion() ​Does working with this column require SQL conversion functions?
    See
    type summary
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​

    [m] convertToDatabaseValueSQL Modifies the SQL expression (identifier, parameter) to convert to a database value.

    Modifies the SQL expression (identifier, parameter) to convert to a database value. 
    public function convertToDatabaseValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToDatabaseValueSQL() ​Modifies the SQL expression (identifier, parameter) to convert to a database value.

    [m] convertToPHPValueSQL Modifies the SQL expression (identifier, parameter) to convert to a PHP value.

    Modifies the SQL expression (identifier, parameter) to convert to a PHP value. 
    public function convertToPHPValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToPHPValueSQL() ​Modifies the SQL expression (identifier, parameter) to convert to a PHP value.

    [m] getMappedDatabaseTypes Gets an array of database types that map to this Doctrine type.

    Gets an array of database types that map to this Doctrine type. 
    public function getMappedDatabaseTypes(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string[]
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​Type::getMappedDatabaseTypes() ​Gets an array of database types that map to this Doctrine type.

    [C] BlobType Type that maps an SQL BLOB to a PHP resource stream.

    Type that maps an SQL BLOB to a PHP resource stream.

    Hierarchy

    Parents
    type summary
    ​Type ​The base class for so-called Doctrine mapping types.

    [m] getSQLDeclaration Gets the SQL declaration snippet for a column of this type.

    Gets the SQL declaration snippet for a column of this type. 
    public function getSQLDeclaration(
    array|mixed[] $column,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​Type::getSQLDeclaration() ​Gets the SQL declaration snippet for a column of this type.

    [m] convertToPHPValue <tag_inheritdoc data-type='' data-description=''>Converts a value from its database representation to its PHP representation

    Converts a value from its database representation to its PHP representation 
    public function convertToPHPValue(
    mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): mixed

    of this type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​mixed ​The PHP representation of the value.
    Throws
    type summary
    ​ConversionException ​
    Prototype
    kind source summary
    ​override ​Type::convertToPHPValue() ​Converts a value from its database representation to its PHP representation

    [m] getName Gets the name of this type.

    deprecated

    Gets the name of this type. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​Type::getName() ​Gets the name of this type.

    [m] getBindingType <tag_inheritdoc data-type='' data-description=''>Gets the (preferred) binding type for values of this type that

    Gets the (preferred) binding type for values of this type that 
    public function getBindingType(): int

    can be used when binding parameters to prepared statements.

    This method should return one of the Doctrine\DBAL\ParameterType constants.

    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​override ​Type::getBindingType() ​Gets the (preferred) binding type for values of this type that
    See
    type summary
    ​ParameterType ​

    [m] __construct

    final

    final public function __construct()
    Prototype
    kind source summary
    ​inherit ​Type::__construct() ​
    See
    type summary
    ​Type::addType() ​

    [m] convertToDatabaseValue Converts a value from its PHP representation to its database representation

    Converts a value from its PHP representation to its database representation 
    public function convertToDatabaseValue(
    mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): mixed

    of this type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​mixed ​The database representation of the value.
    Throws
    type summary
    ​ConversionException ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToDatabaseValue() ​Converts a value from its PHP representation to its database representation

    [M] getTypeRegistry

    final

    final public static function getTypeRegistry(): Doctrine\DBAL\Types\TypeRegistry
    Return
    type summary
    ​TypeRegistry ​
    Prototype
    kind source summary
    ​inherit ​Type::getTypeRegistry() ​

    [M] getType Factory method to create type instances.

    Factory method to create type instances. 
    public static function getType(string $name): Doctrine\DBAL\Types\Type

    Type instances are implemented as flyweights.

    Parameter
    type name summary
    ​string ​$name ​The name of the type (as returned by getName()).
    Return
    type summary
    ​Type ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::getType() ​Factory method to create type instances.

    [M] lookupName Finds a name for the given type.

    Finds a name for the given type. 
    public static function lookupName(Doctrine\DBAL\Types\Type $type): string
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::lookupName() ​Finds a name for the given type.

    [M] addType Adds a custom type to the type map.

    Adds a custom type to the type map. 
    public static function addType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​The name of the type. This should correspond to what getName() returns.
    ​class-string ​$className ​The class name of the custom type.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::addType() ​Adds a custom type to the type map.

    [M] hasType Checks if exists support for a type.

    Checks if exists support for a type. 
    public static function hasType(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​The name of the type.
    Return
    type summary
    ​bool ​TRUE if type is supported; FALSE otherwise.
    Prototype
    kind source summary
    ​inherit ​Type::hasType() ​Checks if exists support for a type.

    [M] overrideType Overrides an already defined type to use a different implementation.

    Overrides an already defined type to use a different implementation. 
    public static function overrideType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​
    ​class-string ​$className ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::overrideType() ​Overrides an already defined type to use a different implementation.

    [M] getTypesMap Gets the types array map which holds all registered types and the corresponding

    Gets the types array map which holds all registered types and the corresponding 
    public static function getTypesMap(): array

    type class

    Return
    type summary
    ​array ​string>
    Prototype
    kind source summary
    ​inherit ​Type::getTypesMap() ​Gets the types array map which holds all registered types and the corresponding

    [m] canRequireSQLConversion Does working with this column require SQL conversion functions?

    deprecated

    Does working with this column require SQL conversion functions? 
    public function canRequireSQLConversion(): bool

    This is a metadata function that is required for example in the ORM. Usage of convertToDatabaseValueSQL and convertToPHPValueSQL works for any type and mostly does nothing. This method can additionally be used for optimization purposes.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​Type::canRequireSQLConversion() ​Does working with this column require SQL conversion functions?
    See
    type summary
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​

    [m] convertToDatabaseValueSQL Modifies the SQL expression (identifier, parameter) to convert to a database value.

    Modifies the SQL expression (identifier, parameter) to convert to a database value. 
    public function convertToDatabaseValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToDatabaseValueSQL() ​Modifies the SQL expression (identifier, parameter) to convert to a database value.

    [m] convertToPHPValueSQL Modifies the SQL expression (identifier, parameter) to convert to a PHP value.

    Modifies the SQL expression (identifier, parameter) to convert to a PHP value. 
    public function convertToPHPValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToPHPValueSQL() ​Modifies the SQL expression (identifier, parameter) to convert to a PHP value.

    [m] getMappedDatabaseTypes Gets an array of database types that map to this Doctrine type.

    Gets an array of database types that map to this Doctrine type. 
    public function getMappedDatabaseTypes(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string[]
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​Type::getMappedDatabaseTypes() ​Gets an array of database types that map to this Doctrine type.

    [m] requiresSQLCommentHint If this Doctrine Type maps to an already mapped database type,

    deprecated

    If this Doctrine Type maps to an already mapped database type, 
    public function requiresSQLCommentHint(Doctrine\DBAL\Platforms\AbstractPlatform $platform): bool

    reverse schema engineering can't tell them apart. You need to mark one of those types as commented, which will have Doctrine use an SQL comment to typehint the actual Doctrine Type.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​Type::requiresSQLCommentHint() ​If this Doctrine Type maps to an already mapped database type,

    [C] StringType Type that maps an SQL VARCHAR to a PHP string.

    Type that maps an SQL VARCHAR to a PHP string.

    Hierarchy

    Parents
    type summary
    ​Type ​The base class for so-called Doctrine mapping types.

    [m] getSQLDeclaration Gets the SQL declaration snippet for a column of this type.

    Gets the SQL declaration snippet for a column of this type. 
    public function getSQLDeclaration(
    array|mixed[] $column,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​Type::getSQLDeclaration() ​Gets the SQL declaration snippet for a column of this type.

    [m] getName Gets the name of this type.

    deprecated

    Gets the name of this type. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​Type::getName() ​Gets the name of this type.

    [m] __construct

    final

    final public function __construct()
    Prototype
    kind source summary
    ​inherit ​Type::__construct() ​
    See
    type summary
    ​Type::addType() ​

    [m] convertToDatabaseValue Converts a value from its PHP representation to its database representation

    Converts a value from its PHP representation to its database representation 
    public function convertToDatabaseValue(
    mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): mixed

    of this type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​mixed ​The database representation of the value.
    Throws
    type summary
    ​ConversionException ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToDatabaseValue() ​Converts a value from its PHP representation to its database representation

    [m] convertToPHPValue Converts a value from its database representation to its PHP representation

    Converts a value from its database representation to its PHP representation 
    public function convertToPHPValue(
    mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): mixed

    of this type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​mixed ​The PHP representation of the value.
    Throws
    type summary
    ​ConversionException ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToPHPValue() ​Converts a value from its database representation to its PHP representation

    [M] getTypeRegistry

    final

    final public static function getTypeRegistry(): Doctrine\DBAL\Types\TypeRegistry
    Return
    type summary
    ​TypeRegistry ​
    Prototype
    kind source summary
    ​inherit ​Type::getTypeRegistry() ​

    [M] getType Factory method to create type instances.

    Factory method to create type instances. 
    public static function getType(string $name): Doctrine\DBAL\Types\Type

    Type instances are implemented as flyweights.

    Parameter
    type name summary
    ​string ​$name ​The name of the type (as returned by getName()).
    Return
    type summary
    ​Type ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::getType() ​Factory method to create type instances.

    [M] lookupName Finds a name for the given type.

    Finds a name for the given type. 
    public static function lookupName(Doctrine\DBAL\Types\Type $type): string
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::lookupName() ​Finds a name for the given type.

    [M] addType Adds a custom type to the type map.

    Adds a custom type to the type map. 
    public static function addType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​The name of the type. This should correspond to what getName() returns.
    ​class-string ​$className ​The class name of the custom type.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::addType() ​Adds a custom type to the type map.

    [M] hasType Checks if exists support for a type.

    Checks if exists support for a type. 
    public static function hasType(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​The name of the type.
    Return
    type summary
    ​bool ​TRUE if type is supported; FALSE otherwise.
    Prototype
    kind source summary
    ​inherit ​Type::hasType() ​Checks if exists support for a type.

    [M] overrideType Overrides an already defined type to use a different implementation.

    Overrides an already defined type to use a different implementation. 
    public static function overrideType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​
    ​class-string ​$className ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::overrideType() ​Overrides an already defined type to use a different implementation.

    [m] getBindingType Gets the (preferred) binding type for values of this type that

    Gets the (preferred) binding type for values of this type that 
    public function getBindingType(): int

    can be used when binding parameters to prepared statements.

    This method should return one of the Doctrine\DBAL\ParameterType constants.

    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Type::getBindingType() ​Gets the (preferred) binding type for values of this type that
    See
    type summary
    ​ParameterType ​

    [M] getTypesMap Gets the types array map which holds all registered types and the corresponding

    Gets the types array map which holds all registered types and the corresponding 
    public static function getTypesMap(): array

    type class

    Return
    type summary
    ​array ​string>
    Prototype
    kind source summary
    ​inherit ​Type::getTypesMap() ​Gets the types array map which holds all registered types and the corresponding

    [m] canRequireSQLConversion Does working with this column require SQL conversion functions?

    deprecated

    Does working with this column require SQL conversion functions? 
    public function canRequireSQLConversion(): bool

    This is a metadata function that is required for example in the ORM. Usage of convertToDatabaseValueSQL and convertToPHPValueSQL works for any type and mostly does nothing. This method can additionally be used for optimization purposes.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​Type::canRequireSQLConversion() ​Does working with this column require SQL conversion functions?
    See
    type summary
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​

    [m] convertToDatabaseValueSQL Modifies the SQL expression (identifier, parameter) to convert to a database value.

    Modifies the SQL expression (identifier, parameter) to convert to a database value. 
    public function convertToDatabaseValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToDatabaseValueSQL() ​Modifies the SQL expression (identifier, parameter) to convert to a database value.

    [m] convertToPHPValueSQL Modifies the SQL expression (identifier, parameter) to convert to a PHP value.

    Modifies the SQL expression (identifier, parameter) to convert to a PHP value. 
    public function convertToPHPValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToPHPValueSQL() ​Modifies the SQL expression (identifier, parameter) to convert to a PHP value.

    [m] getMappedDatabaseTypes Gets an array of database types that map to this Doctrine type.

    Gets an array of database types that map to this Doctrine type. 
    public function getMappedDatabaseTypes(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string[]
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​Type::getMappedDatabaseTypes() ​Gets an array of database types that map to this Doctrine type.

    [m] requiresSQLCommentHint If this Doctrine Type maps to an already mapped database type,

    deprecated

    If this Doctrine Type maps to an already mapped database type, 
    public function requiresSQLCommentHint(Doctrine\DBAL\Platforms\AbstractPlatform $platform): bool

    reverse schema engineering can't tell them apart. You need to mark one of those types as commented, which will have Doctrine use an SQL comment to typehint the actual Doctrine Type.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​Type::requiresSQLCommentHint() ​If this Doctrine Type maps to an already mapped database type,

    [C] TextType Type that maps an SQL CLOB to a PHP string.

    Type that maps an SQL CLOB to a PHP string.

    Hierarchy

    Parents
    type summary
    ​Type ​The base class for so-called Doctrine mapping types.

    [m] getSQLDeclaration Gets the SQL declaration snippet for a column of this type.

    Gets the SQL declaration snippet for a column of this type. 
    public function getSQLDeclaration(
    array|mixed[] $column,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​Type::getSQLDeclaration() ​Gets the SQL declaration snippet for a column of this type.

    [m] convertToPHPValue <tag_inheritdoc data-type='' data-description=''>Converts a value from its database representation to its PHP representation

    Converts a value from its database representation to its PHP representation 
    public function convertToPHPValue(
    mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): mixed

    of this type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​mixed ​The PHP representation of the value.
    Throws
    type summary
    ​ConversionException ​
    Prototype
    kind source summary
    ​override ​Type::convertToPHPValue() ​Converts a value from its database representation to its PHP representation

    [m] getName Gets the name of this type.

    deprecated

    Gets the name of this type. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​Type::getName() ​Gets the name of this type.

    [m] __construct

    final

    final public function __construct()
    Prototype
    kind source summary
    ​inherit ​Type::__construct() ​
    See
    type summary
    ​Type::addType() ​

    [m] convertToDatabaseValue Converts a value from its PHP representation to its database representation

    Converts a value from its PHP representation to its database representation 
    public function convertToDatabaseValue(
    mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): mixed

    of this type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​mixed ​The database representation of the value.
    Throws
    type summary
    ​ConversionException ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToDatabaseValue() ​Converts a value from its PHP representation to its database representation

    [M] getTypeRegistry

    final

    final public static function getTypeRegistry(): Doctrine\DBAL\Types\TypeRegistry
    Return
    type summary
    ​TypeRegistry ​
    Prototype
    kind source summary
    ​inherit ​Type::getTypeRegistry() ​

    [M] getType Factory method to create type instances.

    Factory method to create type instances. 
    public static function getType(string $name): Doctrine\DBAL\Types\Type

    Type instances are implemented as flyweights.

    Parameter
    type name summary
    ​string ​$name ​The name of the type (as returned by getName()).
    Return
    type summary
    ​Type ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::getType() ​Factory method to create type instances.

    [M] lookupName Finds a name for the given type.

    Finds a name for the given type. 
    public static function lookupName(Doctrine\DBAL\Types\Type $type): string
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::lookupName() ​Finds a name for the given type.

    [M] addType Adds a custom type to the type map.

    Adds a custom type to the type map. 
    public static function addType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​The name of the type. This should correspond to what getName() returns.
    ​class-string ​$className ​The class name of the custom type.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::addType() ​Adds a custom type to the type map.

    [M] hasType Checks if exists support for a type.

    Checks if exists support for a type. 
    public static function hasType(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​The name of the type.
    Return
    type summary
    ​bool ​TRUE if type is supported; FALSE otherwise.
    Prototype
    kind source summary
    ​inherit ​Type::hasType() ​Checks if exists support for a type.

    [M] overrideType Overrides an already defined type to use a different implementation.

    Overrides an already defined type to use a different implementation. 
    public static function overrideType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​
    ​class-string ​$className ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::overrideType() ​Overrides an already defined type to use a different implementation.

    [m] getBindingType Gets the (preferred) binding type for values of this type that

    Gets the (preferred) binding type for values of this type that 
    public function getBindingType(): int

    can be used when binding parameters to prepared statements.

    This method should return one of the Doctrine\DBAL\ParameterType constants.

    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Type::getBindingType() ​Gets the (preferred) binding type for values of this type that
    See
    type summary
    ​ParameterType ​

    [M] getTypesMap Gets the types array map which holds all registered types and the corresponding

    Gets the types array map which holds all registered types and the corresponding 
    public static function getTypesMap(): array

    type class

    Return
    type summary
    ​array ​string>
    Prototype
    kind source summary
    ​inherit ​Type::getTypesMap() ​Gets the types array map which holds all registered types and the corresponding

    [m] canRequireSQLConversion Does working with this column require SQL conversion functions?

    deprecated

    Does working with this column require SQL conversion functions? 
    public function canRequireSQLConversion(): bool

    This is a metadata function that is required for example in the ORM. Usage of convertToDatabaseValueSQL and convertToPHPValueSQL works for any type and mostly does nothing. This method can additionally be used for optimization purposes.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​Type::canRequireSQLConversion() ​Does working with this column require SQL conversion functions?
    See
    type summary
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​

    [m] convertToDatabaseValueSQL Modifies the SQL expression (identifier, parameter) to convert to a database value.

    Modifies the SQL expression (identifier, parameter) to convert to a database value. 
    public function convertToDatabaseValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToDatabaseValueSQL() ​Modifies the SQL expression (identifier, parameter) to convert to a database value.

    [m] convertToPHPValueSQL Modifies the SQL expression (identifier, parameter) to convert to a PHP value.

    Modifies the SQL expression (identifier, parameter) to convert to a PHP value. 
    public function convertToPHPValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToPHPValueSQL() ​Modifies the SQL expression (identifier, parameter) to convert to a PHP value.

    [m] getMappedDatabaseTypes Gets an array of database types that map to this Doctrine type.

    Gets an array of database types that map to this Doctrine type. 
    public function getMappedDatabaseTypes(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string[]
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​Type::getMappedDatabaseTypes() ​Gets an array of database types that map to this Doctrine type.

    [m] requiresSQLCommentHint If this Doctrine Type maps to an already mapped database type,

    deprecated

    If this Doctrine Type maps to an already mapped database type, 
    public function requiresSQLCommentHint(Doctrine\DBAL\Platforms\AbstractPlatform $platform): bool

    reverse schema engineering can't tell them apart. You need to mark one of those types as commented, which will have Doctrine use an SQL comment to typehint the actual Doctrine Type.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​Type::requiresSQLCommentHint() ​If this Doctrine Type maps to an already mapped database type,

    [C] IntegerType Type that maps an SQL INT to a PHP integer.

    Type that maps an SQL INT to a PHP integer.

    Hierarchy

    Parents
    type summary
    ​Type ​The base class for so-called Doctrine mapping types.
    Implements
    type summary
    ​PhpIntegerMappingType ​Implementations should map a database type to a PHP integer.

    [m] getName Gets the name of this type.

    deprecated

    Gets the name of this type. 
    public function getName(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​Type::getName() ​Gets the name of this type.

    [m] getSQLDeclaration Gets the SQL declaration snippet for a column of this type.

    Gets the SQL declaration snippet for a column of this type. 
    public function getSQLDeclaration(
    array|mixed[] $column,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​array|​mixed[] ​$column ​The column definition
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​override ​Type::getSQLDeclaration() ​Gets the SQL declaration snippet for a column of this type.

    [m] convertToPHPValue <tag_inheritdoc data-type='' data-description=''>Converts a value from its database representation to its PHP representation

    Converts a value from its database representation to its PHP representation 
    public function convertToPHPValue(
    T|mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): (T

    of this type.

    Parameter
    type name summary
    ​T|​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​(T ​is null ? null : int)
    Throws
    type summary
    ​ConversionException ​
    Prototype
    kind source summary
    ​override ​Type::convertToPHPValue() ​Converts a value from its database representation to its PHP representation

    [m] getBindingType <tag_inheritdoc data-type='' data-description=''>Gets the (preferred) binding type for values of this type that

    Gets the (preferred) binding type for values of this type that 
    public function getBindingType(): int

    can be used when binding parameters to prepared statements.

    This method should return one of the Doctrine\DBAL\ParameterType constants.

    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​override ​Type::getBindingType() ​Gets the (preferred) binding type for values of this type that
    See
    type summary
    ​ParameterType ​

    [m] __construct

    final

    final public function __construct()
    Prototype
    kind source summary
    ​inherit ​Type::__construct() ​
    See
    type summary
    ​Type::addType() ​

    [m] convertToDatabaseValue Converts a value from its PHP representation to its database representation

    Converts a value from its PHP representation to its database representation 
    public function convertToDatabaseValue(
    mixed $value,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): mixed

    of this type.

    Parameter
    type name summary
    ​mixed ​$value ​The value to convert.
    ​AbstractPlatform ​$platform ​The currently used database platform.
    Return
    type summary
    ​mixed ​The database representation of the value.
    Throws
    type summary
    ​ConversionException ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToDatabaseValue() ​Converts a value from its PHP representation to its database representation

    [M] getTypeRegistry

    final

    final public static function getTypeRegistry(): Doctrine\DBAL\Types\TypeRegistry
    Return
    type summary
    ​TypeRegistry ​
    Prototype
    kind source summary
    ​inherit ​Type::getTypeRegistry() ​

    [M] getType Factory method to create type instances.

    Factory method to create type instances. 
    public static function getType(string $name): Doctrine\DBAL\Types\Type

    Type instances are implemented as flyweights.

    Parameter
    type name summary
    ​string ​$name ​The name of the type (as returned by getName()).
    Return
    type summary
    ​Type ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::getType() ​Factory method to create type instances.

    [M] lookupName Finds a name for the given type.

    Finds a name for the given type. 
    public static function lookupName(Doctrine\DBAL\Types\Type $type): string
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::lookupName() ​Finds a name for the given type.

    [M] addType Adds a custom type to the type map.

    Adds a custom type to the type map. 
    public static function addType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​The name of the type. This should correspond to what getName() returns.
    ​class-string ​$className ​The class name of the custom type.
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::addType() ​Adds a custom type to the type map.

    [M] hasType Checks if exists support for a type.

    Checks if exists support for a type. 
    public static function hasType(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​The name of the type.
    Return
    type summary
    ​bool ​TRUE if type is supported; FALSE otherwise.
    Prototype
    kind source summary
    ​inherit ​Type::hasType() ​Checks if exists support for a type.

    [M] overrideType Overrides an already defined type to use a different implementation.

    Overrides an already defined type to use a different implementation. 
    public static function overrideType(
    string $name,
    class-string $className
): void
    Parameter
    type name summary
    ​string ​$name ​
    ​class-string ​$className ​
    Return
    type summary
    ​void ​
    Throws
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Type::overrideType() ​Overrides an already defined type to use a different implementation.

    [M] getTypesMap Gets the types array map which holds all registered types and the corresponding

    Gets the types array map which holds all registered types and the corresponding 
    public static function getTypesMap(): array

    type class

    Return
    type summary
    ​array ​string>
    Prototype
    kind source summary
    ​inherit ​Type::getTypesMap() ​Gets the types array map which holds all registered types and the corresponding

    [m] canRequireSQLConversion Does working with this column require SQL conversion functions?

    deprecated

    Does working with this column require SQL conversion functions? 
    public function canRequireSQLConversion(): bool

    This is a metadata function that is required for example in the ORM. Usage of convertToDatabaseValueSQL and convertToPHPValueSQL works for any type and mostly does nothing. This method can additionally be used for optimization purposes.

    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​Type::canRequireSQLConversion() ​Does working with this column require SQL conversion functions?
    See
    type summary
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​
    ​convertToDatabaseValueSQL ​
    ​convertToPHPValueSQL ​

    [m] convertToDatabaseValueSQL Modifies the SQL expression (identifier, parameter) to convert to a database value.

    Modifies the SQL expression (identifier, parameter) to convert to a database value. 
    public function convertToDatabaseValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToDatabaseValueSQL() ​Modifies the SQL expression (identifier, parameter) to convert to a database value.

    [m] convertToPHPValueSQL Modifies the SQL expression (identifier, parameter) to convert to a PHP value.

    Modifies the SQL expression (identifier, parameter) to convert to a PHP value. 
    public function convertToPHPValueSQL(
    string $sqlExpr,
    Doctrine\DBAL\Platforms\AbstractPlatform $platform
): string
    Parameter
    type name summary
    ​string ​$sqlExpr ​
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Type::convertToPHPValueSQL() ​Modifies the SQL expression (identifier, parameter) to convert to a PHP value.

    [m] getMappedDatabaseTypes Gets an array of database types that map to this Doctrine type.

    Gets an array of database types that map to this Doctrine type. 
    public function getMappedDatabaseTypes(Doctrine\DBAL\Platforms\AbstractPlatform $platform): string[]
    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​string[] ​
    Prototype
    kind source summary
    ​inherit ​Type::getMappedDatabaseTypes() ​Gets an array of database types that map to this Doctrine type.

    [m] requiresSQLCommentHint If this Doctrine Type maps to an already mapped database type,

    deprecated

    If this Doctrine Type maps to an already mapped database type, 
    public function requiresSQLCommentHint(Doctrine\DBAL\Platforms\AbstractPlatform $platform): bool

    reverse schema engineering can't tell them apart. You need to mark one of those types as commented, which will have Doctrine use an SQL comment to typehint the actual Doctrine Type.

    Parameter
    type name summary
    ​AbstractPlatform ​$platform ​
    Return
    type summary
    ​bool ​
    Prototype
    kind source summary
    ​inherit ​Type::requiresSQLCommentHint() ​If this Doctrine Type maps to an already mapped database type,

    [C] TypeRegistry The type registry is responsible for holding a map of all known DBAL types.

    final

    The type registry is responsible for holding a map of all known DBAL types. The types are stored using the flyweight pattern so that one type only exists as exactly one instance.

    [m] __construct 

    public function __construct(array $instances = [])
    Parameter
    type name summary
    ​array ​$instances = [] ​

    [m] get Finds a type by the given name.

    Finds a type by the given name. 
    public function get(string $name): Doctrine\DBAL\Types\Type
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Type ​
    Throws
    type summary
    ​Exception ​

    [m] lookupName Finds a name for the given type.

    Finds a name for the given type. 
    public function lookupName(Doctrine\DBAL\Types\Type $type): string
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​string ​
    Throws
    type summary
    ​Exception ​

    [m] has Checks if there is a type of the given name.

    Checks if there is a type of the given name. 
    public function has(string $name): bool
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​bool ​

    [m] register Registers a custom type to the type map.

    Registers a custom type to the type map. 
    public function register(
    string $name,
    Doctrine\DBAL\Types\Type $type
)
    Parameter
    type name summary
    ​string ​$name ​
    ​Type ​$type ​
    Throws
    type summary
    ​Exception ​

    [m] override Overrides an already defined type to use a different implementation.

    Overrides an already defined type to use a different implementation. 
    public function override(
    string $name,
    Doctrine\DBAL\Types\Type $type
)
    Parameter
    type name summary
    ​string ​$name ​
    ​Type ​$type ​
    Throws
    type summary
    ​Exception ​

    [m] getMap Gets the map of all registered types and their corresponding type instances.

    Gets the map of all registered types and their corresponding type instances. 
    public function getMap(): array
    Return
    type summary
    ​array ​Type>

    [C] ConversionException Conversion Exception is thrown when the database to PHP conversion fails.

    Conversion Exception is thrown when the database to PHP conversion fails.

    Hierarchy

    Parents
    type summary
    ​Exception ​
    ​Exception ​
    Implements
    type summary
    ​Stringable ​
    ​Throwable ​

    [p] $message 

    protected string $message = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$message ​

    [p] $code 

    protected int $code = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$code ​

    [p] $file 

    protected string $file = ""

    Type: string

    Prototype
    kind source summary
    ​inherit ​Exception::$file ​

    [p] $line 

    protected int $line = 0

    Type: int

    Prototype
    kind source summary
    ​inherit ​Exception::$line ​

    [M] conversionFailed Thrown when a Database to Doctrine Type Conversion fails.

    Thrown when a Database to Doctrine Type Conversion fails. 
    public static function conversionFailed(
    mixed $value,
    string $toType,
    ?\Throwable $previous = null
): Doctrine\DBAL\Types\ConversionException
    Parameter
    type name summary
    ​mixed ​$value ​
    ​string ​$toType ​
    ​?Throwable ​$previous = null ​
    Return
    type summary
    ​ConversionException ​

    [M] conversionFailedFormat Thrown when a Database to Doctrine Type Conversion fails and we can make a statement

    Thrown when a Database to Doctrine Type Conversion fails and we can make a statement 
    public static function conversionFailedFormat(
    mixed $value,
    string $toType,
    string $expectedFormat,
    ?\Throwable $previous = null
): Doctrine\DBAL\Types\ConversionException

    about the expected format.

    Parameter
    type name summary
    ​mixed ​$value ​
    ​string ​$toType ​
    ​string ​$expectedFormat ​
    ​?Throwable ​$previous = null ​
    Return
    type summary
    ​ConversionException ​

    [M] conversionFailedInvalidType Thrown when the PHP value passed to the converter was not of the expected type.

    Thrown when the PHP value passed to the converter was not of the expected type. 
    public static function conversionFailedInvalidType(
    mixed $value,
    string $toType,
    array|string[] $possibleTypes,
    ?\Throwable $previous = null
): Doctrine\DBAL\Types\ConversionException
    Parameter
    type name summary
    ​mixed ​$value ​
    ​string ​$toType ​
    ​array|​string[] ​$possibleTypes ​
    ​?Throwable ​$previous = null ​
    Return
    type summary
    ​ConversionException ​

    [M] conversionFailedSerialization 

    public static function conversionFailedSerialization(
    mixed $value,
    string $format,
    string $error
): Doctrine\DBAL\Types\ConversionException
    Parameter
    type name summary
    ​mixed ​$value ​
    ​string ​$format ​
    ​string ​$error ​
    Return
    type summary
    ​ConversionException ​

    [M] conversionFailedUnserialization 

    public static function conversionFailedUnserialization(
    string $format,
    string $error
): Doctrine\DBAL\Types\ConversionException
    Parameter
    type name summary
    ​string ​$format ​
    ​string ​$error ​
    Return
    type summary
    ​ConversionException ​

    [M] notSupported 

    public static function notSupported(string $method): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$method ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::notSupported() ​

    [M] invalidPlatformType 

    public static function invalidPlatformType(mixed $invalidPlatform): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​mixed ​$invalidPlatform ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformType() ​

    [M] invalidPlatformVersionSpecified Returns a new instance for an invalid specified platform version.

    Returns a new instance for an invalid specified platform version. 
    public static function invalidPlatformVersionSpecified(
    string $version,
    string $expectedFormat
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$version ​The invalid platform version given.
    ​string ​$expectedFormat ​The expected platform version format.
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidPlatformVersionSpecified() ​Returns a new instance for an invalid specified platform version.

    [M] driverRequired 

    public static function driverRequired(?string|string|null $url = null): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​
    ?string|​string|​null    		 ​$url = null ​The URL that was provided in the connection parameters (if any).
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::driverRequired() ​

    [M] unknownDriver 

    public static function unknownDriver(
    string $unknownDriverName,
    array|string[] $knownDrivers
): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$unknownDriverName ​
    ​array|​string[] ​$knownDrivers ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownDriver() ​

    [M] invalidWrapperClass 

    public static function invalidWrapperClass(string $wrapperClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$wrapperClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidWrapperClass() ​

    [M] invalidDriverClass 

    public static function invalidDriverClass(string $driverClass): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$driverClass ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::invalidDriverClass() ​

    [M] noColumnsSpecifiedForTable 

    public static function noColumnsSpecifiedForTable(string $tableName): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$tableName ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::noColumnsSpecifiedForTable() ​

    [M] typeExists 

    public static function typeExists(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeExists() ​

    [M] unknownColumnType 

    public static function unknownColumnType(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::unknownColumnType() ​

    [M] typeNotFound 

    public static function typeNotFound(string $name): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​string ​$name ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotFound() ​

    [M] typeNotRegistered 

    public static function typeNotRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeNotRegistered() ​

    [M] typeAlreadyRegistered 

    public static function typeAlreadyRegistered(Doctrine\DBAL\Types\Type $type): Doctrine\DBAL\Exception
    Parameter
    type name summary
    ​Type ​$type ​
    Return
    type summary
    ​Exception ​
    Prototype
    kind source summary
    ​inherit ​Exception::typeAlreadyRegistered() ​

    [m] __construct 

    public function __construct(
    string $message = "",
    int $code = 0,
    ?\Throwable $previous = null
)
    Parameter
    type name summary
    ​string ​$message = "" ​
    ​int ​$code = 0 ​
    ​?Throwable ​$previous = null ​
    Prototype
    kind source summary
    ​inherit ​Exception::__construct() ​

    [m] __wakeup 

    public function __wakeup()
    Prototype
    kind source summary
    ​inherit ​Exception::__wakeup() ​

    [m] getMessage

    final

    final public function getMessage(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getMessage() ​

    [m] getCode

    final

    final public function getCode()
    Prototype
    kind source summary
    ​inherit ​Exception::getCode() ​

    [m] getFile

    final

    final public function getFile(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getFile() ​

    [m] getLine

    final

    final public function getLine(): int
    Return
    type summary
    ​int ​
    Prototype
    kind source summary
    ​inherit ​Exception::getLine() ​

    [m] getTrace

    final

    final public function getTrace(): array
    Return
    type summary
    ​array ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTrace() ​

    [m] getPrevious

    final

    final public function getPrevious(): ?\Throwable
    Return
    type summary
    ​?Throwable ​
    Prototype
    kind source summary
    ​inherit ​Exception::getPrevious() ​

    [m] getTraceAsString

    final

    final public function getTraceAsString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::getTraceAsString() ​

    [m] __toString 

    public function __toString(): string
    Return
    type summary
    ​string ​
    Prototype
    kind source summary
    ​inherit ​Exception::__toString() ​

    [I] PhpIntegerMappingType Implementations should map a database type to a PHP integer.

    Implementations should map a database type to a PHP integer.

    Hierarchy

    コントロールパネル
    View
    Head
    Body