Documentation

Dongle
in package

Application

Database driver dongle

This class uses regex to convert MySQL to various other drivers.

$db : DatabaseManager
$driver : string
$strictModeDisabled : bool
__construct() : mixed: Constructor.
cast() : string: Some drivers require same-type comparisons.
convertTimestamps() : mixed: Alters a table's TIMESTAMP field(s) to be nullable and converts existing values.
disableStrictMode() : mixed: Used to disable strict mode during migrations
getDriver() : string: Returns the driver name as a string, eg: pgsql
getTablePrefix() : string: Get the table prefix.
parse() : string: Transforms an SQL statement to match the active driver.
parseBooleanExpression() : string: Transforms true|false expressions in a statement.
parseConcat() : string: Transforms CONCAT statement.
parseGroupConcat() : string: Transforms GROUP_CONCAT statement.
parseIfNull() : string: Transforms IFNULL statement.
raw() : mixed: Transforms and executes a raw SQL statement

$db


    protected
        DatabaseManager
    $db

Database helper object

$driver


    protected
        string
    $driver

Driver to convert to: mysql, sqlite, pgsql, sqlsrv, postgis.

$strictModeDisabled


    protected
        bool
    $strictModeDisabled

Used to determine whether strict mode has been disabled.

__construct()

Constructor.


    public
                __construct([string $driver = 'mysql' ][, DatabaseManager $db = null ]) : mixed

Parameters

$driver : string = 'mysql'
$db : DatabaseManager = null

Return values

mixed —

cast()

Some drivers require same-type comparisons.


    public
                cast(string $sql[, mixed $asType = 'INTEGER' ]) : string

Parameters

$sql : string
$asType : mixed = 'INTEGER'

Return values

string —

convertTimestamps()

Alters a table's TIMESTAMP field(s) to be nullable and converts existing values.


    public
                convertTimestamps(string $table[, string|array<string|int, mixed> $columns = null ]) : mixed

This is needed to transition from older Laravel code that set DEFAULT 0, which is an invalid date in newer MySQL versions where NO_ZERO_DATE is included in strict mode.

Parameters

$table : string
$columns : string|array<string|int, mixed> = null: Column name(s). Defaults to ['created_at', 'updated_at']

Return values

mixed —

disableStrictMode()

Used to disable strict mode during migrations


    public
                disableStrictMode() : mixed

Return values

mixed —

getDriver()

Returns the driver name as a string, eg: pgsql


    public
                getDriver() : string

Return values

string —

getTablePrefix()

Get the table prefix.


    public
                getTablePrefix() : string

Return values

string —

parse()

Transforms an SQL statement to match the active driver.


    public
                parse(string $sql) : string

Parameters

$sql : string

Return values

string —

parseBooleanExpression()

Transforms true|false expressions in a statement.


    public
                parseBooleanExpression(string $sql) : string

Parameters

$sql : string

Return values

string —

parseConcat()

Transforms CONCAT statement.


    public
                parseConcat(string $sql) : string

Parameters

$sql : string

Return values

string —

parseGroupConcat()

Transforms GROUP_CONCAT statement.


    public
                parseGroupConcat(string $sql) : string

Parameters

$sql : string

Return values

string —

parseIfNull()

Transforms IFNULL statement.


    public
                parseIfNull(string $sql) : string

Parameters

$sql : string

Return values

string —

raw()

Transforms and executes a raw SQL statement


    public
                raw(string $sql) : mixed

Parameters

$sql : string

Return values

mixed —