SqlsrvDriver

Extends DatabaseDriver

SQL Server Database Driver

link
since

1.0

package

Joomla Framework

Methods

__construct

Constructor.

__construct(array options) : mixed
inherited
since

1.0

Arguments

options

arrayList of options used to configure the connection

Response

mixed

__destruct

Destructor.

__destruct() : mixed
inherited
since

2.0.0

Response

mixed

__get

Magic method to access properties of the database driver.

__get(string name) : mixed
inherited deprecated
since

1.4.0

deprecated

3.0 This is a B/C proxy since $this->name was previously public

Arguments

name

stringThe name of the property.

Response

mixedA value if the property name is valid, null otherwise.

alterDbCharacterSet

Alter database's character set.

alterDbCharacterSet(string dbName) : bool|resource
inherited
since

2.0.0

throws

\RuntimeException

Arguments

dbName

stringThe database name that will be altered

Response

bool|resource

checkFieldExists

Method to check and see if a field exists in a table.

checkFieldExists(string table, string field) : bool
since

1.0

Arguments

table

stringThe table in which to verify the field.

field

stringThe field to verify.

Response

boolTrue if the field exists in the table.

connect

Connects to the database if needed.

connect() : void
since

1.0

throws

\RuntimeException

connected

Determines if the connection to the server is active.

connected() : bool
since

1.0

Response

boolTrue if connected to the database engine.

createDatabase

Create a new database using information from $options object.

createDatabase(\stdClass options, bool utf = true) : bool|resource
inherited
since

2.0.0

throws

\RuntimeException

Arguments

options

\stdClassObject used to pass user and database name to database driver. This object must have "db_name" and "db_user" set.

utf

boolTrue if the database supports the UTF-8 character set.

Response

bool|resource

decodeBinary

Replace special placeholder representing binary field with the original string.

decodeBinary(string|resource data) : string
inherited
since

1.7.0

Arguments

data

string|resourceEncoded string or resource.

Response

stringThe original string.

disconnect

Disconnects the database.

disconnect() : void
inherited
since

2.0.0

dispatchEvent

Dispatch an event.

dispatchEvent(\Joomla\Event\EventInterface event) : void
inherited
since

2.0.0

Arguments

event

\Joomla\Event\EventInterfaceThe event to dispatch

dropTable

Drops a table from the database.

dropTable(string table, bool ifExists = true) : $this
inherited
since

2.0.0

throws

\RuntimeException

Arguments

table

stringThe name of the database table to drop.

ifExists

boolOptionally specify that the table must exist before it is dropped.

Response

$this

escape

Method to escape a string for usage in an SQL statement.

escape(string text, bool extra = false) : string

The escaping for MSSQL isn't handled in the driver though that would be nice. Because of this we need to handle the escaping ourselves.

since

1.0

Arguments

text

stringThe string to be escaped.

extra

boolOptional parameter to provide extra escaping.

Response

stringThe escaped string.

execute

Execute the SQL statement.

execute() : bool
inherited
since

2.0.0

throws

\RuntimeException

Response

bool

fetchArray

Method to fetch a row from the result set cursor as an array.

fetchArray() : mixed
inherited
since

1.0

Response

mixedEither the next row from the result set or false if there are no more rows.

fetchAssoc

Method to fetch a row from the result set cursor as an associative array.

fetchAssoc() : mixed
inherited
since

1.0

Response

mixedEither the next row from the result set or false if there are no more rows.

fetchObject

Method to fetch a row from the result set cursor as an object.

fetchObject() : mixed
inherited

Note, the fetch mode should be configured before calling this method using StatementInterface::setFetchMode().

since

1.0

Response

mixedEither the next row from the result set or false if there are no more rows.

freeResult

Method to free up the memory used for the result set.

freeResult() : void
inherited
since

1.0

getAffectedRows

Get the number of affected rows for the previous executed SQL statement.

getAffectedRows() : int
inherited
since

2.0.0

Response

intThe number of affected rows in the previous operation

getAlterDbCharacterSet

