← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/transaction_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/transaction_log/docs/index.rst
1
1
Transaction Log
2
2
===============
3
3
 
4
 
Description
5
 
-----------
6
 
 
7
4
The Drizzle Transaction Log contains a sequence of
8
5
`Google Protocol Buffer <http://code.google.com/p/protobuf/>`_
9
6
messages that describe the transactions which have been run.
10
7
 
 
8
Loading
 
9
-------
 
10
 
 
11
This plugin is loaded by default, but it may need to be configured.  See
 
12
the plugin's :ref:`transaction_log_configuration` and
 
13
:ref:`transaction_log_variables`.
 
14
 
 
15
To stop the plugin from loading by default, start :program:`drizzled`
 
16
with::
 
17
 
 
18
   --plugin-remove=transaction_log
 
19
 
 
20
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
21
 
 
22
.. _transaction_log_configuration:
11
23
 
12
24
Configuration
13
25
-------------
14
26
 
15
 
Several server variables control the transaction log.
 
27
These command line options configure the plugin when :program:`drizzled`
 
28
is started.  See :doc:`/configuration` for more information about specifying
 
29
command line options.
16
30
 
17
31
.. program:: drizzled
18
32
 
19
33
.. option:: --transaction-log.enable
20
34
 
 
35
   :Default: false
 
36
   :Variable: :ref:`transaction_log_enable <transaction_log_enable>`
 
37
 
21
38
   Enable transaction log.
22
39
 
23
 
.. option:: --transaction-log.enable-checksum
 
40
.. option:: --transaction-log.enable-checksum 
 
41
 
 
42
   :Default: false
 
43
   :Variable: :ref:`transaction_log_enable_checksum <transaction_log_enable_checksum>`
24
44
 
25
45
   Enable CRC32 Checksumming of each written transaction log entry
26
46
 
27
 
.. option:: --transaction-log.file=arg
28
 
 
29
 
  Path to the file to use for transaction log. The default will be
30
 
  :file:`transaction.log`.
31
 
 
32
 
.. option:: --transaction-log.use-replicator
33
 
 
34
 
   Name of the replicator plugin to use (default='default_replicator')
 
47
.. option:: --transaction-log.file ARG
 
48
 
 
49
   :Default: :file:`transaction.log`
 
50
   :Variable: :ref:`transaction_log_file <transaction_log_file>`
 
51
 
 
52
   Path to the file to use for transaction log.
35
53
 
36
54
.. option:: --transaction-log.flush-frequency=arg
37
55
 
 
56
   :Default: ``0``
 
57
   :Variable: :ref:`transaction_log_flush_frequency <transaction_log_flush_frequency>`
 
58
 
38
59
   * 0 : rely on operating system to sync log file (default)
39
60
   * 1 : sync file at each transaction write
40
61
   * 2 : sync log file once per second
41
62
 
42
 
.. option:: --transaction-log.num-write-buffers=arg
 
63
.. option:: --transaction-log.num-write-buffers ARG
 
64
 
 
65
   :Default: 8
 
66
   :Variable: :ref:`transaction_log_num_write_buffers <transaction_log_num_write_buffers>`
 
67
 
 
68
   Number of slots for in-memory write buffers.
 
69
 
 
70
.. option:: --transaction-log.truncate-debug 
 
71
 
 
72
   :Default: false
 
73
   :Variable: :ref:`transaction_log_truncate_debug <transaction_log_truncate_debug>`
 
74
 
 
75
   DEBUGGING - Truncate transaction log.
 
76
 
 
77
.. option:: --transaction-log.use-replicator ARG
 
78
 
 
79
   :Default: ``default_replicator``
 
80
   :Variable: :ref:`transaction_log_use_replicator <transaction_log_use_replicator>`
 
81
 
 
82
   Name of the replicator plugin to use.
 
83
 
 
84
.. _transaction_log_variables:
 
85
 
 
86
Variables
 
87
---------
 
