Class DboSource

Properties summary

• $_connection protected
  array
  A reference to the physical connection of this DataSource
• $_methodCacheChange protected
  boolean

  Indicates whether there was a change on the cached results on the methods of this class This will be used for storing in a more persistent cache

• $_queriesCnt protected
  integer
  Queries count.
• $_queriesLog protected
  array
  Log of queries executed by this DataSource
• $_queriesLogMax protected
  integer
  Maximum number of items in query log
• $_queriesTime protected
  integer
  Total duration of all queries.
• $_queryCache protected
  array
  Caches serialized results of executed queries
• $_queryDefaults protected
  array
  Default fields that are used by the DBO
• $_result protected
  array
  Result
• $_sqlBoolOps protected
  array
  The set of valid SQL boolean operations usable in a WHERE statement
• $_sqlOps protected
  array
  The set of valid SQL operations usable in a WHERE statement
• $_transactionNesting protected
  integer
  Indicates the level of nested transactions
• $affected public
  string
  String to hold how many rows were affected by the last SQL operation.
• $alias public
  string
  Database keyword used to assign aliases to identifiers.
• $cacheMethods public
  boolean

  Whether or not to cache the results of DboSource::name() and DboSource::conditions() into the memory cache. Set to false to disable the use of the memory cache.

• $configKeyName public
  string
  The DataSource configuration key name
• $description public
  string
  Description string for this Database Data Source.
• $endQuote public
  string
  The ending character that this DataSource uses for quoted identifiers.
• $fieldParameters public
  array
  List of engine specific additional field parameters used on table creating
• $fullDebug public
  boolean
  Print full query debug info?
• $index public
  array
  index definition, standard cake, primary, index, unique
• $methodCache public static
  array

  Caches result from query parsing operations. Cached results for both DboSource::name() and DboSource::conditions() will be stored here. Method caching uses md5(). If you have problems with collisions, set DboSource::$cacheMethods to false.

• $numRows public
  integer
  Number of rows in current resultset
• $startQuote public
  string
  The starting character that this DataSource uses for quoted identifiers.
• $tableParameters public
  array
  List of table engine specific parameters used on table creating
• $took public
  integer
  Time the last query took
• $useNestedTransactions public
  boolean

  Flag to support nested transactions. If it is set to false, you will be able to use the transaction methods (begin/commit/rollback), but just the global transaction will be executed.

• $virtualFieldSeparator public
  string
  Separator string for virtualField composition

Inherited Properties

• _baseConfig, _descriptions, _sources, _transactionStarted, cacheSources, config, connected

Method Summary

• __construct() public

  Constructor

• __destruct() public

  Used for storing in cache the results of the in-memory methodCache

• _beginNested() protected

  Begin a nested transaction

• _buildFieldParameters() protected

  Build the field parameters, in a position

• _commitNested() protected

  Commit a nested transaction

• _constructVirtualFields() protected

  Converts model virtual fields into sql expressions to be fetched later

• _dropTable() protected

  Generate a "drop table" statement for a single table

• _execute() protected

  Executes given SQL statement.

• _fetchHasAndBelongsToMany() protected

  Fetch 'hasAndBelongsToMany' associations.

• _fetchHasMany() protected

  Fetch 'hasMany' associations.

• _filterResults() protected

  Passes association results through afterFind filters of the corresponding model.

• _filterResultsInclusive() protected

  Passes association results through afterFind filters of the corresponding model.

• _getJoins() protected

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

• _matchRecords() protected

  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.

• _mergeAssociation() protected

  Merge association of merge into data

• _mergeConditions() protected

  Merges a mixed set of string/array conditions.

• _mergeHasMany() protected

  Merge the results of 'hasMany' associations.

• _parseKey() protected

  Extracts a Model.field identifier and an SQL condition operator from a string, formats and inserts values, and composes them into an SQL snippet.

• _prepareUpdateFields() protected

  Quotes and prepares fields and values for an SQL UPDATE statement

• _quoteFields() protected

  Quotes Model.fields

• _quoteMatchedField() protected

  Auxiliary function to quote matches Model.fields from a preg_replace_callback call

• _rollbackNested() protected

  Rollback a nested transaction

• _scrubQueryData() protected

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

• _writeQueryCache() protected

  Writes a new key for the in memory sql query cache

• alterSchema() public

  Generate an alter syntax from CakeSchema::compare()

• begin() public

  Begin a transaction

• boolean() public

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

