Connection
        
        extends BaseConnection
    
    
            
            in package
            
        
    
    
    
Connection for SQLSRV
Tags
Table of Contents
Properties
- $aliasedTables : array<string|int, mixed>
- $charset : string
- $compress : bool
- $connectDuration : float
- $connectTime : float
- $connID : false|TConnection
- Connection ID
- $database : string
- Database name
- $dataCache : array<string|int, mixed>
- Holds previously looked up data for performance reasons.
- $dateFormat : array<string|int, mixed>
- $DBCollat : string
- $DBDebug : bool
- $DBDriver : string
- Database driver
- $DBPrefix : string
- $DSN : string
- $encrypt : array<string|int, mixed>|bool
- $escapeChar : string
- Identifier escape character
- $failover : array<string|int, mixed>
- $hostname : string
- $lastQuery : Query
- $likeEscapeChar : string
- ESCAPE character
- $likeEscapeStr : string
- ESCAPE statement string
- $password : string
- $pConnect : bool
- $port : int|string
- $pretend : bool
- $protectIdentifiers : bool
- Protect identifiers flag
- $queryClass : string
- $reservedIdentifiers : array<string|int, mixed>
- $resultID : false|TResult
- Result ID
- $schema : string
- Database schema
- $scrollable : false|string
- Scrollable flag
- $strictOn : bool
- $subdriver : string
- $swapPre : string
- $transDepth : int
- $transEnabled : bool
- Transaction enabled flag
- $transFailure : bool
- $transStatus : bool
- $transStrict : bool
- Strict transaction mode flag
- $username : string
- $_quoted_identifier : bool
- Quoted identifier flag
- $_reserved_identifiers : array<int, string>
- List of reserved identifiers
- $pregEscapeChar : array<string|int, mixed>
- RegExp used to escape identifiers
- $transException : bool
- Whether to throw exceptions during transaction
Methods
- __construct() : mixed
- Class constructor
- __get() : array<string|int, mixed>|bool|float|int|object|resource|string|null
- Accessor for properties if they exist.
- __isset() : bool
- Checker for properties existence.
- addTableAlias() : $this
- Add a table alias to our list.
- affectedRows() : int
- Returns the total number of rows affected by this query.
- callFunction() : array<string|int, mixed>|bool|float|int|object|resource|string|null
- This function enables you to call PHP database functions that are not natively included in CodeIgniter, in a platform independent manner.
- close() : void
- Close the database connection.
- connect() : false|resource
- Connect to the database.
- disableForeignKeyChecks() : bool
- Disables foreign key checks temporarily.
- enableForeignKeyChecks() : bool
- Enables foreign key checks temporarily.
- error() : array<string, int|string>
- Returns the last error code and message.
- escape() : mixed
- "Smart" Escape String
- escapeIdentifier() : string
- Escape the SQL Identifier
- escapeIdentifiers() : mixed
- Escape the SQL Identifiers
- escapeLikeString() : array<int, string>|string
- Escape LIKE String
- escapeString() : array<int, string>|string
- Escape String
- fieldExists() : bool
- Determine if a particular field exists
- getConnectDuration() : string
- Returns the number of seconds with microseconds that it took to connect to the database.
- getConnection() : false|TConnection
- Returns the actual connection object. If both a 'read' and 'write' connection has been specified, you can pass either term in to get that connection. If you pass either alias in and only a single connection is present, it must return the sole connection.
- getConnectStart() : float|null
- Returns the time we started to connect to this database in seconds with microseconds.
- getDatabase() : string
- Returns the name of the current database being used.
- getError() : array<string, int|string>
- Returns the last error encountered by this connection.
- getFieldData() : array<int, stdClass>
- Returns an object with field data
- getFieldNames() : false|array<int, string>
- Fetch Field Names
- getForeignKeyData() : array<string, stdClass>
- Returns an object with foreign key data
- getIndexData() : array<string, stdClass>
- Returns an object with key data
- getLastQuery() : Query
- Returns the last query's statement object.
- getPlatform() : string
- The name of the platform in use (MySQLi, mssql, etc)
- getPrefix() : string
- Returns the database prefix.
- getVersion() : string
- Returns a string containing the version of the database being used.
- initialize() : void
- Initializes the database connection/settings.
- insertID() : int|string
- Insert ID
- isWriteType() : bool
- Determines if a query is a "write" type.
- listTables() : false|array<int, string>
- Returns an array of table names
- newQuery() : BaseBuilder
- Returns a new instance of the BaseBuilder class with a cleared FROM clause.
- persistentConnect() : false|TConnection
- Create a persistent database connection.
- prefixTable() : string
- Prepends a database prefix if one exists in configuration
- prepare() : BasePreparedQuery|null
- Creates a prepared statement with the database that can then be used to execute multiple statements against. Within the closure, you would build the query in any normal way, though the Query Builder is the expected manner.
- pretend() : $this
- Allows the engine to be set into a mode where queries are not actually executed, but they are still generated, timed, etc.
- protectIdentifiers() : mixed
- Protect Identifiers
- query() : BaseResult<TConnection, TResult>|bool|Query
- Orchestrates a query against the database. Queries must use Database\Statement objects to store the query and build it.
- reconnect() : void
- Keep or establish the connection if no queries have been sent for a length of time exceeding the server's idle timeout.
- resetDataCache() : $this
- Empties our data cache. Especially helpful during testing.
- resetTransStatus() : static
- Reset transaction status - to restart transactions after strict mode failure
- setAliasedTables() : $this
- Sets the Table Aliases to use. These are typically collected during use of the Builder, and set here so queries are built correctly.
- setDatabase() : bool
- Select a specific database table to use.
- setPrefix() : string
- Set DB Prefix
- showLastQuery() : string
- Returns a string representation of the last query's statement object.
- simpleQuery() : false|TResult
- Performs a basic query against the database. No binding or caching is performed, nor are transactions handled. Simply takes a raw query string and returns the database-specific result id.
- table() : BaseBuilder
- Returns a non-shared new instance of the query builder for this connection.
- tableExists() : bool
- Determine if a particular table exists
- transBegin() : bool
- Begin Transaction
- transCommit() : bool
- Commit Transaction
- transComplete() : bool
- Complete Transaction
- transException() : $this
- If set to true, exceptions are thrown during transactions.
- transOff() : void
- Disable Transactions
- transRollback() : bool
- Rollback Transaction
- transStart() : bool
- Start Transaction
- transStatus() : bool
- Lets you retrieve the transaction flag to determine if it has failed
- transStrict() : $this
- Enable/disable Transaction Strict Mode
- _close() : void
- Close the database connection.
- _disableForeignKeyChecks() : string
- Disables foreign key checks temporarily.
- _enableForeignKeyChecks() : string
- Enables foreign key checks temporarily.
- _escapeString() : string
- Platform-dependant string escape
- _fieldData() : array<int, stdClass>
- Returns an array of objects with field data
- _foreignKeyData() : array<string, stdClass>
- Returns an array of objects with Foreign key data referenced_object_id parent_object_id
- _indexData() : array<string, stdClass>
- Returns an array of objects with index data
- _listColumns() : false|string
- Generates a platform-specific query string so that the column names can be fetched.
- _listTables() : false|string
- Generates the SQL for listing tables in a platform-dependent manner.
- _transBegin() : bool
- Begin Transaction
- _transCommit() : bool
- Commit Transaction
- _transRollback() : bool
- Rollback Transaction
- execute() : false|resource
- Executes the query against the database.
- foreignKeyDataToObjects() : array<string, stdClass>
- Converts array of arrays generated by _foreignKeyData() to array of objects
- getDriverFunctionPrefix() : string
- Get the prefix of the function to access the DB.
- normalizeDefault() : string|null
- Normalizes SQL Server COLUMN_DEFAULT values.
Properties
$aliasedTables read-only
        public
            array<string|int, mixed>
    $aliasedTables
    
    
    
    
    
    