Return the query string to alter the database character set.

getAlterDbCharacterSet(string dbName) : string
inherited
since

1.6.0

Arguments

dbName

stringThe database name

Response

stringThe query that alter the database query string

getCollation

Method to get the database collation in use by sampling a text field of a table in the database.

getCollation() : string|bool
since

1.0

Response

string|boolThe collation in use by the database or boolean false if not supported.

getConnection

Method that provides access to the underlying database connection.

getConnection() : resource
inherited
since

1.0

Response

resourceThe underlying database connection resource.

getConnectionCollation

Method to get the database connection collation in use by sampling a text field of a table in the database.

getConnectionCollation() : string|bool
since

1.6.0

throws

\RuntimeException

Response

string|boolThe collation in use by the database connection (string) or boolean false if not supported.

getConnectionEncryption

Method to get the database encryption details (cipher and protocol) in use.

getConnectionEncryption() : string
since

2.0.0

throws

\RuntimeException

Response

stringThe database encryption details.

getConnectors

Get a list of available database connectors.

getConnectors() : array
inherited static

The list will only be populated with connectors that the class exists for and the environment supports its use. This gives us the ability to have a multitude of connector classes that are self-aware as to whether or not they are able to be used on a given system.

since

1.0

Response

arrayAn array of available database connectors.

getCount

Get the total number of SQL statements executed by the database driver.

getCount() : int
inherited
since

1.0

Response

int

getCreateDatabaseQuery

Return the query string to create new Database.

getCreateDatabaseQuery(\Joomla\Database\stdClass options, bool utf) : string
inherited
since

2.0.0

Arguments

options

\Joomla\Database\stdClassObject used to pass user and database name to database driver. This object must have "db_name" and "db_user" set.

utf

boolTrue if the database supports the UTF-8 character set.

Response

stringThe query that creates database

getDatabase

Gets the name of the database used by this connection.

getDatabase() : string
inherited
since

1.0

Response

string

getDateFormat

Returns a PHP date() function compliant date format for the database driver.

getDateFormat() : string
inherited
since

1.0

Response

string

getDispatcher

Get the event dispatcher.

getDispatcher() : \Joomla\Event\DispatcherInterface
inherited
since

1.2.0

throws

\UnexpectedValueExceptionMay be thrown if the dispatcher has not been set.

Response

\Joomla\Event\DispatcherInterface

getExporter

Gets an exporter class object.

getExporter() : \Joomla\Database\DatabaseExporter
inherited
since

1.0

throws

\RuntimeException

Response

\Joomla\Database\DatabaseExporterAn exporter object.

getImporter

Gets an importer class object.

getImporter() : \Joomla\Database\DatabaseImporter
inherited
since

1.0

Response

\Joomla\Database\DatabaseImporter

getInstance

Method to return a DatabaseDriver instance based on the given options.

getInstance(array options = []) : \Joomla\Database\DatabaseDriver
inherited static deprecated

There are three global options and then the rest are specific to the database driver.

  • The 'driver' option defines which DatabaseDriver class is used for the connection -- the default is 'mysqli'.
  • The 'database' option determines which database is to be used for the connection.
  • The 'select' option determines whether the connector should automatically select the chosen database.

Instances are unique to the given options and new objects are only created when a unique options array is passed into the method. This ensures that we don't end up with unnecessary database connection resources.

since

1.0

throws

\RuntimeException

deprecated

3.0 Use DatabaseFactory::getDriver() instead

Arguments

options

arrayParameters to be passed to the database driver.

Response

\Joomla\Database\DatabaseDriver

getIterator

Get a new iterator on the current query.

getIterator(string column = null, string class = stdClass::class) : \Joomla\Database\DatabaseIterator
inherited
since

1.0

Arguments

column

stringAn option column to use as the iterator key.

class

stringThe class of object that is returned.

Response

\Joomla\Database\DatabaseIterator

getMinimum

Get the minimum supported database version.

getMinimum() : string
inherited
since

1.0

Response

string

getMonitor

