Docs For Class atkMsSqlDb

Home

Documentation home

Atk index

Docs For Class atkMsSqlDb [ package: atk ]

Class: atkMsSqlDb

Source Location: /db/class.atkmssqldb.inc

Class atkMsSqlDb

Class Overview

Driver for MsSQL databases

This driver is only supporting MS SQL partially at the moment

Succesfully tested:

SELECT, INSERT, UPDATE, DELETE, LEFT JOIN, ORDER BY, LIKE
atkAttribute
atkNumberAttribute
atkOneToManyRelation
atkManyToOneRelation
atkBoolAttribute

Located in /db/class.atkmssqldb.inc [line 49]

Wiki documentation

atkDb
   |
   --atkMysqlDb
      |
      --atkMsSqlDb

Author(s):

Harrie Verveer <harrie@ibuildings.nl>

Information Tags:

Todo:

- LIMIT and OFFSET support

REGEX support
SOUNDEX support
Support for DATE attribute
Support for TIME attribute
Support for DATETIME attribute

Attributes and database functions not stated above are untested

Methods

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkMysqlDb atkMysqlDb::$m_identifierQuoting atkMysqlDb::$m_seq_field atkMysqlDb::$m_seq_namefield atkMysqlDb::$m_seq_table atkMysqlDb::$m_type Inherited From atkDb atkDb::$m_affected_rows atkDb::$m_auto_free atkDb::$m_charset atkDb::$m_collate atkDb::$m_connection atkDb::$m_database atkDb::$m_errno atkDb::$m_error atkDb::$m_errorLookup atkDb::$m_haltonerror atkDb::$m_host atkDb::$m_link_id atkDb::$m_mode atkDb::$m_password atkDb::$m_port atkDb::$m_query_id atkDb::$m_record atkDb::$m_row atkDb::$m_tableMeta atkDb::$m_user atkDb::$m_user_error atkDb::$m_vendor	Inherited From atkMysqlDb atkMysqlDb::affected_rows() Evaluate the result; which rows were affected by the query. atkMysqlDb::atkmysqldb() Base constructor atkMysqlDb::disconnect() Disconnect from database atkMysqlDb::doConnect() Connect to the database atkMysqlDb::dropAll() Drop all database tables. atkMysqlDb::escapeSQL() Escaping a MySQL string, in a mysqli safe way atkMysqlDb::func_datetimetochar() Get TO_CHAR() equivalent for the current database. atkMysqlDb::func_datetochar() Get TO_CHAR() equivalent for the current database. atkMysqlDb::getColumnLength() Mysql_field_len returns unusable results for decimal,float and double column types. atkMysqlDb::getErrorType() Determine whether an error that occurred is a recoverable (user) error or a system error. atkMysqlDb::getSearchModes() This function indicates what searchmodes the database supports. atkMysqlDb::lock() Lock a certain table in the database atkMysqlDb::locktables_fallback_on_error() This method provides a fallback when error 1100 occurs (Table ... not locked using LOCK TABLES). This method locks the table and runs the query again. atkMysqlDb::metadata() Return the meta data of a certain table atkMysqlDb::nextid() Get the next sequence number of a certain sequence. atkMysqlDb::next_record() Goto the next record in the result set atkMysqlDb::num_fields() Evaluatie the result; how many fields where affected by the query. atkMysqlDb::num_rows() Evaluate the result; how many rows were affected by the query. atkMysqlDb::query() Performs a query atkMysqlDb::seek() Goto a certain position in result set. atkMysqlDb::setSequenceValue() Set database sequence value. atkMysqlDb::tableExists() This function checks the database for a table with the provide name atkMysqlDb::table_names() Return the available table names atkMysqlDb::unlock() Unlock table(s) in the database atkMysqlDb::vendorDateFormat() Convert a php date() format specifier to a mysql specific format specifier. atkMysqlDb::_getTableType() Returns the table type. atkMysqlDb::_setErrorVariables() Store MySQL errors in internal variables atkMysqlDb::_translateError() Translates known database errors to developer-friendly messages Inherited From atkDb atkDb::affected_rows() Retrieve the number of rows affected by the last query. atkDb::clearMapping() Clear the current database mapping. atkDb::cloneAll() Clones the database structure of the given database to this database. This also means the complete database is emptied beforehand. atkDb::commit() Commit the current transaction. atkDb::connect() Connect to the database. atkDb::createDDL() Create an atkDDL object for constructing ddl queries. atkDb::createQuery() Create an atkQuery object for constructing queries. atkDb::deleteAll() Empty all database tables. atkDb::disconnect() Disconnect from database atkDb::doConnect() Connect to the database atkDb::dropAll() Drop all database tables. atkDb::errorLookup() Looks up the error atkDb::escapeSQL() escapes quotes for use in SQL: ' -> '' (and sometimes % -> %%) atkDb::func_concat() Get CONCAT() equivalent for the current database. atkDb::func_concat_ws() Get CONCAT_WS() equivalent for the current database. atkDb::func_datetimetochar() Get TO_CHAR() equivalent for the current database. atkDb::func_datetochar() Get TO_CHAR() equivalent for the current database. atkDb::func_now() get NOW() or SYSDATE() equivalent for the current database atkDb::func_substring() get SUBSTRING() equivalent for the current database. atkDb::getAtkDbErrno() Get generic atk errorccode atkDb::getDbErrno() Get vendor-dependent database error number. atkDb::getDbError() Get vendor-dependent database error message. atkDb::getDbStatus() Check if current db is present and acceptable for current user atkDb::getErrorMsg() Get localized error message (for display in the application) atkDb::getErrorType() Determine whether an error that occurred is a recoverable (user) error or a system error. atkDb::getHaltOnError() Halt on error? atkDb::getInstance() Get database instance. atkDb::getMapping() Returns the current database mapping. atkDb::getQueryId() Returns the current query resource. atkDb::getQueryMode() Returns the query mode atkDb::getRow() Returns the first row for the given query. atkDb::getRows() Get all rows for the given query. atkDb::getRowsAssoc() Get rows in an associative array with the given column used as key for the rows. atkDb::getSearchModes() This function indicates what searchmodes the database supports. atkDb::getTranslatedDatabaseName() Returns the real database name. If a mapping atkDb::getType() Get the database driver type. atkDb::getValue() Get a single value from a certain specified query atkDb::getValues() Get an array with all the values in the specified column. atkDb::getValuesAssoc() Get rows in an associative array with the given key column used as key and the given value column used as value. atkDb::halt() If haltonerror is set, this will raise an atkerror. If not, it will place the error in atkdebug and continue. atkDb::hasError() Has error? atkDb::hasMode() Check if the current instance has the given mode atkDb::init() (Re)Initialise a database driver with a connection atkDb::link_id() Get the current connection. atkDb::lock() Lock a table in the database. atkDb::maxIdentifierLength() Returns the maximum length an identifier (tablename, columnname, etc) may have atkDb::metadata() Return the meta data of a certain table HIE GEBLEVEN atkDb::nextid() Get the next sequence number of a certain sequence. atkDb::next_record() Retrieve the next record in the resultset. atkDb::prepare() Creates a new statement for the given query. atkDb::query() Parse and execute a query. atkDb::query_id() Get the current query statement resource id. atkDb::quoteIdentifier() Quote Indentifier atkDb::resetQueryId() Rests the query resource. atkDb::rollback() Rollback the current transaction. atkDb::savepoint() Set savepoint with the given name. atkDb::setHaltOnError() Halt on error or not? atkDb::setInstance() Replace the current instance of a named connection at runtime with a different connection. This is useful for example for replacing a named database instance with a mock object for testing purposes. atkDb::setQueryId() Sets the current query identifier used for next_record() etc. atkDb::setSequenceValue() Set database sequence value. atkDb::setUserError() Define custom user error codes. atkDb::tableExists() This function checks the database for a table with the provide name atkDb::tableMeta() Fetches table meta data from database atkDb::table_names() Return the available table names atkDb::toggleForeignKeys() Enable/disable all foreign key constraints. atkDb::unlock() Relieve all locks. atkDb::useMapping() Use the given mapping to translate database requests from one database to another database. This can be used for test purposes. atkDb::vendorDateFormat() Convert a php date() format specifier to a vendor specific format specifier. atkDb::_getOrUseMapping() Get or set the database mapping atkDb::_getTableMetaFromCache() If cached it'll return the table metadata from cache. atkDb::_getTableMetaFromDb() Returns the tablemetadata directly from db atkDb::_translateError() Translate database-vendor dependent error messages into an ATK generic error code.