$charset read-only
        public
            string
    $charset
    
    
    
    
    
    
$compress read-only
        public
            bool
    $compress
    
    
    
    
    
    
$connectDuration read-only
        public
            float
    $connectDuration
    
    
    
    
    
    
$connectTime read-only
        public
            float
    $connectTime
    
    
    
    
    
    
$connID
Connection ID
        public
            false|TConnection
    $connID
     = false
    
    
    
    
    
$database
Database name
        public
            string
    $database
    
    
    
    
    
    
$dataCache
Holds previously looked up data for performance reasons.
        public
            array<string|int, mixed>
    $dataCache
     = []
    
    
    
    
    
$dateFormat read-only
        public
            array<string|int, mixed>
    $dateFormat
    
    
    
    
    
    
$DBCollat read-only
        public
            string
    $DBCollat
    
    
    
    
    
    
$DBDebug read-only
        public
            bool
    $DBDebug
    
    
    
    
    
    
$DBDriver
Database driver
        public
            string
    $DBDriver
     = 'SQLSRV'
    
    
    
    
    
$DBPrefix read-only
        public
            string
    $DBPrefix
    
    
    
    
    
    
$DSN read-only
        public
            string
    $DSN
    
    
    
    
    
    
$encrypt read-only
        public
            array<string|int, mixed>|bool
    $encrypt
    
    
    
    
    
    