Get the query monitor.

getMonitor() : \Joomla\Database\QueryMonitorInterface|null
inherited
since

2.0.0

Response

\Joomla\Database\QueryMonitorInterface|nullThe query monitor or null if not set.

getName

Get the name of the database driver.

getName() : string
inherited

If $this->name is not set it will try guessing the driver name from the class name.

since

1.4.0

Response

string

getNullDate

Get the null or zero representation of a timestamp for the database driver.

getNullDate() : string
inherited
since

1.0

Response

string

getNumRows

Get the number of returned rows for the previous executed SQL statement.

getNumRows() : int
inherited
since

2.0.0

Response

intThe number of returned rows.

getPrefix

Get the common table prefix for the database driver.

getPrefix() : string
inherited
since

1.0

Response

stringThe common database table prefix.

getQuery

Get the current query object or a new DatabaseQuery object.

getQuery(bool new = false) : \Joomla\Database\DatabaseQuery
inherited
since

1.0

Arguments

new

boolFalse to return the current query object, True to return a new DatabaseQuery object.

Response

\Joomla\Database\DatabaseQuery

getServerType

Get the server family type.

getServerType() : string
inherited

If $this->serverType is not set it will attempt guessing the server family type from the driver name. If this is not possible the driver name will be returned instead.

since

1.4.0

Response

string

getTableColumns

Retrieves field information about the given tables.

getTableColumns(mixed table, bool typeOnly = true) : array
since

1.0

throws

\RuntimeException

Arguments

table

mixedA table name

typeOnly

boolTrue to only return field types.

Response

arrayAn array of fields.

getTableConstraints

Get table constraints

getTableConstraints(string tableName) : array
since

1.0

Arguments

tableName

stringThe name of the database table.

Response

arrayAny constraints available for the table.

getTableCreate

Shows the table CREATE statement that creates the given tables.

getTableCreate(mixed tables) : array
inherited abstract
since

1.0

throws

\RuntimeException

Arguments

tables

mixedA table name or a list of table names.

Response

arrayA list of the create SQL for the tables.

getTableKeys

Get the details list of keys for a table.

getTableKeys(string table) : array
since

1.0

throws

\RuntimeException

Arguments

table

stringThe name of the table.

Response

arrayAn array of the column specification for the table.

getTableList

Method to get an array of all tables in the database.

getTableList() : array
since

1.0

throws

\RuntimeException

Response

arrayAn array of all the tables in the database.

getVersion

Get the version of the database connector.

getVersion() : string
since

1.0

Response

stringThe database connector version.

hasUtfSupport

Determine whether or not the database engine supports UTF-8 character encoding.

hasUtfSupport() : bool
inherited
since

1.0

Response

boolTrue if the database engine supports UTF-8 character encoding.

insertid

Method to get the auto-incremented value from the last INSERT statement.

insertid() : int
since

1.0

Response

intThe value of the auto-increment field from the last inserted row.

insertObject

Inserts a row into a table based on an object's properties.

insertObject(string table, object &object, string key = null) : bool
inherited
since

1.0

throws

\RuntimeException

Arguments

table

stringThe name of the database table to insert into.

object

objectA reference to an object whose public properties match the table fields.

key

stringThe name of the primary key. If provided the object property is updated.

Response

bool

isConnectionEncryptionSupported

Method to test if the database TLS connections encryption are supported.

isConnectionEncryptionSupported() : bool
since

2.0.0

Response

boolWhether the database supports TLS connections encryption.

isMinimumVersion

Method to check whether the installed database version is supported by the database driver

isMinimumVersion() : bool
inherited
since

1.0

Response

boolTrue if the database version is supported

isSupported

Test to see if the SQLSRV connector is available.

isSupported() : bool
static
since

1.0

Response

boolTrue on success, false otherwise.

loadAssoc

Method to get the first row of the result set from the database query as an associative array of ['field_name' => 'row_value'].

loadAssoc() : mixed
inherited
since

1.0

throws

\RuntimeException

Response

mixedThe return value or null if the query failed.

