~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/memory/docs/index.rst

  • Committer: Daniel Nichter
  • Date: 2011-08-13 20:41:38 UTC
  • mto: This revision was merged to the branch mainline in revision 2413.
  • Revision ID: daniel@percona.com-20110813204138-stxa89ca1t7cg1uy
Skeleton documentation for all plugins, more complete docu for first half of plugins.
Clean up plugin.ini titles and descriptions.
Reformat and reorganize root index.
Change Administrative to Administration and remove empty files (logging, etc.)
Add, fix, and tag documentation for functions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Memory Storage Engine
 
2
=====================
 
3
 
 
4
Hash based.
 
5
 
 
6
.. _memory_loading:
 
7
 
 
8
Loading
 
9
-------
 
10
 
 
11
This plugin is loaded by default, but it may need to be configured.  See
 
12
the plugin's :ref:`memory_configuration` and
 
13
:ref:`memory_variables`.
 
14
 
 
15
To stop the plugin from loading by default, start :program:`drizzled`
 
16
with::
 
17
 
 
18
   --plugin-remove=memory
 
19
 
 
20
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
21
 
 
22
.. _memory_configuration:
 
23
 
 
24
Configuration
 
25
-------------
 
26
 
 
27
These command line options configure the plugin when :program:`drizzled`
 
28
is started.  See :doc:`/configuration` for more information about specifying
 
29
command line options.
 
30
 
 
31
.. program:: drizzled
 
32
 
 
33
.. _memory_variables:
 
34
 
 
35
Variables
 
36
---------
 
37
 
 
38
These variables show the running configuration of the plugin.
 
39
See `variables` for more information about querying and setting variables.
 
40
 
 
41
.. _memory_examples:
 
42
 
 
43
Examples
 
44
--------
 
45
 
 
46
Sorry, there are no examples for this plugin.
 
47
 
 
48
.. _memory_authors:
 
49
 
 
50
Authors
 
51
-------
 
52
 
 
53
MySQL AB
 
54
 
 
55
.. _memory_version:
 
56
 
 
57
Version
 
58
-------
 
59
 
 
60
This documentation applies to **memory 1.0**.
 
61
 
 
62
To see which version of the plugin a Drizzle server is running, execute:
 
63
 
 
64
.. code-block:: mysql
 
65
 
 
66
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='memory'
 
67