← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/drizzle_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/drizzle_protocol/docs/index.rst
 
1
Drizzle Protocol
 
2
================
 
3
 
 
4
:program:`drizzle_protocol` implements the Drizzle network protocol.
 
5
 
 
6
.. _drizzle_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:`drizzle_protocol_configuration` and
 
13
:ref:`drizzle_protocol_variables`.
 
14
 
 
15
To stop the plugin from loading by default, start :program:`drizzled`
 
16
with::
 
17
 
 
18
   --plugin-remove=drizzle_protocol
 
19
 
 
20
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
21
 
 
22
.. _drizzle_protocol_configuration:
 
23
 
 
24
Configuration
 
25
-------------
 
26
 
 
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.
 
30
 
 
31
.. program:: drizzled
 
32
 
 
33
.. option:: --drizzle-protocol.bind-address ARG
 
34
 
 
35
   :Default: localhost
 
36
   :Variable: :ref:`drizzle_protocol_bind_address <drizzle_protocol_bind_address>`
 
37
 
 
38
   Address to bind to.
 
39
 
 
40
.. option:: --drizzle-protocol.buffer-length ARG
 
41
 
 
42
   :Default: 16384
 
43
   :Variable: :ref:`drizzle_protocol_buffer_length <drizzle_protocol_buffer_length>`
 
44
 
 
45
   Buffer length.
 
46
 
 
47
.. option:: --drizzle-protocol.connect-timeout ARG
 
48
 
 
49
   :Default: 10
 
50
   :Variable: :ref:`drizzle_protocol_connect_timeout <drizzle_protocol_connect_timeout>`
 
51
 
 
52
   Connect Timeout.
 
53
 
 
54
.. option:: --drizzle-protocol.max-connections ARG
 
55
 
 
56
   :Default: 1000
 
57
   :Variable: :ref:`drizzle_protocol_max_connections <drizzle_protocol_max_connections>`
 
58
 
 
59
   Maximum simultaneous connections.
 
60
 
 
61
.. option:: --drizzle-protocol.port ARG
 
62
 
 
63
   :Default: 4427
 
64
   :Variable: :ref:`drizzle_protocol_port <drizzle_protocol_port>`
 
65
 
 
66
   Port number to use for connection or 0 for default to with Drizzle/MySQL protocol.
 
67
 
 
68
.. option:: --drizzle-protocol.read-timeout ARG
 
69
 
 
70
   :Default: 30
 
71
   :Variable: :ref:`drizzle_protocol_read_timeout <drizzle_protocol_read_timeout>`
 
72
 
 
73
   Read Timeout.
 
74
 
 
75
.. option:: --drizzle-protocol.retry-count ARG
 
76
 
 
77
   :Default: 10
 
78
   :Variable: :ref:`drizzle_protocol_retry_count <drizzle_protocol_retry_count>`
 
79
 
 
80
   Retry Count.
 
81
 
 
82
.. option:: --drizzle-protocol.write-timeout ARG
 
83
 
 
84
   :Default: 60
 
85
   :Variable: :ref:`drizzle_protocol_write_timeout <drizzle_protocol_write_timeout>`
 
86
 
 
87
   Write Timeout.
 
88
 
 
89
.. _drizzle_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
.. _drizzle_protocol_bind_address:
 
98
 
 
99
* ``drizzle_protocol_bind_address``
 
100
 
 
101
   :Scope: Global
 
102
   :Dynamic: No
 
103
   :Option: :option:`--drizzle-protocol.bind-address`
 
104
 
 
105
   Address to bind to.
 
106
 
 
107
.. _drizzle_protocol_buffer_length:
 
108
 
 
109
* ``drizzle_protocol_buffer_length``
 
110
 
 
111
   :Scope: Global
 
112
   :Dynamic: No
 
113
   :Option: :option:`--drizzle-protocol.buffer-length`
 
114
 
 
115
   Buffer length.
 
116
 
 
117
.. _drizzle_protocol_connect_timeout:
 
118
 
 
119
* ``drizzle_protocol_connect_timeout``
 
120
 
 
121
   :Scope: Global
 
122
   :Dynamic: No
 
123
   :Option: :option:`--drizzle-protocol.connect-timeout`
 
124
 
 
125
   Connect Timeout.
 
126
 
 
127
.. _drizzle_protocol_max_connections:
 
128
 
 
129
* ``drizzle_protocol_max_connections``
 
130
 
 
131
   :Scope: Global
 
132
   :Dynamic: No
 
133
   :Option: :option:`--drizzle-protocol.max-connections`
 
134
 
 
135
   Maximum simultaneous connections.
 
136
 
 
137
.. _drizzle_protocol_port:
 
138
 
 
139
* ``drizzle_protocol_port``
 
140
 
 
141
   :Scope: Global
 
142
   :Dynamic: No
 
143
   :Option: :option:`--drizzle-protocol.port`
 
144
 
 
145
   Port number to use for connection or 0 for default to with Drizzle/MySQL protocol.
 
146
 
 
147
.. _drizzle_protocol_read_timeout:
 
148
 
 
149
* ``drizzle_protocol_read_timeout``
 
150
 
 
151
   :Scope: Global
 
152
   :Dynamic: No
 
153
   :Option: :option:`--drizzle-protocol.read-timeout`
 
154
 
 
155
   Read Timeout.
 
156
 
 
157
.. _drizzle_protocol_retry_count:
 
158
 
 
159
* ``drizzle_protocol_retry_count``
 
160
 
 
161
   :Scope: Global
 
162
   :Dynamic: No
 
163
   :Option: :option:`--drizzle-protocol.retry-count`
 
164
 
 
165
   Retry Count.
 
166
 
 
167
.. _drizzle_protocol_write_timeout:
 
168
 
 
169
* ``drizzle_protocol_write_timeout``
 
170
 
 
171
   :Scope: Global
 
172
   :Dynamic: No
 
173
   :Option: :option:`--drizzle-protocol.write-timeout`
 
174
 
 
175
   Write Timeout.
 
176
 
 
177
.. _drizzle_protocol_authors:
 
178
 
 
179
Authors
 
180
-------
 
181
 
 
182
Brian Aker
 
183
 
 
184
.. _drizzle_protocol_version:
 
185
 
 
186
Version
 
187
-------
 
188
 
 
189
This documentation applies to **drizzle_protocol 0.3**.
 
190
 
 
191
To see which version of the plugin a Drizzle server is running, execute:
 
192
 
 
193
.. code-block:: mysql
 
194
 
 
195
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='drizzle_protocol'
 
196
 
 
197
Changelog
 
198
---------
 
199
 
 
200
v0.3
 
201
^^^^
 
202
* First release.