~ubuntu-branches/ubuntu/trusty/drizzle/trusty

« back to all changes in this revision

Viewing changes to docs/replication/appliers/rabbitmq.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:
 
1
.. _rabbitmq_applier:
 
2
 
 
3
RabbitMQ Applier
 
4
================
 
5
 
 
6
The RabbitMQ applier plugin, named ``rabbitmq``, applies replication events to a `RabbitMQ <http://www.rabbitmq.com>`_ server.  This can be used to create advanced replication solutions, to visualize data, or to build triggers.
 
7
 
 
8
Loading
 
9
-------
 
10
 
 
11
To load this plugin, start :program:`drizzled` with::
 
12
 
 
13
   --plugin-add=rabbitmq
 
14
 
 
15
Loading the plugin may not enable or configure it.  See the plugin's
 
16
:ref:`rabbitmq_configuration` and :ref:`rabbitmq_variables`.
 
17
 
 
18
.. seealso:: :ref:`drizzled_plugin_options` for more information about adding and removing plugins.
 
19
 
 
20
.. _rabbitmq_configuration:
 
21
 
 
22
Configuration
 
23
-------------
 
24
 
 
25
These command line options configure the plugin when :program:`drizzled`
 
26
is started.  See :ref:`command_line_options` for more information about
 
27
specifying command line options.
 
28
 
 
29
.. program:: drizzled
 
30
 
 
31
.. option:: --rabbitmq.exchange ARG
 
32
 
 
33
   :Default: ReplicationExchange
 
34
   :Variable: :ref:`rabbitmq_exchange <rabbitmq_exchange>`
 
35
 
 
36
   Name of RabbitMQ exchange to publish to
 
37
 
 
38
.. option:: --rabbitmq.host ARG
 
39
 
 
40
   :Default: localhost
 
41
   :Variable: :ref:`rabbitmq_host <rabbitmq_host>`
 
42
 
 
43
   Host name to connect to
 
44
 
 
45
.. option:: --rabbitmq.password ARG
 
46
 
 
47
   :Default: guest
 
48
   :Variable: :ref:`rabbitmq_password <rabbitmq_password>`
 
49
 
 
50
   RabbitMQ password
 
51
 
 
52
.. option:: --rabbitmq.port ARG
 
53
 
 
54
   :Default: 5672
 
55
   :Variable: :ref:`rabbitmq_port <rabbitmq_port>`
 
56
 
 
57
   Port to connect to
 
58
 
 
59
.. option:: --rabbitmq.routingkey ARG
 
60
 
 
61
   :Default: ReplicationRoutingKey
 
62
   :Variable: :ref:`rabbitmq_routingkey <rabbitmq_routingkey>`
 
63
 
 
64
   Name of RabbitMQ routing key to use
 
65
 
 
66
.. option:: --rabbitmq.use-replicator ARG
 
67
 
 
68
   :Default: default_replicator
 
69
   :Variable:
 
70
 
 
71
   Name of the replicator plugin to use (default='default_replicator')
 
72
 
 
73
.. option:: --rabbitmq.username ARG
 
74
 
 
75
   :Default: guest
 
76
   :Variable: :ref:`rabbitmq_username <rabbitmq_username>`
 
77
 
 
78
   RabbitMQ username
 
79
 
 
80
.. option:: --rabbitmq.virtualhost ARG
 
81
 
 
82
   :Default: /
 
83
   :Variable: :ref:`rabbitmq_virtualhost <rabbitmq_virtualhost>`
 
84
 
 
85
   RabbitMQ virtualhost
 
86
 
 
87
.. _rabbitmq_variables:
 
88
 
 
89
Variables
 
90
---------
 
91
 
 
92
These variables show the running configuration of the plugin.
 
93
See `variables` for more information about querying and setting variables.
 
94
 
 
95
.. _rabbitmq_exchange:
 
96
 
 
97
* ``rabbitmq_exchange``
 
98
 
 
99
   :Scope: Global
 
100
   :Dynamic: No
 
101
   :Option: :option:`--rabbitmq.exchange`
 
102
 
 
103
   Name of RabbitMQ exchange to publish to
 
104
 
 
105
.. _rabbitmq_host:
 
106
 
 
107
* ``rabbitmq_host``
 
108
 
 
109
   :Scope: Global
 
110
   :Dynamic: No
 
111
   :Option: :option:`--rabbitmq.host`
 
112
 
 
113
   Host name to connect to
 
114
 
 
115
.. _rabbitmq_password:
 
116
 
 
117
* ``rabbitmq_password``
 
118
 
 
119
   :Scope: Global
 
120
   :Dynamic: No
 
121
   :Option: :option:`--rabbitmq.password`
 
122
 
 
123
   RabbitMQ password
 
124
 
 
125
.. _rabbitmq_port:
 
126
 
 
127
* ``rabbitmq_port``
 
128
 
 
129
   :Scope: Global
 
130
   :Dynamic: No
 
131
   :Option: :option:`--rabbitmq.port`
 
132
 
 
133
   Port to connect to
 
134
 
 
135
.. _rabbitmq_routingkey:
 
136
 
 
137
* ``rabbitmq_routingkey``
 
138
 
 
139
   :Scope: Global
 
140
   :Dynamic: No
 
141
   :Option: :option:`--rabbitmq.routingkey`
 
142
 
 
143
   Name of RabbitMQ routing key to use
 
144
 
 
145
.. _rabbitmq_username:
 
146
 
 
147
* ``rabbitmq_username``
 
148
 
 
149
   :Scope: Global
 
150
   :Dynamic: No
 
151
   :Option: :option:`--rabbitmq.username`
 
152
 
 
153
   RabbitMQ username
 
154
 
 
155
.. _rabbitmq_virtualhost:
 
156
 
 
157
* ``rabbitmq_virtualhost``
 
158
 
 
159
   :Scope: Global
 
160
   :Dynamic: No
 
161
   :Option: :option:`--rabbitmq.virtualhost`
 
162
 
 
163
   RabbitMQ virtualhost
 
164
 
 
165
 
 
166
Implementation Details
 
167
----------------------
 
168
 
 
169
* :program:`drizzled` will not sart if the rabbitmq server is not available.
 
170
* If the rabbitmq server goes away, the plugin will try to reconnect and resend the message 3 times, after that, the transaction is rolled back.
 
171
 
 
172
.. _rabbitmq_version:
 
173
 
 
174
Version
 
175
-------
 
176
 
 
177
This documentation applies to :ref:`rabbitmq_0.1_drizzle_7.0`.
 
178
 
 
179
To see which version of the ``rabbitmq`` plugin a Drizzle server is running,
 
180
execute:
 
181
 
 
182
.. code-block:: mysql
 
183
 
 
184
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='rabbitmq'
 
185
 
 
186
Changelog
 
187
---------
 
188
 
 
189
.. toctree::
 
190
   :maxdepth: 2
 
191
 
 
192
   rabbitmq/changelog
 
193
 
 
194
.. _rabbitmq_authors:
 
195
 
 
196
Authors
 
197
-------
 
198
 
 
199
Marcus Eriksson