loadAssocList

Method to get an array of the result set rows from the database query where each row is an associative array of ['field_name' => 'row_value']. The array of rows can optionally be keyed by a field name, but defaults to a sequential numeric array.

loadAssocList(string key = null, string column = null) : mixed
inherited

NOTE: Choosing to key the result array by a non-unique field name can result in unwanted behavior and should be avoided.

since

1.0

throws

\RuntimeException

Arguments

key

stringThe name of a field on which to key the result array.

column

stringAn optional column name. Instead of the whole row, only this column value will be in the result array.

Response

mixedThe return value or null if the query failed.

loadColumn

Method to get an array of values from the $offset field in each row of the result set from the database query.

loadColumn(int offset) : mixed
inherited
since

1.0

throws

\RuntimeException

Arguments

offset

intThe row offset to use to build the result array.

Response

mixedThe return value or null if the query failed.

loadObject

Method to get the first row of the result set from the database query as an object.

loadObject(string class = stdClass::class) : mixed
inherited
since

1.0

throws

\RuntimeException

Arguments

class

stringThe class name to use for the returned row object.

Response

mixedThe return value or null if the query failed.

loadObjectList

Method to get an array of the result set rows from the database query where each row is an object. The array of objects can optionally be keyed by a field name, but defaults to a sequential numeric array.

loadObjectList(string key = '', string class = stdClass::class) : mixed
inherited

NOTE: Choosing to key the result array by a non-unique field name can result in unwanted behavior and should be avoided.

since

1.0

throws

\RuntimeException

Arguments

key

stringThe name of a field on which to key the result array.

class

stringThe class name to use for the returned row objects.

Response

mixedThe return value or null if the query failed.

loadResult

Method to get the first field of the first row of the result set from the database query.

loadResult() : mixed
inherited
since

1.0

throws

\RuntimeException

Response

mixedThe return value or null if the query failed.

loadRow

Method to get the first row of the result set from the database query as an array.

loadRow() : mixed
inherited

Columns are indexed numerically so the first column in the result set would be accessible via $row[0], etc.

since

1.0

throws

\RuntimeException

Response

mixedThe return value or null if the query failed.

loadRowList

Method to get an array of the result set rows from the database query where each row is an array. The array of objects can optionally be keyed by a field offset, but defaults to a sequential numeric array.

loadRowList(string key = null) : array
inherited

NOTE: Choosing to key the result array by a non-unique field can result in unwanted behavior and should be avoided.

since

1.0

throws

\RuntimeException

Arguments

key

stringThe name of a field on which to key the result array.

Response

arrayAn array of results.

lockTable

Locks a table in the database.

lockTable(string tableName) : $this
since

1.0

throws

\RuntimeException

Arguments

tableName

stringThe name of the table to lock.

Response

$this

prepareStatement

Prepares a SQL statement for execution

prepareStatement(string query) : \Joomla\Database\StatementInterface
inherited abstract
since

2.0.0

throws

\Joomla\Database\Exception\PrepareStatementFailureException

Arguments

query

stringThe SQL query to be prepared.

Response

\Joomla\Database\StatementInterface

q

Alias for quote method

q(array|string text, bool escape = true) : string
inherited
since

1.0

Arguments

text

array|stringA string or an array of strings to quote.

escape

boolTrue (default) to escape the string, false to leave it unchanged.

Response

stringThe quoted input string.

qn

Alias for quoteName method

qn(array|string name, array|string as = null) : array|string
inherited
since

1.0

Arguments

name

array|stringThe identifier name to wrap in quotes, or an array of identifier names to wrap in quotes. Each type supports dot-notation name.

as

array|stringThe AS query part associated to $name. It can be string or array, in latter case it has to be same length of $name; if is null there will not be any AS part for string or array element.

Response

array|stringThe quote wrapped name, same type of $name.

quote

Quotes and optionally escapes a string to database requirements for use in database queries.

quote(array|string text, bool escape = true) : string
inherited
since

1.0

Arguments

text

