← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/mysql_unix_socket_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_unix_socket_protocol/docs/index.rst
1
1
MySQL Unix Socket Protocol
2
2
==========================
3
3
 
4
 
The MySQL Unix Socket Protocol plugin allows MySQL compatible clients which
5
 
use the unix socket file to connect to Drizzle.
 
4
MySQL Unix Socket Protocol Module.
 
5
 
 
6
.. _mysql_unix_socket_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_unix_socket_protocol_configuration` and
 
13
:ref:`mysql_unix_socket_protocol_variables`.
 
14
 
 
15
To stop the plugin from loading by default, start :program:`drizzled`
 
16
with::
 
17
 
 
18
   --plugin-remove=mysql_unix_socket_protocol
 
19
 
 
20
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
21
 
 
22
.. _mysql_unix_socket_protocol_configuration:
6
23
 
7
24
Configuration
8
25
-------------
9
26
 
10
 
There are several server variables to control the MySQL Unix Socket 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.
11
30
 
12
31
.. program:: drizzled
13
32
 
14
 
.. option:: --mysql-unix-socket-protocol.path (=/tmp/mysql.socket)
15
 
 
16
 
   The path used for the socket file
17
 
 
18
 
.. option:: --mysql-unix-socket-protocol.clobber
19
 
 
20
 
   Remove the socket file if one already exists
21
 
 
22
 
.. option:: --mysql-unix-socket-protocol.max-connections (=1000)
23
 
 
24
 
   The maximum simultaneous connections via. the unix socket protocol
 
33
.. option:: --mysql-unix-socket-protocol.clobber 
 
34
 
 
35
   :Default: 
 
36
   :Variable:
 
37
 
 
38
   Clobber socket file if one is there already.
 
39
 
 
40
.. option:: --mysql-unix-socket-protocol.max-connections ARG
 
41
 
 
42
   :Default: 1000
 
43
   :Variable: :ref:`mysql_unix_socket_protocol_max_connections <mysql_unix_socket_protocol_max_connections>`
 
44
 
 
45
   Maximum simultaneous connections.
 
46
 
 
47
.. option:: --mysql-unix-socket-protocol.path ARG
 
48
 
 
49
   :Default: DRIZZLE_UNIX_SOCKET_PATH
 
50
   :Variable:
 
51
 
 
52
   Path used for MySQL UNIX Socket Protocol.
 
53
 
 
54
.. _mysql_unix_socket_protocol_variables:
 
55
 
 
56
Variables
 
57
---------
 
58
 
 
59
These variables show the running configuration of the plugin.
 
60
See `variables` for more information about querying and setting variables.
 
61
 
 
62
.. _mysql_unix_socket_protocol_clobber:
 
63
 
 
64
* ``mysql_unix_socket_protocol_clobber``
 
65
 
 
66
   :Scope: Global
 
67
   :Dynamic: No
 
68
   :Option:
 
69
 
 
70
   Unknown
 
71
 
 
72
.. _mysql_unix_socket_protocol_max_connections:
 
73
 
 
74
* ``mysql_unix_socket_protocol_max_connections``
 
75
 
 
76
   :Scope: Global
 
77
   :Dynamic: No
 
78
   :Option: :option:`--mysql-unix-socket-protocol.max-connections`
 
79
 
 
80
   Maximum simultaneous connections.
 
81
 
 
82
.. _mysql_unix_socket_protocol_path:
 
83
 
 
84
* ``mysql_unix_socket_protocol_path``
 
85
 
 
86
   :Scope: Global
 
87
   :Dynamic: No
 
88
   :Option:
 
89
 
 
90
   Unknown
 
91
 
 
92
.. _mysql_unix_socket_protocol_examples:
 
93
 
 
94
Examples
 
95
--------
 
96
 
 
97
Sorry, there are no examples for this plugin.
 
98
 
 
99
.. _mysql_unix_socket_protocol_authors:
 
100
 
 
101
Authors
 
102
-------
 
103
 
 
104
Brian Aker
 
105
 
 
106
.. _mysql_unix_socket_protocol_version:
 
107
 
 
108
Version
 
109
-------
 
110
 
 
111
This documentation applies to **mysql_unix_socket_protocol 0.3**.
 
112
 
 
113
To see which version of the plugin a Drizzle server is running, execute:
 
114
 
 
115
.. code-block:: mysql
 
116
 
 
117
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='mysql_unix_socket_protocol'
 
118