Development:XMLDB Documentation: Difference between revisions
From MoodleDocs
No edit summary |
|||
| (25 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
__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. | 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 === | === Introduction === | ||
* [[Development: | * [[Development:XMLDB introduction|Introduction]]: Where the general idea of the XMLDB whole thing is explained. | ||
* [[Development:XMLDB roadmap|Roadmap]]: An overall view of the process of implementing the XMLDB subsystem, with details for each point of the process. | * [[Development:XMLDB roadmap|Roadmap]]: An overall view of the process of implementing the XMLDB subsystem, with details for each point of the process. | ||
* [[Development:XMLDB problems|Problems]]: A comprensive list of issues that need to be determined/solved prior to incorporate them to the [[XMLDB Roadmap|roadmap]]. | |||
=== Installation === | === Installation === | ||
| Line 16: | Line 19: | ||
=== Developing === | === Developing === | ||
* [[Development:DDL functions|DDL functions]]: One list of the new XMLDB Data Definition functions and their usage. | * [[Development:DDL functions|DDL functions]]: One list of the new XMLDB Data Definition functions and their usage. | ||
* [[Development:DML functions|DML functions]]: One list of the available Data Manipulation functions and their usage. | * [[Development:DML functions|DML functions]]: One list of the available Data Manipulation functions and their usage. | ||
* [[Development:Coding|Coding guidelines]]: The main coding guidelines and, more exactly, the [[Development:Coding#Database structures|database structures section]] that you must follow carefully in order to produce good code. | * [[Development:XMLDB defining an XML structure|XMLDB Usage]]: Explanation about the XML schema basis, the [[Development:XMLDB defining an XML structure#The XMLDB editor|XML editor]] embedded within Moodle, its [[Development:XMLDB defining an XML structure#Conventions|naming conventions]] and one simple but illustrative [[Development:XMLDB defining an XML structure#One example: the assignment module|example]]. | ||
* [[Development:Coding|Coding guidelines]]: The main coding guidelines and, more exactly, the [[Development:Coding#Database structures|database structures section]] that you must follow carefully in order to produce good cross-db code. | |||
* [[Development:Database Schema|Database schema]]: Moodle database diagrams in [http://fabforce.net/dbdesigner4/ DBDesigner4] format. | |||
=== Bugs and new features === | === Bugs and new features === | ||
* XMLDB | * [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] | ||
* XMLDB | * [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] | ||
* Developers forum | * [http://moodle.org/mod/forum/view.php?id=55 Developers forum]: For general development discussions. | ||
* Databases forum | * [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.2/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 === | |||
* [[Development:XMLDB column types|DB column types]] - Some links about column types inside every RDBMS and their characteristics | |||
* [[Development:XMLDB key and index naming|DB key and index naming]] - Some info about automatic naming of keys/indexes and other objects. | |||
* [[Development:XMLDB reserved words|DB reserved words]] - A collection of reserver words inside each RDBMS | |||
[[Category:XMLDB]] | [[Category:XMLDB]] | ||
[[Category:Installation]] | [[Category:Installation]] | ||
Latest revision as of 05:36, 20 August 2008
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 XMLDB category and to the general Developer and Installation categories plus some interesting external links.
Introduction
- Introduction: Where the general idea of the XMLDB whole thing is explained.
- Roadmap: An overall view of the process of implementing the XMLDB subsystem, with details for each point of the process.
- Problems: A comprensive list of issues that need to be determined/solved prior to incorporate them to the 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 LAMP platform working in your server.
Developing
- DDL functions: One list of the new XMLDB Data Definition functions and their usage.
- DML functions: One list of the available Data Manipulation functions and their usage.
- XMLDB Usage: Explanation about the XML schema basis, the XML editor embedded within Moodle, its naming conventions and one simple but illustrative example.
- Coding guidelines: The main coding guidelines and, more exactly, the database structures section that you must follow carefully in order to produce good cross-db code.
- Database schema: Moodle database diagrams in DBDesigner4 format.
Bugs and new features
- XMLDB known bugs
- XMLDB pending improvements and features
- Developers forum: For general development discussions.
- 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:
See also
- DB column types - Some links about column types inside every RDBMS and their characteristics
- DB key and index naming - Some info about automatic naming of keys/indexes and other objects.
- DB reserved words - A collection of reserver words inside each RDBMS