array|stringA string or an array of strings to quote.

escape

boolTrue (default) to escape the string, false to leave it unchanged.

Response

stringThe quoted input string.

quoteBinary

Quotes a binary string to database requirements for use in database queries.

quoteBinary(string data) : string
inherited
since

1.7.0

Arguments

data

stringA binary string to quote.

Response

stringThe binary quoted input string.

quoteName

Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection risks and reserved word conflicts.

quoteName(array|string name, array|string as = null) : array|string
inherited
since

1.0

Arguments

name

array|stringThe identifier name to wrap in quotes, or an array of identifier names to wrap in quotes. Each type supports dot-notation name.

as

array|stringThe AS query part associated to $name. It can be string or array, in latter case it has to be same length of $name; if is null there will not be any AS part for string or array element.

Response

array|stringThe quote wrapped name, same type of $name.

quoteNameStr

Quote strings coming from quoteName call.

quoteNameStr(array strArr) : string
inherited deprecated
since

1.0

deprecated

2.0 Use quoteNameString instead

Arguments

strArr

arrayArray of strings coming from quoteName dot-explosion.

Response

stringDot-imploded string of quoted parts.

quoteNameString

Quote string coming from quoteName call.

quoteNameString(string name, bool asSinglePart = false) : string
inherited
since

1.7.0

Arguments

name

stringIdentifier name to be quoted.

asSinglePart

boolTreat the name as a single part of the identifier.

Response

stringQuoted identifier string.

renameConstraints

Rename constraints.

renameConstraints(array constraints = [], string prefix = null, string backup = null) : void
since

1.0

Arguments

constraints

arrayArray(strings) of table constraints

prefix

stringA string

backup

stringA string

renameTable

Renames a table in the database.

renameTable(string oldTable, string newTable, string backup = null, string prefix = null) : $this
since

1.0

throws

\RuntimeException

Arguments

oldTable

stringThe name of the table to be renamed

newTable

stringThe new name for the table.

backup

stringTable prefix

prefix

stringFor the table - used to rename constraints in non-mysql databases

Response

$this

replacePrefix

This function replaces a string identifier with the configured table prefix.

replacePrefix(string sql, string prefix = '#__') : string
inherited
since

1.0

Arguments

sql

stringThe SQL statement to prepare.

prefix

stringThe table prefix.

Response

stringThe processed SQL statement.

select

Select a database for use.

select(string database) : bool
since

1.0

throws

\Joomla\Database\Exception\ConnectionFailureException

Arguments

database

stringThe name of the database to select for use.

Response

boolTrue if the database was successfully selected.

setDispatcher

Set the dispatcher to use.

setDispatcher(\Joomla\Event\DispatcherInterface dispatcher) : $this
inherited
since

1.2.0

Arguments

dispatcher

\Joomla\Event\DispatcherInterfaceThe dispatcher to use.

Response

$this

setMonitor

Set a query monitor.

setMonitor(\Joomla\Database\QueryMonitorInterface|null monitor = null) : $this
inherited
since

2.0.0

Arguments

monitor

\Joomla\Database\QueryMonitorInterface|nullThe query monitor.

Response

$this

setQuery

Sets the SQL statement string for later execution.

setQuery(string|\Joomla\Database\QueryInterface query, int offset, int limit) : $this
inherited
since

1.0

throws

\InvalidArgumentException

Arguments

query

string|\Joomla\Database\QueryInterfaceThe SQL statement to set either as a Query object or a string.

offset

intThe affected row offset to set. {@deprecated Use LimitableInterface::setLimit() instead}

limit

intThe maximum affected rows to set. {@deprecated Use LimitableInterface::setLimit() instead}

Response

$this

setUtf

Set the connection to use UTF-8 character encoding.

setUtf() : bool
inherited abstract
since

1.0

Response

boolTrue on success.

splitSql

Splits a string of multiple queries into an array of individual queries.

splitSql(string sql) : array
inherited static
since

1.0

Arguments

sql

stringInput SQL string with which to split into individual queries.