$escapeChar
Identifier escape character
        public
            string
    $escapeChar
     = '"'
    
    
    
    
    
$failover read-only
        public
            array<string|int, mixed>
    $failover
    
    
    
    
    
    
$hostname read-only
        public
            string
    $hostname
    
    
    
    
    
    
$lastQuery read-only
        public
            Query
    $lastQuery
    
    
    
    
    
    
$likeEscapeChar
ESCAPE character
        public
            string
    $likeEscapeChar
     = '!'
    
    
    
    
    
$likeEscapeStr
ESCAPE statement string
        public
            string
    $likeEscapeStr
     = " ESCAPE '%s' "
    
    
    
    
    
$password read-only
        public
            string
    $password
    
    
    
    
    
    
$pConnect read-only
        public
            bool
    $pConnect
    
    
    
    
    
    
$port read-only
        public
            int|string
    $port
    
    
    
    
    
    
$pretend read-only
        public
            bool
    $pretend
    
    
    
    
    
    
$protectIdentifiers
Protect identifiers flag
        public
            bool
    $protectIdentifiers
     = true
    
    
    
    
    
$queryClass read-only
        public
            string
    $queryClass
    
    
    
    
    
    
$reservedIdentifiers read-only
        public
            array<string|int, mixed>
    $reservedIdentifiers
    
    
    
    
    
    
$resultID
Result ID
        public
            false|TResult
    $resultID
     = false
    
    
    
    
    
$schema
Database schema
        public
            string
    $schema
     = 'dbo'
    
    
    
    
    
$scrollable
Scrollable flag
        public
            false|string
    $scrollable
    
        Determines what cursor type to use when executing queries.
FALSE or SQLSRV_CURSOR_FORWARD would increase performance, but would disable num_rows() (and possibly insert_id())
$strictOn read-only
        public
            bool
    $strictOn
    
    
    
    
    
    
$subdriver read-only
        public
            string
    $subdriver
    
    
    
    
    
    
$swapPre read-only
        public
            string
    $swapPre
    
    
    
    
    
    
$transDepth read-only
        public
            int
    $transDepth
    
    
    
    
    
    
$transEnabled
Transaction enabled flag
        public
            bool
    $transEnabled
     = true
    
    
    
    
    
$transFailure read-only
        public
            bool
    $transFailure
    
    
    
    
    
    
$transStatus read-only
        public
            bool
    $transStatus
    
    
    
    
    
    
$transStrict
Strict transaction mode flag
        public
            bool
    $transStrict
     = true
    
    
    
    
    
$username read-only
        public
            string
    $username
    
    
    
    
    
    
$_quoted_identifier
Quoted identifier flag
        protected
            bool
    $_quoted_identifier
     = true
        Whether to use SQL-92 standard quoted identifier (double quotes) or brackets for identifier escaping.
