Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Db_Adapter_Sqlsrv Class Reference

Public Member Functions

 setTransactionIsolationLevel ($level=null)
 Set the transaction isoltion level.
 
 isConnected ()
 Test if a connection is active.
 
 closeConnection ()
 Force the connection to close.
 
 prepare ($sql)
 Returns an SQL statement for preparation.
 
 lastInsertId ($tableName=null, $primaryKey=null)
 Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.
 
 insert ($table, array $bind)
 Inserts a table row with specified data.
 
 listTables ()
 Returns a list of the tables in the database.
 
 describeTable ($tableName, $schemaName=null)
 Returns the column descriptions for a table.
 
 setFetchMode ($mode)
 Set the fetch mode.
 
 limit ($sql, $count, $offset=0)
 Adds an adapter-specific LIMIT clause to the SELECT statement.
 
 supportsParameters ($type)
 Check if the adapter supports real SQL parameters.
 
 getServerVersion ()
 Retrieve server version in PHP style.
 
- Public Member Functions inherited from Zend_Db_Adapter_Abstract
 __construct ($config)
 Constructor.
 
 getConnection ()
 Returns the underlying database connection object or resource.
 
 getConfig ()
 Returns the configuration variables in this adapter.
 
 setProfiler ($profiler)
 Set the adapter's profiler object.
 
 getProfiler ()
 Returns the profiler for this adapter.
 
 getStatementClass ()
 Get the default statement class.
 
 setStatementClass ($class)
 Set the default statement class.
 
 query ($sql, $bind=array())
 Prepares and executes an SQL statement with bound data.
 
 beginTransaction ()
 Leave autocommit mode and begin a transaction.
 
 commit ()
 Commit a transaction and return to autocommit mode.
 
 rollBack ()
 Roll back a transaction and return to autocommit mode.
 
 insert ($table, array $bind)
 Inserts a table row with specified data.
 
 update ($table, array $bind, $where= '')
 Updates table rows with specified data based on a WHERE clause.
 
 delete ($table, $where= '')
 Deletes table rows based on a WHERE clause.
 
 select ()
 Creates and returns a new Zend_Db_Select object for this adapter.
 
 getFetchMode ()
 Get the fetch mode.
 
 fetchAll ($sql, $bind=array(), $fetchMode=null)
 Fetches all SQL result rows as a sequential array.
 
 fetchRow ($sql, $bind=array(), $fetchMode=null)
 Fetches the first row of the SQL result.
 
 fetchAssoc ($sql, $bind=array())
 Fetches all SQL result rows as an associative array.
 
 fetchCol ($sql, $bind=array())
 Fetches the first column of all SQL result rows as an array.
 
 fetchPairs ($sql, $bind=array())
 Fetches all SQL result rows as an array of key-value pairs.
 
 fetchOne ($sql, $bind=array())
 Fetches the first column of the first row of the SQL result.
 
 quote ($value, $type=null)
 Safely quotes a value for an SQL statement.
 
 quoteInto ($text, $value, $type=null, $count=null)
 Quotes a value and places into a piece of text at a placeholder.
 
 quoteIdentifier ($ident, $auto=false)
 Quotes an identifier.
 
 quoteColumnAs ($ident, $alias, $auto=false)
 Quote a column identifier and alias.
 
 quoteTableAs ($ident, $alias=null, $auto=false)
 Quote a table identifier and alias.
 
 getQuoteIdentifierSymbol ()
 Returns the symbol the adapter uses for delimited identifiers.
 
 lastSequenceId ($sequenceName)
 Return the most recent value from the specified sequence in the database.
 
 nextSequenceId ($sequenceName)
 Generate a new value from the specified sequence in the database, and return it.
 
 foldCase ($key)
 Helper method to change the case of the strings used when returning result sets in FETCH_ASSOC and FETCH_BOTH modes.
 
 __sleep ()
 called when object is getting serialized This disconnects the DB object that cant be serialized
 
 __wakeup ()
 called when object is getting unserialized
 
 listTables ()
 Abstract Methods.
 
 describeTable ($tableName, $schemaName=null)
 Returns the column descriptions for a table.
 
 isConnected ()
 Test if a connection is active.
 
 closeConnection ()
 Force the connection to close.
 
 prepare ($sql)
 Prepare a statement and return a PDOStatement-like object.
 
 lastInsertId ($tableName=null, $primaryKey=null)
 Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.
 
 setFetchMode ($mode)
 Set the fetch mode.
 
 limit ($sql, $count, $offset=0)
 Adds an adapter-specific LIMIT clause to the SELECT statement.
 
 supportsParameters ($type)
 Check if the adapter supports real SQL parameters.
 
 getServerVersion ()
 Retrieve server version in PHP style.
 

Protected Member Functions

 _connect ()
 Creates a connection resource.
 
 _checkRequiredOptions (array $config)
 Check for config options that are mandatory.
 
 _quote ($value)
 Quote a raw string.
 
 _beginTransaction ()
 Leave autocommit mode and begin a transaction.
 
 _commit ()
 Commit a transaction and return to autocommit mode.
 
 _rollBack ()
 Roll back a transaction and return to autocommit mode.
 
