|
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 |
||
|
2222.2.1
by Mark Atwood
documentation work |
11 |
Drizzle is a transactional, relational, community-driven open-source database that is forked from the popular MySQL database. |
|
1900.2.11
by Stewart Smith
docs: have proper subsections on main index page, also include more information about drizzle straight from drizzle.org |
12 |
|
|
2222.2.1
by Mark Atwood
documentation work |
13 |
The Drizzle team has removed non-essential code, has re-factored the remaining code, and has converted the code to modern C++ and modern libraries. |
|
1900.2.11
by Stewart Smith
docs: have proper subsections on main index page, also include more information about drizzle straight from drizzle.org |
14 |
|
15 |
Charter |
|
16 |
* A database optimized for Cloud infrastructure and Web applications |
|
|
2222.2.1
by Mark Atwood
documentation work |
17 |
* Design for massive concurrency on modern multi-CPU architectures
|
18 |
* Optimize memory use for increased performance and parallelism
|
|
|
1900.2.11
by Stewart Smith
docs: have proper subsections on main index page, also include more information about drizzle straight from drizzle.org |
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 |
||
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
27 |
Introduction
|
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 |
|
|
1994.4.104
by Marisa Plumb
new doc with note about versioning |
37 |
versioning |
|
1900.2.18
by Stewart Smith
add section on notable differences from MySQL |
38 |
mysql_differences |
|
1838.2.1
by Brian Aker
More docs. |
39 |
|
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
40 |
Compiling and Installing
|
41 |
------------------------
|
|
|
2099.2.2
by Andrew Hutchings
Add compiling and installing section with basic content |
42 |
.. toctree:: |
43 |
:maxdepth: 2
|
|
44 |
||
45 |
installing/requirements |
|
46 |
installing/from_source |
|
47 |
installing/ubuntu |
|
48 |
installing/redhat |
|
49 |
||
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
50 |
Contributing
|
51 |
------------
|
|
|
2197.2.2
by Andrew Hutchings
Add basic contributing section to docs |
52 |
.. toctree:: |
53 |
:maxdepth: 2
|
|
54 |
||
55 |
contributing/introduction |
|
56 |
contributing/code |
|
57 |
contributing/documentation |
|
58 |
||
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
59 |
SQL Language
|
60 |
------------
|
|
|
1838.2.1
by Brian Aker
More docs. |
61 |
.. toctree:: |
62 |
:maxdepth: 2
|
|
63 |
||
|
1878.5.4
by Brian Aker
Update documentation. |
64 |
queries |
|
1994.4.52
by Marisa Plumb
modifying folder structure |
65 |
functions/overview |
|
1994.4.39
by Marisa Plumb
new material to address https://bugs.launchpad.net/drizzle/+bug/684803, new functions |
66 |
data_types |
|
1838.2.1
by Brian Aker
More docs. |
67 |
ddl |
68 |
dml |
|
|
1878.5.6
by Brian Aker
A couple of fixes to documentation. |
69 |
columntypes |
70 |
variables |
|
|
1933.1.9
by Brian Aker
Additional documentation and testing. |
71 |
locks |
72 |
barriers |
|
|
1878.5.6
by Brian Aker
A couple of fixes to documentation. |
73 |
dynamic |
74 |
getting_information |
|
75 |
transactional |
|
|
1994.4.23
by Marisa Plumb
new data types content |
76 |
administrative |
|
1994.4.62
by Marisa Plumb
string and resources |
77 |
resources/index |
|
1994.4.23
by Marisa Plumb
new data types content |
78 |
|
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
79 |
Replication
|
80 |
-----------
|
|
|
1878.5.7
by Brian Aker
Additional documenation. |
81 |
.. toctree:: |
82 |
:maxdepth: 2
|
|
83 |
||
|
2270.1.1
by Brian Aker
Update docs. |
84 |
replication |
|
1878.5.7
by Brian Aker
Additional documenation. |
85 |
|
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
86 |
Configuration
|
87 |
-------------
|
|
|
1794.2.3
by Monty Taylor
Added stubs for option docs. |
88 |
.. toctree:: |
89 |
:maxdepth: 2
|
|
90 |
||
91 |
configuration |
|
|
1794.2.5
by Monty Taylor
Added support to pandora for finding and including per-plugin documentation. |
92 |
options |
93 |
||
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
94 |
Administration
|
95 |
--------------
|
|
|
2270.1.1
by Brian Aker
Update docs. |
96 |
.. toctree:: |
97 |
:maxdepth: 2
|
|
98 |
||
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
99 |
administration/index |
|
2270.1.1
by Brian Aker
Update docs. |
100 |
|
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
101 |
Plugins
|
102 |
-------
|
|
|
1994.4.23
by Marisa Plumb
new data types content |
103 |
.. toctree:: |
104 |
:maxdepth: 2
|
|
105 |
||
|
1994.4.35
by Marisa Plumb
restoring list.rst to as ref in toc |
106 |
plugins/list |
|
1994.4.25
by Marisa Plumb
moved protocol doc to main 'docs' folder |
107 |
|
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
108 |
Clients
|
109 |
-------
|
|
|
1794.2.9
by Monty Taylor
Made some TOC structure changes. Added stubs for a couple of command line |
110 |
.. toctree:: |
111 |
:maxdepth: 2
|
|
112 |
||
113 |
clients/drizzle.rst |
|
114 |
clients/drizzledump.rst |
|
|
2099.2.1
by Andrew Hutchings
Add errors page to drizzle client docs |
115 |
clients/errors.rst |
|
1794.2.9
by Monty Taylor
Made some TOC structure changes. Added stubs for a couple of command line |
116 |
|
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
117 |
libdrizzle
|
118 |
----------
|
|
|
1836.3.1
by Monty Taylor
Removed libdrizzle doxygen. Put in function stubs in sphinx. Someone can |
119 |
.. toctree:: |
120 |
:maxdepth: 2
|
|
121 |
||
122 |
libdrizzle/api.rst |
|
123 |
libdrizzle/developer.rst |
|
|
2270.1.1
by Brian Aker
Update docs. |
124 |
protocol |
|
1836.3.1
by Monty Taylor
Removed libdrizzle doxygen. Put in function stubs in sphinx. Someone can |
125 |
|
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
126 |
Testing
|
127 |
-------
|
|
|
1892.4.1
by patrick crews
Added Sphinx docs for test-run.pl |
128 |
.. toctree:: |
129 |
:maxdepth: 2
|
|
130 |
||
131 |
testing/test-run.rst |
|
|
2128.1.1
by patrick crews
Added initial docs for dbqp.py |
132 |
testing/dbqp.rst |
|
2198.5.2
by patrick crews
Added docs for randgen |
133 |
testing/randgen.rst |
|
2324.2.3
by patrick crews
Initial voodoo worked to give us a crashme mode. Need docs still |
134 |
testing/sql-bench.rst |
|
2317.1.2
by patrick crews
Updated docs for sysbench |
135 |
testing/sysbench.rst |
|
2274.1.5
by patrick crews
Added initial docs for cnf file tricks - using pre-populated datadir for starters |
136 |
testing/writing_tests.rst |
|
1892.4.1
by patrick crews
Added Sphinx docs for test-run.pl |
137 |
|
|
1731.5.1
by Monty Taylor
Added sphinx infrastructure |
138 |
Indices and tables
|
139 |
==================
|
|
140 |
||
141 |
* :ref:`genindex` |
|
142 |
* :ref:`search` |
|
143 |