← 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-10-23 16:01:37 UTC
  • mto: This revision was merged to the branch mainline in revision 2448.
  • Revision ID: daniel@percona.com-20111023160137-7ac3blgz8z4tf8za
Add Administration Getting Started and Logging.  Capitalize SQL clause keywords.

Show diffs side-by-side

added added

removed removed

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