$_reserved_identifiers
List of reserved identifiers
        protected
            array<int, string>
    $_reserved_identifiers
     = ['*']
        Identifiers that must NOT be escaped.
$pregEscapeChar
RegExp used to escape identifiers
        protected
            array<string|int, mixed>
    $pregEscapeChar
     = []
    
    
    
    
    
$transException
Whether to throw exceptions during transaction
        protected
            bool
    $transException
     = false
    
    
    
    
    
Methods
__construct()
Class constructor
    public
                    __construct(array<string|int, mixed> $params) : mixed
    Parameters
- $params : array<string|int, mixed>
__get()
Accessor for properties if they exist.
    public
                    __get(string $key) : array<string|int, mixed>|bool|float|int|object|resource|string|null
    Parameters
- $key : string
Return values
array<string|int, mixed>|bool|float|int|object|resource|string|null__isset()
Checker for properties existence.
    public
                    __isset(string $key) : bool
    Parameters
- $key : string
Return values
booladdTableAlias()
Add a table alias to our list.
    public
                    addTableAlias(string $alias) : $this
    Parameters
- $alias : string
Return values
$thisaffectedRows()
Returns the total number of rows affected by this query.
    public
                    affectedRows() : int
    Return values
intcallFunction()
This function enables you to call PHP database functions that are not natively included in CodeIgniter, in a platform independent manner.
    public
                    callFunction(string $functionName, array<string|int, mixed> ...$params) : array<string|int, mixed>|bool|float|int|object|resource|string|null
    Parameters
- $functionName : string
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>|bool|float|int|object|resource|string|nullclose()
Close the database connection.
    public
                    close() : void
    connect()
Connect to the database.
    public
                    connect([bool $persistent = false ]) : false|resource
    Parameters
- $persistent : bool = false
Tags
Return values
false|resourcedisableForeignKeyChecks()
Disables foreign key checks temporarily.
    public
                    disableForeignKeyChecks() : bool
    Return values
boolenableForeignKeyChecks()
Enables foreign key checks temporarily.
    public
                    enableForeignKeyChecks() : bool
    Return values
boolerror()
Returns the last error code and message.
    public
                    error() : array<string, int|string>
    Must return this format: ['code' => string|int, 'message' => string] intval(code) === 0 means "no error".
Return values
array<string, int|string>escape()
"Smart" Escape String
    public
                    escape(array<string|int, mixed>|bool|float|int|object|string|null $str) : mixed
    Escapes data based on type. Sets boolean and null types
Parameters
- $str : array<string|int, mixed>|bool|float|int|object|string|null
escapeIdentifier()
Escape the SQL Identifier
    public
                    escapeIdentifier(non-empty-string|TableName $item) : string
    This function escapes single identifier.
Parameters
- $item : non-empty-string|TableName
Return values
stringescapeIdentifiers()
Escape the SQL Identifiers
    public
                    escapeIdentifiers(array<string|int, mixed>|string $item) : mixed
    This function escapes column and table names
Parameters
- $item : array<string|int, mixed>|string
escapeLikeString()
Escape LIKE String
    public
                    escapeLikeString(array<int, string|Stringable>|string|Stringable $str) : array<int, string>|string
    Calls the individual driver for platform specific escaping for LIKE conditions
Parameters
- $str : array<int, string|Stringable>|string|Stringable
Return values
array<int, string>|stringescapeString()
Escape String
    public
                    escapeString(array<int, string|Stringable>|string|Stringable $str[, bool $like = false ]) : array<int, string>|string
    Parameters
- $str : array<int, string|Stringable>|string|Stringable
- 
                    Input string 
- $like : bool = false
- 
                    Whether the string will be used in a LIKE condition 
Return values
array<int, string>|stringfieldExists()
Determine if a particular field exists
    public
                    fieldExists(string $fieldName, string $tableName) : bool
    Parameters
- $fieldName : string
- $tableName : string
Return values
boolgetConnectDuration()
Returns the number of seconds with microseconds that it took to connect to the database.
    public
                    getConnectDuration([int $decimals = 6 ]) : string
    Used by the Debug Toolbar's timeline.