• buildAssociationQuery() public

  Builds an SQL statement.

• buildColumn() public

  Generate a database-native column schema string

• buildIndex() public

  Format indexes for create table.

• buildJoinStatement() public

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

• buildStatement() public

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

• buildTableParameters() public

  Format parameters for create table

• cacheMethod() public

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

• calculate() public

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

• close() public

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

• commit() public

  Commit a transaction

• conditionKeysToString() public

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

• conditions() public

  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.

• create() public

  The "C" in CRUD

• createSchema() public

  Generate a database-native schema for the given Schema object

• defaultConditions() public

  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.

• delete() public

  Generates and executes an SQL DELETE statement. For databases that do not support aliases in UPDATE queries.

• disconnect() public

  Disconnects from database.

• dropSchema() public

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

• execute() public

  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.

• expression() public

  Returns an object to represent a database expression in a query. Expression objects are not sanitized or escaped.

• fetchAll() public

  Returns an array of all result rows for a given SQL query.

• fetchAssociated() public

  Fetch 'hasMany' associations.

• fetchResult() public

  Fetches the next row from the current result set

• fetchRow() public

  Returns a row from current resultset as an array

• fetchVirtualField() public

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

• field() public

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

• fields() public

  Generates the fields list of an SQL query.

• flushMethodCache() public

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

• fullTableName() public

  Gets full table name including prefix

• generateAssociationQuery() public

  Generates a query or part of a query from a single model or two associated models.

• getConnection() public

  Get the underlying connection object.

• getConstraint() public

  Returns a conditions array for the constraint between two models.

• getLog() public

  Get the query log as an array.

• getQueryCache() public

  Returns the result for a sql query if it is already cached

• getVersion() public

  Gets the version string of the database server

• group() public

  Create a GROUP BY SQL clause.

• hasAny() public

  Checks if the specified table contains any record matching specified SQL

• hasResult() public

  Checks if the result is valid

• identifier() public

  Returns an object to represent a database identifier in a query. Expression objects are not sanitized or escaped.

• index() public

  Returns an array of the indexes in given datasource name.

• insertMulti() public

  Inserts multiple values into a table

• introspectType() public

  Guesses the data type of an array

• isConnected() public

  Checks if the source is connected to the database.

• lastAffected() public

  Returns number of affected rows in previous database operation. If no previous operation exists, this returns false.

• lastError() public

  Returns a formatted error message from previous database operation.

• lastInsertId() public

  Returns the ID generated from the previous INSERT operation.

• lastNumRows() public

  Returns number of rows in previous resultset. If no previous resultset exists, this returns false.

• length() public

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

• limit() public

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

• logQuery() public

  Log given SQL query.

• name() public

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

• nestedTransactionSupported() public

  Check if the server support nested transactions

• order() public

  Returns an ORDER BY clause as a string.

• prepareFields() public

  Prepares fields required by an SQL statement.

• query() public

  DataSource Query abstraction

• queryAssociation() public

  Queries associations.

• rawQuery() public

  Executes given SQL statement.

• read() public

  The "R" in CRUD

• readTableParameters() public

  Read additional table parameters

• reconnect() public

  Reconnects to database server with optional new settings

• renderJoinStatement() public

  Renders a final SQL JOIN statement

• renderStatement() public

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

• resetSequence() public

  Reset a sequence based on the MAX() value of $column. Useful for resetting sequences after using insertMulti().

• resolveKey() public

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

• rollback() public

  Rollback a transaction

• showLog() public

  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.

• truncate() public

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

• update() public

  Generates and executes an SQL UPDATE statement for given model, fields, and values. For databases that do not support aliases in UPDATE queries.

• value() public

  Returns a quoted and escaped string of $data for use in an SQL statement.

Method Detail

Methods inherited from DataSource

Methods inherited from Object

Properties detail

null

false

array()

200

null

array()

array(
    'conditions' => array(),
    'fields' => null,
    'table' => null,
    'alias' => null,
    'order' => null,
    'limit' => null,
    'joins' => array(),
    'group' => null,
    'offset' => null
)

null

array('and', 'or', 'not', 'and not', 'or not', 'xor', '||', '&&')

array('like', 'ilike', 'rlike', 'or', 'not', 'in', 'between', 'regexp', 'similar to')

null

'AS '

true

null

"Database Data Source"

null

array()

false

array('PRI' => 'primary', 'MUL' => 'index', 'UNI' => 'unique')

array()

null

null

array()

null

false

'__'