Inherited Properties

Inherited Methods

Inherited From atkMysqlDb

atkMysqlDb::$m_identifierQuoting

atkMysqlDb::$m_seq_field

atkMysqlDb::$m_seq_namefield

atkMysqlDb::$m_seq_table

atkMysqlDb::$m_type

Inherited From atkDb

atkDb::$m_affected_rows

atkDb::$m_auto_free

atkDb::$m_charset

atkDb::$m_collate

atkDb::$m_connection

atkDb::$m_database

atkDb::$m_errno

atkDb::$m_error

atkDb::$m_errorLookup

atkDb::$m_haltonerror

atkDb::$m_host

atkDb::$m_link_id

atkDb::$m_mode

atkDb::$m_password

atkDb::$m_port

atkDb::$m_query_id

atkDb::$m_record

atkDb::$m_row

atkDb::$m_tableMeta

atkDb::$m_user

atkDb::$m_user_error

atkDb::$m_vendor

Inherited From atkMysqlDb

atkMysqlDb::affected_rows()

Evaluate the result; which rows were affected by the query.

atkMysqlDb::atkmysqldb()

Base constructor

atkMysqlDb::disconnect()

Disconnect from database

atkMysqlDb::doConnect()

Connect to the database

atkMysqlDb::dropAll()