88
 
 
89
These variables show the running configuration of the plugin.
 
90
See `variables` for more information about querying and setting variables.
 
91
 
 
92
.. _transaction_log_enable:
 
93
 
 
94
* ``transaction_log_enable``
 
95
 
 
96
   :Scope: Global
 
97
   :Dynamic: No
 
98
   :Option: :option:`--transaction-log.enable`
 
99
 
 
100
   If the transaction log is enabled or not.
 
101
 
 
102
.. _transaction_log_enable_checksum:
 
103
 
 
104
* ``transaction_log_enable_checksum``
 
105
 
 
106
   :Scope: Global
 
107
   :Dynamic: No
 
108
   :Option: :option:`--transaction-log.enable-checksum`
 
109
 
 
110
   Enable CRC32 Checksumming of each written transaction log entry
 
111
 
 
112
.. _transaction_log_file:
 
113
 
 
114
* ``transaction_log_file``
 
115
 
 
116
   :Scope: Global
 
117
   :Dynamic: No
 
118
   :Option: :option:`--transaction-log.file`
 
119
 
 
120
   Path to the file to use for transaction log
 
121
 
 
122
.. _transaction_log_flush_frequency:
 
123
 
 
124
* ``transaction_log_flush_frequency``
 
125
 
 
126
   :Scope: Global
 
127
   :Dynamic: No
 
128
   :Option: :option:`--transaction-log.flush-frequency`
 
129
 
 
130
   Flush frequency.
 
131
 
 
132
.. _transaction_log_num_write_buffers:
 
133
 
 
134
* ``transaction_log_num_write_buffers``
 
135
 
 
136
   :Scope: Global
 
137
   :Dynamic: No
 
138
   :Option: :option:`--transaction-log.num-write-buffers`
43
139
 
44
140
   Number of slots for in-memory write buffers (default=8).
45
141
 
 
142
.. _transaction_log_truncate_debug:
 
143
 
 
144
* ``transaction_log_truncate_debug``
 
145
 
 
146
   :Scope: Global
 
147
   :Dynamic: No
 
148
   :Option: :option:`--transaction-log.truncate-debug`
 
149
 
 
150
   DEBUGGING - Truncate transaction log
 
151
 
 
152
.. _transaction_log_use_replicator:
 
153
 
 
154
* ``transaction_log_use_replicator``
 
155
 
 
156
   :Scope: Global
 
157
   :Dynamic: No
 
158
   :Option: :option:`--transaction-log.use-replicator`
 
159
 
 
160
   Name of the replicator plugin to use (default='default_replicator')
46
161
 
47
162
Transaction Log Messages
48
163
------------------------
51
166
<http://code.google.com/p/protobuf/>`_ (GPB) format. See the :doc:`Replication
52
167
documentation </replication>` for more information.
53
168
 
54
 
 
55
169
Transaction Log Format
56
170
----------------------
57
171
 
69
183
  this is always a Transaction GPB message.
70
184
* **Length** - The length, in bytes, of the serialized message.
71
185
* **Serialized Message** - The actual message data.
 
186
 
 
187
.. _transaction_log_examples:
 
188
 
 
189
Examples
 
190
--------
 
191
 
 
192
Sorry, there are no examples for this plugin.
 
193
 
 
194
.. _transaction_log_authors:
 
195
 
 
196
Authors
 
197
-------
 
198
 
 
199
Jay Pipes
 
200
 
 
201
.. _transaction_log_version:
 
202
 
 
203
Version
 
204
-------
 
205
 
 
206
This documentation applies to **transaction_log 0.1.1**.
 
207
 
 
208
To see which version of the plugin a Drizzle server is running, execute:
 
209
 
 
210
.. code-block:: mysql
 
211
 
 
212
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='transaction_log'
 
213
 
 
214
Changelog
 
215
---------
 
216
 
 
217
v0.1.1
 
218
^^^^^^
 
219
* First release.