Parameters
- $decimals : int = 6
Return values
stringgetConnection()
Returns the actual connection object. If both a 'read' and 'write' connection has been specified, you can pass either term in to get that connection. If you pass either alias in and only a single connection is present, it must return the sole connection.
    public
                    getConnection([string|null $alias = null ]) : false|TConnection
    Parameters
- $alias : string|null = null
Return values
false|TConnectiongetConnectStart()
Returns the time we started to connect to this database in seconds with microseconds.
    public
                    getConnectStart() : float|null
    Used by the Debug Toolbar's timeline.
Return values
float|nullgetDatabase()
Returns the name of the current database being used.
    public
                    getDatabase() : string
    Return values
stringgetError()
Returns the last error encountered by this connection.
    public
                    getError() : array<string, int|string>
    Use error() instead.
Return values
array<string, int|string>getFieldData()
Returns an object with field data
    public
                    getFieldData(string $table) : array<int, stdClass>
    Parameters
- $table : string
Return values
array<int, stdClass>getFieldNames()
Fetch Field Names
    public
                    getFieldNames(string|TableName $tableName) : false|array<int, string>
    Parameters
- $tableName : string|TableName
Tags
Return values
false|array<int, string>getForeignKeyData()
Returns an object with foreign key data
    public
                    getForeignKeyData(string $table) : array<string, stdClass>
    Parameters
- $table : string
Return values
array<string, stdClass>getIndexData()
Returns an object with key data
    public
                    getIndexData(string $table) : array<string, stdClass>
    Parameters
- $table : string
Return values
array<string, stdClass>getLastQuery()
Returns the last query's statement object.
    public
                    getLastQuery() : Query
    Return values
QuerygetPlatform()
The name of the platform in use (MySQLi, mssql, etc)
    public
                    getPlatform() : string
    Return values
stringgetPrefix()
Returns the database prefix.
    public
                    getPrefix() : string
    Return values
stringgetVersion()
Returns a string containing the version of the database being used.
    public
                    getVersion() : string
    Return values
stringinitialize()
Initializes the database connection/settings.
    public
                    initialize() : void
    Tags
insertID()
Insert ID
    public
                    insertID() : int|string
    Return values
int|stringisWriteType()
Determines if a query is a "write" type.
    public
                    isWriteType(string $sql) : bool
    Overrides BaseConnection::isWriteType, adding additional read query types.
Parameters
- $sql : string
Return values
boollistTables()
Returns an array of table names
    public
                    listTables([bool $constrainByPrefix = false ]) : false|array<int, string>
    Parameters
- $constrainByPrefix : bool = false
Tags
Return values
false|array<int, string>newQuery()
Returns a new instance of the BaseBuilder class with a cleared FROM clause.
    public
                    newQuery() : BaseBuilder
    Return values
BaseBuilderpersistentConnect()
Create a persistent database connection.
    public
                    persistentConnect() : false|TConnection
    Return values
false|TConnectionprefixTable()
Prepends a database prefix if one exists in configuration
    public
                    prefixTable([string $table = '' ]) : string
    Parameters
- $table : string = ''
Tags
Return values
stringprepare()
Creates a prepared statement with the database that can then be used to execute multiple statements against. Within the closure, you would build the query in any normal way, though the Query Builder is the expected manner.
    public
                    prepare(callable(BaseConnection): mixed $func[, array<string|int, mixed> $options = [] ]) : BasePreparedQuery|null
    Example: $stmt = $db->prepare(function($db) { return $db->table('users') ->where('id', 1) ->get(); })
Parameters
- $func : callable(BaseConnection): mixed
- $options : array<string|int, mixed> = []
Return values
BasePreparedQuery|nullpretend()
Allows the engine to be set into a mode where queries are not actually executed, but they are still generated, timed, etc.
    public
                    pretend([bool $pretend = true ]) : $this
    This is primarily used by the prepared query functionality.