Drop all database tables.

atkMysqlDb::escapeSQL()

Escaping a MySQL string, in a mysqli safe way

atkMysqlDb::func_datetimetochar()

Get TO_CHAR() equivalent for the current database.

atkMysqlDb::func_datetochar()

Get TO_CHAR() equivalent for the current database.

atkMysqlDb::getColumnLength()

Mysql_field_len returns unusable results for decimal,float and double column types.

atkMysqlDb::getErrorType()

Determine whether an error that occurred is a recoverable (user) error or a system error.

atkMysqlDb::getSearchModes()

This function indicates what searchmodes the database supports.

atkMysqlDb::lock()

Lock a certain table in the database

atkMysqlDb::locktables_fallback_on_error()

This method provides a fallback when error 1100 occurs (Table ... not locked using LOCK TABLES). This method locks the table and runs the query again.

atkMysqlDb::metadata()

Return the meta data of a certain table

atkMysqlDb::nextid()

Get the next sequence number of a certain sequence.

atkMysqlDb::next_record()

Goto the next record in the result set

atkMysqlDb::num_fields()

Evaluatie the result; how many fields where affected by the query.

atkMysqlDb::num_rows()

Evaluate the result; how many rows were affected by the query.

atkMysqlDb::query()

Performs a query

atkMysqlDb::seek()

Goto a certain position in result set.

atkMysqlDb::setSequenceValue()

Set database sequence value.

atkMysqlDb::tableExists()

This function checks the database for a table with the provide name

atkMysqlDb::table_names()

Return the available table names

atkMysqlDb::unlock()

Unlock table(s) in the database

atkMysqlDb::vendorDateFormat()

Convert a php date() format specifier to a mysql specific format specifier.

atkMysqlDb::_getTableType()

Returns the table type.

atkMysqlDb::_setErrorVariables()

Store MySQL errors in internal variables

atkMysqlDb::_translateError()

Translates known database errors to developer-friendly messages

Inherited From atkDb

atkDb::affected_rows()

Retrieve the number of rows affected by the last query.

atkDb::clearMapping()

Clear the current database mapping.

atkDb::cloneAll()

Clones the database structure of the given database to this database. This also means the complete database is emptied beforehand.

atkDb::commit()

Commit the current transaction.

atkDb::connect()

Connect to the database.

atkDb::createDDL()

Create an atkDDL object for constructing ddl queries.

atkDb::createQuery()

Create an atkQuery object for constructing queries.

atkDb::deleteAll()

Empty all database tables.

atkDb::disconnect()

Disconnect from database

atkDb::doConnect()

Connect to the database

atkDb::dropAll()

Drop all database tables.

atkDb::errorLookup()

Looks up the error

atkDb::escapeSQL()

escapes quotes for use in SQL: ' -> '' (and sometimes % -> %%)

atkDb::func_concat()

Get CONCAT() equivalent for the current database.

atkDb::func_concat_ws()

Get CONCAT_WS() equivalent for the current database.

atkDb::func_datetimetochar()

Get TO_CHAR() equivalent for the current database.

atkDb::func_datetochar()

Get TO_CHAR() equivalent for the current database.

atkDb::func_now()

get NOW() or SYSDATE() equivalent for the current database

atkDb::func_substring()

get SUBSTRING() equivalent for the current database.

atkDb::getAtkDbErrno()

Get generic atk errorccode

atkDb::getDbErrno()

Get vendor-dependent database error number.

atkDb::getDbError()

Get vendor-dependent database error message.

atkDb::getDbStatus()

Check if current db is present and acceptable for current user

atkDb::getErrorMsg()

Get localized error message (for display in the application)

atkDb::getErrorType()

Determine whether an error that occurred is a recoverable (user) error or a system error.

atkDb::getHaltOnError()

Halt on error?

atkDb::getInstance()

