MDB
[ class tree: MDB ] [ index: MDB ] [ all elements ]

Class: MDB_querysim

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

Class Overview

PEAR
   |
   --MDB_Common
      |
      --MDB_querysim

MDB QuerySim driver


Author(s):

Variables

Methods


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 217]
MDB QuerySim driver


[ Top ]


Class Variables

$columns = array()

[line 233]


Type:   mixed


[ Top ]

$connected_host =

[line 223]


Type:   mixed


[ Top ]

$connected_password =

[line 225]


Type:   mixed


[ Top ]

$connected_port =

[line 226]


Type:   mixed


[ Top ]

$connected_user =

[line 224]


Type:   mixed


[ Top ]

$connection =  0

[line 222]


Type:   mixed


[ Top ]

$decimal_factor =  1.0

[line 230]


Type:   mixed


[ Top ]

$escape_quotes =  "\\"

[line 229]


Type:   mixed


[ Top ]

$highest_fetched_row = array()

[line 232]


Type:   mixed


[ Top ]

$opened_persistent =  ''

[line 227]


Type:   mixed


[ Top ]



Method Detail

MDB_querysim (Constructor)   [line 241]

MDB_querysim MDB_querysim( )

Constructor

[ Top ]

connect   [line 284]

mixed connect( string $dsn, mixed $persistent)

Open a file or simulate a successful database connect
  • Return: MDB_OK string on success, a MDB error object on failure
  • Access: public

Parameters:

string   $dsn   —  the data source name (see MDB::parseDSN for syntax)
mixed   $persistent   —  (optional) boolean whether the connection should be persistent (default FALSE) or assoc array of config options

[ Top ]

endOfResult   [line 657]

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 ]

fetch   [line 679]

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

fetch value from a simulated result set
  • Return: string on success, a MDB error on failure
  • Access: public

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

Parameters:

array   $result   —  simulated result
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 757]

mixed fetchInto( &$result, [int $fetchmode = MDB_FETCHMODE_DEFAULT], [int $rownum = null], resource $result)

Fetch a row and return data in an array.
  • Return: data array or NULL 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   —  ignored
int   $rownum   —  the row number to fetch
   &$result   — 

[ Top ]

freeResult   [line 723]

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

getColumnNames   [line 607]

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 ]

nextResult   [line 801]

true nextResult( array &$result)

Move the array result pointer to the next available row
  • Return: if a result is available otherwise return false
  • Access: public

Parameters:

array   &$result   —  a valid QuerySim result array

[ Top ]

numCols   [line 636]

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

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

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

Get QuerySim text from appropriate source and return the parsed text.
  • Return: Simulated result set as a multidimentional array if valid QuerySim text was passed in. A MDB error is returned on failure.
  • Access: public

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

Parameters:

mixed   $types   —  array that contains the types of the columns in the result set
string   $query   —  The QuerySim text

[ Top ]

setOption   [line 367]

mixed setOption( string $option, mixed $value)

Set the option for the MDB class
  • Return: MDB_OK or MDB_Error

Overrides MDB_Common::setOption() (set the option for the db class)

Parameters:

string   $option   —  option name
mixed   $value   —  value for the option

[ Top ]

_close   [line 342]

bool _close( )

Close a file or simulate a successful database disconnect
  • Return: TRUE on success, FALSE if file closed. Always TRUE if simulated.
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 10:15:32 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.