Docs For Class atki5db

Home

Documentation home

Atk index

Docs For Class atki5db [ package: atk ]

Class: atki5db

Source Location: /db/class.atki5db.inc

Class atki5db

Class Overview

IBM i5-specific databasedriver. This driver is based on the db2 driver but uses the i5_ library instead of the db2_ library. This allows us not just execute queries, but also to run some commands on the i5 machine. This is used to set the librarylist on-the-fly, for example.

You can supply a librarylist in your database configuration by adding librarylist to your database configuration:

$db['default']['librarylist'] = array('MYLIBL', 'HISLIBL');

Located in /db/class.atki5db.inc [line 17]

Wiki documentation

atkDb
   |
   --atkdb2db
      |
      --atki5db

Author(s):

Harrie Verveer <harrie@ibuildings.nl>

Information Tags:

Methods

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkdb2db atkdb2db::$m_seq_field atkdb2db::$m_seq_namefield atkdb2db::$m_seq_table atkdb2db::$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_identifierQuoting 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 atkdb2db atkdb2db::atkdb2db() Base constructor atkdb2db::affected_rows() Evaluate the result; which rows were affected by the query. atkdb2db::disconnect() Disconnect from database atkdb2db::doConnect() Connect to the database atkdb2db::func_datetimetochar() Get TO_CHAR() equivalent for the current database. atkdb2db::func_datetochar() Get TO_CHAR() equivalent for the current database. atkdb2db::getEbcdicFields() Sometimes, when certain database functions are used, DB2 returns EBCDIC instead of ASCII. Figure out what fields need to get a special treatment. atkdb2db::getrows() Get all rows that are the result of a certain specified query atkdb2db::getSearchModes() This function indicates what searchmodes the database supports. atkdb2db::lock() Lock a certain table in the database atkdb2db::metadata() Return the meta data of a certain table atkdb2db::metadataToFlags() We need to reconstruct the flags array ourselves based on the fields we obtained from INFORMATION_SCHEMA.COLUMNS. Get properties from the row provided and return an array based on these properties. atkdb2db::nextid() Get the next sequence number of a certain sequence. atkdb2db::next_record() Goto the next record in the result set atkdb2db::num_fields() Evaluatie the result; how many fields where affected by the query. atkdb2db::num_rows() Evaluate the result; how many rows were affected by the query. atkdb2db::query() Performs a query atkdb2db::seek() Goto a certain position in result set. atkdb2db::setSequenceValue() Set database sequence value. atkdb2db::tableExists() This function checks the database for a table with the provide name atkdb2db::table_names() Return the available table names atkdb2db::unlock() Unlock table(s) in the database atkdb2db::vendorDateFormat() Convert a php date() format specifier to a mysql specific format specifier. atkdb2db::_getTableType() Returns the table type. atkdb2db::_setErrorVariables() Store MySQL errors in internal variables atkdb2db::_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 atkdb2db

atkdb2db::$m_seq_field

atkdb2db::$m_seq_namefield

atkdb2db::$m_seq_table

atkdb2db::$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_identifierQuoting

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 atkdb2db

atkdb2db::atkdb2db()

Base constructor

atkdb2db::affected_rows()

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

atkdb2db::disconnect()

Disconnect from database

atkdb2db::doConnect()

Connect to the database

atkdb2db::func_datetimetochar()

Get TO_CHAR() equivalent for the current database.

atkdb2db::func_datetochar()

Get TO_CHAR() equivalent for the current database.

atkdb2db::getEbcdicFields()

Sometimes, when certain database functions are used, DB2 returns EBCDIC instead of ASCII. Figure out what fields need to get a special treatment.

atkdb2db::getrows()

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

atkdb2db::getSearchModes()

This function indicates what searchmodes the database supports.

atkdb2db::lock()

Lock a certain table in the database

atkdb2db::metadata()

Return the meta data of a certain table

atkdb2db::metadataToFlags()

We need to reconstruct the flags array ourselves based on the fields we obtained from INFORMATION_SCHEMA.COLUMNS. Get properties from the row provided and return an array based on these properties.

