The API

Generate MySQL index alteration statements for a table.

Generate a MySQL Alter Table syntax for the given Schema comparison

Generate MySQL table parameter alteration statementes for a table.

Begin a transaction

(i.e. if the database/model does not support transactions, or a transaction has not started).

Translates between PHP boolean values and Database (faked) boolean values

Generate a database-native column schema string

Build the field parameters, in a position

Format indexes for create table

Builds and generates a JOIN statement from an array. Handles final clean-up before conversion.

Builds and generates an SQL statement from an array. Handles final clean-up before conversion.

Format parameters for create table

Cache a value into the methodCaches. Will respect the value of DboSource::$cacheMethods. Will retrieve a value from the cache if $value is null.

If caching is disabled and a write is attempted, the $value will be returned. A read will either return the value or null.

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Returns an SQL calculation, i.e. COUNT() or MAX()

Disconnects database, kills the connection and says the connection is closed.

Converts database-layer column types to basic types

Commit a transaction

(i.e. if the database/model does not support transactions, or a transaction has not started).

Creates a WHERE clause by parsing given conditions array. Used by DboSource::conditions().

Creates a WHERE clause by parsing given conditions data. If an array or string conditions are provided those conditions will be parsed and quoted. If a boolean is given it will be integer cast as condition. Null will return 1 = 1.

Results of this method are stored in a memory cache. This improves performance, but because the method uses a simple hashing algorithm it can infrequently have collisions. Setting DboSource::$cacheMethods to false will disable the memory cache.

Constructor

Converts model virtual fields into sql expressions to be fetched later

The "C" in CRUD

Creates new records in the database.

Generate a database-native schema for the given Schema object

Creates a default set of conditions from the model if $conditions is null/empty. If conditions are supplied then they will be returned. If a model doesn't exist and no conditions were provided either null or false will be returned based on what was input.

Generates and executes an SQL DELETE statement for given id/conditions on given model.

Returns an array of the fields in given table name.

Closes the current datasource.

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array

Generate a MySQL "drop table" statement for the given Schema object

Queries the database with given SQL statement, and obtains some metadata about the result (rows affected, timing, any errors, number of rows in resultset). The query is also logged. If Configure::read('debug') is set, the log is shown all the time, else it is only shown on errors.

Options

• stats - Collect meta data stats for this query. Stats include time take, rows affected, any errors, and number of rows returned. Defaults to true.
• log - Whether or not the query should be logged to the memory log.

Returns an object to represent a database expression in a query

Returns an array of all result rows for a given SQL query. Returns false if no rows matched.

A more efficient way to fetch associations. Woohoo!

Returns a row from current resultset as an array

Modifies $result array to place virtual fields in model entry where they belongs to

Returns a single field of the first of query results for a given SQL query, or false if empty.

Generates the fields list of an SQL query.

Empties the method caches. These caches are used by DboSource::name() and DboSource::conditions()

Gets full table name including prefix

Generates an array representing a query or part of a query from a single model or two associated models

Returns a conditions array for the constraint between two models

Returns an array of SQL JOIN fragments from a model's associations

Get the query log as an array.

Create a GROUP BY SQL clause

Checks if the specified table contains any record matching specified SQL

Checks if the result is valid

Returns an object to represent a database identifier in a query

Returns an array of the indexes in given datasource name.

Inserts multiple values into a table

Replaces {$cakeID$} and {$cakeForeignKey$} placeholders in query data.

Guesses the data type of an array

Checks if the source is connected to the database.

Returns true if the DataSource supports the given interface (method)

Gets the length of a database-native column description, or null if no length

Returns a limit statement in the correct format for the particular database.

Returns an detailed array of sources (tables) in the database.

Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.

Log given SQL query.

Gets a list of record IDs for the given conditions. Used for multi-record updates and deletes in databases that do not support aliases in UPDATE/DELETE queries.

mergeHasMany - Merge the results of hasMany relations.

Returns a quoted name of $data for use in an SQL statement. Strips fields out of SQL functions before quoting.

Results of this method are stored in a memory cache. This improves performance, but because the method uses a simple hashing algorithm it can infrequently have collisions. Setting DboSource::$cacheMethods to false will disable the memory cache.

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Returns an ORDER BY clause as a string.

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Quotes and prepares fields and values for an SQL UPDATE statement

DataSource Query abstraction

Queries associations. Used to fetch results on recursive models.

Executes given SQL statement.

The "R" in CRUD

Reads record(s) from the database.

Read additional table parameters

Reconnects to database server with optional new settings

Renders a final SQL JOIN statement

Renders a final SQL statement by putting together the component parts in the correct order

Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.

Returns a key formatted like a string Model.fieldname(i.e. Post.title, or Country.name)

Rollback a transaction

(i.e. if the database/model does not support transactions, or a transaction has not started).

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Private helper method to remove query metadata in given data array.

Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.

Sets the configuration for the DataSource. Merges the $config information with the _baseConfig and the existing $config property.

Sets the database encoding

Outputs the contents of the queries log. If in a non-CLI environment the sql_log element will be rendered and output. If in a CLI environment, a plain text log is generated.

Output information about an SQL query. The SQL statement, number of rows in resultset, and execution time in microseconds. If the query fails, an error is output instead.

Convenience method for DboSource::listSources(). Returns source names in lowercase.

Stop execution of the current script. Wraps exit() making testing easier.

Object-to-string conversion. Each class can override this method as necessary.

Deletes all the records in a table and resets the count of the auto-incrementing primary key, where applicable.

Generates and executes an SQL UPDATE statement for given model, fields, and values.