Docs For Class atkPgsqlDb

Inherited Properties	Inherited Methods
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	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::getInstance() Get database instance. atkDb::getMapping() Returns the current database mapping. atkDb::getQueryMode() Returns the query mode atkDb::getrows() Get all rows that are the result of a certain specified query 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 (first row, first column) from a certain specified query atkDb::getValues() Get an array with all the values in the (first) column. 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::query() Parse and execute a query. atkDb::query_id() Get the current query statement resource id. atkDb::quoteIdentifier() Quote Indentifier 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::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 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

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::getInstance()

Get database instance.

atkDb::getMapping()

Returns the current database mapping.

atkDb::getQueryMode()

Returns the query mode

atkDb::getrows()

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

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 (first row, first column) from a certain specified query

atkDb::getValues()

Get an array with all the values in the (first) column.

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::query()

Parse and execute a query.

atkDb::query_id()

Get the current query statement resource id.

atkDb::quoteIdentifier()

Quote Indentifier

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::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 ]

Property Summary

mixed	$m_type
mixed	$m_vendor

[ Top ]

Method Summary

affected	affected_rows()	Evaluate the result; which rows were affected by the query.
void	atkpgsqldb()	Base constructor
connection	connect()	Connect to the database
void	disconnect()	Disconnect from database, we use a persistent
array	getSearchModes()	This function indicates what searchmodes the database supports.
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
void	seek()	Goto a certain position in result set.
bool	tableExists()	Check if table exists.
array	table_names()	Return the available table names
result	unlock()	Unlock table(s) in the database
int	_translateError()	TODO FIXME: I don't know what errormessges postgresql gives, so this function only returns DB_UNKNOWNERROR for now.

[ Top ]

Properties

mixed $m_type = "pgsql" [line 30]

Redefinition of:

atkDb::$m_type: Driver name.

[ Top ]

mixed $m_vendor = "postgresql" [line 31]

Redefinition of:

atkDb::$m_vendor: Vendor.

[ Top ]

Methods

affected_rows [line 217]

affected affected_rows(
)

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

API Tags:

Return:

rows

Redefinition of:

atkDb::affected_rows(): Retrieve the number of rows affected by the last query.

[ Top ]

atkpgsqldb [line 36]

void atkpgsqldb(
)

Base constructor

[ Top ]

connect [line 45]

connection connect(
)

Connect to the database

API Tags:

Return:

identifier

Redefinition of:

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

[ Top ]

disconnect [line 94]

void disconnect(
)

Disconnect from database, we use a persistent

link, so this won't be necessary!

Redefinition of:

atkDb::disconnect(): Disconnect from database

[ Top ]

getSearchModes [line 452]

array getSearchModes(
)

This function indicates what searchmodes the database supports.

API Tags:

Return:

with search modes

Redefinition of:

atkDb::getSearchModes(): This function indicates what searchmodes the database supports.

[ Top ]

lock [line 178]

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:

atkDb::lock(): Lock a table in the database.

[ Top ]

metadata [line 303]

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:

atkDb::metadata(): Return the meta data of a certain table HIE GEBLEVEN

[ Top ]

nextid [line 248]

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:

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

[ Top ]

next_record [line 143]

result next_record(
)

Goto the next record in the result set

API Tags:

Return:

of going to the next record

Redefinition of:

atkDb::next_record(): Retrieve the next record in the resultset.

[ Top ]

num_fields [line 237]

number num_fields(
)

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

API Tags:

Return:

of affected fields

[ Top ]

num_rows [line 227]

number num_rows(
)

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

API Tags:

Return:

of affected rows

[ Top ]

query [line 104]

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

Redefinition of:

atkDb::query(): Parse and execute a query.

[ Top ]

seek [line 167]

void seek(
[int
$position = 0] 
)

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

[ Top ]

tableExists [line 442]

bool tableExists(
string
$table 
)

Check if table exists.

Parameters:

string

$table:

the table to find

API Tags:

Return:

true if found, false if not found

Redefinition of:

atkDb::tableExists(): This function checks the database for a table with the provide name

[ Top ]

table_names [line 418]

array table_names(
)

Return the available table names

API Tags:

Return:

with table names etc.

Redefinition of:

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

[ Top ]

unlock [line 198]

result unlock(
)

Unlock table(s) in the database

API Tags:

Return:

of unlocking

Redefinition of:

atkDb::unlock(): Relieve all locks.

[ Top ]

_translateError [line 85]

int _translateError(
[mixed
$error = ""] 
)

TODO FIXME: I don't know what errormessges postgresql gives, so this function only returns DB_UNKNOWNERROR for now.

Parameters:

mixed

$error:

API Tags:

Return:

The ATK error code

Redefinition of:

atkDb::_translateError(): Translate database-vendor dependent error messages into an ATK generic error code.

[ Top ]