2425.2.2
by Daniel Nichter
A lot of doc changes: rewrite and expand Configuration and Administration, re-order top-level sections, enhance Contributing, add Release Notes, add Help and Support, fix title casing, label all plugins, other misc. enhancements. |
1 |
.. _auth_all@: |
2 |
||
3 |
||
1731.5.1
by Monty Taylor
Added sphinx infrastructure |
4 |
.. Drizzle documentation master file, created by
|
5 |
sphinx-quickstart on Fri Aug 27 08:33:41 2010.
|
|
6 |
You can adapt this file completely to your liking, but it should at least
|
|
7 |
contain the root `toctree` directive.
|
|
8 |
||
9 |
Welcome to Drizzle's documentation!
|
|
10 |
===================================
|
|
11 |
||
1994.4.44
by Marisa Plumb
adding logo w/license file |
12 |
.. image:: logo.png |
13 |
||
2222.2.1
by Mark Atwood
documentation work |
14 |
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 |
15 |
|
2222.2.1
by Mark Atwood
documentation work |
16 |
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 |
17 |
|
18 |
Charter |
|
19 |
* A database optimized for Cloud infrastructure and Web applications |
|
2222.2.1
by Mark Atwood
documentation work |
20 |
* Design for massive concurrency on modern multi-CPU architectures
|
21 |
* 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 |
22 |
* Open source, open community, open design
|
23 |
||
24 |
Scope |
|
25 |
* Re-designed modular architecture providing plugins with defined APIs |
|
26 |
* Simple design for ease of use and administration
|
|
27 |
* Reliable, ACID transactional
|
|
1794.2.3
by Monty Taylor
Added stubs for option docs. |
28 |
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
29 |
Introduction
|
30 |
------------
|
|
1838.2.1
by Brian Aker
More docs. |
31 |
.. toctree:: |
32 |
:maxdepth: 2
|
|
1994.4.1
by Marisa Plumb
doc modifications |
33 |
|
1838.2.1
by Brian Aker
More docs. |
34 |
preface |
1994.4.44
by Marisa Plumb
adding logo w/license file |
35 |
license |
1838.2.1
by Brian Aker
More docs. |
36 |
what_is_drizzle |
37 |
brief_history_of_drizzle |
|
38 |
how_to_report_a_bug |
|
2425.2.2
by Daniel Nichter
A lot of doc changes: rewrite and expand Configuration and Administration, re-order top-level sections, enhance Contributing, add Release Notes, add Help and Support, fix title casing, label all plugins, other misc. enhancements. |
39 |
help |
1994.4.104
by Marisa Plumb
new doc with note about versioning |
40 |
versioning |
1900.2.18
by Stewart Smith
add section on notable differences from MySQL |
41 |
mysql_differences |
1838.2.1
by Brian Aker
More docs. |
42 |
|
2425.2.2
by Daniel Nichter
A lot of doc changes: rewrite and expand Configuration and Administration, re-order top-level sections, enhance Contributing, add Release Notes, add Help and Support, fix title casing, label all plugins, other misc. enhancements. |
43 |
Contributing
|
44 |
------------
|
|
45 |
.. toctree:: |
|
46 |
:maxdepth: 2
|
|
47 |
||
48 |
contributing/getting_started |
|
49 |
contributing/code |
|
50 |
contributing/documentation |
|
51 |
contributing/more_ways |
|
52 |
||
53 |
Installing
|
|
54 |
----------
|
|
2099.2.2
by Andrew Hutchings
Add compiling and installing section with basic content |
55 |
.. toctree:: |
56 |
:maxdepth: 2
|
|
57 |
||
58 |
installing/requirements |
|
59 |
installing/ubuntu |
|
60 |
installing/redhat |
|
2425.2.2
by Daniel Nichter
A lot of doc changes: rewrite and expand Configuration and Administration, re-order top-level sections, enhance Contributing, add Release Notes, add Help and Support, fix title casing, label all plugins, other misc. enhancements. |
61 |
installing/from_source |
62 |
||
63 |
Configuration
|
|
64 |
-------------
|
|
65 |
.. toctree:: |
|
66 |
:maxdepth: 2
|
|
67 |
||
68 |
configuration/index |
|
69 |
configuration/drizzled |
|
70 |
||
71 |
Administration
|
|
72 |
--------------
|
|
73 |
.. toctree:: |
|
74 |
:maxdepth: 2
|
|
2425.2.3
by Daniel Nichter
Add Administration Getting Started and Logging. Capitalize SQL clause keywords. |
75 |
|
76 |
administration/getting_started |
|
2425.2.2
by Daniel Nichter
A lot of doc changes: rewrite and expand Configuration and Administration, re-order top-level sections, enhance Contributing, add Release Notes, add Help and Support, fix title casing, label all plugins, other misc. enhancements. |
77 |
administration/drizzled |
78 |
administration/authentication |
|
79 |
administration/authorization |
|
2425.2.3
by Daniel Nichter
Add Administration Getting Started and Logging. Capitalize SQL clause keywords. |
80 |
administration/logging |
2425.2.2
by Daniel Nichter
A lot of doc changes: rewrite and expand Configuration and Administration, re-order top-level sections, enhance Contributing, add Release Notes, add Help and Support, fix title casing, label all plugins, other misc. enhancements. |
81 |
administration/plugins |
82 |
administration/storage_engines |
|
83 |
||
84 |
Replication
|
|
85 |
-----------
|
|
86 |
.. toctree:: |
|
87 |
:maxdepth: 2
|
|
88 |
||
89 |
replication/drizzle |
|
2197.2.2
by Andrew Hutchings
Add basic contributing section to docs |
90 |
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
91 |
SQL Language
|
92 |
------------
|
|
1838.2.1
by Brian Aker
More docs. |
93 |
.. toctree:: |
94 |
:maxdepth: 2
|
|
95 |
||
1878.5.4
by Brian Aker
Update documentation. |
96 |
queries |
1994.4.52
by Marisa Plumb
modifying folder structure |
97 |
functions/overview |
1994.4.39
by Marisa Plumb
new material to address https://bugs.launchpad.net/drizzle/+bug/684803, new functions |
98 |
data_types |
1838.2.1
by Brian Aker
More docs. |
99 |
ddl |
100 |
dml |
|
1878.5.6
by Brian Aker
A couple of fixes to documentation. |
101 |
columntypes |
102 |
variables |
|
1933.1.9
by Brian Aker
Additional documentation and testing. |
103 |
locks |
104 |
barriers |
|
1878.5.6
by Brian Aker
A couple of fixes to documentation. |
105 |
dynamic |
106 |
getting_information |
|
107 |
transactional |
|
1994.4.23
by Marisa Plumb
new data types content |
108 |
administrative |
1994.4.62
by Marisa Plumb
string and resources |
109 |
resources/index |
1994.4.23
by Marisa Plumb
new data types content |
110 |
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
111 |
Clients
|
112 |
-------
|
|
1794.2.9
by Monty Taylor
Made some TOC structure changes. Added stubs for a couple of command line |
113 |
.. toctree:: |
114 |
:maxdepth: 2
|
|
115 |
||
116 |
clients/drizzle.rst |
|
117 |
clients/drizzledump.rst |
|
2425.2.2
by Daniel Nichter
A lot of doc changes: rewrite and expand Configuration and Administration, re-order top-level sections, enhance Contributing, add Release Notes, add Help and Support, fix title casing, label all plugins, other misc. enhancements. |
118 |
|
119 |
Plugins
|
|
120 |
-------
|
|
121 |
.. toctree:: |
|
122 |
:maxdepth: 2
|
|
123 |
||
124 |
plugins/list |
|
125 |
||
126 |
Release Notes
|
|
127 |
-------------
|
|
128 |
||
129 |
.. toctree:: |
|
130 |
:maxdepth: 2
|
|
131 |
||
132 |
release_notes/drizzle-7.0 |
|
1794.2.9
by Monty Taylor
Made some TOC structure changes. Added stubs for a couple of command line |
133 |
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
134 |
libdrizzle
|
135 |
----------
|
|
1836.3.1
by Monty Taylor
Removed libdrizzle doxygen. Put in function stubs in sphinx. Someone can |
136 |
.. toctree:: |
137 |
:maxdepth: 2
|
|
138 |
||
139 |
libdrizzle/api.rst |
|
140 |
libdrizzle/developer.rst |
|
2270.1.1
by Brian Aker
Update docs. |
141 |
protocol |
1836.3.1
by Monty Taylor
Removed libdrizzle doxygen. Put in function stubs in sphinx. Someone can |
142 |
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
143 |
Testing
|
144 |
-------
|
|
1892.4.1
by patrick crews
Added Sphinx docs for test-run.pl |
145 |
.. toctree:: |
146 |
:maxdepth: 2
|
|
147 |
||
148 |
testing/test-run.rst |
|
2128.1.1
by patrick crews
Added initial docs for dbqp.py |
149 |
testing/dbqp.rst |
2198.5.2
by patrick crews
Added docs for randgen |
150 |
testing/randgen.rst |
2324.2.3
by patrick crews
Initial voodoo worked to give us a crashme mode. Need docs still |
151 |
testing/sql-bench.rst |
2317.1.2
by patrick crews
Updated docs for sysbench |
152 |
testing/sysbench.rst |
2274.1.5
by patrick crews
Added initial docs for cnf file tricks - using pre-populated datadir for starters |
153 |
testing/writing_tests.rst |
1892.4.1
by patrick crews
Added Sphinx docs for test-run.pl |
154 |
|
1731.5.1
by Monty Taylor
Added sphinx infrastructure |
155 |
Indices and tables
|
156 |
==================
|
|
157 |
||
158 |
* :ref:`genindex` |
|
159 |
* :ref:`search` |
|
160 |