← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/json_server/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/json_server/docs/index.rst
 
1
JSON Server
 
2
===========
 
3
 
 
4
JSON HTTP interface.
 
5
 
 
6
.. _json_server_loading:
 
7
 
 
8
Loading
 
9
-------
 
10
 
 
11
To load this plugin, start :program:`drizzled` with::
 
12
 
 
13
   --plugin-add=json_server
 
14
 
 
15
Loading the plugin may not enable or configure it.  See the plugin's
 
16
:ref:`json_server_configuration` and :ref:`json_server_variables`.
 
17
 
 
18
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
19
 
 
20
.. _json_server_configuration:
 
21
 
 
22
Configuration
 
23
-------------
 
24
 
 
25
These command line options configure the plugin when :program:`drizzled`
 
26
is started.  See :doc:`/configuration` for more information about specifying
 
27
command line options.
 
28
 
 
29
.. program:: drizzled
 
30
 
 
31
.. option:: --json-server.port ARG
 
32
 
 
33
   :Default: 8086
 
34
   :Variable: :ref:`json_server_port <json_server_port>`
 
35
 
 
36
   Port number to use for connection or 0 for default (port 8086) 
 
37
 
 
38
.. _json_server_variables:
 
39
 
 
40
Variables
 
41
---------
 
42
 
 
43
These variables show the running configuration of the plugin.
 
44
See `variables` for more information about querying and setting variables.
 
45
 
 
46
.. _json_server_port:
 
47
 
 
48
* ``json_server_port``
 
49
 
 
50
   :Scope: Global
 
51
   :Dynamic: No
 
52
   :Option: :option:`--json-server.port`
 
53
 
 
54
   Port number to use for connection or 0 for default (port 8086) 
 
55
 
 
56
.. _json_server_examples:
 
57
 
 
58
Examples
 
59
--------
 
60
 
 
61
Sorry, there are no examples for this plugin.
 
62
 
 
63
.. _json_server_authors:
 
64
 
 
65
Authors
 
66
-------
 
67
 
 
68
Stewart Smith
 
69
 
 
70
.. _json_server_version:
 
71
 
 
72
Version
 
73
-------
 
74
 
 
75
This documentation applies to **json_server 0.1**.
 
76
 
 
77
To see which version of the plugin a Drizzle server is running, execute:
 
78
 
 
79
.. code-block:: mysql
 
80
 
 
81
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='json_server'
 
82
 
 
83
Changelog
 
84
---------
 
85
 
 
86
v0.1
 
87
^^^^
 
88
* First release.