~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/function_engine/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
Function Engine
 
2
===============
 
3
 
 
4
:program:`function_engine` is a low-level plugin that provides the
 
5
interface for other function plugins.
 
6
 
 
7
.. warning::
 
8
 
 
9
   Drizzle depends on the :program:`function_engine` plugin.  If it is not
 
10
   loaded, most commands will not work and ``DATA_DICTIONARY`` and
 
11
   ``INFORMATION_SCHEMA`` will not be available.
 
12
 
 
13
.. _function_engine_loading:
 
14
 
 
15
Loading
 
16
-------
 
17
 
 
18
This plugin is loaded by default and it should not be unloaded.  See the
 
19
warning above.
 
20
 
 
21
 
 
22
Authors
 
23
-------
 
24
 
 
25
Brian Aker
 
26
 
 
27
.. _function_engine_version:
 
28
 
 
29
Version
 
30
-------
 
31
 
 
32
This documentation applies to **function_engine 1.0**.
 
33
 
 
34
To see which version of the plugin a Drizzle server is running, execute:
 
35
 
 
36
.. code-block:: mysql
 
37
 
 
38
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='function_engine'
 
39
 
 
40
Changelog
 
41
---------
 
42
 
 
43
v1.0
 
44
^^^^
 
45
* First release.