← Back to branch summary

~ubuntu-branches/ubuntu/saucy/drizzle/saucy-proposed

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Clint Byrum
  • Date: 2012-06-19 10:46:49 UTC
  • mfrom: (1.1.6)
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20120619104649-e2l0ggd4oz3um0f4
Tags: upstream-7.1.36-stable
Import upstream version 7.1.36-stable

Show diffs side-by-side

added added

removed removed

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