~vjsamuel/drizzle/fix-bug-850898

« back to all changes in this revision

Viewing changes to plugin/filtered_replicator/docs/index.rst

  • Committer: Mark Atwood
  • Date: 2011-09-13 19:54:55 UTC
  • mfrom: (2397.1.3 plugin-docs)
  • Revision ID: me@mark.atwood.name-20110913195455-3bk3locm85m4jimp
mergeĀ lp:~daniel-nichter/drizzle/plugin-docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
*******************
2
1
Filtered Replicator
3
 
*******************
4
 
 
5
 
Description
6
 
###########
7
 
 
8
 
The Filtered Replicator plugin registers itself in the Drizzle kernel replication
9
 
stream process as a new replicator (see :ref:`replication_streams` for more
10
 
information). It provides a way to filter replication messages by schema name or
11
 
table name. Regular expressions can be used for the schema and table names.
12
 
 
13
 
To make the filtered replicator available, you must enable the plugin when the
14
 
server is started using the :option:`--plugin-add` option.
 
2
===================
 
3
 
 
4
The Filtered Replicator plugin registers itself in the Drizzle kernel
 
5
replication stream process as a new replicator (see :ref:`replication_streams`
 
6
for more information). It provides a way to filter replication messages by
 
7
schema name or table name.  Regular expressions can be used for the schema and
 
8
table names.
 
9
 
 
10
.. _filtered_replicator_loading:
 
11
 
 
12
Loading
 
13
-------
 
14
 
 
15
To load this plugin, start :program:`drizzled` with::
 
16
 
 
17
   --plugin-add=filtered_replicator
 
18
 
 
19
Loading the plugin may not enable or configure it.  See the plugin's
 
20
:ref:`filtered_replicator_configuration` and :ref:`filtered_replicator_variables`.
 
21
 
 
22
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
23
 
 
24
.. _filtered_replicator_configuration:
15
25
 
16
26
Configuration
17
 
#############
 
27
-------------
 
28
 
 
29
These command line options configure the plugin when :program:`drizzled`
 
30
is started.  See :doc:`/configuration` for more information about specifying
 
31
command line options.
18
32
 
19
33
.. program:: drizzled
20
34
 
21
 
.. option:: --filtered-replicator.filteredschemas
22
 
 
23
 
   Comma-separated list of schema names to exclude from replication.
24
 
 
25
 
.. option:: --filtered-replicator.filteredtables
26
 
 
27
 
   Comma-separated list of table names to exclude from replication.
28
 
 
29
 
.. option:: --filtered-replicator.schemaregex
30
 
 
31
 
   Regular expression to apply to schemas to exclude from replication.
32
 
 
33
 
.. option:: --filtered-replicator.tableregex
34
 
 
35
 
   Regular expression to apply to tables to exclude from replication.
 
35
.. option:: --filtered-replicator.filteredschemas ARG
 
36
 
 
37
   :Default: 
 
38
   :Variable: :ref:`filtered_replicator_filteredschemas <filtered_replicator_filteredschemas>`
 
39
 
 
40
   Comma-separated list of schemas to exclude from replication.
 
41
 
 
42
.. option:: --filtered-replicator.filteredtables ARG
 
43
 
 
44
   :Default: 
 
45
   :Variable: :ref:`filtered_replicator_filteredtables <filtered_replicator_filteredtables>`
 
46
 
 
47
   Comma-separated list of tables to exclude from replication.
 
48
 
 
49
.. option:: --filtered-replicator.schemaregex ARG
 
50
 
 
51
   :Default: 
 
52
   :Variable: :ref:`filtered_replicator_schemaregex <filtered_replicator_schemaregex>`
 
53
 
 
54
   Regular expression to apply to schemas to exclude from replication.
 
55
 
 
56
.. option:: --filtered-replicator.tableregex ARG
 
57
 
 
58
   :Default: 
 
59
   :Variable: :ref:`filtered_replicator_tableregex <filtered_replicator_tableregex>`
 
60
 
 
61
   Regular expression to apply to tables to exclude from replication.
 
62
 
 
63
.. _filtered_replicator_variables:
 
64
 
 
65
Variables
 
66
---------
 
67
 
 
68
These variables show the running configuration of the plugin.
 
69
See `variables` for more information about querying and setting variables.
 
70
 
 
71
.. _filtered_replicator_filteredschemas:
 
72
 
 
73
* ``filtered_replicator_filteredschemas``
 
74
 
 
75
   :Scope: Global
 
76
   :Dynamic: No
 
77
   :Option: :option:`--filtered-replicator.filteredschemas`
 
78
 
 
79
   Comma-separated list of schemas to exclude from replication.
 
80
 
 
81
.. _filtered_replicator_filteredtables:
 
82
 
 
83
* ``filtered_replicator_filteredtables``
 
84
 
 
85
   :Scope: Global
 
86
   :Dynamic: No
 
87
   :Option: :option:`--filtered-replicator.filteredtables`
 
88
 
 
89
   Comma-separated list of tables to exclude from replication.
 
90
 
 
91
.. _filtered_replicator_schemaregex:
 
92
 
 
93
* ``filtered_replicator_schemaregex``
 
94
 
 
95
   :Scope: Global
 
96
   :Dynamic: No
 
97
   :Option: :option:`--filtered-replicator.schemaregex`
 
98
 
 
99
   Regular expression to apply to schemas to exclude from replication.
 
100
 
 
101
.. _filtered_replicator_tableregex:
 
102
 
 
103
* ``filtered_replicator_tableregex``
 
104
 
 
105
   :Scope: Global
 
106
   :Dynamic: No
 
107
   :Option: :option:`--filtered-replicator.tableregex`
 
108
 
 
109
   Regular expression to apply to tables to exclude from replication.
 
110
 
 
111
.. _filtered_replicator_examples:
36
112
 
37
113
Examples
38
 
########
39
 
 
40
 
To prevent changes to the *foo* schema from being replicated::
41
 
 
42
 
  sbin/drizzled --plugin-add=filtered_replicator \
43
 
                --filtered-replicator.filteredschemas=foo
44
 
 
45
 
To prevent changes to any schema beginning with *test* from being replicated::
46
 
 
47
 
  sbin/drizzled --plugin-add=filtered_replicator \
48
 
                --filtered-replicator.schemaregex="test*"
49
 
 
50
 
To prevent changes to any table beginning with *junk* from being replicated::
51
 
 
52
 
  sbin/drizzled --plugin-add=filtered_replicator \
53
 
                --filtered-replicator.tableregex="junk*"
 
114
--------
 
115
 
 
116
Sorry, there are no examples for this plugin.
 
117
 
 
118
.. _filtered_replicator_authors:
 
119
 
 
120
Authors
 
121
-------
 
122
 
 
123
Padraig O Sullivan
 
124
 
 
125
.. _filtered_replicator_version:
 
126
 
 
127
Version
 
128
-------
 
129
 
 
130
This documentation applies to **filtered_replicator 0.2**.
 
131
 
 
132
To see which version of the plugin a Drizzle server is running, execute:
 
133
 
 
134
.. code-block:: mysql
 
135
 
 
136
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='filtered_replicator'
 
137
 
 
138
Chagnelog
 
139
---------
 
140
 
 
141
v0.2
 
142
^^^^
 
143
* First release.