Get database instance.

atkDb::getMapping()

Returns the current database mapping.

atkDb::getQueryId()

Returns the current query resource.

atkDb::getQueryMode()

Returns the query mode

atkDb::getRow()

Returns the first row for the given query.

atkDb::getRows()

Get all rows for the given query.

atkDb::getRowsAssoc()

Get rows in an associative array with the given column used as key for the rows.

atkDb::getSearchModes()

This function indicates what searchmodes the database supports.

atkDb::getTranslatedDatabaseName()

Returns the real database name. If a mapping

atkDb::getType()

Get the database driver type.

atkDb::getValue()

Get a single value from a certain specified query

atkDb::getValues()

Get an array with all the values in the specified column.

atkDb::getValuesAssoc()

Get rows in an associative array with the given key column used as key and the given value column used as value.

atkDb::halt()

If haltonerror is set, this will raise an atkerror. If not, it will place the error in atkdebug and continue.

atkDb::hasError()

Has error?

atkDb::hasMode()

Check if the current instance has the given mode

atkDb::init()

(Re)Initialise a database driver with a connection

atkDb::link_id()

Get the current connection.

atkDb::lock()

Lock a table in the database.

atkDb::maxIdentifierLength()

Returns the maximum length an identifier (tablename, columnname, etc) may have

atkDb::metadata()

Return the meta data of a certain table HIE GEBLEVEN

atkDb::nextid()

Get the next sequence number of a certain sequence.

atkDb::next_record()

Retrieve the next record in the resultset.

atkDb::prepare()

Creates a new statement for the given query.

atkDb::query()

Parse and execute a query.

atkDb::query_id()

Get the current query statement resource id.

atkDb::quoteIdentifier()

Quote Indentifier

atkDb::resetQueryId()

Rests the query resource.

atkDb::rollback()

Rollback the current transaction.

atkDb::savepoint()

Set savepoint with the given name.

atkDb::setHaltOnError()

Halt on error or not?

atkDb::setInstance()

Replace the current instance of a named connection at runtime with a different connection. This is useful for example for replacing a named database instance with a mock object for testing purposes.

atkDb::setQueryId()

Sets the current query identifier used for next_record() etc.

atkDb::setSequenceValue()

Set database sequence value.

atkDb::setUserError()

Define custom user error codes.

atkDb::tableExists()

This function checks the database for a table with the provide name

atkDb::tableMeta()

Fetches table meta data from database

atkDb::table_names()

Return the available table names

atkDb::toggleForeignKeys()

Enable/disable all foreign key constraints.

atkDb::unlock()

Relieve all locks.

atkDb::useMapping()

Use the given mapping to translate database requests from one database to another database. This can be used for test purposes.

atkDb::vendorDateFormat()

Convert a php date() format specifier to a vendor specific format specifier.

atkDb::_getOrUseMapping()

Get or set the database mapping

atkDb::_getTableMetaFromCache()

If cached it'll return the table metadata from cache.

atkDb::_getTableMetaFromDb()

Returns the tablemetadata directly from db

atkDb::_translateError()

Translate database-vendor dependent error messages into an ATK generic error code.

[ Top ]

Method Summary

atkMsSqlDb	atkMsSqlDb()	Class constructor
affected	affected_rows()	Evaluate the result; which rows were affected by the query.
void	commit()	Commit the current transaction.
connection	connect()	Connect to the database
void	disconnect()	Disconnect from database
String	getErrorMsg()	Get localized error message (for display in the application)
array	getrows()	Get all rows that are the result of a certain specified query
result	lock()	Lock a certain table in the database
array	metadata()	Return the meta data of a certain table
the	nextid()	Get the next sequence number of a certain sequence.
result	next_record()	Goto the next record in the result set
number	num_fields()	Evaluatie the result; how many fields where affected by the query.
number	num_rows()	Evaluate the result; how many rows were affected by the query.
void	query()	Performs a query
bool	rollback()	Rollback the the current transaction.
void	seek()	Goto a certain position in result set.
array	table_names()	Return the available table names
result	unlock()	Unlock table(s) in the database
int	_translateError()	Translate database-vendor dependent error messages into an ATK generic error code.

[ Top ]

Properties

Methods

Constructor atkMsSqlDb [line 55]

atkMsSqlDb atkMsSqlDb(
)

Class constructor

[ Top ]

affected_rows [line 242]

affected affected_rows(
)

Evaluate the result; which rows were affected by the query.

API Tags:

Return:

rows

Redefinition of:

atkMysqlDb::affected_rows(): Evaluate the result; which rows were affected by the query.

[ Top ]

