Development:Using XMLDB - Revision history

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

2008-02-23T18:34:09Z

What is XMLDB and how can it help you

← Older revision		Revision as of 18:34, 23 February 2008
Line 5:		Line 5:
	XMLDB stores the database definition in an XML format that can be used to install Moodle on any database. Everywhere in Moodle now uses XMLDB.		XMLDB stores the database definition in an XML format that can be used to install Moodle on any database. Everywhere in Moodle now uses XMLDB.

	In every module (or other plugin) folder, there is a ''db/'' folder where the database structure stored. IN the past, this used to contain separate files ''mysql.php'', ''mysql.sql'', etc. for different databases. It ~~means~~ that you ~~have~~ to create different files for each database ~~systems~~. If there ~~are~~ more databases you ~~want~~ your module to be compatible with, you ~~have~~ to create more files. Switching to XMLDB means that you only have to create one file, and there is an editor to help you, so it saves you time.		In every module (or other plugin) folder, there is a ''db/'' folder where the database structure is stored. In the past, this used to contain separate files ''mysql.php'', ''mysql.sql'', etc. for different databases. It meant that you had to create different files for each database system. If there were more databases you wanted your module to be compatible with, you had to create more files. Switching to XMLDB means that you only have to create one file, and there is an editor to help you, so it saves you time.

	==Getting started==		==Getting started==

TimHunt at 14:42, 14 January 2008

2008-01-14T14:42:14Z

← Older revision		Revision as of 14:42, 14 January 2008
Line 1:		Line 1:
	{{Moodle 1.7}}Note: This page is a work in progress. It is intended ~~for~~ third-party ~~module developers~~ to help them switch to XMLDB.		{{Moodle 1.7}}Note: This page is a work in progress. It is intended to help developers of third-party modules, and other plugins, to help them switch to XMLDB.

	==What is XMLDB and how can it help you==		==What is XMLDB and how can it help you==
	~~XMLDB is a database format created to help developers from creating custom database schemas for different database system. It's like a database in XML format. Everywhere in Moodle now uses XMLDB.~~

	~~In every module folder, there is a ''db/'' folder where~~ the database ~~structure stored. The folder usually contains ''mysql.php'', ''mysql.sql'', etc~~. ~~for different databases~~.		XMLDB stores the database definition in an XML format that can be used to install Moodle on any database. Everywhere in Moodle now uses XMLDB.

	It means that you have to create different files for each database systems. If there are more databases 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 and~~ saves ~~your~~ time ~~and effort by creating just 1 file~~.		In every module (or other plugin) folder, there is a ''db/'' folder where the database structure stored. IN the past, this used to contain separate files ''mysql.php'', ''mysql.sql'', etc. for different databases. It means that you have to create different files for each database systems. If there are more databases you want your module to be compatible with, you have to create more files. Switching to XMLDB means that you only have to create one file, and there is an editor to help you, so it saves you time.

	==Getting started==		==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.

	The XMLDB editor is located in administration block, go to ''Miscellaneous > XMLDB editor''. Find your module name. Initially 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.		The XMLDB database definition is stored in the file ''db/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.

			The XMLDB editor is located in administration block, go to ''Miscellaneous > XMLDB editor''. Find your module name. Initially you won't be able to click on ''Create'' link and also can't edit your module (If the ''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, though it can help you with the 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 existing MySQL tables to XMLDB.		Note that XMLDB editor is not a tool for creating your module, though it can help you with the 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 existing MySQL tables to XMLDB.
Line 24:		Line 24:

	===Start editing===		===Start editing===

	To start editing ''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.		To start editing ''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.

Line 49:		Line 50:

	===Other operation===		===Other operation===

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

	==See also==		==See also==

	*[[XMLDB editor]]		*[[XMLDB editor]]
	*[[Development:XMLDB introduction]]		*[[Development:XMLDB introduction]]

Tsala: formatting

2008-01-12T19:40:42Z

formatting

← Older revision		Revision as of 19:40, 12 January 2008
Line 1:		Line 1:
	(This page is in progress ~~of writing and editing,~~ intended for third-party module developers to help them switch to XMLDB.)		{{Moodle 1.7}}Note: This page is a work in progress. It is intended for third-party module developers to help them switch to XMLDB.
	~~{{Moodle 1.7}}~~
	==What is XMLDB and how can it help you==		==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.		XMLDB is a database format created to help developers from creating custom database schemas for different database system. It's like a database in XML format. Everywhere in Moodle now uses 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~~.		In every module folder, there is a ''db/'' folder where the database structure stored. The folder usually contains ''mysql.php'', ''mysql.sql'', etc. for different databases.

	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.		It means that you have to create different files for each database systems. If there are more databases 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 and saves your time and effort by creating just 1 file.

	==Getting ~~Started~~==		==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 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.		The XMLDB editor is located in administration block, go to ''Miscellaneous > XMLDB editor''. Find your module name. Initially 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.		Note that XMLDB editor is not a tool for creating your module, though it can help you with the 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 existing MySQL tables to XMLDB.

	Another XMLDB's advantage is you can create table~~'s comment~~ as you want. To describe it to other developer.		Another XMLDB's advantage is you can create table comments 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.		XMLDB editor is really easy to work with. We strongly recommend you to play with it for a while and read [[XMLDB editor]] and about XMLDB structure [[Development:XMLDB defining an XML structure]].

	~~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''===

	~~===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.

	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===		===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.		To start editing ''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===		===Create new table===
Line 36:		Line 34:

	# Click ''Edit'' on your desired 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.		# Click ''New Field'', You can now edit field information like name, comment, type, length, etc. See [[Development:XMLDB column types] for XMLDB column type comparing with other database system.
	# When you're done, click ''Change''.		# When you're done, click ''Change''.

Line 46:		Line 44:
	# Click ''New Table from MySQL''		# 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''.		# 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 !		# Do it again until 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~~]		Note: Table name must contains only lowercase character, number, underscore and length must not exceed 28 characters. More info here: [[Development:XMLDB defining an XML structure]]

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

	~~==See Also==~~
	~~[[Development:XMLDB_introduction]]~~

	~~[[Development:XMLDB defining an XML structure]]~~

	~~[[Development:XMLDB_column_types]]~~

	[[XMLDB editor]]		==See also==
			*[[XMLDB editor]]
			*[[Development:XMLDB introduction]]
			*[[Development:XMLDB defining an XML structure]]
			*[[Development:XMLDB column types]]

	[[Category:Developer\|Using XMLDB]]		[[Category:Developer\|Using XMLDB]]
	[[Category:XMLDB]]		[[Category:XMLDB]]

Okiknow: /* Getting Started */

2008-01-12T15:51:44Z

Getting Started

← Older revision		Revision as of 15:51, 12 January 2008
Line 49:		Line 49:

	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]		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==		==See Also==