atkdb2db::nextid()

Get the next sequence number of a certain sequence.

atkdb2db::next_record()

Goto the next record in the result set

atkdb2db::num_fields()

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

atkdb2db::num_rows()

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

atkdb2db::query()

Performs a query

atkdb2db::seek()

Goto a certain position in result set.

atkdb2db::setSequenceValue()

Set database sequence value.

atkdb2db::tableExists()

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

atkdb2db::table_names()

Return the available table names

atkdb2db::unlock()

Unlock table(s) in the database

atkdb2db::vendorDateFormat()

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

atkdb2db::_getTableType()

Returns the table type.

atkdb2db::_setErrorVariables()

Store MySQL errors in internal variables

atkdb2db::_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

atki5db	atki5db()
void	add_to_librarylist()
affected	affected_rows()	Evaluate the result; which rows were affected by the query.
void	disconnect()	Disconnect from i5 machine
mixed	doConnect()	Connect to the i5 machine
array	metadata()	Return the meta data of a certain table
void	nextid()
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.
boolean	query()	Performs a query
void	seek()
result	unlock()	Unlock table(s) in the database
void	_setErrorVariables()	Get errornumber and errormessage from the i5 machine and store them

[ Top ]

Properties

Methods

Constructor atki5db [line 19]

atki5db atki5db(
)

[ Top ]

add_to_librarylist [line 58]

void add_to_librarylist(

$libraries 
)

Parameters:

$libraries:

[ Top ]

affected_rows [line 213]

affected affected_rows(
)

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

API Tags:

Return:

rows

Redefinition of:

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

[ Top ]

disconnect [line 104]

void disconnect(
)

Disconnect from i5 machine

Redefinition of:

atkdb2db::disconnect(): Disconnect from database

[ Top ]

doConnect [line 34]

mixed doConnect(
string
$host, string
$user, string
$password, 
$database, 
$port, 
$charset 
)

Connect to the i5 machine

Parameters:

string	$host:	Hostname
string	$user:	Username
string	$password:	Password
	$database:
	$port:
	$charset:

API Tags:

Return:

Connection status

Redefinition of:

atkdb2db::doConnect(): Connect to the database

[ Top ]

metadata [line 245]

array metadata(
String
$table, [boolean
$full = false] 
)

Return the meta data of a certain table

Parameters:

String	$table:	the table name (optionally in 'database.tablename' format)
boolean	$full:	all meta data or not

API Tags:

Return:

with meta data

Redefinition of:

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

[ Top ]

nextid [line 285]

void nextid(

$sequence 
)

Parameters:

$sequence:

Redefinition of:

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

[ Top ]

next_record [line 163]

result next_record(
[
$row_number = null] 
)

Goto the next record in the result set

Parameters:

$row_number:

API Tags:

Return:

of going to the next record

Redefinition of:

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

[ Top ]

num_fields [line 233]

number num_fields(
)

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

API Tags:

Return:

of affected fields

Redefinition of:

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

[ Top ]

num_rows [line 223]

number num_rows(
)

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

API Tags:

Return:

of affected rows

Redefinition of:

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

[ Top ]

query [line 121]

boolean query(
$query
$query, [$offset
$offset = -1], [$limit
$limit = -1] 
)

Performs a query

Parameters:

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

API Tags:

Return:

True on success, false on failure

Redefinition of:

atkdb2db::query(): Performs a query

[ Top ]

seek [line 203]

void seek(
[
$row_number = 0] 
)

Parameters:

$row_number:

Redefinition of:

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

[ Top ]

unlock [line 334]

result unlock(
)

Unlock table(s) in the database

API Tags:

Return:

of unlocking

Redefinition of:

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

[ Top ]

_setErrorVariables [line 81]

void _setErrorVariables(
)

Get errornumber and errormessage from the i5 machine and store them

in the errno and error member variables

Redefinition of:

atkdb2db::_setErrorVariables(): Store MySQL errors in internal variables

[ Top ]