← Back to branch summary

~ubuntu-branches/ubuntu/trusty/drizzle/trusty

« back to all changes in this revision

Viewing changes to docs/plugins/mysql_unix_socket_protocol/index.rst

  • Committer: Package Import Robot
  • Author(s): Clint Byrum
  • Date: 2012-06-19 10:46:49 UTC
  • mfrom: (1.1.6)
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20120619104649-e2l0ggd4oz3um0f4
Tags: upstream-7.1.36-stable
Import upstream version 7.1.36-stable

Show diffs side-by-side

added added

removed removed

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