← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

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

  • Committer: Mark Atwood
  • Date: 2011-09-13 19:54:55 UTC
  • mfrom: (2397.1.3 plugin-docs)
  • Revision ID: me@mark.atwood.name-20110913195455-3bk3locm85m4jimp
merge lp:~daniel-nichter/drizzle/plugin-docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/function_dictionary/docs/index.rst
 
1
Function Dictionary
 
2
===================
 
3
 
 
4
:program:`function_dictionary` creates the ``FUNCTIONS`` dictionary which lists
 
5
available functions.
 
6
 
 
7
.. _function_dictionary_loading:
 
8
 
 
9
Loading
 
10
-------
 
11
 
 
12
To load this plugin, start :program:`drizzled` with::
 
13
 
 
14
   --plugin-add=function_dictionary
 
15
 
 
16
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
17
 
 
18
.. _function_dictionary_examples:
 
19
 
 
20
Examples
 
21
--------
 
22
 
 
23
List all available functions:
 
24
 
 
25
.. code-block:: mysql
 
26
 
 
27
   drizzle> SELECT * FROM DATA_DICTIONARY.FUNCTIONS;
 
28
   +-----------------------+
 
29
   | FUNCTION_NAME         |
 
30
   +-----------------------+
 
31
   | LOWER                 | 
 
32
   | LAST_INSERT_ID        | 
 
33
   | LTRIM                 | 
 
34
   | GREATEST              | 
 
35
   ...
 
36
 
 
37
.. _function_dictionary_authors:
 
38
 
 
39
Authors
 
40
-------
 
41
 
 
42
Brian Aker
 
43
 
 
44
.. _function_dictionary_version:
 
45
 
 
46
Version
 
47
-------
 
48
 
 
49
This documentation applies to **function_dictionary 1.0**.
 
50
 
 
51
To see which version of the plugin a Drizzle server is running, execute:
 
52
 
 
53
.. code-block:: mysql
 
54
 
 
55
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='function_dictionary'
 
56
 
 
57
Changelog
 
58
---------
 
59
 
 
60
v1.0
 
61
^^^^
 
62
* First release.