~drizzle-trunk/drizzle/development

1731.5.1 by Monty Taylor
Added sphinx infrastructure
1
.. Drizzle documentation master file, created by
2
   sphinx-quickstart on Fri Aug 27 08:33:41 2010.
3
   You can adapt this file completely to your liking, but it should at least
4
   contain the root `toctree` directive.
5
6
Welcome to Drizzle's documentation!
7
===================================
8
1994.4.44 by Marisa Plumb
adding logo w/license file
9
.. image:: logo.png
10
1900.2.11 by Stewart Smith
docs: have proper subsections on main index page, also include more information about drizzle straight from drizzle.org
11
Drizzle is a transactional, relational, community-driven open source database that is forked from the popular MySQL database.
12
13
The Drizzle team has removed non-essential code, re-factored the remaining code and modernized the code base moving to C++.
14
15
Charter
16
 * A database optimized for Cloud infrastructure and Web applications
17
 * Design for massive concurrency on modern multi-cpu architecture
18
 * Optimize memory for increased performance and parallelism
19
 * Open source, open community, open design
20
21
Scope
22
 * Re-designed modular architecture providing plugins with defined APIs
23
 * Simple design for ease of use and administration
24
 * Reliable, ACID transactional
1794.2.3 by Monty Taylor
Added stubs for option docs.
25
26
1838.2.1 by Brian Aker
More docs.
27
Introduction:
1900.2.11 by Stewart Smith
docs: have proper subsections on main index page, also include more information about drizzle straight from drizzle.org
28
-------------
1838.2.1 by Brian Aker
More docs.
29
.. toctree::
30
   :maxdepth: 2
1994.4.1 by Marisa Plumb
doc modifications
31
   
1838.2.1 by Brian Aker
More docs.
32
   preface
1994.4.44 by Marisa Plumb
adding logo w/license file
33
   license
1838.2.1 by Brian Aker
More docs.
34
   what_is_drizzle
35
   brief_history_of_drizzle
36
   how_to_report_a_bug
1900.2.18 by Stewart Smith
add section on notable differences from MySQL
37
   mysql_differences
1838.2.1 by Brian Aker
More docs.
38
2099.2.2 by Andrew Hutchings
Add compiling and installing section with basic content
39
Compiling and Installing:
40
-------------------------
41
.. toctree::
42
   :maxdepth: 2
43
44
   installing/requirements
45
   installing/from_source
46
   installing/ubuntu
47
   installing/redhat
48
1838.2.1 by Brian Aker
More docs.
49
SQL Language:
1900.2.11 by Stewart Smith
docs: have proper subsections on main index page, also include more information about drizzle straight from drizzle.org
50
-------------
1838.2.1 by Brian Aker
More docs.
51
.. toctree::
52
   :maxdepth: 2
53
1878.5.4 by Brian Aker
Update documentation.
54
   queries
1994.4.52 by Marisa Plumb
modifying folder structure
55
   functions/overview
1994.4.39 by Marisa Plumb
new material to address https://bugs.launchpad.net/drizzle/+bug/684803, new functions
56
   data_types
1838.2.1 by Brian Aker
More docs.
57
   ddl
58
   dml
1878.5.6 by Brian Aker
A couple of fixes to documentation.
59
   columntypes 
60
   variables 
1933.1.9 by Brian Aker
Additional documentation and testing.
61
   locks 
62
   barriers 
1878.5.6 by Brian Aker
A couple of fixes to documentation.
63
   dynamic 
64
   getting_information 
65
   transactional 
1994.4.23 by Marisa Plumb
new data types content
66
   administrative
1994.4.62 by Marisa Plumb
string and resources
67
   resources/index
1994.4.23 by Marisa Plumb
new data types content
68
1994.4.22 by Marisa Plumb
create table fixes, index toc adjustments
69
User Level Topics:
70
------------------
1878.5.7 by Brian Aker
Additional documenation.
71
.. toctree::
72
   :maxdepth: 2
73
74
   storage_engines
1994.4.21 by Marisa Plumb
adding tungsten doc
75
   using_replication
1878.5.7 by Brian Aker
Additional documenation.
76
   logging
77
1794.2.3 by Monty Taylor
Added stubs for option docs.
78
Configuration:
1994.4.22 by Marisa Plumb
create table fixes, index toc adjustments
79
--------------
1794.2.3 by Monty Taylor
Added stubs for option docs.
80
.. toctree::
81
   :maxdepth: 2
82
83
   configuration
1794.2.5 by Monty Taylor
Added support to pandora for finding and including per-plugin documentation.
84
   options
85
1994.4.23 by Marisa Plumb
new data types content
86
Plugins:
87
^^^^^^^^
88
.. toctree::
89
   :maxdepth: 2
90
1994.4.35 by Marisa Plumb
restoring list.rst to as ref in toc
91
   plugins/list
1994.4.25 by Marisa Plumb
moved protocol doc to main 'docs' folder
92
1794.2.9 by Monty Taylor
Made some TOC structure changes. Added stubs for a couple of command line
93
Architecture:
1994.4.22 by Marisa Plumb
create table fixes, index toc adjustments
94
-------------
1794.2.9 by Monty Taylor
Made some TOC structure changes. Added stubs for a couple of command line
95
.. toctree::
96
   :maxdepth: 2
97
98
   protocol
1861.2.1 by David Shrewsbury
Add some initial Transaction Log plugin and Replication documentation.
99
   replication
1794.2.9 by Monty Taylor
Made some TOC structure changes. Added stubs for a couple of command line
100
101
Clients:
1994.4.22 by Marisa Plumb
create table fixes, index toc adjustments
102
--------
1794.2.9 by Monty Taylor
Made some TOC structure changes. Added stubs for a couple of command line
103
.. toctree::
104
   :maxdepth: 2
105
106
   clients/drizzle.rst
107
   clients/drizzledump.rst
2015.2.1 by Andrew Hutchings
Add admin tool and protocol docs (which include the new settings)
108
   clients/drizzleadmin.rst
2099.2.1 by Andrew Hutchings
Add errors page to drizzle client docs
109
   clients/errors.rst
1794.2.9 by Monty Taylor
Made some TOC structure changes. Added stubs for a couple of command line
110
1836.3.1 by Monty Taylor
Removed libdrizzle doxygen. Put in function stubs in sphinx. Someone can
111
libdrizzle:
1994.4.22 by Marisa Plumb
create table fixes, index toc adjustments
112
-----------
1836.3.1 by Monty Taylor
Removed libdrizzle doxygen. Put in function stubs in sphinx. Someone can
113
.. toctree::
114
   :maxdepth: 2
115
116
   libdrizzle/api.rst
117
   libdrizzle/developer.rst
118
1892.4.1 by patrick crews
Added Sphinx docs for test-run.pl
119
Testing:
1994.4.22 by Marisa Plumb
create table fixes, index toc adjustments
120
--------
1892.4.1 by patrick crews
Added Sphinx docs for test-run.pl
121
.. toctree::
122
   :maxdepth: 2
123
 
124
   testing/test-run.rst
125
1731.5.1 by Monty Taylor
Added sphinx infrastructure
126
Indices and tables
127
==================
128
129
* :ref:`genindex`
130
* :ref:`search`
131