~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/error_dictionary/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
Error Dictionary
 
2
================
 
3
 
 
4
:program:`error_dictionary` creates the ``ERRORS`` dictionary which lists
 
5
the error codes and messages generated by Drizzle.
 
6
 
 
7
.. _error_dictionary_loading:
 
8
 
 
9
Loading
 
10
-------
 
11
 
 
12
This plugin is loaded by default.  To stop the plugin from loading by default,
 
13
start :program:`drizzled` with::
 
14
 
 
15
   --plugin-remove=error_dictionary
 
16
 
 
17
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
18
 
 
19
.. _error_dictionary_configuration:
 
20
 
 
21
Examples
 
22
--------
 
23
 
 
24
List Drizzle's error codes and messages:
 
25
 
 
26
.. code-block:: mysql
 
27
 
 
28
   drizzle> SELECT * FROM DATA_DICTIONARY.ERRORS\G
 
29
   *************************** 1. row ***************************
 
30
        ERROR_CODE: 1167
 
31
        ERROR_NAME: ER_WRONG_KEY_COLUMN
 
32
     ERROR_MESSAGE: The used storage engine can't index column '%-.192s'
 
33
   ERROR_SQL_STATE: 42000
 
34
   *************************** 2. row ***************************
 
35
        ERROR_CODE: 0
 
36
        ERROR_NAME: EE_OK
 
37
     ERROR_MESSAGE: SUCCESS
 
38
   ERROR_SQL_STATE: HY000
 
39
 
 
40
   -- Hundreds more...
 
41
 
 
42
.. _error_dictionary_authors:
 
43
 
 
44
Authors
 
45
-------
 
46
 
 
47
Monty Taylor
 
48
 
 
49
.. _error_dictionary_version:
 
50
 
 
51
Version
 
52
-------
 
53
 
 
54
This documentation applies to **error_dictionary 1.0**.
 
55
 
 
56
To see which version of the plugin a Drizzle server is running, execute:
 
57
 
 
58
.. code-block:: mysql
 
59
 
 
60
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='error_dictionary'
 
61
 
 
62
Changelog
 
63
---------
 
64
 
 
65
v1.0
 
66
^^^^
 
67
* First release.