← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/mysql_protocol/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/mysql_protocol/docs/index.rst
1
1
MySQL Protocol
2
2
==============
3
3
 
4
 
The MySQL Protocol plugin allows MySQL compatible clients to connect to Drizzle.
 
4
MySQL Protocol Module.
 
5
 
 
6
.. _mysql_protocol_loading:
 
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:`mysql_protocol_configuration` and
 
13
:ref:`mysql_protocol_variables`.
 
14
 
 
15
To stop the plugin from loading by default, start :program:`drizzled`
 
16
with::
 
17
 
 
18
   --plugin-remove=mysql_protocol
 
19
 
 
20
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
21
 
 
22
.. _mysql_protocol_configuration:
5
23
 
6
24
Configuration
7
25
-------------
8
26
 
9
 
There are several server variables to control the MySQL Protocol.
 
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.
10
30
 
11
31
.. program:: drizzled
12
32
 
13
 
.. option:: --mysql-protocol.port arg (=3306)
14
 
 
15
 
   The port number to use with MySQL connections (0 is the same as 3306)
16
 
 
17
 
.. option:: --mysql-protocol.connect-timeout arg (=10)
18
 
 
19
 
   Connection timeout in seconds
20
 
 
21
 
.. option:: --mysql-protocol.read-timeout arg (=30)
22
 
 
23
 
   Port read timeout in seconds
24
 
 
25
 
.. option:: --mysql-protocol.write-timeout arg (=60)
26
 
 
27
 
   Port write timeout in seconds
28
 
 
29
 
.. option:: --mysql-protocol.retry-count arg (=10)
30
 
 
31
 
   Retry count for the read and write timeout before killing the connection
32
 
 
33
 
.. option:: --mysql-protocol.buffer-length arg (=16384)
34
 
 
35
 
   Buffer length
36
 
 
37
 
.. option:: --mysql-protocol.bind-address arg
38
 
 
39
 
   Address to bind to
40
 
 
41
 
.. option:: --mysql-protocol.max-connections arg (=1000)
42
 
 
43
 
   Maximum simultaneous connections
44
 
 
45
 
.. option:: --mysql-protocol.admin-ip-addresses arg
46
 
 
47
 
   A comma seprated list of IP addresses for admin tools to connect from
 
33
.. option:: --mysql-protocol.bind-address ARG
 
34
 
 
35
   :Default: localhost
 
36
   :Variable: :ref:`mysql_protocol_bind_address <mysql_protocol_bind_address>`
 
37
 
 
38
   Address to bind to.
 
39
 
 
40
.. option:: --mysql-protocol.buffer-length ARG
 
41
 
 
42
   :Default: 16384
 
43
   :Variable: :ref:`mysql_protocol_buffer_length <mysql_protocol_buffer_length>`
 
44
 
 
45
   Buffer length.
 
46
 
 
47
.. option:: --mysql-protocol.connect-timeout ARG
 
48
 
 
49
   :Default: 10
 
50
   :Variable: :ref:`mysql_protocol_connect_timeout <mysql_protocol_connect_timeout>`
 
51
 
 
52
   Connect Timeout.
 
53
 
 
54
.. option:: --mysql-protocol.max-connections ARG
 
55
 
 
56
   :Default: 1000
 
57
   :Variable: :ref:`mysql_protocol_max_connections <mysql_protocol_max_connections>`
 
58
 
 
59
   Maximum simultaneous connections.
 
60
 
 
61
.. option:: --mysql-protocol.port ARG
 
62
 
 
63
   :Default: 3306
 
64
   :Variable: :ref:`mysql_protocol_port <mysql_protocol_port>`
 
65
 
 
66
   Port number to use for connection or 0 for default to with MySQL 
 
67
 
 
68
.. option:: --mysql-protocol.read-timeout ARG
 
69
 
 
70
   :Default: 30
 
71
   :Variable: :ref:`mysql_protocol_read_timeout <mysql_protocol_read_timeout>`
 
72
 
 
73
   Read Timeout.
 
74
 
 
75
.. option:: --mysql-protocol.retry-count ARG
 
76
 
 
77
   :Default: 10
 
