Class: MDB_mysql

Source Location: /MDB-1.3.0/MDB/mysql.php

Class Overview

PEAR
   |
   --MDB_Common
      |
      --MDB_mysql

MDB MySQL driver

Author(s):

Lukas Smith <smith at backendmedia.com>

Inherited Variables

Inherited Methods

Class: MDB_Common

MDB_Common::MDB_Common(): Constructor
MDB_Common::affectedRows(): returns the affected rows of a query
MDB_Common::alterTable(): alter an existing table
MDB_Common::autoCommit(): Define whether database changes done on the database be automatically committed. This function may also implicitly start or end a transaction.
MDB_Common::captureDebugOutput(): set a debug handler
MDB_Common::commit(): Commit the database changes done during a transaction that is in progress. This function may only be called when auto-committing is disabled, otherwise it will fail. Therefore, a new transaction is implicitly started after committing the pending changes.
MDB_Common::convertResult(): convert a value to a RDBMS indepdenant MDB type
MDB_Common::convertResultRow(): convert a result row
MDB_Common::createDatabase(): create a new database
MDB_Common::createIndex(): get the stucture of a field into an array
MDB_Common::createLob(): Create a handler object of a specified class with functions to retrieve data from a large object data stream.
MDB_Common::createSequence(): create sequence
MDB_Common::createTable(): create a new table
MDB_Common::currId(): returns the current id of a sequence
MDB_Common::debug(): set a debug message
MDB_Common::debugOutput(): output debug info
MDB_Common::destroyLob(): Free any resources allocated during the lifetime of the large object handler object.
MDB_Common::disconnect(): Log out and disconnect from the database.
MDB_Common::dropDatabase(): drop an existing database
MDB_Common::dropIndex(): drop existing index
MDB_Common::dropSequence(): drop existing sequence
MDB_Common::dropTable(): drop an existing table
MDB_Common::endOfLob(): Determine whether it was reached the end of the large object and therefore there is no more data to be read for the its input stream.
MDB_Common::endOfResult(): check if the end of the result set has been reached
MDB_Common::endOfResultLob(): Determine whether it was reached the end of the large object and therefore there is no more data to be read for the its input stream.
MDB_Common::error(): Retrieve the error message text associated with the last operation that failed. Some functions may fail but they do not return the reason that makes them to fail. This function is meant to retrieve a textual description of the failure cause.
MDB_Common::errorCode(): Map native error codes to MDB's portable ones. Requires that the DB implementation's constructor fills in the $errorcode_map property.
MDB_Common::errorMessage(): Map a MDB error code to a textual message. This is actually just a wrapper for MDB::errorMessage().
MDB_Common::errorNative(): returns an errormessage, provides by the database
MDB_Common::execute(): Executes a prepared SQL query
MDB_Common::executeMultiple(): This function does several execute() calls on the same statement handle.
MDB_Common::executeQuery(): Execute a prepared query statement.
MDB_Common::fetch(): fetch value from a result set
MDB_Common::fetchAll(): Fetch and return a column of data (it uses fetchInto for that)
MDB_Common::fetchBlob(): fetch a blob value from a result set
MDB_Common::fetchBoolean(): fetch a boolean value from a result set
MDB_Common::fetchClob(): fetch a clob value from a result set
MDB_Common::fetchCol(): Fetch and return a column of data (it uses fetchInto for that)
MDB_Common::fetchDate(): fetch a date value from a result set
MDB_Common::fetchDecimal(): fetch a decimal value from a result set
MDB_Common::fetchFloat(): fetch a float value from a result set
MDB_Common::fetchInto(): Fetch a row and return data in an array.
MDB_Common::fetchLob(): fetch a lob value from a result set
MDB_Common::fetchOne(): Fetch and return a field of data (it uses fetchInto for that)
MDB_Common::fetchRow(): Fetch and return a row of data (it uses fetchInto for that)
MDB_Common::fetchTime(): fetch a time value from a result set
MDB_Common::fetchTimestamp(): fetch a timestamp value from a result set
MDB_Common::freeBlobValue(): free a binary large object
MDB_Common::freeClobValue(): free a character large object
MDB_Common::freePreparedQuery(): Release resources allocated for the specified prepared query.
MDB_Common::freeResult(): Free the internal resources associated with $result.
MDB_Common::getAll(): Fetch all the rows returned from a query.
MDB_Common::getAssoc(): Fetch the entire result set of a query and return it as an associative array using the first column as the key.
MDB_Common::getBlobDeclaration(): Obtain DBMS specific SQL code portion needed to declare an binary large object type field to be used in statements like CREATE TABLE.
MDB_Common::getBlobValue(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB_Common::getBooleanDeclaration(): Obtain DBMS specific SQL code portion needed to declare a boolean type field to be used in statements like CREATE TABLE.
MDB_Common::getBooleanValue(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB_Common::getClobDeclaration(): Obtain DBMS specific SQL code portion needed to declare an character large object type field to be used in statements like CREATE TABLE.
MDB_Common::getClobValue(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB_Common::getCol(): Fetch a single column from a result set and return it as an indexed array.
MDB_Common::getColumnNames(): Retrieve the names of columns returned by the DBMS in a query result.
MDB_Common::getDateDeclaration(): Obtain DBMS specific SQL code portion needed to declare a date type field to be used in statements like CREATE TABLE.
MDB_Common::getDateValue(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB_Common::getDecimalDeclaration(): Obtain DBMS specific SQL code portion needed to declare a decimal type field to be used in statements like CREATE TABLE.
MDB_Common::getDecimalValue(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB_Common::getDSN(): return the DSN as a string
MDB_Common::getFieldDeclaration(): get declaration of a field
MDB_Common::getFieldDeclarationList(): get declaration of a number of field in bulk
MDB_Common::getFloatDeclaration(): Obtain DBMS specific SQL code portion needed to declare a float type field to be used in statements like CREATE TABLE.
MDB_Common::getFloatValue(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB_Common::getIntegerDeclaration(): Obtain DBMS specific SQL code portion needed to declare an integer type field to be used in statements like CREATE TABLE.
MDB_Common::getIntegerValue(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB_Common::getOne(): Fetch the first column of the first row of data returned from a query. Takes care of doing the query and freeing the results when finished.
MDB_Common::getOption(): returns the value of an option
MDB_Common::getRow(): Fetch the first row of data returned from a query. Takes care of doing the query and freeing the results when finished.
MDB_Common::getSequenceDefinition(): get the stucture of a sequence into an array
MDB_Common::getSequenceName(): adds sequence name formating to a sequence name
MDB_Common::getTableFieldDefinition(): get the stucture of a field into an array
MDB_Common::getTableIndexDefinition(): get the stucture of an index into an array
MDB_Common::getTextDeclaration(): Obtain DBMS specific SQL code portion needed to declare an text type field to be used in statements like CREATE TABLE.
MDB_Common::getTextValue(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB_Common::getTimeDeclaration(): Obtain DBMS specific SQL code portion needed to declare a time field to be used in statements like CREATE TABLE.
MDB_Common::getTimestampDeclaration(): Obtain DBMS specific SQL code portion needed to declare a timestamp field to be used in statements like CREATE TABLE.
MDB_Common::getTimestampValue(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB_Common::getTimeValue(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB_Common::getValue(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB_Common::getWarnings(): get all warnings in reverse order.
MDB_Common::limitQuery(): Generates a limited query
MDB_Common::listDatabases(): list all databases
MDB_Common::listFunctions(): list all functions in the current database
MDB_Common::listSequences(): list all tables in the current database
MDB_Common::listTableFields(): list all fields in a tables in the current database
MDB_Common::listTableIndexes(): list all indexes in a table
MDB_Common::listTables(): list all tables in the current database
MDB_Common::listUsers(): list all users
MDB_Common::listViews(): list all viewes in the current database
MDB_Common::loadLob(): loads the LOB module
MDB_Common::loadManager(): loads the Manager module
MDB_Common::nextId(): returns the next free id of a sequence
MDB_Common::numCols(): Count the number of columns returned by the DBMS in a query result.
MDB_Common::numRows(): returns the number of rows in a result object
MDB_Common::prepareQuery(): Prepares a query for multiple execution with execute().
MDB_Common::query(): Send a query to the database and return any results
MDB_Common::queryAll(): Execute the specified query, fetch all the rows of the result set into a two dimensional array and then frees the result set.
MDB_Common::queryCol(): Execute the specified query, fetch the value from the first column of each row of the result set into an array and then frees the result set.
MDB_Common::queryOne(): Execute the specified query, fetch the value from the first column of the first row of the result set and then frees the result set.
MDB_Common::queryRow(): Execute the specified query, fetch the values from the first row of the result set into an array and then frees the result set.
MDB_Common::quoteIdentifier(): Quote a string so it can be safely used as a table or column name
MDB_Common::raiseError(): This method is used to communicate an error and invoke error callbacks etc. Basically a wrapper for PEAR::raiseError without the message string.
MDB_Common::readLob(): Read data from large object input stream.
MDB_Common::replace(): Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT query, except that if there is already a row in the table with the same key field values, the REPLACE query just updates its values instead of inserting a new row.
MDB_Common::resetWarnings(): reset the warning array
MDB_Common::resultIsNull(): Determine whether the value of a query result located in given row and field is a NULL.
MDB_Common::rollback(): Cancel any database changes done during a transaction that is in progress. This function may only be called when auto-committing is disabled, otherwise it will fail. Therefore, a new transaction is implicitly started after canceling the pending changes.
MDB_Common::setDatabase(): Select a different database
MDB_Common::setDSN(): set the DSN
MDB_Common::setErrorHandler(): Specify a function that is called when an error occurs.
MDB_Common::setFetchMode(): Sets which fetch mode should be used by default on queries on this connection.
MDB_Common::setOption(): set the option for the db class
MDB_Common::setParam(): Set the value of a parameter of a prepared query.
MDB_Common::setParamArray(): Set the values of multiple a parameter of a prepared query in bulk.
MDB_Common::setParamBlob(): Set a parameter of a prepared query with a binary large object value.
MDB_Common::setParamBoolean(): Set a parameter of a prepared query with a boolean value.
MDB_Common::setParamClob(): Set a parameter of a prepared query with a character large object value.
MDB_Common::setParamDate(): Set a parameter of a prepared query with a date value.
MDB_Common::setParamDecimal(): Set a parameter of a prepared query with a decimal value.
MDB_Common::setParamFloat(): Set a parameter of a prepared query with a float value.
MDB_Common::setParamInteger(): Set a parameter of a prepared query with a text value.
MDB_Common::setParamNull(): Set the value of a parameter of a prepared query to NULL.
MDB_Common::setParamText(): Set a parameter of a prepared query with a text value.
MDB_Common::setParamTime(): Set a parameter of a prepared query with a time value.
MDB_Common::setParamTimestamp(): Set a parameter of a prepared query with a time stamp value.
MDB_Common::setResultTypes(): Define the list of types to be associated with the columns of a given result set.
MDB_Common::setSelectedRowRange(): set the range of the next query
MDB_Common::subSelect(): simple subselect emulation: leaves the query untouched for all RDBMS that support subselects
MDB_Common::support(): Tell whether a DB implementation or its backend extension supports a given feature.
MDB_Common::tableInfo(): returns meta data about the result set
MDB_Common::__toString(): String conversation

Class Details

[line 61]
MDB MySQL driver

Notes:

The decimal type fields are emulated with integer fields.

Author: Lukas Smith <smith@backendmedia.com>

[ Top ]

Class Variables

$columns = array()

[line 76]

Type:

mixed

[ Top ]

$connected_host =

[line 66]

Type:

mixed

[ Top ]

$connected_password =

[line 68]

Type:

mixed

[ Top ]

$connected_port =

[line 69]

Type:

mixed

[ Top ]

$connected_user =

[line 67]

Type:

mixed

[ Top ]

$connection = 0

[line 65]

Type:

mixed

[ Top ]

$decimal_factor = 1.0

[line 73]

Type:

mixed

[ Top ]

$default_table_type = ''

[line 79]

Type:

mixed

[ Top ]

$dummy_primary_key = 'dummy_primary_key'

[line 81]

Type:

mixed

[ Top ]

$escape_quotes = "\\"

[line 72]

Type:

mixed

[ Top ]

$fixed_float = 0

[line 80]

Type:

mixed

[ Top ]

$highest_fetched_row = array()

[line 75]

Type:

mixed

[ Top ]

$opened_persistent = ''

[line 70]

Type:

mixed

[ Top ]

Method Detail

MDB_mysql (Constructor) [line 89]

MDB_mysql MDB_mysql(
)

Constructor

[ Top ]

autoCommit [line 224]

mixed autoCommit(
boolean
$auto_commit)

Define whether database changes done on the database be automatically committed. This function may also implicitly start or end a transaction.

Return: MDB_OK on success, a MDB error on failure
Access: public

Overrides MDB_Common::autoCommit() (Define whether database changes done on the database be automatically committed. This function may also implicitly start or end a transaction.)

Parameters:

boolean $auto_commit — flag that indicates whether the database changes should be committed right after executing every query statement. If this argument is 0 a transaction implicitly started. Otherwise, if a transaction is in progress it is ended by committing any database changes that were pending.

[ Top ]

commit [line 269]

mixed commit(
)

Commit the database changes done during a transaction that is in progress. This function may only be called when auto-committing is disabled, otherwise it will fail. Therefore, a new transaction is implicitly started after committing the pending changes.

Return: MDB_OK on success, a MDB error on failure
Access: public

Overrides MDB_Common::commit() (Commit the database changes done during a transaction that is in progress. This function may only be called when auto-committing is disabled, otherwise it will fail. Therefore, a new transaction is implicitly started after committing the pending changes.)

[ Top ]

connect [line 318]

TRUE connect(
)

Connect to the database

Return: on success, MDB_Error on failure

[ Top ]

convertResult [line 829]

mixed convertResult(
mixed
$value, int
$type)

convert a value to a RDBMS indepdenant MDB type

Return: converted value
Access: public

Overrides MDB_Common::convertResult() (convert a value to a RDBMS indepdenant MDB type)

Parameters:

mixed	`$value`	—	value to be converted
int	`$type`	—	constant that specifies which type to convert to

[ Top ]

currId [line 1366]

mixed currId(
string
$seq_name)

returns the current id of a sequence

Return: MDB_Error or id
Access: public

Overrides MDB_Common::currId() (returns the current id of a sequence)

Parameters:

string $seq_name — name of the sequence

[ Top ]

endOfResult [line 749]

mixed endOfResult(
resource
$result)

check if the end of the result set has been reached

Return: TRUE or FALSE on sucess, a MDB error on failure
Access: public

Overrides MDB_Common::endOfResult() (check if the end of the result set has been reached)

Parameters:

resource $result — result identifier

[ Top ]

errorNative [line 145]

int errorNative(
)

Get the native error code of the last error (if any) that occured on the current connection.

Return: native MySQL error code
Access: public

Overrides MDB_Common::errorNative() (returns an errormessage, provides by the database)

[ Top ]

fetch [line 771]

mixed fetch(
resource
$result, int
$row, int
$field)

fetch value from a result set

Return: string on success, a MDB error on failure
Access: public

Overrides MDB_Common::fetch() (fetch value from a result set)

Parameters:

resource	`$result`	—	result identifier
int	`$row`	—	number of the row where the data can be found
int	`$field`	—	field number where the data can be found

[ Top ]

fetchBlob [line 813]

mixed fetchBlob(
resource
$result, int
$row, int
$field)

fetch a blob value from a result set

Return: content of the specified data cell, a MDB error on failure
Access: public

Overrides MDB_Common::fetchBlob() (fetch a blob value from a result set)

Parameters:

resource	`$result`	—	result identifier
int	`$row`	—	number of the row where the data can be found
int	`$field`	—	field number where the data can be found

[ Top ]

fetchClob [line 796]

mixed fetchClob(
resource
$result, int
$row, int
$field)

fetch a clob value from a result set

Return: content of the specified data cell, a MDB error on failure, a MDB error on failure
Access: public

Overrides MDB_Common::fetchClob() (fetch a clob value from a result set)

Parameters:

resource	`$result`	—	result identifier
int	`$row`	—	number of the row where the data can be found
int	`$field`	—	field number where the data can be found

[ Top ]

fetchInto [line 1389]

int fetchInto(
resource
$result, [int
$fetchmode = MDB_FETCHMODE_DEFAULT], [int
$rownum = NULL])

Fetch a row and insert the data into an existing array.

Return: data array on success, a MDB error on failure
Access: public

Overrides MDB_Common::fetchInto() (Fetch a row and return data in an array.)

Parameters:

resource	`$result`	—	result identifier
int	`$fetchmode`	—	how the array data should be indexed
int	`$rownum`	—	the row number to fetch

[ Top ]

freeBlobValue [line 1270]

MDB_OK freeBlobValue(
resource
$prepared_query, string
$blob)

free a binary large object

Access: public

Overrides MDB_Common::freeBlobValue() (free a binary large object)

Parameters:

resource	`$prepared_query`	—	query handle from prepare()
string	`$blob`	—

[ Top ]

freeClobValue [line 1226]

MDB_OK freeClobValue(
resource
$prepared_query, string
$clob)

free a character large object

Access: public

Overrides MDB_Common::freeClobValue() (free a character large object)

Parameters:

resource	`$prepared_query`	—	query handle from prepare()
string	`$clob`	—

[ Top ]

freeResult [line 864]

boolean freeResult(
$result
$result)

Free the internal resources associated with $result.

Return: TRUE on success, FALSE if $result is invalid
Access: public

Overrides MDB_Common::freeResult() (Free the internal resources associated with $result.)

Parameters:

$result $result — result identifier

[ Top ]

getBlobDeclaration [line 993]

string getBlobDeclaration(
string
$name, string
$field)

Obtain DBMS specific SQL code portion needed to declare an binary large object type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: public

Overrides MDB_Common::getBlobDeclaration() (Obtain DBMS specific SQL code portion needed to declare an binary large object type field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

string

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

length Integer value that determines the maximum length of the large object field. If this argument is missing the field should be declared to have the longest length allowed by the DBMS.

notnull Boolean flag that indicates whether this field is constrained to not be set to NULL.

[ Top ]

getBlobValue [line 1246]

string getBlobValue(
resource
$prepared_query, $parameter
$parameter, $blob
$blob)

Convert a text value into a DBMS specific format that is suitable to compose query statements.

Return: text string that represents the given argument value in a DBMS specific format.
Access: public

Overrides MDB_Common::getBlobValue() (Convert a text value into a DBMS specific format that is suitable to compose query statements.)

Parameters:

resource	`$prepared_query`	—	query handle from prepare()
$parameter	`$parameter`	—
$blob	`$blob`	—

[ Top ]

getClobDeclaration [line 943]

string getClobDeclaration(
string
$name, string
$field)

Obtain DBMS specific SQL code portion needed to declare an character large object type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: public

Overrides MDB_Common::getClobDeclaration() (Obtain DBMS specific SQL code portion needed to declare an character large object type field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

string

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

length Integer value that determines the maximum length of the large object field. If this argument is missing the field should be declared to have the longest length allowed by the DBMS.

notnull Boolean flag that indicates whether this field is constrained to not be set to NULL.

[ Top ]

getClobValue [line 1202]

string getClobValue(
resource
$prepared_query, $parameter
$parameter, $clob
$clob)

Convert a text value into a DBMS specific format that is suitable to compose query statements.

Return: text string that represents the given argument value in a DBMS specific format.
Access: public

Overrides MDB_Common::getClobValue() (Convert a text value into a DBMS specific format that is suitable to compose query statements.)

Parameters:

resource	`$prepared_query`	—	query handle from prepare()
$parameter	`$parameter`	—
$clob	`$clob`	—

[ Top ]

getColumnNames [line 697]

mixed getColumnNames(
resource
$result)

Retrieve the names of columns returned by the DBMS in a query result.

Return:
an associative array variable that will hold the names of columns. The indexes of the array are the column names mapped to lower case and the values are the respective numbers of the columns starting from 0. Some DBMS may not return any columns when the result set does not contain any rows.
a MDB error on failure
Access: public

Overrides MDB_Common::getColumnNames() (Retrieve the names of columns returned by the DBMS in a query result.)

Parameters:

resource $result — result identifier

[ Top ]

getDateDeclaration [line 1041]

string getDateDeclaration(
string
$name, string
$field)

Obtain DBMS specific SQL code portion needed to declare an date type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: public

Overrides MDB_Common::getDateDeclaration() (Obtain DBMS specific SQL code portion needed to declare a date type field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

string

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

default Date value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to NULL.

[ Top ]

getDecimalDeclaration [line 1179]

string getDecimalDeclaration(
string
$name, string
$field)

Obtain DBMS specific SQL code portion needed to declare an decimal type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: public

Overrides MDB_Common::getDecimalDeclaration() (Obtain DBMS specific SQL code portion needed to declare a decimal type field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

string

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

default Integer value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to NULL.

[ Top ]

getDecimalValue [line 1305]

string getDecimalValue(
string
$value)

Convert a text value into a DBMS specific format that is suitable to compose query statements.

Return: text string that represents the given argument value in a DBMS specific format.
Access: public

Overrides MDB_Common::getDecimalValue() (Convert a text value into a DBMS specific format that is suitable to compose query statements.)

Parameters:

string $value — text string value that is intended to be converted.

[ Top ]

getFloatDeclaration [line 1136]

string getFloatDeclaration(
string
$name, string
$field)

Obtain DBMS specific SQL code portion needed to declare an float type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: public

Overrides MDB_Common::getFloatDeclaration() (Obtain DBMS specific SQL code portion needed to declare a float type field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

string

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

default Integer value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to NULL.

[ Top ]

getFloatValue [line 1288]

string getFloatValue(
string
$value)

Convert a text value into a DBMS specific format that is suitable to compose query statements.

Return: text string that represents the given argument value in a DBMS specific format.
Access: public

Overrides MDB_Common::getFloatValue() (Convert a text value into a DBMS specific format that is suitable to compose query statements.)

Parameters:

string $value — text string value that is intended to be converted.

[ Top ]

getIntegerDeclaration [line 908]

string getIntegerDeclaration(
string
$name, string
$field)

Obtain DBMS specific SQL code portion needed to declare an integer type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: public

Overrides MDB_Common::getIntegerDeclaration() (Obtain DBMS specific SQL code portion needed to declare an integer type field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

string

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

unsigned Boolean flag that indicates whether the field should be declared as unsigned integer if possible.

default Integer value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to NULL.

[ Top ]

getTimeDeclaration [line 1104]

string getTimeDeclaration(
string
$name, string
$field)

Obtain DBMS specific SQL code portion needed to declare an time type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: public

Overrides MDB_Common::getTimeDeclaration() (Obtain DBMS specific SQL code portion needed to declare a time field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

string

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

default Time value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to NULL.

[ Top ]

getTimestampDeclaration [line 1073]

string getTimestampDeclaration(
string
$name, string
$field)

Obtain DBMS specific SQL code portion needed to declare an timestamp type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: public

Overrides MDB_Common::getTimestampDeclaration() (Obtain DBMS specific SQL code portion needed to declare a timestamp field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

string

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

default Time stamp value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to NULL.

[ Top ]

mysqlRaiseError [line 164]

object a mysqlRaiseError(
[integer
$errno = NULL], [string
$message = NULL])

This method is used to communicate an error and invoke error callbacks etc. Basically a wrapper for MDB::raiseError that checks for native error msgs.

Return: PEAR error object
See: PEAR_Error
Access: public

Parameters:

integer	`$errno`	—	error code
string	`$message`	—	userinfo message

[ Top ]

nextId [line 1324]

mixed nextId(
string
$seq_name, [boolean
$ondemand = TRUE])

returns the next free id of a sequence

Return: MDB_Error or id
Access: public

Overrides MDB_Common::nextId() (returns the next free id of a sequence)

Parameters:

string	`$seq_name`	—	name of the sequence
boolean	`$ondemand`	—	when true the seqence is automatic created, if it not exists

[ Top ]

nextResult [line 1435]

true nextResult(
a
$result)

Move the internal mysql result pointer to the next available result Currently not supported

Return: if a result is available otherwise return false
Access: public

Parameters:

a $result — valid result resource

[ Top ]

numCols [line 729]

mixed numCols(
resource
$result)

Count the number of columns returned by the DBMS in a query result.

Return: integer value with the number of columns, a MDB error on failure
Access: public

Overrides MDB_Common::numCols() (Count the number of columns returned by the DBMS in a query result.)

Parameters:

resource $result — result identifier

[ Top ]

numRows [line 849]

mixed numRows(
ressource
$result)

returns the number of rows in a result object

Return: MDB_Error or the number of rows
Access: public

Overrides MDB_Common::numRows() (returns the number of rows in a result object)

Parameters:

ressource $result — a valid result ressouce pointer

[ Top ]

query [line 463]

mixed query(
string
$query, [mixed
$types = NULL])

Send a query to the database and return any results

Return: a result handle or MDB_OK on success, a MDB error on failure
Access: public

Overrides MDB_Common::query() (Send a query to the database and return any results)

Parameters:

string	`$query`	—	the SQL query
mixed	`$types`	—	array that contains the types of the columns in the result set

[ Top ]

quoteIdentifier [line 200]

string quoteIdentifier(
string
$str)

Quote a string so it can be safely used as a table or column name

Quoting style depends on which database driver is being used.

MySQL can't handle the backtick character (`) in table or column names.

Return: quoted identifier string
Access: public

Overrides MDB_Common::quoteIdentifier() (Quote a string so it can be safely used as a table or column name)

Parameters:

string $str — identifier name to be quoted

[ Top ]

replace [line 612]

mixed replace(
string
$table, array
$fields)

Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT query, except that if there is already a row in the table with the same key field values, the REPLACE query just updates its values instead of inserting a new row.

The REPLACE type of query does not make part of the SQL standards. Since practically only MySQL implements it natively, this type of query is emulated through this method for other DBMS using standard types of queries inside a transaction to assure the atomicity of the operation.

Return: MDB_OK on success, a MDB error on failure
Access: public

Overrides MDB_Common::replace() (Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT query, except that if there is already a row in the table with the same key field values, the REPLACE query just updates its values instead of inserting a new row.)

Parameters:

string $table — name of the table on which the REPLACE query will be executed.

array

$fields

—

associative array that describes the fields and the values that will be inserted or updated in the specified table. The indexes of the array are the names of all the fields of the table. The values of the array are also associative arrays that describe the values and other properties of the table fields.

Here follows a list of field properties that need to be specified:

Value: Value to be assigned to the specified field. This value may be of specified in database independent type format as this function can perform the necessary datatype conversions.

Default: this property is required unless the Null property is set to 1.

Type Name of the type of the field. Currently, all types Metabase are supported except for clob and blob.

Default: no type conversion

Null Boolean property that indicates that the value for this field should be set to NULL.

The default value for fields missing in INSERT queries may be specified the definition of a table. Often, the default value is already NULL, but since the REPLACE may be emulated using an UPDATE query, make sure that all fields of the table are listed in this function argument array.

Default: 0

Key Boolean property that indicates that this field should be handled as a primary key or at least as part of the compound unique index of the table that will determine the row that will updated if it exists or inserted a new row otherwise.

This function will fail if no key field is specified or if the value of a key field is set to NULL because fields that are part of unique index they may not be NULL.

Default: 0

[ Top ]

rollback [line 296]

mixed rollback(
)

Cancel any database changes done during a transaction that is in progress. This function may only be called when auto-committing is disabled, otherwise it will fail. Therefore, a new transaction is implicitly started after canceling the pending changes.

Return: MDB_OK on success, a MDB error on failure
Access: public

Overrides MDB_Common::rollback() (Cancel any database changes done during a transaction that is in progress. This function may only be called when auto-committing is disabled, otherwise it will fail. Therefore, a new transaction is implicitly started after canceling the pending changes.)

[ Top ]

subSelect [line 525]

string subSelect(
string
$query, [string
$quote = FALSE])

simple subselect emulation for Mysql

Return: the query
Access: public

Overrides MDB_Common::subSelect() (simple subselect emulation: leaves the query untouched for all RDBMS that support subselects)

Parameters:

string	`$query`	—	the SQL query for the subselect that may only return a column
string	`$quote`	—	determines if the data needs to be quoted before being returned

[ Top ]

tableInfo [line 1451]

array tableInfo(
resource
$result, [mixed
$mode = NULL])

returns meta data about the result set

Return: an nested array, or a MDB error
Access: public

Overrides MDB_Common::tableInfo() (returns meta data about the result set)

Parameters:

resource	`$result`	—	result identifier
mixed	`$mode`	—	depends on implementation

[ Top ]