fDatabaseclassv1.0.0b40

Configures the connection to a database - connection is not made until the first query is executed

Passing NULL to any parameter other than $type and $database will cause the default value to be used.

Clears all of the schema info out of the object and, if set, the fCache object

Closes the database connection

Connects to the database specified, if no connection exists

This method is only intended to force a connection, all operations that require a database connection will automatically call this method.

Sets the schema info to be cached to the fCache object specified

Sets if debug messages should be shown

Escapes a value for insertion into SQL

The valid data types are:

• 'blob'
• 'boolean'
• 'date'
• 'float'
• 'identifier'
• 'integer'
• 'string' (also varchar, char or text)
• 'varchar'
• 'char'
• 'text'
• 'time'
• 'timestamp'

In addition to being able to specify the data type, you can also pass in an SQL statement with data type placeholders in the following form:

• %l for a blob
• %b for a boolean
• %d for a date
• %f for a float
• %r for an indentifier (table or column name)
• %i for an integer
• %s for a string
• %t for a time
• %p for a timestamp

Depending on what $sql_or_type and $value are, the output will be slightly different. If $sql_or_type is a data type or a single placeholder and $value is:

• a scalar value - an escaped SQL string is returned
• an array - an array of escaped SQL strings is returned

If $sql_or_type is a SQL string and $value is:

• a scalar value - the escaped value is inserted into the SQL string
• an array - the escaped values are inserted into the SQL string separated by commas

If $sql_or_type is a SQL string, it is also possible to pass an array of all values as a single parameter instead of one value per parameter. An example would look like the following:

$db->escape(
    "SELECT * FROM users WHERE status = %s AND authorization_level = %s",
    array('Active', 'Admin')
);

Executes one or more SQL queries without returning any results

Returns the database connection resource or object

Gets the name of the database currently connected to

Gets the host for this database

Gets the port for this database

Gets the fSQLTranslation object used for translated queries

Gets the database type

Gets the username for this database

Gets the version of the database system

Will indicate if a transaction is currently in progress

Prepares a single fStatement object to execute prepared statements

Identifier placeholders (%r) are not supported with prepared statements. In addition, multiple values can not be escaped by a placeholder - only a single value can be provided.

Executes one or more SQL queries and returns the result(s)

Registers a callback for one of the various query hooks - multiple callbacks can be registered for each hook

The following hooks are available:

• 'unmodified': The original SQL passed to fDatabase, for prepared statements this is called just once before the fStatement object is created
• 'extracted': The SQL after all non-empty strings have been extracted and replaced with ordered sprintf-style placeholders
• 'run': After the SQL has been run

Methods for the 'unmodified' hook should have the following signature:

• $database: The fDatabase instance
• &$sql: The original, unedited SQL
• &$values: The values to be escaped into the placeholders in the SQL

Methods for the 'extracted' hook should have the following signature:

• $database: The fDatabase instance
• &$sql: The SQL with all strings removed and replaced with %1$s-style placeholders
• &$values: The values to be escaped into the placeholders in the SQL

The extracted hook is the best place to modify the SQL since there is no risk of breaking string literals. Please note that there may be empty strings ('') present in the SQL since some databases treat those as NULL.

Methods for the 'run' hook should have the following signature:

• $database: The fDatabase instance
• $query: The (string) SQL or array(0 => {fStatement object}, 1 => {values array})
• $query_time: The (float) number of seconds the query took
• $result The fResult or fUnbufferedResult object, or FALSE if no result

Translates one or more SQL statements using fSQLTranslation and executes them without returning any results

Translates a SQL statement and creates an fStatement object from it

Identifier placeholders (%r) are not supported with prepared statements. In addition, multiple values can not be escaped by a placeholder - only a single value can be provided.

Translates one or more SQL statements using fSQLTranslation and executes them

Executes a single SQL statement in unbuffered mode. This is optimal for

large results sets since it does not load the whole result set into memory first. The gotcha is that only one unbuffered result can exist at one time. If another unbuffered query is executed, the old result will be deleted.

Translates the SQL statement using fSQLTranslation and then executes it

in unbuffered mode. This is optimal for large results sets since it does not load the whole result set into memory first. The gotcha is that only one unbuffered result can exist at one time. If another unbuffered query is executed, the old result will be deleted.

Unescapes a value coming out of a database based on its data type

The valid data types are:

• 'blob' (or '%l')
• 'boolean' (or '%b')
• 'date' (or '%d')
• 'float' (or '%f')
• 'integer' (or '%i')
• 'string' (also '%s', 'varchar', 'char' or 'text')
• 'time' (or '%t')
• 'timestamp' (or '%p')