← Back to branch summary

~vjsamuel/drizzle/more-doc-fixes

« back to all changes in this revision

Viewing changes to plugin/utility_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/utility_dictionary/docs/index.rst
 
1
Utility Dictionary
 
2
==================
 
3
 
 
4
The :program:`utility_dictionary` plugin provides several DATA_DICTIONARY tables:
 
5
 
 
6
* COUNTER
 
7
* ENVIRONMENTAL
 
8
* RANDOM_NUMBER
 
9
* RANDOM_STRING
 
10
 
 
11
 
 
12
.. _utility_dictionary_loading:
 
13
 
 
14
Loading
 
15
-------
 
16
 
 
17
To load this plugin, start :program:`drizzled` with::
 
18
 
 
19
   --plugin-add=utility_dictionary
 
20
 
 
21
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
22
 
 
23
Examples
 
24
--------
 
25
 
 
26
.. code-block:: mysql
 
27
 
 
28
   drizzle> SELECT * FROM DATA_DICTIONARY.COUNTER;
 
29
   +-------+
 
30
   | VALUE |
 
31
   +-------+
 
32
   |     1 | 
 
33
   +-------+
 
34
 
 
35
   drizzle> SELECT * FROM DATA_DICTIONARY.COUNTER;
 
36
   +-------+
 
37
   | VALUE |
 
38
   +-------+
 
39
   |     2 | 
 
40
   +-------+
 
41
 
 
42
   drizzle> SELECT * FROM DATA_DICTIONARY.COUNTER;
 
43
   +-------+
 
44
   | VALUE |
 
45
   +-------+
 
46
   |     3 | 
 
47
   +-------+
 
48
 
 
49
   drizzle> SELECT * FROM DATA_DICTIONARY.ENVIRONMENTAL;
 
50
   +---------------+----------------------------+
 
51
   | VARIABLE_NAME | VARIABLE_VALUE             |
 
52
   +---------------+----------------------------+
 
53
   | SHELL         | /bin/bash                  | 
 
54
   | TERM          | xterm-color                | 
 
55
   | USER          | daniel                     | 
 
56
   | EDITOR        | vi                         | 
 
57
   | HOME          | /Users/daniel              | 
 
58
   | LOGNAME       | daniel                     | 
 
59
   | DISPLAY       | /tmp/launch-ccfH4l/org.x:0 | 
 
60
   | _             | ./sbin/drizzled            | 
 
61
   +---------------+----------------------------+
 
62
 
 
63
   drizzle> SELECT * FROM DATA_DICTIONARY.RANDOM_NUMBER;
 
64
   +------------+
 
65
   | VALUE      |
 
66
   +------------+
 
67
   | 1804289383 | 
 
68
   +------------+
 
69
 
 
70
   drizzle> SELECT * FROM DATA_DICTIONARY.RANDOM_STRING;
 
71
   +----------------------+
 
72
   | VALUE                |
 
73
   +----------------------+
 
74
   | 8FJid3GaHpRC2L6jX3i9 |
 
75
   +----------------------+
 
76
 
 
77
.. _utility_dictionary_authors:
 
78
 
 
79
Authors
 
80
-------
 
81
 
 
82
Brian Aker
 
83
 
 
84
.. _utility_dictionary_version:
 
85
 
 
86
Version
 
87
-------
 
88
 
 
89
This documentation applies to **utility_dictionary 1.0**.
 
90
 
 
91
To see which version of the plugin a Drizzle server is running, execute:
 
92
 
 
93
.. code-block:: mysql
 
94
 
 
95
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='utility_dictionary'
 
96
 
 
97
Changelog
 
98
---------
 
99
 
 
100
v1.0
 
101
^^^^
 
102
* First release.