diff --git a/reference/mysqlnd_memcache/constants.xml b/reference/mysqlnd_memcache/constants.xml index ad8edb3e85..67df6c6065 100644 --- a/reference/mysqlnd_memcache/constants.xml +++ b/reference/mysqlnd_memcache/constants.xml @@ -17,13 +17,12 @@ - Default regular expression (pcre style) used for matching SELECT - statements that shall be mapped into a MySQL Memcache Plugin - access, if possible. + Default regular expression (PCRE style) used for matching SELECT + statements that will be mapped into a MySQL Memcache Plugin access point, if possible. - It is possible to use a different but the defailt regular expression for pattern - matching. See also mysqlnd_memcache_set. + It is also possible to use mysqlnd_memcache_set, but the default + approach is using this regular expression for pattern matching. @@ -34,7 +33,7 @@ Assorted - The plugins version number can be obtained using + The version number of this plugin can be obtained by using MYSQLND_MEMCACHE_VERSION or MYSQLND_MEMCACHE_VERSION_ID. MYSQLND_MEMCACHE_VERSION diff --git a/reference/mysqlnd_memcache/functions/mysqlnd-memcache-get-config.xml b/reference/mysqlnd_memcache/functions/mysqlnd-memcache-get-config.xml index e50ab3e41b..de8ad0fb2f 100644 --- a/reference/mysqlnd_memcache/functions/mysqlnd-memcache-get-config.xml +++ b/reference/mysqlnd_memcache/functions/mysqlnd-memcache-get-config.xml @@ -15,11 +15,11 @@ mixedconnection - This function returns an array containing all the mysqlnd_memcache related - configuration attached to a MySQL connection. This includes MySQL the - Memcache object provided via mysqlnd_memcache_set - as well as the table mapping configuration which was automatically collected - from the MySQL server. + This function returns an array of all mysqlnd_memcache related configuration + information that is attached to the MySQL connection. This includes MySQL, the + Memcache object provided via mysqlnd_memcache_set, + and the table mapping configuration that was automatically collected + from the MySQL Server. @@ -30,10 +30,9 @@ connection - A handle to a MySQL server of the type + A handle to a MySQL Server using one of the MySQL API extensions for PHP, which are PDO_MYSQL, mysqli or - ext/mysql for which the configuration is to - be returned. + ext/mysql. @@ -43,15 +42,14 @@ &reftitle.returnvalues; - If the connection is associated with a memcache connection an array will - be returned. Otherwise this function will return false. + An array of mysqlnd_memcache configuration information on success, otherwise &false;. The returned array has these elements: - mysqlnd_memcache_get_config array structure + <function>mysqlnd_memcache_get_config</function> array structure @@ -65,20 +63,20 @@ Instance of Memcached associated to this MySQL connection by mysqlnd_memcache_set. You can use this to - change settings of the memcache connection or directly querying the - server onthis connection. + change settings of the memcache connection, or directly by querying the + server on this connection. pattern - Regular expression used to match an SQL query being sent to the server. + The PCRE regular expression used to match the SQL query sent to the server. Queries matching this pattern will be further analyzed to decide whether the query can be intercepted and sent via the memcache interface or whether the query is sent using the general MySQL protocol to the - server. The pattern either is the default pattern, - MYSQLND_MEMCACHE_DEFAULT_REGEXP or set via - mysqlnd_memcache_set. + server. The pattern is either the default pattern + (MYSQLND_MEMCACHE_DEFAULT_REGEXP) or it is set via + mysqlnd_memcache_set. @@ -88,7 +86,7 @@ were discovered by this plugin. The key for these elements is the name of the container in the MySQL configuration. The value is described below. The contents of this field is created by querying the MySQL - server during associting a MySQL and a memcache connection using + Server during association to MySQL and a memcache connection using mysqlnd_memcache_set. @@ -117,7 +115,7 @@ prefix A prefix used while accessing data via memcache. With the MySQL InnoDB - Memcache Deamon plugin this usully begins with @@ and ends with a + Memcache Deamon plugin, this usually begins with @@ and ends with a configurable separator. This prefix is placed in front of the key value while using the memcache protocol. @@ -131,7 +129,7 @@ table_name - Name of the table which contins the data accessible via memcache + Name of the table which contains the data accessible via memcache protocol. @@ -139,21 +137,21 @@ id_field_name Name of the database field (column) with the id used as key when - accessing the table vi a memcache. Often this is the database field + accessing the table via memcache. Often this is the database field having a primary key. separator - A seprator used to split different field values. This is needed as + The separator used to split the different field values. This is needed as memcache only provides access to a single value while MySQL can map multiple columns to this value. - The separator, which can be set in the MySQL Server configuration - should not be part ofany value retrieved via memcache as proper - mapping can't be guranteed. + The separator, which can be set in the MySQL Server configuration, + should not be part of any value retrieved via memcache because proper + mapping can't be guaranteed. @@ -161,7 +159,7 @@ fields - An array with the names of all fields availle forthis mapping. + An array with the name of all fields available for this mapping. diff --git a/reference/mysqlnd_memcache/functions/mysqlnd-memcache-set.xml b/reference/mysqlnd_memcache/functions/mysqlnd-memcache-set.xml index d21bcfdbe5..35dfae7990 100644 --- a/reference/mysqlnd_memcache/functions/mysqlnd-memcache-set.xml +++ b/reference/mysqlnd_memcache/functions/mysqlnd-memcache-set.xml @@ -20,12 +20,12 @@ Associate mysql_connection with memcache_connection using pattern - as decision Regexp and callback as notification - callback or unset the association of mysql_connection. + as a PCRE regular expression, and callback as a notification + callback or to unset the association of mysql_connection. - While associating a MySQL connection with a Memcache connection this function - will query the MySQL server for its configuration. It will automatically + While associating a MySQL connection with a Memcache connection, this function + will query the MySQL Server for its configuration. It will automatically detect whether the server is configured to use the InnoDB Memcache Daemon Plugin or MySQL Cluster NDB Memcache support. It will also query the server to automatically identify exported tables and other configuration options. @@ -41,10 +41,9 @@ mysql_connection - A handle to a MySQL server of the type + A handle to a MySQL Server using one of the MySQL API extensions for PHP, which are PDO_MYSQL, mysqli or - ext/mysql for which the configuration is to - be set. + ext/mysql. @@ -52,10 +51,10 @@ memcache_connection - A Memcached instance with an + A Memcached instance with a connection to the MySQL Memcache Daemon plugin. If this parameter - is ommitted mysql_connection will be unassociated - from any memcache connection. If a previous association exists it will be + is omitted, then mysql_connection will be unassociated + from any memcache connection. And if a previous association exists, then it will be replaced. @@ -69,7 +68,7 @@ Memcache-queries. The query should have three sub patterns. The first subpattern contains the requested field list, the second the name of the ID column from the query and the third the requested value. If - this parameteris ommitted or set to &null; a default + this parameter is omitted or os set to &null;, then a default pattern will be used. @@ -90,8 +89,8 @@ &reftitle.returnvalues; - If the association or disassociation succeds the function returns &true;. In - case of an error &false; is being returned. + &true; if the association or disassociation is successful, otherwise &false; if there + is an error. @@ -101,7 +100,7 @@ <function>mysqlnd_memcache_set</function> example with - <function>var_dump</function> as simple debugging callabck. + var_dump as a simple debugging callback. mysqlnd_memcache.enable 1 - PHP_INI_SYSTEM - + PHP_INI_SYSTEM + Available since 1.0.0 @@ -46,10 +46,10 @@ mysqlnd C API calls. - This option is mostly meant to be used by developers building this - extension static into PHP. In general users are encouraged to build - this extension as shared object and unloading it completely if not - needed. + This option is mainly used by developers to build this + extension statically into PHP. General users are encouraged to build + this extension as a shared object, and to unload it completely when + it is not needed. diff --git a/reference/mysqlnd_memcache/quickstart.xml b/reference/mysqlnd_memcache/quickstart.xml index 987b6afd73..17ddeffa72 100644 --- a/reference/mysqlnd_memcache/quickstart.xml +++ b/reference/mysqlnd_memcache/quickstart.xml @@ -20,22 +20,14 @@ The plugin is implemented as a PHP extension. See also the installation instructions to - install the - mysqlnd_memcache extension. + install this extension. Compile or configure the PHP MySQL extension (API) (mysqli, - PDO_MYSQL, - mysql) that you plan to use with support - for the mysqlnd library. mysqlnd_memcache - is a plugin for the mysqlnd library. To use the plugin with any of the PHP - MySQL extensions, the extension has to use the mysqlnd library. - - - The mysqlnd_memcche PHP extension depends on the - memcached extension. Refer to the - according installation - instructions for installing that module. + PDO_MYSQL, mysql). + That extension must use the mysqlnd library as + because mysqlnd_memcache is a plugin for the mysqlnd library. For additional information, + refer to the mysqlnd_memcache installation instructions. Then, load this extension into PHP and activate the plugin in the PHP configuration @@ -48,20 +40,22 @@ - Follow the instructions given in the MySQL Reference Manual on installing - the Memcache plugins for the MySQL server. Activate the plugins and - configure the Memcache access to SQL tables. + Follow the instructions given in the MySQL + Reference Manual on installing the Memcache plugins for the MySQL server. Activate + the plugins and configure Memcache access for SQL tables. - For all future examples it is assumed that you have created a SQL table - like the following and configured Memcache access to it. + The examples in this quickguide assume that the following table exists, and that + Memcache is configured with access to it. @@ -126,8 +120,8 @@ mysqlnd_memcache_set($mysqli, $memc); /* This is a query which queries table test using id as key in the WHERE part - and is accessing fields f1, f2 and f3. Therefore mysqlnd_memcache - will intercept it and route it ia memcache. + and is accessing fields f1, f2 and f3. Therefore, mysqlnd_memcache + will intercept it and route it via memcache. */ $result = $mysqli->query("SELECT f1, f2, f3 FROM test WHERE id = 1"); while ($row = $result->fetch_row()) { @@ -136,7 +130,7 @@ while ($row = $result->fetch_row()) { /* This is a query which queries table test but using f1 in the WHERE clause. - Therefore mysqlnd_memcache can't intercept it. This will be executed + Therefore, mysqlnd_memcache can't intercept it. This will be executed using the MySQL protocol */ $mysqli->query("SELECT id FROM test WHERE f1 = 'Lady'"); diff --git a/reference/mysqlnd_memcache/setup.xml b/reference/mysqlnd_memcache/setup.xml index 01f6b4369d..10d8270173 100644 --- a/reference/mysqlnd_memcache/setup.xml +++ b/reference/mysqlnd_memcache/setup.xml @@ -7,37 +7,28 @@
&reftitle.required; - This extension requires PHP 5.4.4 or newer. + PHP: this extension requires PHP 5.4+, version PHP 5.4.4 or never. The required + PHP extensions are PCRE (enabled by default), and + the memcached extension version 2.0.x. - For accessing InnoDB tables this PHP extension requires - MySQL Server 5.6.6 or newer with the InnoDB Memcache - Daemon Plugin. - - - For accessing MySQL Cluster NDB tables this PHP extensions - requires MySQL Cluster 7.2 or newer with configured NDB - Memcache API nodes. - - - PHP must be compiled with support for Perl regular - expressions through the pcre extension. - PCRE is included into PHP by default. - - - The memcached extension 2.0.x - must be loaded into PHP. - - - The mysqlnd_memcache memcache + The mysqlnd_memcache Memcache plugin supports all PHP applications and all available PHP MySQL extensions (mysqli, mysql, PDO_MYSQL). - The PHP MySQL extension must be configured to use - mysqlnd in order to be able - to use the mysqlnd_memcache plugin for - mysqlnd. + The PHP MySQL extension must be configured with + mysqlnd support. + + + For accessing InnoDB tables, this PHP extension requires + MySQL Server 5.6.6 or newer with the InnoDB Memcache + Daemon Plugin enabled. + + + For accessing MySQL Cluster NDB tables, this PHP extension requires + MySQL Cluster 7.2 or newer with the NDB Memcache API nodes + enabled.