Property | Type | Description | |
---|---|---|---|
$check_tcp_responsiveness | Whether to check with fsockopen prior to mysql_connect | ||
$db_connections | The log of db connections made and the time each one took | ||
$dbh | resource | The current MySQL link resource | |
$dbh2host | Lookup array (dbhname => host:port) | ||
$dbhs | array | Associative array (dbhname => dbh) for established MySQL connections | |
$default_lag_threshold | Maximum lag in seconds. Set null to disable. Requires callbacks | ||
$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 | The last server used and the database name selected | ||
$ludicrous_callbacks | Optional directory of callbacks to determine datasets from queries | ||
$ludicrous_servers | The multi-dimensional array of datasets and servers | ||
$ludicrous_tables | Optional directory of tables and their datasets | ||
$max_connections | The maximum number of db links to keep open. The least-recently used link will be closed when the number of links exceeds this | ||
$open_connections | The list of unclosed connections sorted by LRU | ||
$persistent | 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 | Custom callback to save debug info in $this->queries | ||
$srtm | Otherwise it is an array of written tables | ||
$used_servers | Lookup array (dbhname => (server, db name) ) for re-selecting the db when a link is re-used |
Property | Type | Description | |
---|---|---|---|
$reconnect_retries | integer | The number of times to retry reconnecting before dying |
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 ( array $db = [] ) | Add the connection parameters for a database | |
add_table ( $dataset, $table ) | Specify the dataset where a table is found | |
check_connection ( boolean $allow_bail = true, $dbh_or_table = false ) : boolean | void | Check that the connection to the database is still up. If not, try to reconnect | |
check_database_version ( false | string | resource $dbh_or_table = false ) : WP_Error | Whether or not MySQL database is at least the required minimum version. | |
check_lag ( ) : integer | Check lag | |
check_tcp_responsiveness ( $host, $port, $float_timeout ) : boolean | Check the responsiveness of a TCP/IP daemon | |
close ( false | string | resource $dbh_or_table = false ) : boolean | Closes the current database connection | |
db_connect ( $query = '' ) : resource | Figure out which db 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 ( string $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 ( ) : integer | Run lag callbacks and return current lag | |
get_lag_cache ( ) : integer | Run lag cache callbacks and return current lag | |
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 | |
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 | |
select ( string $db, false | string | resource $dbh_or_table = false ) | Selects a database using the current database connection | |
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 | |
set_sql_mode ( array $modes = [], false | string | resource $dbh_or_table = false ) | Change the current SQL mode, and ensure its WordPress compatibility | |
supports_collation ( false | string | resource $dbh_or_table = false ) : boolean | This function is called when WordPress is generating the table schema to determine whether or not the current database supports or needs the collation statements |
Method | Description | |
---|---|---|
_do_query ( string $query, boolean $dbh_or_table = false ) | Internal function to perform the mysql_query() call | |
get_table_charset ( string $table ) : mixed | Retrieves a tables character set. | |
load_col_info ( ) | Load the column metadata from the last query. | |
single_db_connect ( string $dbhname, string $host, string $user, string $password ) : boolean | mysqli | resource | Connect selected database | |
strip_invalid_text_using_db ( string $string, string $charset ) : mixed | Given a string, a character set and a table, ask the DB to check the string encoding. | |
tcp_cache_get ( string $key ) : mixed | Get cached up/down value of previous TCP response | |
tcp_cache_set ( string $key, string $value ) : boolean | Set cached up/down value of current TCP response | |
tcp_get_cache_expiration ( ) : integer | Get the number of seconds TCP response is good for | |
tcp_get_cache_key ( string $host, string $port ) : string | Get the cache key used for TCP responses |
Method | Description | |
---|---|---|
dbh_type_check ( $dbh ) : boolean | ||
get_db_object ( false | string | resource $dbh_or_table = false ) | Get the db connection object |
public __construct ( $args = null ) |
public _real_escape ( $string ) |
public add_callback ( $callback, $group = 'dataset' ) |
public add_database ( array $db = [] ) | ||
$db | array |
public add_table ( $dataset, $table ) |
public check_database_version ( false | string | resource $dbh_or_table = false ) : WP_Error | ||
$dbh_or_table | false | string | resource | the database (the current database, the database housing the specified table, or the database of the MySQL resource) |
return | WP_Error |
public check_tcp_responsiveness ( $host, $port, $float_timeout ) : boolean | ||
return | boolean | true when $host:$post responds within $float_timeout seconds, else false |
public close ( false | string | resource $dbh_or_table = false ) : boolean | ||
$dbh_or_table | false | string | resource | the database (the current database, the database housing the specified table, or the database of the MySQL resource) |
return | boolean | True if the connection was successfully closed, false if it wasn't, or the connection doesn't exist. |
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 database (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 ( string $dbhname ) | ||
$dbhname | string |
public get_caller ( ) : string | ||
return | string | the name of the calling function |
public get_lag_cache ( ) : integer | ||
return | integer |
protected get_table_charset ( string $table ) : mixed | ||
$table | string | Table name |
return | mixed | The table character set, or WP_Error if we couldn't find it |
public is_write_query ( $q ) : boolean | ||
return | boolean |
protected load_col_info ( ) |
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 set_sql_mode ( array $modes = [], false | string | resource $dbh_or_table = false ) | ||
$modes | array | Optional. A list of SQL modes to set. |
$dbh_or_table | false | string | resource | the database (the current database, the database housing the specified table, or the database of the MySQL resource) |
protected single_db_connect ( string $dbhname, string $host, string $user, string $password ) : boolean | mysqli | resource | ||
$dbhname | string | |
$host | string | Internet address: host:port of server on internet. |
$user | string | Database user. |
$password | string | Database password. |
return | boolean | mysqli | resource |
public supports_collation ( false | string | resource $dbh_or_table = false ) : boolean | ||
$dbh_or_table | false | string | resource | the database (the current database, the database housing the specified table, or the database of the MySQL resource) |
return | boolean |
protected tcp_cache_get ( string $key ) : mixed | ||
$key | string | Results of tcp_get_cache_key() |
return | mixed | Results of wp_cache_get() |
protected tcp_get_cache_expiration ( ) : integer | ||
return | integer |
public $check_tcp_responsiveness |
public $db_connections |
public array $dbhs | ||
return | array |
public $default_lag_threshold |
public resource $last_found_rows_result | ||
return | resource |
public string $last_table | ||
return | string |
public $last_used_server |
public $ludicrous_callbacks |
public $ludicrous_servers |
public $ludicrous_tables |
public $max_connections |
public $open_connections |
public $persistent |
protected int $reconnect_retries | ||
return | integer |
public $save_backtrace |
public bool $save_queries | ||
return | boolean |
public $save_query_callback |