Response

array

transactionCommit

Method to commit a transaction.

transactionCommit(bool toSavepoint = false) : void
since

1.0

throws

\RuntimeException

Arguments

toSavepoint

boolIf true, commit to the last savepoint.

transactionRollback

Method to roll back a transaction.

transactionRollback(bool toSavepoint = false) : void
since

1.0

throws

\RuntimeException

Arguments

toSavepoint

boolIf true, rollback to the last savepoint.

transactionStart

Method to initialize a transaction.

transactionStart(bool asSavepoint = false) : void
since

1.0

throws

\RuntimeException

Arguments

asSavepoint

boolIf true and a transaction is already active, a savepoint will be created.

truncateTable

Method to truncate a table.

truncateTable(string table) : void
inherited
since

1.0

throws

\RuntimeException

Arguments

table

stringThe table to truncate

unlockTables

Unlocks tables in the database.

unlockTables() : $this
since

1.0

throws

\RuntimeException

Response

$this

updateObject

Updates a row in a table based on an object's properties.

updateObject(string table, object &object, array|string key, bool nulls = false) : bool
inherited
since

1.0

throws

\RuntimeException

Arguments

table

stringThe name of the database table to update.

object

objectA reference to an object whose public properties match the table fields.

key

array|stringThe name of the primary key.

nulls

boolTrue to update null fields or false to ignore them.

Response

boolTrue on success.

Properties

name

The name of the database driver.

inherited
since

1.0

Type(s)

string

nameQuote

The character(s) used to quote SQL statement names such as table names or field names, etc.

inherited

If a single character string the same character is used for both sides of the quoted name, else the first character will be used for the opening quote and the second for the closing quote.

since

1.0

Type(s)

string

nullDate

The null or zero representation of a timestamp for the database driver.

inherited
since

1.0

Type(s)

string

dbMinimum

The minimum supported database version.

inherited static
since

1.0

Type(s)

string

database

The name of the database.

inherited
since

1.0

Type(s)

string

serverType

The type of the database server family supported by this driver.

inherited
since

1.4.0

Type(s)

string

connection

The database connection resource.

inherited
since

1.0

Type(s)

resource

connectors

Holds the list of available db connectors.

inherited static
since

1.0

Type(s)

array

count

The number of SQL statements executed by the database driver.

inherited
since

1.0

Type(s)

int

cursor

The database connection cursor from the last query.

inherited
since

1.0

Type(s)

resource

executed

Contains the current query execution status

inherited
since

2.0.0

Type(s)

bool

limit

The affected row limit for the current SQL statement.

inherited
since

1.0

Type(s)

int

offset

The affected row offset to apply for the current SQL statement.

inherited
since

1.0

Type(s)

int

options

Passed in upon instantiation and saved.

inherited
since

1.0

Type(s)

array

sql

The current SQL statement to execute.

inherited
since

1.0

Type(s)

mixed

statement

The prepared statement.

inherited
since

2.0.0

Type(s)

\Joomla\Database\StatementInterface

tablePrefix

The common database table prefix.

inherited
since

1.0

Type(s)

string

utf

True if the database engine supports UTF-8 character encoding.

inherited
since

1.0

Type(s)

bool

errorNum

The database error number.

inherited
since

1.0

Type(s)

int

errorMsg

The database error message.

inherited
since

1.0

Type(s)

string

instances

DatabaseDriver instances container.

inherited static deprecated
since

1.0

deprecated

3.0 Singleton storage will no longer be supported.

Type(s)

\Joomla\Database\DatabaseDriver[]

transactionDepth

The depth of the current transaction.

inherited
since

1.0

Type(s)

int

factory

DatabaseFactory object

inherited
since

2.0.0

Type(s)

\Joomla\Database\DatabaseFactory

monitor

Query monitor object

inherited
since

2.0.0

Type(s)

\Joomla\Database\QueryMonitorInterface

dispatcher

Event Dispatcher

inherited
since

1.2.0

Type(s)

\Joomla\Event\DispatcherInterface|null