| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Part of the Joomla Framework Database Package
| Copyright: | Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. |
| License: | GNU General Public License version 2 or later; see LICENSE |
| File Size: | 986 lines (22 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
SqlsrvDriver:: (34 methods):
isSupported()
__construct()
connect()
disconnect()
getTableConstraints()
renameConstraints()
escape()
quote()
quoteBinary()
connected()
dropTable()
getCollation()
getConnectionCollation()
getConnectionEncryption()
isConnectionEncryptionSupported()
getTableColumns()
getTableCreate()
getTableKeys()
getTableList()
getVersion()
insertObject()
insertid()
execute()
replacePrefix()
select()
setUtf()
transactionCommit()
transactionRollback()
transactionStart()
checkFieldExists()
prepareStatement()
renameTable()
lockTable()
unlockTables()
Class: SqlsrvDriver - X-Ref
SQL Server Database Driver| isSupported() X-Ref |
| Test to see if the SQLSRV connector is available. return: boolean True on success, false otherwise. |
| __construct(array $options) X-Ref |
| Constructor. param: array $options List of options used to configure the connection |
| connect() X-Ref |
| Connects to the database if needed. return: void Returns void if the database connected successfully. |
| disconnect() X-Ref |
| Disconnects the database. return: void |
| getTableConstraints($tableName) X-Ref |
| Get table constraints param: string $tableName The name of the database table. return: array Any constraints available for the table. |
| renameConstraints($constraints = [], $prefix = null, $backup = null) X-Ref |
| Rename constraints. param: array $constraints Array(strings) of table constraints param: string $prefix A string param: string $backup A string return: void |
| escape($text, $extra = false) X-Ref |
| Method to escape a string for usage in an SQL statement. 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. param: string $text The string to be escaped. param: boolean $extra Optional parameter to provide extra escaping. return: string The escaped string. |
| quote($text, $escape = true) X-Ref |
| Quotes and optionally escapes a string to database requirements for use in database queries. param: mixed $text A string or an array of strings to quote. param: boolean $escape True (default) to escape the string, false to leave it unchanged. return: string The quoted input string. |
| quoteBinary($data) X-Ref |
| Quotes a binary string to database requirements for use in database queries. param: string $data A binary string to quote. return: string The binary quoted input string. |
| connected() X-Ref |
| Determines if the connection to the server is active. return: boolean True if connected to the database engine. |
| dropTable($table, $ifExists = true) X-Ref |
| Drops a table from the database. param: string $table The name of the database table to drop. param: boolean $ifExists Optionally specify that the table must exist before it is dropped. return: $this |
| getCollation() X-Ref |
| Method to get the database collation in use by sampling a text field of a table in the database. return: string|boolean The collation in use by the database or boolean false if not supported. |
| getConnectionCollation() X-Ref |
| Method to get the database connection collation in use by sampling a text field of a table in the database. return: string|boolean The collation in use by the database connection (string) or boolean false if not supported. |
| getConnectionEncryption() X-Ref |
| Method to get the database encryption details (cipher and protocol) in use. return: string The database encryption details. |
| isConnectionEncryptionSupported() X-Ref |
| Method to test if the database TLS connections encryption are supported. return: boolean Whether the database supports TLS connections encryption. |
| getTableColumns($table, $typeOnly = true) X-Ref |
| Retrieves field information about the given tables. param: mixed $table A table name param: boolean $typeOnly True to only return field types. return: array An array of fields. |
| getTableCreate($tables) X-Ref |
| Shows the table CREATE statement that creates the given tables. This is unsupported by MSSQL. param: mixed $tables A table name or a list of table names. return: array A list of the create SQL for the tables. |
| getTableKeys($table) X-Ref |
| Get the details list of keys for a table. param: string $table The name of the table. return: array An array of the column specification for the table. |
| getTableList() X-Ref |
| Method to get an array of all tables in the database. return: array An array of all the tables in the database. |
| getVersion() X-Ref |
| Get the version of the database connector. return: string The database connector version. |
| insertObject($table, &$object, $key = null) X-Ref |
| Inserts a row into a table based on an object's properties. param: string $table The name of the database table to insert into. param: object $object A reference to an object whose public properties match the table fields. param: string $key The name of the primary key. If provided the object property is updated. return: boolean True on success. |
| insertid() X-Ref |
| Method to get the auto-incremented value from the last INSERT statement. return: integer The value of the auto-increment field from the last inserted row. |
| execute() X-Ref |
| Execute the SQL statement. return: boolean |
| replacePrefix($sql, $prefix = ') X-Ref |
| This function replaces a string identifier with the configured table prefix. param: string $sql The SQL statement to prepare. param: string $prefix The table prefix. return: string The processed SQL statement. |
| select($database) X-Ref |
| Select a database for use. param: string $database The name of the database to select for use. return: boolean True if the database was successfully selected. |
| setUtf() X-Ref |
| Set the connection to use UTF-8 character encoding. return: boolean True on success. |
| transactionCommit($toSavepoint = false) X-Ref |
| Method to commit a transaction. param: boolean $toSavepoint If true, commit to the last savepoint. return: void |
| transactionRollback($toSavepoint = false) X-Ref |
| Method to roll back a transaction. param: boolean $toSavepoint If true, rollback to the last savepoint. return: void |
| transactionStart($asSavepoint = false) X-Ref |
| Method to initialize a transaction. param: boolean $asSavepoint If true and a transaction is already active, a savepoint will be created. return: void |
| checkFieldExists($table, $field) X-Ref |
| Method to check and see if a field exists in a table. param: string $table The table in which to verify the field. param: string $field The field to verify. return: boolean True if the field exists in the table. |
| prepareStatement(string $query) X-Ref |
| Prepares a SQL statement for execution param: string $query The SQL query to be prepared. return: StatementInterface |
| renameTable($oldTable, $newTable, $backup = null, $prefix = null) X-Ref |
| Renames a table in the database. param: string $oldTable The name of the table to be renamed param: string $newTable The new name for the table. param: string $backup Table prefix param: string $prefix For the table - used to rename constraints in non-mysql databases return: $this |
| lockTable($tableName) X-Ref |
| Locks a table in the database. param: string $tableName The name of the table to lock. return: $this |
| unlockTables() X-Ref |
| Unlocks tables in the database. return: $this |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |