← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/replication/replicators/filtered.rst

  • Committer: Package Import Robot
  • Author(s): Clint Byrum
  • Date: 2012-06-19 10:46:49 UTC
  • mfrom: (1.2.11) (2.1.16 sid)
  • Revision ID: package-import@ubuntu.com-20120619104649-9ij634mxm4x8pp4l
Tags: 1:7.1.36-stable-1ubuntu1
https://launchpad.net/bugs/987575
* Merge from Debian unstable. (LP: #987575)
  Remaining changes:
  - Added upstart script.
* debian/drizzle.upstart: dropped logger since upstart logs job
  output now.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/replication/replicators/filtered.rst
 
1
.. _filtered_replicator:
 
2
 
 
3
Filtered Replicator
 
4
===================
 
5
 
 
6
The filtered replicator plugin, named ``filtered_replicator``, filters
 
7
replication events based on schema name or table name.  Regular expressions
 
8
can be used for the schema and 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:: :ref:`drizzled_plugin_options` for more information about adding and removing plugins.
 
23
 
 
24
.. _filtered_replicator_configuration:
 
25
 
 
26
Configuration
 
27
-------------
 
28
 
 
29
These command line options configure the plugin when :program:`drizzled`
 
30
is started.  See :ref:`command_line_options` for more information about
 
31
specifying command line options.
 
32
 
 
33
.. program:: drizzled
 
34
 
 
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:
 
112
 
 
113
Examples
 
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.