← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/query_log/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
https://launchpad.net/bugs/793182
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:
plugin/query_log/docs/index.rst
12
12
 
13
13
.. option:: --query-log.file FILE
14
14
 
15
 
  | Default: :file:`drizzled-queries.log`
16
 
  | Variable: ``query_log_file``
 
15
  :Default: :file:`drizzled-queries.log`
 
16
  :Variable: ``query_log_file``
17
17
 
18
18
  The query log file.  The file is created if it does not exist.  If a full
19
19
  path is not specified, the default relative path is the :file:`local`
21
21
 
22
22
.. option:: --query-log.file-enabled
23
23
 
24
 
  | Default: ``FALSE``
25
 
  | Variable: ``query_log_file_enabled``
 
24
  :Default: ``FALSE``
 
25
  :Variable: ``query_log_file_enabled``
26
26
 
27
27
  Enable logging to :option:`--query-log.file`.
28
28
  This logging destination is disabled by default.  Specify this option to
31
31
 
32
32
.. option:: --query-log.threshold-execution-time MICROSECONDS
33
33
 
34
 
  | Default: ``0``
35
 
  | Variable: ``query_log_threshold_execution_time``
 
34
  :Default: ``0``
 
35
  :Variable: ``query_log_threshold_execution_time``
36
36
 
37
37
  Log queries with execution times greater than ``MICROSECONDS``.
38
38
  The query log file writes ``execution_time`` as seconds with six decimal
41
41
 
42
42
.. option:: --query-log.threshold-lock-time MICROSECONDS
43
43
 
44
 
  | Default: ``0``
45
 
  | Variable: ``query_log_threshold_lock_time``
 
44
  :Default: ``0``
 
45
  :Variable: ``query_log_threshold_lock_time``
46
46
 
47
47
  Log queries with lock times greater than ``MICROSECONDS``.
48
48
  The query log file writes ``lock_time`` as seconds with six decimal
51
51
 
52
52
.. option:: --query-log.threshold-rows-examined N
53
53
 
54
 
  | Default: ``0``
55
 
  | Variable: ``query_log_threshold_rows_examined``
 
54
  :Default: ``0``
 
55
  :Variable: ``query_log_threshold_rows_examined``
56
56
 
57
57
  Log queries that examine more than ``N`` rows.
58
58
 
59
59
.. option:: --query-log.threshold-rows-sent N
60
60
 
61
 
  | Default: ``0``
62
 
  | Variable: ``query_log_threshold_rows_sent``
 
61
  :Default: ``0``
 
62
  :Variable: ``query_log_threshold_rows_sent``
63
63
 
64
64
  Log queries that send (return) more than ``N`` rows.
65
65
 
66
66
.. option:: --query-log.threshold-session-time MICROSECONDS
67
67
 
68
 
  | Default: ``0``
69
 
  | Variable: ``query_log_threshold_session_time``
 
68
  :Default: ``0``
 
69
  :Variable: ``query_log_threshold_session_time``
70
70
 
71
71
  Log queries form sessions active longer than ``MICROSECONDS``.
72
72
  The query log file writes ``session_time`` as seconds with six decimal
75
75
 
76
76
.. option:: --query-log.threshold-tmp-tables N
77
77
 
78
 
  | Default: ``0``
79
 
  | Variable: ``query_log_threshold_tmp_tables``
 
78
  :Default: ``0``
 
79
  :Variable: ``query_log_threshold_tmp_tables``
80
80
 
81
81
  Log queries that use more than ``N`` temporary tables.
82
82
 
83
83
.. option:: --query-log.threshold-warnings N
84
84
 
85
 
  | Default: ``0``
86
 
  | Variable: ``query_log_threshold_warnings``
 
85
  :Default: ``0``
 
86
  :Variable: ``query_log_threshold_warnings``
87
87
 
88
88
  Log queries that cause more than ``N`` errors.
89
89
 
179
179
  0.5 second *  1000000 = 500000 microseconds
180
180
 
181
181
To convert back, multiple the number of microseconds by ``0.000001`` (that's zero point five zeros and a one).
 
182
 
 
183
Authors
 
184
-------
 
185
 
 
186
Daniel Nichter
 
187
 
 
188
Version
 
189
-------
 
190
 
 
191
This documentation applies to **query_log 0.1**.
 
192
 
 
193
To see which version of the plugin a Drizzle server is running, execute:
 
194
 
 
195
.. code-block:: mysql
 
196
 
 
197
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='query_log'
 
198
 
 
199
Changelog
 
200
---------
 
201
 
 
202
v0.1
 
203
^^^^
 
204
* First release.