~drizzle-trunk/drizzle/development

2397.1.1 by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins.
1
Memcached Statistics
2
====================
3
2397.1.3 by Daniel Nichter
Complete documenting 2nd half of plugins.
4
The :program:`memcached_stats` plugin provides `memcached <http://memcached.org/>`_ statistics as INFORMATION_SCHEMA tables.
2397.1.1 by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins.
5
6
.. _memcached_stats_loading:
7
8
Loading
9
-------
10
11
To load this plugin, start :program:`drizzled` with::
12
13
   --plugin-add=memcached_stats
14
15
Loading the plugin may not enable or configure it.  See the plugin's
16
:ref:`memcached_stats_configuration` and :ref:`memcached_stats_variables`.
17
18
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
19
20
.. _memcached_stats_configuration:
21
22
Configuration
23
-------------
24
25
These command line options configure the plugin when :program:`drizzled`
26
is started.  See :doc:`/configuration` for more information about specifying
27
command line options.
28
29
.. program:: drizzled
30
31
.. option:: --memcached-stats.servers ARG
32
33
   :Default: 
34
   :Variable:
35
36
   List of memcached servers.
37
38
.. _memcached_stats_variables:
39
40
Variables
41
---------
42
43
These variables show the running configuration of the plugin.
44
See `variables` for more information about querying and setting variables.
45
46
.. _memcached_stats_servers:
47
48
* ``memcached_stats_servers``
49
50
   :Scope: Global
51
   :Dynamic: No
2397.1.3 by Daniel Nichter
Complete documenting 2nd half of plugins.
52
   :Option: :option:`--memcached-stats.servers`
2397.1.1 by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins.
53
2397.1.3 by Daniel Nichter
Complete documenting 2nd half of plugins.
54
   Memcached servers.
2397.1.1 by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins.
55
56
.. _memcached_stats_examples:
57
58
Examples
59
--------
60
61
Sorry, there are no examples for this plugin.
62
63
.. _memcached_stats_authors:
64
65
Authors
66
-------
67
68
Padraig O'Sullivan
69
70
.. _memcached_stats_version:
71
72
Version
73
-------
74
75
This documentation applies to **memcached_stats 1.0**.
76
77
To see which version of the plugin a Drizzle server is running, execute:
78
79
.. code-block:: mysql
80
81
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='memcached_stats'
82
2397.1.3 by Daniel Nichter
Complete documenting 2nd half of plugins.
83
Changelog
84
---------
85
86
v1.0
87
^^^^
88
* First release.