Parameters
- $pretend : bool = true
Return values
$thisprotectIdentifiers()
Protect Identifiers
    public
                    protectIdentifiers(array<string|int, mixed>|int|string|TableName $item[, bool $prefixSingle = false ][, bool $protectIdentifiers = null ][, bool $fieldExists = true ]) : mixed
    This function is used extensively by the Query Builder class, and by a couple functions in this class. It takes a column or table name (optionally with an alias) and inserts the table prefix onto it. Some logic is necessary in order to deal with column names that include the path. Consider a query like this:
SELECT hostname.database.table.column AS c FROM hostname.database.table
Or a query with aliasing:
SELECT m.member_id, m.member_name FROM members AS m
Since the column name can include up to four segments (host, DB, table, column) or also have an alias prefix, we need to do a bit of work to figure this out and insert the table prefix (if it exists) in the proper position, and escape only the correct identifiers.
Parameters
- $item : array<string|int, mixed>|int|string|TableName
- $prefixSingle : bool = false
- 
                    Prefix a table name with no segments? 
- $protectIdentifiers : bool = null
- 
                    Protect table or column names? 
- $fieldExists : bool = true
- 
                    Supplied $item contains a column name? 
query()
Orchestrates a query against the database. Queries must use Database\Statement objects to store the query and build it.
    public
                    query(string $sql[, array<string|int, mixed>|string|null $binds = null ][, bool $setEscapeFlags = true ][, string $queryClass = '' ]) : BaseResult<TConnection, TResult>|bool|Query
    This method works with the cache.
Should automatically handle different connections for read/write queries if needed.
Parameters
- $sql : string
- $binds : array<string|int, mixed>|string|null = null
- $setEscapeFlags : bool = true
- $queryClass : string = ''
Tags
Return values
BaseResult<TConnection, TResult>|bool|Queryreconnect()
Keep or establish the connection if no queries have been sent for a length of time exceeding the server's idle timeout.
    public
                    reconnect() : void
    resetDataCache()
Empties our data cache. Especially helpful during testing.
    public
                    resetDataCache() : $this
    Return values
$thisresetTransStatus()
Reset transaction status - to restart transactions after strict mode failure
    public
                    resetTransStatus() : static
    Return values
staticsetAliasedTables()
Sets the Table Aliases to use. These are typically collected during use of the Builder, and set here so queries are built correctly.
    public
                    setAliasedTables(array<string|int, mixed> $aliases) : $this
    Parameters
- $aliases : array<string|int, mixed>
Return values
$thissetDatabase()
Select a specific database table to use.
    public
                    setDatabase([string|null $databaseName = null ]) : bool
    Parameters
- $databaseName : string|null = null
Return values
boolsetPrefix()
Set DB Prefix
    public
                    setPrefix([string $prefix = '' ]) : string
    Set's the DB Prefix to something new without needing to reconnect
Parameters
- $prefix : string = ''
- 
                    The prefix 
Return values
stringshowLastQuery()
Returns a string representation of the last query's statement object.
    public
                    showLastQuery() : string
    Return values
stringsimpleQuery()
Performs a basic query against the database. No binding or caching is performed, nor are transactions handled. Simply takes a raw query string and returns the database-specific result id.
    public
                    simpleQuery(string $sql) : false|TResult
    Parameters
- $sql : string
Return values
false|TResulttable()
Returns a non-shared new instance of the query builder for this connection.
    public
                    table(array<string|int, mixed>|string|TableName $tableName) : BaseBuilder
    Parameters
- $tableName : array<string|int, mixed>|string|TableName
Tags
Return values
BaseBuildertableExists()
Determine if a particular table exists
    public
                    tableExists(string $tableName[, bool $cached = true ]) : bool
    Parameters
- $tableName : string
- $cached : bool = true
- 
                    Whether to use data cache 
Return values
booltransBegin()
Begin Transaction
    public
                    transBegin([bool $testMode = false ]) : bool
    Parameters
- $testMode : bool = false
Return values
booltransCommit()
Commit Transaction
    public
                    transCommit() : bool
    Return values
booltransComplete()
Complete Transaction
    public
                    transComplete() : bool
    Return values
