| Property | Type | Description | |
|---|---|---|---|
| $check_tcp_responsiveness | boolean | Whether to check with fsockopen prior to mysql_connect. | |
| $db_connections | array | The log of db connections made and the time each one took | |
| $dbh | resource | The current mysql link resource | |
| $dbh2host | array | Lookup array (dbhname => host:port) | |
| $dbhs | array | Associative array (dbhname => dbh) for established mysql connections | |
| $default_lag_threshold | integer | Maximum lag in seconds. Set null to disable. Requires callbacks. | |
| $hyper_callbacks | array | Optional directory of callbacks to determine datasets from queries | |
| $hyper_servers | array | The multi-dimensional array of datasets and servers | |
| $hyper_tables | array | Optional directory of tables and their datasets | |
| $last_found_rows_result | resource | After any SQL_CALC_FOUND_ROWS query, the query "SELECT FOUND_ROWS()" is sent and the mysql result resource stored here. The next query for FOUND_ROWS() will retrieve this. We do this to prevent any intervening queries from making FOUND_ROWS() inaccessible. You may prevent this by adding "NO_SELECT_FOUND_ROWS" in a comment. | |
| $last_table | string | The last table that was queried | |
| $last_used_server | array | The last server used and the database name selected | |
| $max_connections | integer | The maximum number of db links to keep open. The least-recently used link will be closed when the number of links exceeds this. | |
| $min_tries | integer | Minimum number of connections to try before bailing | |
| $open_connections | The list of unclosed connections sorted by LRU | ||
| $persistent | boolean | Whether to use mysql_pconnect instead of mysql_connect | |
| $save_backtrace | Whether to save debug_backtrace in save_query_callback. You may wish to disable this, e.g. when tracing out-of-memory problems. | ||
| $save_queries | boolean | Whether to store queries in an array. Useful for debugging and profiling. | |
| $save_query_callback | callable | Custom callback to save debug info in $this->queries | |
| $srtm | array | Otherwise it is an array of written tables. | |
| $used_servers | array | Lookup array (dbhname => (server, db name) ) for re-selecting the db when a link is re-used. |
| Method | Description | |
|---|---|---|
| __construct ( $args = null ) | Gets ready to make database connections | |
| _real_escape ( $string ) | * Force addslashes() for the escapes. | |
| add_callback ( $callback, $group = 'dataset' ) | Add a callback to a group of callbacks. | |
| add_database ( $db ) | Add the connection parameters for a database | |
| add_table ( $dataset, $table ) | Specify the dateset where a table is found | |
| check_database_version ( $dbh_or_table = false ) : WP_Error | Whether or not MySQL database is at least the required minimum version. | |
| check_lag ( ) | ||
| check_tcp_responsiveness ( $host, $port, $float_timeout ) : (bool) | Check the responsiveness of a tcp/ip daemon | |
| db_connect ( $query = '' ) : resource | Figure out which database server should handle the query, and connect to it. | |
| db_version ( false | string | resource $dbh_or_table = false ) : false | string | The database version number | |
| disconnect ( $dbhname ) | Disconnect and remove connection from open connections list | |
| flush ( ) | Kill cached query results | |
| get_caller ( ) : string | Get the name of the function that called wpdb. | |
| get_lag ( ) | ||
| get_lag_cache ( ) | ||
| get_table_from_query ( $q ) : string | Find the first table name referenced in a query | |
| has_cap ( string $db_cap, false | string | resource $dbh_or_table = false ) : boolean | Generic function to determine if a database supports a particular feature The additional argument allows the caller to check a specific database. | |
| hyperdb ( $args = null ) | Triggers __construct() for backwards compatibility with PHP4 | |
| init_charset ( ) | Sets $this->charset and $this->collate | |
| is_write_query ( $q ) : boolean | Determine the likelihood that this query could alter anything | |
| query ( string $query ) : integer | Basic query. See docs for more details. | |
| run_callbacks ( $group, $args = null ) | Callbacks are executed in the order in which they are registered until one of them returns something other than null. | |
| send_reads_to_masters ( ) | Set a flag to prevent reading from slaves which might be lagging after a write | |
| set_charset ( resource $dbh, string $charset = null, string $collate = null ) | Sets the connection's character set. | |
| supports_collation ( $dbh_or_table = false ) : boolean | This function is called when WordPress is generating the table schema to determine wether or not the current database supports or needs the collation statements. |
| public __construct ( $args = null ) |
| public _real_escape ( $string ) |
| public add_callback ( $callback, $group = 'dataset' ) |
| public add_database ( $db ) |
| public add_table ( $dataset, $table ) |
| public check_database_version ( $dbh_or_table = false ) : WP_Error | ||
| return | WP_Error | |
| public check_tcp_responsiveness ( $host, $port, $float_timeout ) : (bool) | ||
| return | (bool) | |
| public db_connect ( $query = '' ) : resource | ||
| return | resource | mysql database connection |
| public db_version ( false | string | resource $dbh_or_table = false ) : false | string | ||
| $dbh_or_table | false | string | resource | the databaese (the current database, the database housing the specified table, or the database of the mysql resource) |
| return | false | string | false on failure, version number on success |
| public disconnect ( $dbhname ) |
| public get_caller ( ) : string | ||
| return | string | the name of the calling function |
| public get_table_from_query ( $q ) : string | ||
| return | string | table |
| public hyperdb ( $args = null ) |
| public is_write_query ( $q ) : boolean | ||
| return | boolean | |
| public run_callbacks ( $group, $args = null ) |
| public send_reads_to_masters ( ) |
| public set_charset ( resource $dbh, string $charset = null, string $collate = null ) | ||
| $dbh | resource | The resource given by mysql_connect |
| $charset | string | The character set (optional) |
| $collate | string | The collation (optional) |
| public supports_collation ( $dbh_or_table = false ) : boolean | ||
| return | boolean | |
| public bool $check_tcp_responsiveness | ||
| return | boolean | |
| public array $db_connections | ||
| return | array | |
| public array $dbh2host | ||
| return | array | |
| public array $dbhs | ||
| return | array | |
| public int $default_lag_threshold | ||
| return | integer | |
| public array $hyper_callbacks | ||
| return | array | |
| public array $hyper_servers | ||
| return | array | |
| public array $hyper_tables | ||
| return | array | |
| public resource $last_found_rows_result | ||
| return | resource | |
| public string $last_table | ||
| return | string | |
| public array $last_used_server | ||
| return | array | |
| public int $max_connections | ||
| return | integer | |
| public int $min_tries | ||
| return | integer | |
| public $open_connections |
| public bool $persistent | ||
| return | boolean | |
| public $save_backtrace |
| public bool $save_queries | ||
| return | boolean | |
| public callable $save_query_callback | ||
| return | callable | |
| public array $srtm | ||
| return | array | |
| public array $used_servers | ||
| return | array | |