78
   :Variable: :ref:`mysql_protocol_retry_count <mysql_protocol_retry_count>`
 
79
 
 
80
   Retry Count.
 
81
 
 
82
.. option:: --mysql-protocol.write-timeout ARG
 
83
 
 
84
   :Default: 60
 
85
   :Variable: :ref:`mysql_protocol_write_timeout <mysql_protocol_write_timeout>`
 
86
 
 
87
   Write Timeout.
 
88
 
 
89
.. _mysql_protocol_variables:
 
90
 
 
91
Variables
 
92
---------
 
93
 
 
94
These variables show the running configuration of the plugin.
 
95
See `variables` for more information about querying and setting variables.
 
96
 
 
97
.. _mysql_protocol_bind_address:
 
98
 
 
99
* ``mysql_protocol_bind_address``
 
100
 
 
101
   :Scope: Global
 
102
   :Dynamic: No
 
103
   :Option: :option:`--mysql-protocol.bind-address`
 
104
 
 
105
   Address to bind to.
 
106
 
 
107
.. _mysql_protocol_buffer_length:
 
108
 
 
109
* ``mysql_protocol_buffer_length``
 
110
 
 
111
   :Scope: Global
 
112
   :Dynamic: No
 
113
   :Option: :option:`--mysql-protocol.buffer-length`
 
114
 
 
115
   Buffer length.
 
116
 
 
117
.. _mysql_protocol_connect_timeout:
 
118
 
 
119
* ``mysql_protocol_connect_timeout``
 
120
 
 
121
   :Scope: Global
 
122
   :Dynamic: No
 
123
   :Option: :option:`--mysql-protocol.connect-timeout`
 
124
 
 
125
   Connect Timeout.
 
126
 
 
127
.. _mysql_protocol_max_connections:
 
128
 
 
129
* ``mysql_protocol_max_connections``
 
130
 
 
131
   :Scope: Global
 
132
   :Dynamic: No
 
133
   :Option: :option:`--mysql-protocol.max-connections`
 
134
 
 
135
   Maximum simultaneous connections.
 
136
 
 
137
.. _mysql_protocol_port:
 
138
 
 
139
* ``mysql_protocol_port``
 
140
 
 
141
   :Scope: Global
 
142
   :Dynamic: No
 
143
   :Option: :option:`--mysql-protocol.port`
 
144
 
 
145
   Port number to use for connection or 0 for default to with MySQL 
 
146
 
 
147
.. _mysql_protocol_read_timeout:
 
148
 
 
149
* ``mysql_protocol_read_timeout``
 
150
 
 
151
   :Scope: Global
 
152
   :Dynamic: No
 
153
   :Option: :option:`--mysql-protocol.read-timeout`
 
154
 
 
155
   Read Timeout.
 
156
 
 
157
.. _mysql_protocol_retry_count:
 
158
 
 
159
* ``mysql_protocol_retry_count``
 
160
 
 
161
   :Scope: Global
 
162
   :Dynamic: No
 
163
   :Option: :option:`--mysql-protocol.retry-count`
 
164
 
 
165
   Retry Count.
 
166
 
 
167
.. _mysql_protocol_write_timeout:
 
168
 
 
169
* ``mysql_protocol_write_timeout``
 
170
 
 
171
   :Scope: Global
 
172
   :Dynamic: No
 
173
   :Option: :option:`--mysql-protocol.write-timeout`
 
174
 
 
175
   Write Timeout.
 
176
 
 
177
.. _mysql_protocol_examples:
 
178
 
 
179
Examples
 
180
--------
 
181
 
 
182
Sorry, there are no examples for this plugin.
 
183
 
 
184
.. _mysql_protocol_authors:
 
185
 
 
186
Authors
 
187
-------
 
188
 
 
189
Eric Day
 
190
 
 
191
.. _mysql_protocol_version:
 
192
 
 
193
Version
 
194
-------
 
195
 
 
196
This documentation applies to **mysql_protocol 0.1**.
 
197
 
 
198
To see which version of the plugin a Drizzle server is running, execute:
 
199
 
 
200
.. code-block:: mysql
 
201
 
 
202
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='mysql_protocol'
 
203