~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/http_functions/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
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:
 
1
HTTP Functions
 
2
==============
 
3
 
 
4
The ``http_functions`` plugin provides functions to get and post HTTP
 
5
data:
 
6
 
 
7
* ``HTTP_GET``
 
8
* ``HTTP_POST``
 
9
 
 
10
.. _http_functions_loading:
 
11
 
 
12
Loading
 
13
-------
 
14
 
 
15
To load this plugin, start :program:`drizzled` with::
 
16
 
 
17
   --plugin-add=http_functions
 
18
 
 
19
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
20
 
 
21
.. _http_functions_authors:
 
22
 
 
23
Examples
 
24
--------
 
25
 
 
26
Start :program:`drizzled` with the plugin::
 
27
 
 
28
   sbin/drizzled --plugin-add=http_functions
 
29
 
 
30
Get `www.drizzle.org <http://www.drizzle.org>`_:
 
31
 
 
32
.. code-block:: mysql
 
33
 
 
34
   drizzle> SELECT HTTP_GET('www.drizzle.org')\G
 
35
   *************************** 1. row ***************************
 
36
   HTTP_GET('www.drizzle.org'): <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN"
 
37
   "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">
 
38
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" version="XHTML+RDFa 1.0" dir="ltr"
 
39
   ...
 
40
 
 
41
Authors
 
42
-------
 
43
 
 
44
Stewart Smith
 
45
 
 
46
.. _http_functions_version:
 
47
 
 
48
Version
 
49
-------
 
50
 
 
51
This documentation applies to **http_functions 1.0**.
 
52
 
 
53
To see which version of the plugin a Drizzle server is running, execute:
 
54
 
 
55
.. code-block:: mysql
 
56
 
 
57
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='http_functions'
 
58
 
 
59
Changelog
 
60
---------
 
61
 
 
62
v1.0
 
63
^^^^
 
64
* First release.