← 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: Mark Atwood
  • Date: 2011-09-13 19:54:55 UTC
  • mfrom: (2397.1.3 plugin-docs)
  • Revision ID: me@mark.atwood.name-20110913195455-3bk3locm85m4jimp
merge lp:~daniel-nichter/drizzle/plugin-docs

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