booltransException()
If set to true, exceptions are thrown during transactions.
    public
                    transException(bool $transException) : $this
    Parameters
- $transException : bool
Return values
$thistransOff()
Disable Transactions
    public
                    transOff() : void
    This permits transactions to be disabled at run-time.
transRollback()
Rollback Transaction
    public
                    transRollback() : bool
    Return values
booltransStart()
Start Transaction
    public
                    transStart([bool $testMode = false ]) : bool
    Parameters
- $testMode : bool = false
Return values
booltransStatus()
Lets you retrieve the transaction flag to determine if it has failed
    public
                    transStatus() : bool
    Return values
booltransStrict()
Enable/disable Transaction Strict Mode
    public
                    transStrict([bool $mode = true ]) : $this
    When strict mode is enabled, if you are running multiple groups of transactions, if one group fails all subsequent groups will be rolled back.
If strict mode is disabled, each group is treated autonomously, meaning a failure of one group will not affect any others
Parameters
- $mode : bool = true
- 
                    = true 
Return values
$this_close()
Close the database connection.
    protected
                    _close() : void
    _disableForeignKeyChecks()
Disables foreign key checks temporarily.
    protected
                    _disableForeignKeyChecks() : string
    Return values
string_enableForeignKeyChecks()
Enables foreign key checks temporarily.
    protected
                    _enableForeignKeyChecks() : string
    Return values
string_escapeString()
Platform-dependant string escape
    protected
                    _escapeString(string $str) : string
    Parameters
- $str : string
Return values
string_fieldData()
Returns an array of objects with field data
    protected
                    _fieldData(string $table) : array<int, stdClass>
    Parameters
- $table : string
Tags
Return values
array<int, stdClass>_foreignKeyData()
Returns an array of objects with Foreign key data referenced_object_id parent_object_id
    protected
                    _foreignKeyData(string $table) : array<string, stdClass>
    Parameters
- $table : string
Tags
Return values
array<string, stdClass>_indexData()
Returns an array of objects with index data
    protected
                    _indexData(string $table) : array<string, stdClass>
    Parameters
- $table : string
Tags
Return values
array<string, stdClass>_listColumns()
Generates a platform-specific query string so that the column names can be fetched.
    protected
                    _listColumns([string|TableName $table = '' ]) : false|string
    Parameters
- $table : string|TableName = ''
Return values
false|string_listTables()
Generates the SQL for listing tables in a platform-dependent manner.
    protected
                    _listTables([bool $prefixLimit = false ][, string|null $tableName = null ]) : false|string
    Parameters
- $prefixLimit : bool = false
- $tableName : string|null = null
- 
                    If $tableName is provided will return only this table if exists. 
Return values
false|string_transBegin()
Begin Transaction
    protected
                    _transBegin() : bool
    Return values
bool_transCommit()
Commit Transaction
    protected
                    _transCommit() : bool
    Return values
bool_transRollback()
Rollback Transaction
    protected
                    _transRollback() : bool
    Return values
boolexecute()
Executes the query against the database.
    protected
                    execute(string $sql) : false|resource
    Parameters
- $sql : string
Return values
false|resourceforeignKeyDataToObjects()
Converts array of arrays generated by _foreignKeyData() to array of objects
    protected
                    foreignKeyDataToObjects(array<string|int, mixed> $data) : array<string, stdClass>
    Parameters
- $data : array<string|int, mixed>
Return values
array<string, stdClass> —array[ {constraint_name} => stdClass[ 'constraint_name' => string, 'table_name' => string, 'column_name' => string[], 'foreign_table_name' => string, 'foreign_column_name' => string[], 'on_delete' => string, 'on_update' => string, 'match' => string ] ]
getDriverFunctionPrefix()
Get the prefix of the function to access the DB.
    protected
                    getDriverFunctionPrefix() : string
    Return values
stringnormalizeDefault()
Normalizes SQL Server COLUMN_DEFAULT values.
    private
                    normalizeDefault(string|null $default) : string|null
    Removes wrapping parentheses and handles basic conversions.
Parameters
- $default : string|null