XMLDB Documentation

2009-07-07T12:24:50Z

Grimble: /* Database engine documentation */ Changed link to current PG docs

__NOTOC__

XMLDB is Moodle's database abstraction layer. That is, the library of code that lets moodle interact with and access the database.

In this page you will find links to all the XMLDB related documentation. Currently you will find documents both belonging to the [[:Category:XMLDB|XMLDB]] category and to the general [[:Category:Developer|Developer]] and [[:Category:Installation|Installation]] categories plus some interesting external links.

=== Introduction ===

* [[XMLDB introduction|Introduction]]: Where the general idea of the XMLDB whole thing is explained.
* [[XMLDB roadmap|Roadmap]]: An overall view of the process of implementing the XMLDB subsystem, with details for each point of the process.
* [[XMLDB problems|Problems]]: A comprensive list of issues that need to be determined/solved prior to incorporate them to the [[XMLDB Roadmap|roadmap]].

=== Installation ===

* [[Installing MSSQL for PHP]]: One short manual about the steps needed to successfully add MSSQL support to PHP.
* [[Installing Oracle for PHP]]: One short manual about the steps needed to successfully add Oracle support to PHP.
* [[Installing Moodle]]: The guide to install Moodle (once you have the [[Installing AMP|LAMP platform]] working in your server.

=== Developing ===

* [[DDL functions|DDL functions]]: One list of the new XMLDB Data Definition functions and their usage.
* [[DML functions|DML functions]]: One list of the available Data Manipulation functions and their usage.
* [[XMLDB defining an XML structure|XMLDB Usage]]: Explanation about the XML schema basis, the [[XMLDB defining an XML structure#The XMLDB editor|XML editor]] embedded within Moodle, its [[XMLDB defining an XML structure#Conventions|naming conventions]] and one simple but illustrative [[XMLDB defining an XML structure#One example: the assignment module|example]].
* [[Installing and upgrading plugin database tables]]
* [[Coding|Coding guidelines]]: The main coding guidelines and, more exactly, the [[Database|database structures section]] that you must follow carefully in order to produce good cross-db code.
* [[Database Schema|Database schema]]: Moodle database diagrams in [http://fabforce.net/dbdesigner4/ DBDesigner4] format.

=== Bugs and new features ===

* [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&&type=1&pid=10011&resolution=-1&component=10131&sorter/field=issuekey&sorter/order=DESC XMLDB known bugs]
* [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&&type=4&type=2&type=3&type=5&pid=10011&resolution=-1&component=10131&sorter/field=issuekey&sorter/order=DESC XMLDB pending improvements and features]
* [http://moodle.org/mod/forum/view.php?id=55 Developers forum]: For general development discussions.
* [http://moodle.org/mod/forum/view.php?id=45 Databases forum]: For DBs related development discussions.

=== Database engine documentation ===

Here are convenient links to the reference documentation of the various database engines we support, should you need to check that something is supported by all of them:

* [http://www.postgresql.org/docs/8.4/interactive/index.html Postgres]
* [http://dev.mysql.com/doc/refman/5.0/en/index.html MySQL]
* [http://msdn.microsoft.com/en-us/library/ms189826.aspx MS SQL]
* [http://download.oracle.com/docs/cd/B14117_01/server.101/b10759/toc.htm Oracle]

=== See also ===
* [[XMLDB column types|DB column types]] - Some links about column types inside every RDBMS and their characteristics
* [[XMLDB key and index naming|DB key and index naming]] - Some info about automatic naming of keys/indexes and other objects.
* [[XMLDB reserved words|DB reserved words]] - A collection of reserver words inside each RDBMS

[[Category:XMLDB]]
[[Category:DB]]
[[Category:Installation]]

MoodleDocs - User contributions [en]

XMLDB Documentation