MoodleDocs - User contributions [en]

Using XMLDB

2008-01-12T15:51:44Z

Okiknow: /* Getting Started */

(This page is in progress of writing and editing, intended for third-party module developers to help them switch to XMLDB.)
{{Moodle 1.7}}
==What is XMLDB and how can it help you==
XMLDB is a database format created to help developer from creating custom database schemas for different database system. It's like a database in XML format. Everywhere in Moodle now use XMLDB.

In every module folder, there is db/ folder where database structure stored. The folder usually contains mysql.php, mysql.sql, etc. for different database.

It's mean that you have to create different files for each database systems. If there are more database you want your module to be compatible with, you have to create more files. XMLDB is intended to solve this problem. Switching to XMLDB is very easy, save your time and effort by creating just 1 file.

==Getting Started==
XMLDB file in module is stored in db/ folder, named install.xml. You can use a built-in XMLDB editor to create or edit any install.xml files. If you're using MySQL as your default database schemes. XMLDB editor's powerful tools allowing retrofit MySQL table to XMLDB format.

XMLDB editor is located in administration block, go to ''Miscellaneous > XMLDB editor''. Find your module name. You won't be able to click on ''Create'' link and also can't edit your module (If ''Create'' link is clickable you can skip this step). Since you must make your module folder has write permission first (And if you haven't created db/ folder in your module folder yet, create it now). In Linux operating system, ''chmod'' your /db folder to 777 solves this. Now you're ready to create your module's XMLDB files.

Note that XMLDB editor is not a tool for creating your module (It can help you about database). It is a tool to manage XMLDB database file (think about phpmyadmin manages SQL database). You can create tables/fields/keys/indexes or export your exist MySQL tables to XMLDB.

Another XMLDB's advantage is you can create table's comment as you want. To describe it to other developer.

XMLDB editor is really easy to work with. We strongly recommend you to play with it for a while.

More information about XMLDB editor : [https://docs.moodle.org/en/XMLDB_editor], XMLDB Structure : [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure].

===Create install.xml===

If you never create install.xml before (your db/ doesn't have install.xml), click ''Create'' first. install.xml will store your database info for this module.

===Start editing===
To start edit install.xml, click ''Load'' and then ''Edit''. You need to do this every time before editing any XMLDB file. If this is your first time, there is a default table named like your module stored.

===Create new table===

# Go to ''New Table''.
# Enter table name and comment, click ''change''.

===Add field in table===

# Click ''Edit'' on your desired table.
# Click ''New Field'', You can now edit field information like name, comment, type, length, etc. See [https://docs.moodle.org/en/Development:XMLDB_column_types] for XMLDB column type comparing with other database system.
# When you're done, click ''Change''.

===Retrofit MySQL table to XMLDB===

XMLDB editor can retrofit MySQL table to XMLDB. In other word, it can create XMLDB table from existing SQL. This is useful if your module database already using MySQL.
First, your module has to be installed. Then follow these steps:

# Click ''New Table from MySQL''
# In ''Create Table'' box, choose your table from MySQL database. In ''After Table'' choose where would you like to add this table to (It doesn't matter, just for arrangement). Click ''Create''.
# Do it again untill every table added, you are done !

Note : Table name must contains only lowercase character, number, underscore and length must not exceed 28 characters. More info [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure#Conventions]

===Other operation===
It's intuitive once you use it. There are visible link for editing, moving up or down and deleting.

==See Also==
[[XMLDB_introduction]]

[[XMLDB defining an XML structure]]

[[XMLDB_column_types]]

[[XMLDB editor]]

[[Category:Using XMLDB]]
[[Category:XMLDB]]

Using XMLDB

2008-01-12T15:41:13Z

Okiknow:

(This page is in progress of writing and editing, intended for third-party module developers to help them switch to XMLDB.)
{{Moodle 1.7}}
==What is XMLDB and how can it help you==
XMLDB is a database format created to help developer from creating custom database schemas for different database system. It's like a database in XML format. Everywhere in Moodle now use XMLDB.

In every module folder, there is db/ folder where database structure stored. The folder usually contains mysql.php, mysql.sql, etc. for different database.

It's mean that you have to create different files for each database systems. If there are more database you want your module to be compatible with, you have to create more files. XMLDB is intended to solve this problem. Switching to XMLDB is very easy, save your time and effort by creating just 1 file.

==Getting Started==
XMLDB file in module is stored in db/ folder, named install.xml. You can use a built-in XMLDB editor to create or edit any install.xml files. If you're using MySQL as your default database schemes. XMLDB editor's powerful tools allowing retrofit MySQL table to XMLDB format.

XMLDB editor is located in administration block, go to ''Miscellaneous > XMLDB editor''. Find your module name. You won't be able to click on ''Create'' link and also can't edit your module (If ''Create'' link is clickable you can skip this step). Since you must make your module folder has write permission first (And if you haven't created db/ folder in your module folder yet, create it now). In Linux operating system, ''chmod'' your /db folder to 777 solves this. Now you're ready to create your module's XMLDB files.

Note that XMLDB editor is not a tool for creating your module (It can help you about database). It is a tool to manage XMLDB database file (think about phpmyadmin manages SQL database). You can create tables/fields/keys/indexes or export your exist MySQL tables to XMLDB.

Another XMLDB's advantage is you can create table's comment as you want. To describe it to other developer.

XMLDB editor is really easy to work with. We strongly recommend you to play with it for a while.

More information about XMLDB editor : [https://docs.moodle.org/en/XMLDB_editor], XMLDB Structure : [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure].

===Create install.xml===

If you never create install.xml before (your db/ doesn't have install.xml), click ''Create'' first. install.xml will store your database info for this module.

===Start editing===
To start edit install.xml, click ''Load'' and then ''Edit''. You need to do this every time before editing any XMLDB file. If this is your first time, there is a default table named like your module stored.

===Create new table===

# Go to ''New Table''.
# Enter table name and comment, click ''change''.

===Add field in table===

# Click ''Edit'' on your desired table.
# Click ''New Field'', You can now edit field information like name, comment, type, length, etc. See [https://docs.moodle.org/en/Development:XMLDB_column_types] for XMLDB column type comparing with other database system.
# When you're done, click ''Change''.

===Retrofit MySQL table to XMLDB===

XMLDB editor can retrofit MySQL table to XMLDB. In other word, it can create XMLDB table from existing SQL. This is useful if your module database already using MySQL.
First, your module has to be installed. Then follow these steps:

# Click ''New Table from MySQL''
# In ''Create Table'' box, choose your table from MySQL database. In ''After Table'' choose where would you like to add this table to (It doesn't matter, just for arrangement). Click ''Create''.
# Do it again untill every table added, you are done !

Note : Table name must contains only lowercase character, number, underscore and length must not exceed 28 characters. More info [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure#Conventions]

==See Also==
[[XMLDB_introduction]]

[[XMLDB defining an XML structure]]

[[XMLDB_column_types]]

[[XMLDB editor]]

[[Category:Using XMLDB]]
[[Category:XMLDB]]

Using XMLDB

2008-01-12T15:38:00Z

Okiknow:

(This page is in progress of writing and editing, intended for third-party module developers to help them switch to XMLDB.)
{{Moodle 1.7}}
==What is XMLDB and how can it help you==
XMLDB is a database format created to help developer from creating custom database schemas for different database system. It's like a database in XML format. Everywhere in Moodle now use XMLDB.

In every module folder, there is db/ folder where database structure stored. The folder usually contains mysql.php, mysql.sql, etc. for different database.

It's mean that you have to create different files for each database systems. If there are more database you want your module to be compatible with, you have to create more files. XMLDB is intended to solve this problem. Switching to XMLDB is very easy, save your time and effort by creating just 1 file.

==Getting Started==
XMLDB file in module is stored in db/ folder, named install.xml. You can use a built-in XMLDB editor to create or edit any install.xml files. If you're using MySQL as your default database schemes. XMLDB editor's powerful tools allowing retrofit MySQL table to XMLDB format.

XMLDB editor is located in administration block, go to ''Miscellaneous > XMLDB editor''. Find your module name. You won't be able to click on ''Create'' link and also can't edit your module (If ''Create'' link is clickable you can skip this step). Since you must make your module folder has write permission first (And if you haven't created db/ folder in your module folder yet, create it now). In Linux operating system, ''chmod'' your /db folder to 777 solves this. Now you're ready to create your module's XMLDB files.

Note that XMLDB editor is not a tool for creating your module (It can help you about database). It is a tool to manage XMLDB database file (think about phpmyadmin manages SQL database). You can create tables/fields/keys/indexes or export your exist MySQL tables to XMLDB.

Another XMLDB's advantage is you can create table's comment as you want. To describe it to other developer.

XMLDB editor is really easy to work with. We strongly recommend you to play with it for a while.

More information about XMLDB editor : [https://docs.moodle.org/en/XMLDB_editor], XMLDB Structure : [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure].

===Create install.xml===

If you never create install.xml before (your db/ doesn't have install.xml), click ''Create'' first. install.xml will store your database info for this module.

===Start editing===
To start edit install.xml, click ''Load'' and then ''Edit''. You need to do this every time before editing any XMLDB file. If this is your first time, there is a default table named like your module stored.

===Create new table===

# Go to ''New Table''.
# Enter table name and comment, click ''change''.

===Add field in table===

# Click ''Edit'' on your desired table.
# Click ''New Field'', You can now edit field information like name, comment, type, length, etc.
# When you're done, click ''Change''.

===Retrofit MySQL table to XMLDB===

XMLDB editor can retrofit MySQL table to XMLDB. In other word, it can create XMLDB table from existing SQL. This is useful if your module database already using MySQL.
First, your module has to be installed. Then follow these steps:

# Click ''New Table from MySQL''
# In ''Create Table'' box, choose your table from MySQL database. In ''After Table'' choose where would you like to add this table to (It doesn't matter, just for arrangement). Click ''Create''.
# Do it again untill every table added, you are done !

Note : Table name must contains only lowercase character, number, underscore and length must not exceed 28 characters. More info [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure#Conventions]

==See Also==
[[XMLDB_introduction]]

[[XMLDB defining an XML structure]]

[[XMLDB editor]]

[[Category:Using XMLDB]]
[[Category:XMLDB]]

Using XMLDB

2008-01-10T13:39:28Z

Okiknow: /* Create new table */

(This page is in progress of writing and editing, intended for third-party module developers to help them switch to XMLDB.)
{{Moodle 1.7}}
==What is XMLDB and how can it help you==
XMLDB is a database format created to help developer from creating custom database schemas for different database system. It's like a database in XML format. Everywhere in Moodle now use XMLDB.

In every module folder, there is db/ folder where database structure stored. The folder usually contains mysql.php, mysql.sql, etc. for different database.

It's mean that you have to create different files for each database systems. If there are more database you want your module to be compatible with, you have to create more files. XMLDB is intended to solve this problem. Switching to XMLDB is very easy, save your time and effort by creating just 1 file.

==Getting Started==
XMLDB file in module is stored in db/ folder, named install.xml. You can use a built-in XMLDB editor to create or edit any install.xml files. If you're using MySQL as your default database schemes. XMLDB editor's powerful tools allowing retrofit MySQL table to XMLDB format.

XMLDB editor is located in administration block, go to ''Miscellaneous > XMLDB editor''. Find your module name. You won't be able to click on ''Create'' link and also can't edit your module (If ''Create'' link is clickable you can skip this step). Since you must make your module folder has write permission first (And if you haven't created db/ folder in your module folder yet, create it now). In Linux operating system, ''chmod'' your /db folder to 777 solves this. Now you're ready to create your module's XMLDB files.

Note that XMLDB editor is not a tool for creating your module. It is a tool to manage XMLDB database file (think about phpmyadmin manages SQL database). You can create tables/fields/keys/indexes or export your exist MySQL tables to XMLDB.

Another XMLDB's advantage is you can create table's comment as you want. To describe it to other developer.

XMLDB editor is really easy to work with. We strongly recommend you to play with it for a while.

More information about XMLDB editor : [https://docs.moodle.org/en/XMLDB_editor], XMLDB Structure : [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure].

===Create install.xml===

If you never create install.xml before (your db/ doesn't have install.xml), click ''Create'' first. install.xml will store your database info for this module.

===Start editing===
To start edit install.xml, click ''Load'' and then ''Edit''. You need to do this every time before editing any XMLDB file. If this is your first time, there is a default table named like your module stored.

===Create new table===

# Go to ''New Table''.
# Enter table name and comment, click ''change''.

===Add field in table===

# Click ''Edit'' on your desired table.
# Click ''New Field'', You can now edit field information like name, comment, type, length, etc.
# When you're done, click ''Change''.

===Retrofit MySQL table to XMLDB===

XMLDB editor can retrofit MySQL table to XMLDB. In other word, it can create XMLDB table from existing SQL. This is useful if your module database already using MySQL.
First, your module has to be installed. Then follow these steps:

# Click ''New Table from MySQL''
# In ''Create Table'' box, choose your table from MySQL database. In ''After Table'' choose where would you like to add this table to (It doesn't matter, just for arrangement). Click ''Create''.
# Do it again untill every table added, you are done !

Note : Table name must contains only lowercase character, number, underscore and length must not exceed 28 characters. More info [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure#Conventions]

==See Also==
[[XMLDB_introduction]]

[[XMLDB defining an XML structure]]

[[XMLDB editor]]

[[Category:Using XMLDB]]
[[Category:XMLDB]]

Using XMLDB

2008-01-10T13:38:18Z

Okiknow: /* Start editing */

(This page is in progress of writing and editing, intended for third-party module developers to help them switch to XMLDB.)
{{Moodle 1.7}}
==What is XMLDB and how can it help you==
XMLDB is a database format created to help developer from creating custom database schemas for different database system. It's like a database in XML format. Everywhere in Moodle now use XMLDB.

In every module folder, there is db/ folder where database structure stored. The folder usually contains mysql.php, mysql.sql, etc. for different database.

It's mean that you have to create different files for each database systems. If there are more database you want your module to be compatible with, you have to create more files. XMLDB is intended to solve this problem. Switching to XMLDB is very easy, save your time and effort by creating just 1 file.

==Getting Started==
XMLDB file in module is stored in db/ folder, named install.xml. You can use a built-in XMLDB editor to create or edit any install.xml files. If you're using MySQL as your default database schemes. XMLDB editor's powerful tools allowing retrofit MySQL table to XMLDB format.

XMLDB editor is located in administration block, go to ''Miscellaneous > XMLDB editor''. Find your module name. You won't be able to click on ''Create'' link and also can't edit your module (If ''Create'' link is clickable you can skip this step). Since you must make your module folder has write permission first (And if you haven't created db/ folder in your module folder yet, create it now). In Linux operating system, ''chmod'' your /db folder to 777 solves this. Now you're ready to create your module's XMLDB files.

Note that XMLDB editor is not a tool for creating your module. It is a tool to manage XMLDB database file (think about phpmyadmin manages SQL database). You can create tables/fields/keys/indexes or export your exist MySQL tables to XMLDB.

Another XMLDB's advantage is you can create table's comment as you want. To describe it to other developer.

XMLDB editor is really easy to work with. We strongly recommend you to play with it for a while.

More information about XMLDB editor : [https://docs.moodle.org/en/XMLDB_editor], XMLDB Structure : [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure].

===Create install.xml===

If you never create install.xml before (your db/ doesn't have install.xml), click ''Create'' first. install.xml will store your database info for this module.

===Start editing===
To start edit install.xml, click ''Load'' and then ''Edit''. You need to do this every time before editing any XMLDB file. If this is your first time, there is a default table named like your module stored.

===Create new table===
Just like create table.

# Go to ''New Table''.
# Enter table name and comment, click ''change''.

===Add field in table===

# Click ''Edit'' on your desired table.
# Click ''New Field'', You can now edit field information like name, comment, type, length, etc.
# When you're done, click ''Change''.

===Retrofit MySQL table to XMLDB===

XMLDB editor can retrofit MySQL table to XMLDB. In other word, it can create XMLDB table from existing SQL. This is useful if your module database already using MySQL.
First, your module has to be installed. Then follow these steps:

# Click ''New Table from MySQL''
# In ''Create Table'' box, choose your table from MySQL database. In ''After Table'' choose where would you like to add this table to (It doesn't matter, just for arrangement). Click ''Create''.
# Do it again untill every table added, you are done !

Note : Table name must contains only lowercase character, number, underscore and length must not exceed 28 characters. More info [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure#Conventions]

==See Also==
[[XMLDB_introduction]]

[[XMLDB defining an XML structure]]

[[XMLDB editor]]

[[Category:Using XMLDB]]
[[Category:XMLDB]]

Using XMLDB

2008-01-10T13:37:30Z

Okiknow: /* What is XMLDB and how can it help you */

(This page is in progress of writing and editing, intended for third-party module developers to help them switch to XMLDB.)
{{Moodle 1.7}}
==What is XMLDB and how can it help you==
XMLDB is a database format created to help developer from creating custom database schemas for different database system. It's like a database in XML format. Everywhere in Moodle now use XMLDB.

In every module folder, there is db/ folder where database structure stored. The folder usually contains mysql.php, mysql.sql, etc. for different database.

It's mean that you have to create different files for each database systems. If there are more database you want your module to be compatible with, you have to create more files. XMLDB is intended to solve this problem. Switching to XMLDB is very easy, save your time and effort by creating just 1 file.

==Getting Started==
XMLDB file in module is stored in db/ folder, named install.xml. You can use a built-in XMLDB editor to create or edit any install.xml files. If you're using MySQL as your default database schemes. XMLDB editor's powerful tools allowing retrofit MySQL table to XMLDB format.

XMLDB editor is located in administration block, go to ''Miscellaneous > XMLDB editor''. Find your module name. You won't be able to click on ''Create'' link and also can't edit your module (If ''Create'' link is clickable you can skip this step). Since you must make your module folder has write permission first (And if you haven't created db/ folder in your module folder yet, create it now). In Linux operating system, ''chmod'' your /db folder to 777 solves this. Now you're ready to create your module's XMLDB files.

Note that XMLDB editor is not a tool for creating your module. It is a tool to manage XMLDB database file (think about phpmyadmin manages SQL database). You can create tables/fields/keys/indexes or export your exist MySQL tables to XMLDB.

Another XMLDB's advantage is you can create table's comment as you want. To describe it to other developer.

XMLDB editor is really easy to work with. We strongly recommend you to play with it for a while.

More information about XMLDB editor : [https://docs.moodle.org/en/XMLDB_editor], XMLDB Structure : [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure].

===Create install.xml===

If you never create install.xml before (your db/ doesn't have install.xml), click ''Create'' first. install.xml will store your database info for this module.

===Start editing===
To start edit install.xml, click ''Load'' and then ''Edit''. You need to do this every time before editing any XMLDB file. If this is your first time, there is default table named like your module stored.

===Create new table===
Just like create table.

# Go to ''New Table''.
# Enter table name and comment, click ''change''.

===Add field in table===

# Click ''Edit'' on your desired table.
# Click ''New Field'', You can now edit field information like name, comment, type, length, etc.
# When you're done, click ''Change''.

===Retrofit MySQL table to XMLDB===

XMLDB editor can retrofit MySQL table to XMLDB. In other word, it can create XMLDB table from existing SQL. This is useful if your module database already using MySQL.
First, your module has to be installed. Then follow these steps:

# Click ''New Table from MySQL''
# In ''Create Table'' box, choose your table from MySQL database. In ''After Table'' choose where would you like to add this table to (It doesn't matter, just for arrangement). Click ''Create''.
# Do it again untill every table added, you are done !

Note : Table name must contains only lowercase character, number, underscore and length must not exceed 28 characters. More info [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure#Conventions]

==See Also==
[[XMLDB_introduction]]

[[XMLDB defining an XML structure]]

[[XMLDB editor]]

[[Category:Using XMLDB]]
[[Category:XMLDB]]

Using XMLDB

2008-01-10T13:35:25Z

Okiknow:

(This page is in progress of writing and editing, intended for third-party module developers to help them switch to XMLDB.)
{{Moodle 1.7}}
==What is XMLDB and how can it help you==
XMLDB is database format created to prevent developer from creating custom database schemas for different database system. It's like a database in XML format. Everywhere in Moodle now use XMLDB.

In every module folder, there is db/ folder where database structure stored. The folder usually contains mysql.php, mysql.sql, etc. for different database.

It's mean that you have to create different files for each database systems. If there are more database you want your module to be compatible with, you have to create more files. XMLDB is intended to solve this problem. Switching to XMLDB is very easy, save your time and effort by creating just 1 file.

==Getting Started==
XMLDB file in module is stored in db/ folder, named install.xml. You can use a built-in XMLDB editor to create or edit any install.xml files. If you're using MySQL as your default database schemes. XMLDB editor's powerful tools allowing retrofit MySQL table to XMLDB format.

XMLDB editor is located in administration block, go to ''Miscellaneous > XMLDB editor''. Find your module name. You won't be able to click on ''Create'' link and also can't edit your module (If ''Create'' link is clickable you can skip this step). Since you must make your module folder has write permission first (And if you haven't created db/ folder in your module folder yet, create it now). In Linux operating system, ''chmod'' your /db folder to 777 solves this. Now you're ready to create your module's XMLDB files.

Note that XMLDB editor is not a tool for creating your module. It is a tool to manage XMLDB database file (think about phpmyadmin manages SQL database). You can create tables/fields/keys/indexes or export your exist MySQL tables to XMLDB.

Another XMLDB's advantage is you can create table's comment as you want. To describe it to other developer.

XMLDB editor is really easy to work with. We strongly recommend you to play with it for a while.

More information about XMLDB editor : [https://docs.moodle.org/en/XMLDB_editor], XMLDB Structure : [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure].

===Create install.xml===

If you never create install.xml before (your db/ doesn't have install.xml), click ''Create'' first. install.xml will store your database info for this module.

===Start editing===
To start edit install.xml, click ''Load'' and then ''Edit''. You need to do this every time before editing any XMLDB file. If this is your first time, there is default table named like your module stored.

===Create new table===
Just like create table.

# Go to ''New Table''.
# Enter table name and comment, click ''change''.

===Add field in table===

# Click ''Edit'' on your desired table.
# Click ''New Field'', You can now edit field information like name, comment, type, length, etc.
# When you're done, click ''Change''.

===Retrofit MySQL table to XMLDB===

XMLDB editor can retrofit MySQL table to XMLDB. In other word, it can create XMLDB table from existing SQL. This is useful if your module database already using MySQL.
First, your module has to be installed. Then follow these steps:

# Click ''New Table from MySQL''
# In ''Create Table'' box, choose your table from MySQL database. In ''After Table'' choose where would you like to add this table to (It doesn't matter, just for arrangement). Click ''Create''.
# Do it again untill every table added, you are done !

Note : Table name must contains only lowercase character, number, underscore and length must not exceed 28 characters. More info [https://docs.moodle.org/en/Development:XMLDB_defining_an_XML_structure#Conventions]

==See Also==
[[XMLDB_introduction]]

[[XMLDB defining an XML structure]]

[[XMLDB editor]]

[[Category:Using XMLDB]]
[[Category:XMLDB]]

Using XMLDB

2008-01-10T12:54:01Z

Okiknow:

(This page is in progress of writing and editing, intended for third-party module developers to help them switch to XMLDB.)

==How XMLDB can help you==
Everywhere in Moodle now use XMLDB. XMLDB is database format created to prevent developer from creating custom database schemas for different database system. If you don't know what XMLDB is, You can learn more about it here [[XMLDB_introduction]]

In every module folder, there is db/ folder where database structure stored. The folder usually contains mysql.php, mysql.sql, etc for different database.

It's mean that you have to create different files for each database systems. If there are 5 database, you have to create 10 files (2 each). XMLDB is intended to solve this. Switching to XMLDB is very easy, save your time and effort by creating just 1 file.

==Getting Started==
XMLDB file in module is stored in db/ folder, named install.xml. You can use a built-in XMLDB editor to create or edit any install.xml files. If you're using MySQL as your default database schemes. XMLDB editor's powerful tools allowing retrofit MySQL table to XMLDB format.

XMLDB editor is located in administration block, go to ''Miscellaneous > XMLDB editor''. You may unable to click on ''Create'' link and also can't edit your module. Since you must make your module folder has write permission first (And if you haven't craeted db/ folder in your module folder yet, create it now). In Linux operating system, ''chmod'' your /db folder to 777 solves this. Now you're ready to create your module's XMLDB files.

Note that XMLDB editor is not a tool for creating your module. It is a tool to manage XMLDB database file (think about phpmyadmin manages SQL database). You can create tables/fields/keys/indexes or export your exist MySQL tables to XMLDB.

XMLDB editor is really easy to work with. By playing with it, you will soon understand XMLDB structure and format.

More information about [[XMLDB editor]], XMLDB Structure : [[XMLDB defining an XML structure]].

===Create install.xml===

If you never create install.xml before (your db/ doesn't have install.xml), click ''Create'' first. install.xml will store your database info for this module.

===Start edit===
To start edit install.xml, click ''Load'' and then ''Edit''. You need to do this every time before editing any XMLDB file. If this is your first time, there is default table named like your module stored.

===Retrofit MySQL table to XMLDB===

XMLDB editor can retrofit MySQL table to XMLDB. This is useful if your module database already using MySQL.
First, your module has to be installed. Then follow these steps:

# Go to XMLDB editor, edit your module.
# Click ''New Table from MySQL''
# In ''Create Table'' box, choose your table from MySQL database. In ''After Table'' choose where would you like to add this table to (It doesn't matter but helpful to sort it). Click ''Create''.
# Do it again untill every table added, you are done !

Note : Table's name must contain only character, number, underscore and length must not exceed 28 characters.

[[Category:Using XMLDB]]
[[Category:XMLDB]]

Using XMLDB

2008-01-10T12:21:03Z

Okiknow: /* Creating XMLDB files */

Using XMLDB

2008-01-10T11:42:31Z

Okiknow: /* Creating XMLDB files */

Using XMLDB

2008-01-09T15:14:17Z

Okiknow:

Using XMLDB

2008-01-09T15:12:37Z

Okiknow: /* XMLDB in your module */

(This docs is in progress of writing and editing, aimed to help third-party module developer to switch to XMLDB)
==XMLDB in your module==
Everywhere in Moodle now use XMLDB. Created to prevent developer from creating custom database schemas for different database system. If you don't know what XMLDB is, You can learn more about it here [[XMLDB_introduction]]

In every module folder, there is db/ folder where database structure stored. The folder usually contains mysql.php, mysql.sql, etc for different database.

It's mean that you have to create different files for each database systems. If there are 5 database, you have to create 10 files (2 each). XMLDB is intended to solve this. Switching to XMLDB is very easy, save your time and effort by creating just 1 file.

==Creating XMLDB files==
XMLDB file in module is stored in db/ folder, named install.xml, You can use a built-in XMLDB editor to create or edit any install.xml files. If you're using MySQL as your default database schemes. XMLDB editor's powerful tools allowing retrofit MySQL table to XMLDB format.

'''Retrofitting MySQL table to XMLDB'''

First, your module has to be installed. Then follow these steps.

1. Go to Miscellaneous >> XMLDB editor
2. Find your module folder, be sure it is writable
3. Click Create, then click Load, you will get a page

[[Category:Using XMLDB]]
[[Category:XMLDB]]

Using XMLDB

2008-01-09T15:10:33Z

Okiknow: /* Convert MySQL syntax to XMLDB */

(This docs is in progress of writing and editing, aimed to help third-party module developer to switch to XMLDB)
==XMLDB in your module==
Everywhere in Moodle now use XMLDB. Created to prevent from creating custom database schemas for different database system. If you don't know what XMLDB is, You can learn more about it here [[XMLDB_introduction]]

In every module, there is "db/" directory where database structure stored. usually contains mysql.php, mysql.sql and so on for different database.

It's mean that you have to create different files for each database systems. If there are 5 database, you have to create 10 files (2 each). XMLDB solves this problem as well. Switching to XMLDB is very easy, save your time and effort by creating just 1 file.

==Creating XMLDB files==
XMLDB file in module is stored in db/ folder, named install.xml, You can use a built-in XMLDB editor to create or edit any install.xml files. If you're using MySQL as your default database schemes. XMLDB editor's powerful tools allowing retrofit MySQL table to XMLDB format.

'''Retrofitting MySQL table to XMLDB'''

First, your module has to be installed. Then follow these steps.

1. Go to Miscellaneous >> XMLDB editor
2. Find your module folder, be sure it is writable
3. Click Create, then click Load, you will get a page

[[Category:Using XMLDB]]
[[Category:XMLDB]]

Using XMLDB

2008-01-09T14:55:40Z

Okiknow: /* Developing module using XMLDB */

(This docs is in progress of writing and editing, aimed to help third-party module developer to switch to XMLDB)
==XMLDB in your module==
Everywhere in Moodle now use XMLDB. Created to prevent from creating custom database schemas for different database system. If you don't know what XMLDB is, You can learn more about it here [[XMLDB_introduction]]

In every module, there is "db/" directory where database structure stored. usually contains mysql.php, mysql.sql and so on for different database.

It's mean that you have to create different files for each database systems. If there are 5 database, you have to create 10 files (2 each). XMLDB solves this problem as well. Switching to XMLDB is very easy, save your time and effort by creating just 1 file.

==Convert MySQL syntax to XMLDB==
This can be done easily by using XMLDB Editor built in every Moodle. Simply go to Administration >> Miscellaneous >> XMLDB Editor

[[Category:Using XMLDB]]
[[Category:XMLDB]]

Using XMLDB

2008-01-09T13:30:16Z

Okiknow: /* Developing module using XMLDB */

(This docs is in progress of writing and editing, aimed to help third-party module developer to switch to XMLDB)
==Developing module using XMLDB==
Everywhere in Moodle now use XMLDB. Developed to prevent from creating custom database schemas for different database system.
In every module, there is "db/" directory where database structure stored.

==Convert MySQL syntax to XMLDB==
This can be done easily by using XMLDB Editor built in every Moodle. Simply go to Administration >> Miscellaneous >> XMLDB Editor

[[Category:Using XMLDB]]
[[Category:XMLDB]]

Using XMLDB

2008-01-07T14:48:25Z

Okiknow:

[[Category:Using XMLDB]]
(This docs is in progress of writing and editing, aimed to help third-party module developer to switch to XMLDB)
==Developing module using XMLDB==
If you are Moodle module developer, you might consider switching to XMLDB
Everywhere in Moodle now use XMLDB. Developed to prevent from creating custom database schemas for different database system.

==Convert MySQL syntax to XMLDB==
This can be done easily by using XMLDB Editor built in every Moodle. Simply go to Administration >> Miscellaneous >> XMLDB Editor

Using XMLDB

2008-01-07T13:43:09Z

Okiknow:

Using XMLDB

2008-01-07T13:03:05Z

Okiknow: /* Why use XMLDB */

(This docs is in progress of writing and editing)
==Developing module using XMLDB==
If you are Moodle module developer, you might consider switching to XMLDB
Everywhere in Moodle now use XMLDB.

Using XMLDB

2008-01-07T12:23:28Z

Okiknow:

==Why use XMLDB==