Db/Adapter/Sqlsrv.php
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Db
- Subpackage
- Adapter
- Version
- $Id$
\Zend_Db_Adapter_Sqlsrv
Package: Zend_Db\AdapterClass for connecting to SQL databases and performing common operations.
- Parent(s)
- \Zend_Db_Adapter_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_config = array('dbname' => null, 'username' => null, 'password' => null)
User-provided configuration.
Basic keys are:
username => (string) Connect to the database as this username.
password => (string) Password associated with the username.
dbname => The name of the local SQL Server instance
Default valuearray('dbname' => null, 'username' => null, 'password' => null)
Details- Type
- array
string $_defaultStmtClass = 'Zend_Db_Statement_Sqlsrv'
Default class name for a DB statement.
Default value'Zend_Db_Statement_Sqlsrv'
Details- Type
- string
string $_lastInsertSQL = 'SELECT SCOPE_IDENTITY() as Current_Identity'
Query used to fetch last insert id
Default value'SELECT SCOPE_IDENTITY() as Current_Identity'
Details- Type
- string
array $_numericDataTypes = array(\Zend_Db::INT_TYPE => \Zend_Db::INT_TYPE, \Zend_Db::BIGINT_TYPE => \Zend_Db::BIGINT_TYPE, \Zend_Db::FLOAT_TYPE => \Zend_Db::FLOAT_TYPE, 'INT' => \Zend_Db::INT_TYPE, 'SMALLINT' => \Zend_Db::INT_TYPE, 'TINYINT' => \Zend_Db::INT_TYPE, 'BIGINT' => \Zend_Db::BIGINT_TYPE, 'DECIMAL' => \Zend_Db::FLOAT_TYPE, 'FLOAT' => \Zend_Db::FLOAT_TYPE, 'MONEY' => \Zend_Db::FLOAT_TYPE, 'NUMERIC' => \Zend_Db::FLOAT_TYPE, 'REAL' => \Zend_Db::FLOAT_TYPE, 'SMALLMONEY' => \Zend_Db::FLOAT_TYPE)
Keys are UPPERCASE SQL datatypes or the constants
Zend_Db::INT_TYPE, Zend_Db::BIGINT_TYPE, or Zend_Db::FLOAT_TYPE.
Values are:
0 = 32-bit integer
1 = 64-bit integer
2 = float or decimal
Default valuearray(\Zend_Db::INT_TYPE => \Zend_Db::INT_TYPE, \Zend_Db::BIGINT_TYPE => \Zend_Db::BIGINT_TYPE, \Zend_Db::FLOAT_TYPE => \Zend_Db::FLOAT_TYPE, 'INT' => \Zend_Db::INT_TYPE, 'SMALLINT' => \Zend_Db::INT_TYPE, 'TINYINT' => \Zend_Db::INT_TYPE, 'BIGINT' => \Zend_Db::BIGINT_TYPE, 'DECIMAL' => \Zend_Db::FLOAT_TYPE, 'FLOAT' => \Zend_Db::FLOAT_TYPE, 'MONEY' => \Zend_Db::FLOAT_TYPE, 'NUMERIC' => \Zend_Db::FLOAT_TYPE, 'REAL' => \Zend_Db::FLOAT_TYPE, 'SMALLMONEY' => \Zend_Db::FLOAT_TYPE)
Details- Type
- array
Methods
_checkRequiredOptions(array $config) : void
Check for config options that are mandatory.
Throw exceptions if any are missing.
ParametersName | Type | Description |
---|
$config | array | |
---|
Throws_quote(string $value) : string
ParametersName | Type | Description |
---|
$value | string | Raw string |
---|
ReturnsType | Description |
---|
string | Quoted string |
describeTable(string $tableName, string $schemaName = null) : array
Returns the column descriptions for a table.
The return value is an associative array keyed by the column name,
as returned by the RDBMS.
The value of each array element is an associative array
with the following keys:
SCHEMA_NAME => string; name of schema
TABLE_NAME => string;
COLUMN_NAME => string; column name
COLUMN_POSITION => number; ordinal position of column in table
DATA_TYPE => string; SQL datatype name of column
DEFAULT => string; default expression of column, null if none
NULLABLE => boolean; true if column can have nulls
LENGTH => number; length of CHAR/VARCHAR
SCALE => number; scale of NUMERIC/DECIMAL
PRECISION => number; precision of NUMERIC/DECIMAL
UNSIGNED => boolean; unsigned property of an integer type
PRIMARY => boolean; true if column is part of the primary key
PRIMARY_POSITION => integer; position of column in primary key
IDENTITY => integer; true if column is auto-generated with unique values
ParametersName | Type | Description |
---|
$tableName | string | |
---|
$schemaName | string | OPTIONAL |
---|
ReturnsDetails- Todo
- Discover integer unsigned property.
insert(mixed $table, array $bind) : int
Inserts a table row with specified data.
ParametersName | Type | Description |
---|
$table | mixed | The table to insert data into. |
---|
$bind | array | Column-value pairs. |
---|
ReturnsType | Description |
---|
int | The number of affected rows. |
lastInsertId(string $tableName = null, string $primaryKey = null) : string
Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.
As a convention, on RDBMS brands that support sequences
(e.g. Oracle, PostgreSQL, DB2), this method forms the name of a sequence
from the arguments and returns the last id generated by that sequence.
On RDBMS brands that support IDENTITY/AUTOINCREMENT columns, this method
returns the last value generated for such a column, and the table name
argument is disregarded.
ParametersName | Type | Description |
---|
$tableName | string | OPTIONAL Name of table. |
---|
$primaryKey | string | OPTIONAL Name of primary key column. |
---|
Returnslimit(string $sql, integer $count, integer $offset = 0) : string
Adds an adapter-specific LIMIT clause to the SELECT statement.
ParametersName | Type | Description |
---|
$sql | string | |
---|
$count | integer | |
---|
$offset | integer | OPTIONAL |
---|
ReturnsThrows prepare(string $sql) : \Zend_Db_Statement_Sqlsrv
Returns an SQL statement for preparation.
ParametersName | Type | Description |
---|
$sql | string | The SQL statement with placeholders. |
---|
Returns setFetchMode(integer $mode) : void
ParametersName | Type | Description |
---|
$mode | integer | A fetch mode. |
---|
ThrowsDetails- Todo
- Support FETCH_CLASS and FETCH_INTO.
setTransactionIsolationLevel(integer | null $level = null) : true
Set the transaction isoltion level.
ParametersName | Type | Description |
---|
$level | integer | null | A fetch mode from SQLSRV_TXN_*. |
---|
ReturnsThrows supportsParameters(string $type) : bool
Check if the adapter supports real SQL parameters.
ParametersName | Type | Description |
---|
$type | string | 'positional' or 'named' |
---|
Returns