commit [line 397]

void commit(
)

Commit the current transaction.

Redefinition of:

atkDb::commit(): Commit the current transaction.

[ Top ]

connect [line 66]

connection connect(
)

Connect to the database

API Tags:

Return:

status

Redefinition of:

atkDb::connect(): Connect to the database.

[ Top ]

disconnect [line 109]

void disconnect(
)

Disconnect from database

Redefinition of:

atkMysqlDb::disconnect(): Disconnect from database

[ Top ]

getErrorMsg [line 426]

String getErrorMsg(
)

Get localized error message (for display in the application)

API Tags:

Return:

Error message

Redefinition of:

atkDb::getErrorMsg(): Get localized error message (for display in the application)

[ Top ]

getrows [line 446]

array getrows(
string
$query, [int
$offset = -1], [int
$limit = -1] 
)

Get all rows that are the result of a certain specified query

Note: This is not an efficient way to retrieve records, as this will load all records into one array into memory. If you retrieve a lot of records, you might hit the memory_limit and your script will die.

Parameters:

string	$query:	the query
int	$offset:	The offset to use
int	$limit:	The limit to use

API Tags:

Return:

array with rows

[ Top ]

lock [line 203]

result lock(
string
$table, [string
$mode = "write"] 
)

Lock a certain table in the database

Parameters:

string	$table:	the table name
string	$mode:	the type of locking

API Tags:

Return:

of locking

Redefinition of:

atkMysqlDb::lock(): Lock a certain table in the database

[ Top ]

metadata [line 323]

array metadata(
string
$table, [bool
$full = false] 
)

Return the meta data of a certain table

Parameters:

string	$table:	the table name
bool	$full:	all meta data or not

API Tags:

Return:

with meta data

Redefinition of:

atkMysqlDb::metadata(): Return the meta data of a certain table

[ Top ]

nextid [line 273]

the nextid(
string
$sequence 
)

Get the next sequence number of a certain sequence.

Parameters:

string

$sequence:

the sequence name

API Tags:

Return:

next sequence id

Redefinition of:

atkMysqlDb::nextid(): Get the next sequence number of a certain sequence.

[ Top ]

next_record [line 164]

result next_record(
)

Goto the next record in the result set

API Tags:

Return:

of going to the next record

Redefinition of:

atkMysqlDb::next_record(): Goto the next record in the result set

[ Top ]

num_fields [line 262]

number num_fields(
)

Evaluatie the result; how many fields where affected by the query.

API Tags:

Return:

of affected fields

Redefinition of:

atkMysqlDb::num_fields(): Evaluatie the result; how many fields where affected by the query.

[ Top ]

num_rows [line 252]

number num_rows(
)

Evaluate the result; how many rows were affected by the query.

API Tags:

Return:

of affected rows

Redefinition of:

atkMysqlDb::num_rows(): Evaluate the result; how many rows were affected by the query.

[ Top ]

query [line 122]

void query(
string
$query, [int
$offset = -1], [int
$limit = -1] 
)

Performs a query

Parameters:

string	$query:	the query
int	$offset:	offset in record list
int	$limit:	maximum number of records

Information Tags:

Todo:

implement limit and offset support

Redefinition of:

atkMysqlDb::query(): Performs a query

[ Top ]

rollback [line 412]

bool rollback(
)

Rollback the the current transaction.

API Tags:

Return:

true

Redefinition of:

atkDb::rollback(): Rollback the current transaction.

[ Top ]

seek [line 189]

void seek(
[int
$position = 0], [bool
$haltOnError = true] 
)

Goto a certain position in result set.

Not specifying a position will set the pointer at the beginning of the result set.

Parameters:

int	$position:	the position
bool	$haltOnError:

Redefinition of:

atkMysqlDb::seek(): Goto a certain position in result set.

[ Top ]

table_names [line 376]

array table_names(
)

Return the available table names

API Tags:

Return:

with table names etc.

Redefinition of:

atkMysqlDb::table_names(): Return the available table names

[ Top ]

unlock [line 222]

result unlock(
)

Unlock table(s) in the database

API Tags:

Return:

of unlocking

Redefinition of:

atkMysqlDb::unlock(): Unlock table(s) in the database

[ Top ]

_translateError [line 97]

int _translateError(
mixed
$errno 
)

Translate database-vendor dependent error messages into an ATK generic error code.

Parameters:

mixed

$errno:

Vendor-dependent error code.

API Tags:

Return:	ATK error code
Access:	private

Redefinition of:

atkMysqlDb::_translateError(): Translates known database errors to developer-friendly messages

[ Top ]