Okiknow at 15:41, 12 January 2008

2008-01-12T15:41:13Z

← Older revision		Revision as of 15:41, 12 January 2008
Line 36:		Line 36:

	# Click ''Edit'' on your desired table.		# Click ''Edit'' on your desired table.
	# Click ''New Field'', You can now edit field information like name, comment, type, length, etc.		# 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''.		# When you're done, click ''Change''.

Line 54:		Line 54:

	[[Development:XMLDB defining an XML structure]]		[[Development:XMLDB defining an XML structure]]

			[[Development:XMLDB_column_types]]

	[[XMLDB editor]]		[[XMLDB editor]]

Okiknow at 15:38, 12 January 2008

2008-01-12T15:38:00Z

← Older revision		Revision as of 15:38, 12 January 2008
Line 13:		Line 13:
	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.		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.		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.		Another XMLDB's advantage is you can create table's comment as you want. To describe it to other developer.

Okiknow: /* Create new table */

2008-01-10T13:39:28Z

Create new table

← Older revision		Revision as of 13:39, 10 January 2008
Line 29:		Line 29:

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

	# Go to ''New Table''.		# Go to ''New Table''.

Okiknow: /* Start editing */

2008-01-10T13:38:18Z

Start editing

← Older revision		Revision as of 13:38, 10 January 2008
Line 26:		Line 26:

	===Start editing===		===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.		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===		===Create new table===

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

2008-01-10T13:37:30Z

What is XMLDB and how can it help you

← Older revision		Revision as of 13:37, 10 January 2008
Line 2:		Line 2:
	{{Moodle 1.7}}		{{Moodle 1.7}}
	==What is XMLDB and how can it help you==		==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.		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.		In every module folder, there is db/ folder where database structure stored. The folder usually contains mysql.php, mysql.sql, etc. for different database.

Okiknow at 13:35, 10 January 2008

2008-01-10T13:35:25Z

← Older revision		Revision as of 13:35, 10 January 2008
Line 1:		Line 1:
	(This page is in progress of writing and editing, intended for third-party module developers to help them switch to XMLDB.)		(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.

	~~==How XMLDB can help you==~~		In every module folder, there is db/ folder where database structure stored. The folder usually contains mysql.php, mysql.sql, etc. for different database.
	~~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 [[Development: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 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.

	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==		==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 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.		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.		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~~.		Another XMLDB's advantage is you can create table's comment as you want. To describe it to other developer.

	More information about [[XMLDB editor]], XMLDB Structure : [[Development:~~XMLDB defining an XML structure]~~].		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===		===Create install.xml===
Line 23:		Line 25:
	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.		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~~===		===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.		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===		===Retrofit MySQL table to XMLDB===

	XMLDB editor can retrofit MySQL table to XMLDB. This is useful if your module database already using MySQL.		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:		First, your module has to be installed. Then follow these steps:

	~~# Go to XMLDB editor, edit your module.~~
	# Click ''New Table from MySQL''		# 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''.		# 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 !		# 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.		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==
			[[Development:XMLDB_introduction]]

			[[Development:XMLDB defining an XML structure]]

			[[XMLDB editor]]

	[[Category:Developer\|Using XMLDB]]		[[Category:Developer\|Using XMLDB]]
	[[Category:XMLDB]]		[[Category:XMLDB]]