- Protected Member Functions inherited from Zend_Db_Adapter_Abstract
 _checkRequiredOptions (array $config)
 Check for config options that are mandatory.
 
 _whereExpr ($where)
 Convert an array, string, or Zend_Db_Expr object into a string to put in a WHERE clause.
 
 _quote ($value)
 Quote a raw string.
 
 _quoteIdentifierAs ($ident, $alias=null, $auto=false, $as= 'AS ')
 Quote an identifier and an optional alias.
 
 _quoteIdentifier ($value, $auto=false)
 Quote an identifier.
 
 _connect ()
 Creates a connection to the database.
 
 _beginTransaction ()
 Begin a transaction.
 
 _commit ()
 Commit a transaction.
 
 _rollBack ()
 Roll-back a transaction.
 

Protected Attributes

 $_config
 
 $_lastInsertId
 
 $_lastInsertSQL = 'SELECT SCOPE_IDENTITY() as Current_Identity'
 
 $_numericDataTypes
 
 $_defaultStmtClass = 'Zend_Db_Statement_Sqlsrv'
 
- Protected Attributes inherited from Zend_Db_Adapter_Abstract
 $_config = array()
 
 $_fetchMode = Zend_Db::FETCH_ASSOC
 
 $_profiler
 
 $_defaultStmtClass = 'Zend_Db_Statement'
 
 $_defaultProfilerClass = 'Zend_Db_Profiler'
 
 $_connection = null
 
 $_caseFolding = Zend_Db::CASE_NATURAL
 
 $_autoQuoteIdentifiers = true
 
 $_numericDataTypes
 
 $_allowSerialization = true
 
 $_autoReconnectOnUnserialize = false
 

Member Function Documentation

_beginTransaction ( )
protected

Leave autocommit mode and begin a transaction.

Returns
void
Exceptions
Zend_Db_Adapter_Sqlsrv_Exception
_checkRequiredOptions ( array  $config)
protected

Check for config options that are mandatory.

Throw exceptions if any are missing.

Parameters
array$config
Exceptions
Zend_Db_Adapter_Exception
See Also
Zend_Db_Adapter_Exception
Zend_Db_Adapter_Exception
Zend_Db_Adapter_Exception
_commit ( )
protected

Commit a transaction and return to autocommit mode.

Returns
void
Exceptions
Zend_Db_Adapter_Sqlsrv_Exception
_connect ( )
protected

Creates a connection resource.

Returns
void
Exceptions
Zend_Db_Adapter_Sqlsrv_Exception
See Also
Zend_Db_Adapter_Sqlsrv_Exception
Zend_Db_Adapter_Sqlsrv_Exception
_quote (   $value)
protected

Quote a raw string.

Parameters
string$valueRaw string
Returns
string Quoted string
_rollBack ( )
protected

Roll back a transaction and return to autocommit mode.

Returns
void
Exceptions
Zend_Db_Adapter_Sqlsrv_Exception
closeConnection ( )

Force the connection to close.

Returns
void
describeTable (   $tableName,
  $schemaName = null 
)

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

Todo:
Discover integer unsigned property.
Parameters
string$tableName
string$schemaNameOPTIONAL
Returns
array

Discover metadata information about this table.

Discover primary key column(s) for this table.

getServerVersion ( )

Retrieve server version in PHP style.

Returns
string
insert (   $table,
array  $bind 
)

Inserts a table row with specified data.

Parameters
mixed$tableThe table to insert data into.
array$bindColumn-value pairs.
Returns
int The number of affected rows.
isConnected ( )

Test if a connection is active.

Returns
boolean
lastInsertId (   $tableName = null,
  $primaryKey = null 
)

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.

Parameters
string$tableNameOPTIONAL Name of table.
string$primaryKeyOPTIONAL Name of primary key column.
Returns
string
limit (   $sql,
  $count,
  $offset = 0 
)

Adds an adapter-specific LIMIT clause to the SELECT statement.

Parameters
string$sql
integer$count
integer$offsetOPTIONAL
Returns
string
Exceptions
Zend_Db_Adapter_Sqlsrv_Exception
See Also
Zend_Db_Adapter_Exception
listTables ( )

Returns a list of the tables in the database.

Returns
array
prepare (   $sql)

Returns an SQL statement for preparation.

Parameters
string$sqlThe SQL statement with placeholders.
Returns
Zend_Db_Statement_Sqlsrv
See Also
Zend_Loader
setFetchMode (   $mode)

Set the fetch mode.

Todo:
Support FETCH_CLASS and FETCH_INTO.
Parameters
integer$modeA fetch mode.
Returns
void
Exceptions
Zend_Db_Adapter_Sqlsrv_Exception
setTransactionIsolationLevel (   $level = null)

Set the transaction isoltion level.

Parameters
integer | null$levelA fetch mode from SQLSRV_TXN_*.
Returns
true
Exceptions
Zend_Db_Adapter_Sqlsrv_Exception
supportsParameters (   $type)

Check if the adapter supports real SQL parameters.

Parameters
string$type'positional' or 'named'
Returns
bool

Member Data Documentation

$_config
protected
Initial value:
= array(
'dbname' => null,
'username' => null,
'password' => null,
)
$_defaultStmtClass = 'Zend_Db_Statement_Sqlsrv'
protected
$_lastInsertId
protected
$_lastInsertSQL = 'SELECT SCOPE_IDENTITY() as Current_Identity'
protected
$_numericDataTypes
protected