~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
1900.2.11 by Stewart Smith
docs: have proper subsections on main index page, also include more information about drizzle straight from drizzle.org
9
Drizzle is a transactional, relational, community-driven open source database that is forked from the popular MySQL database.
10
11
The Drizzle team has removed non-essential code, re-factored the remaining code and modernized the code base moving to C++.
12
13
Charter
14
 * A database optimized for Cloud infrastructure and Web applications
15
 * Design for massive concurrency on modern multi-cpu architecture
16
 * Optimize memory for increased performance and parallelism
17
 * Open source, open community, open design
18
19
Scope
20
 * Re-designed modular architecture providing plugins with defined APIs
21
 * Simple design for ease of use and administration
22
 * Reliable, ACID transactional
1794.2.3 by Monty Taylor
Added stubs for option docs.
23
24
1838.2.1 by Brian Aker
More docs.
25
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
26
-------------
1838.2.1 by Brian Aker
More docs.
27
.. toctree::
28
   :maxdepth: 2
1994.4.1 by Marisa Plumb
doc modifications
29
   
1838.2.1 by Brian Aker
More docs.
30
   preface
31
   what_is_drizzle
32
   brief_history_of_drizzle
33
   how_to_report_a_bug
1900.2.18 by Stewart Smith
add section on notable differences from MySQL
34
   mysql_differences
1838.2.1 by Brian Aker
More docs.
35
36
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
37
-------------
1838.2.1 by Brian Aker
More docs.
38
.. toctree::
39
   :maxdepth: 2
40
1878.5.4 by Brian Aker
Update documentation.
41
   queries
1994.4.10 by Marisa Plumb
added outline for functions, modified clause related docs
42
   functions
1838.2.1 by Brian Aker
More docs.
43
   ddl
44
   dml
1878.5.6 by Brian Aker
A couple of fixes to documentation.
45
   columntypes 
46
   variables 
1933.1.9 by Brian Aker
Additional documentation and testing.
47
   locks 
48
   barriers 
1878.5.6 by Brian Aker
A couple of fixes to documentation.
49
   dynamic 
50
   getting_information 
51
   transactional 
1994.4.23 by Marisa Plumb
new data types content
52
   administrative
53
54
Data Types:
55
-----------
56
.. toctree::
57
   :maxdepth: 2
58
59
   data_types
60
1994.4.22 by Marisa Plumb
create table fixes, index toc adjustments
61
User Level Topics:
62
------------------
1878.5.7 by Brian Aker
Additional documenation.
63
.. toctree::
64
   :maxdepth: 2
65
66
   storage_engines
1994.4.21 by Marisa Plumb
adding tungsten doc
67
   using_replication
1878.5.7 by Brian Aker
Additional documenation.
68
   logging
69
1794.2.3 by Monty Taylor
Added stubs for option docs.
70
Configuration:
1994.4.22 by Marisa Plumb
create table fixes, index toc adjustments
71
--------------
1794.2.3 by Monty Taylor
Added stubs for option docs.
72
.. toctree::
73
   :maxdepth: 2
74
75
   configuration
1794.2.5 by Monty Taylor
Added support to pandora for finding and including per-plugin documentation.
76
   options
77
1994.4.23 by Marisa Plumb
new data types content
78
Plugins:
79
^^^^^^^^
80
.. toctree::
81
   :maxdepth: 2
82
1994.4.35 by Marisa Plumb
restoring list.rst to as ref in toc
83
   plugins/list
1994.4.25 by Marisa Plumb
moved protocol doc to main 'docs' folder
84
1794.2.9 by Monty Taylor
Made some TOC structure changes. Added stubs for a couple of command line
85
Architecture:
1994.4.22 by Marisa Plumb
create table fixes, index toc adjustments
86
-------------
1794.2.9 by Monty Taylor
Made some TOC structure changes. Added stubs for a couple of command line
87
.. toctree::
88
   :maxdepth: 2
89
90
   protocol
1861.2.1 by David Shrewsbury
Add some initial Transaction Log plugin and Replication documentation.
91
   replication
1794.2.9 by Monty Taylor
Made some TOC structure changes. Added stubs for a couple of command line
92
93
Clients:
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
   clients/drizzle.rst
99
   clients/drizzledump.rst
2015.2.1 by Andrew Hutchings
Add admin tool and protocol docs (which include the new settings)
100
   clients/drizzleadmin.rst
1794.2.9 by Monty Taylor
Made some TOC structure changes. Added stubs for a couple of command line
101
1836.3.1 by Monty Taylor
Removed libdrizzle doxygen. Put in function stubs in sphinx. Someone can
102
libdrizzle:
1994.4.22 by Marisa Plumb
create table fixes, index toc adjustments
103
-----------
1836.3.1 by Monty Taylor
Removed libdrizzle doxygen. Put in function stubs in sphinx. Someone can
104
.. toctree::
105
   :maxdepth: 2
106
107
   libdrizzle/api.rst
108
   libdrizzle/developer.rst
109
1892.4.1 by patrick crews
Added Sphinx docs for test-run.pl
110
Testing:
1994.4.22 by Marisa Plumb
create table fixes, index toc adjustments
111
--------
1892.4.1 by patrick crews
Added Sphinx docs for test-run.pl
112
.. toctree::
113
   :maxdepth: 2
114
 
115
   testing/test-run.rst
116
1731.5.1 by Monty Taylor
Added sphinx infrastructure
117
Indices and tables
118
==================
119
120
* :ref:`genindex`
121
* :ref:`search`
122