← Back to branch summary

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

« back to all changes in this revision

Viewing changes to plugin/logging_query/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/logging_query/docs/index.rst
 
1
.. _logging_query_plugin:
 
2
 
 
3
Query Logging
 
4
=============
 
5
 
 
6
The :program:`logging_query` plugin logs queries to a CSV file.
 
7
 
 
8
.. _logging_query_loading:
 
9
 
 
10
Loading
 
11
-------
 
12
 
 
13
To load this plugin, start :program:`drizzled` with::
 
14
 
 
15
   --plugin-add=logging_query
 
16
 
 
17
Loading the plugin may not enable or configure it.  See the plugin's
 
18
:ref:`logging_query_configuration` and :ref:`logging_query_variables`.
 
19
 
 
20
.. seealso:: :ref:`drizzled_plugin_options` for more information about adding and removing plugins.
 
21
 
 
22
.. _logging_query_configuration:
 
23
 
 
24
Configuration
 
25
-------------
 
26
 
 
27
These command line options configure the plugin when :program:`drizzled`
 
28
is started.  See :ref:`command_line_options` for more information about specifying
 
29
command line options.
 
30
 
 
31
.. program:: drizzled
 
32
 
 
33
.. option:: --logging-query.enable 
 
34
 
 
35
   :Default: false
 
36
   :Variable: :ref:`logging_query_enable <logging_query_enable>`
 
37
 
 
38
   Enable logging to CSV file.
 
39
 
 
40
.. option:: --logging-query.filename 
 
41
 
 
42
   :Default: 
 
43
   :Variable: :ref:`logging_query_filename <logging_query_filename>`
 
44
 
 
45
   File to log to.
 
46
 
 
47
.. option:: --logging-query.pcre ARG
 
48
 
 
49
   :Default: 
 
50
   :Variable: :ref:`logging_query_pcre <logging_query_pcre>`
 
51
 
 
52
   PCRE to match the query against.
 
53
 
 
54
.. option:: --logging-query.threshold-big-examined 
 
55
 
 
56
   :Default: 0
 
57
   :Variable: :ref:`logging_query_threshold_big_examined <logging_query_threshold_big_examined>`
 
58
 
 
59
   Threshold for logging big queries by rows examined.
 
60
 
 
61
.. option:: --logging-query.threshold-big-resultset 
 
62
 
 
63
   :Default: 0
 
64
   :Variable: :ref:`logging_query_threshold_big_resultset <logging_query_threshold_big_resultset>`
 
65
 
 
66
   Threshold for logging big queries by result set size.
 
67
 
 
68
.. option:: --logging-query.threshold-slow 
 
69
 
 
70
   :Default: 0
 
71
   :Variable: :ref:`logging_query_threshold_slow <logging_query_threshold_slow>`
 
72
 
 
73
   Threshold for logging slow queries by execution time.
 
74
 
 
75
.. _logging_query_variables:
 
76
 
 
77
Variables
 
78
---------
 
79
 
 
80
These variables show the running configuration of the plugin.
 
81
See `variables` for more information about querying and setting variables.
 
82
 
 
83
.. _logging_query_enable:
 
84
 
 
85
* ``logging_query_enable``
 
86
 
 
87
   :Scope: Global
 
88
   :Dynamic: No
 
89
   :Option: :option:`--logging-query.enable`
 
90
 
 
91
   Enable logging to CSV file.
 
92
 
 
93
.. _logging_query_filename:
 
94
 
 
95
* ``logging_query_filename``
 
96
 
 
97
   :Scope: Global
 
98
   :Dynamic: No
 
99
   :Option: :option:`--logging-query.filename`
 
100
 
 
101
   File to log to.
 
102
 
 
103
.. _logging_query_pcre:
 
104
 
 
105
* ``logging_query_pcre``
 
106
 
 
107
   :Scope: Global
 
108
   :Dynamic: No
 
109
   :Option: :option:`--logging-query.pcre`
 
110
 
 
111
   PCRE to match the query against.
 
112
 
 
113
.. _logging_query_threshold_big_examined:
 
114
 
 
115
* ``logging_query_threshold_big_examined``
 
116
 
 
117
   :Scope: Global
 
118
   :Dynamic: No
 
119
   :Option: :option:`--logging-query.threshold-big-examined`
 
120
 
 
121
   Threshold for logging big queries by rows examined.
 
122
 
 
123
.. _logging_query_threshold_big_resultset:
 
124
 
 
125
* ``logging_query_threshold_big_resultset``
 
126
 
 
127
   :Scope: Global
 
128
   :Dynamic: No
 
129
   :Option: :option:`--logging-query.threshold-big-resultset`
 
130
 
 
131
   Threshold for logging big queries by result set size.
 
132
 
 
133
.. _logging_query_threshold_slow:
 
134
 
 
135
* ``logging_query_threshold_slow``
 
136
 
 
137
   :Scope: Global
 
138
   :Dynamic: No
 
139
   :Option: :option:`--logging-query.threshold-slow`
 
140
 
 
141
   Threshold for logging slow queries by execution time.
 
142
 
 
143
.. _logging_query_examples:
 
144
 
 
145
Examples
 
146
--------
 
147
 
 
148
Sorry, there are no examples for this plugin.
 
149
 
 
150
.. _logging_query_authors:
 
151
 
 
152
Authors
 
153
-------
 
154
 
 
155
Mark Atwood
 
156
 
 
157
.. _logging_query_version:
 
158
 
 
159
Version
 
160
-------
 
161
 
 
162
This documentation applies to **logging_query 0.2**.
 
163
 
 
164
To see which version of the plugin a Drizzle server is running, execute:
 
165
 
 
166
.. code-block:: mysql
 
167
 
 
168
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='logging_query'
 
169
 
 
170
Changelog
 
171
---------
 
172
 
 
173
v0.2
 
174
^^^^
 
175
* First release.