Data definition API - Revision history

Devdocsbot: Protected "Data definition API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-13T14:05:36Z

Protected "Data definition API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 14:05, 13 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-13T14:03:11Z

Update migration status and path

← Older revision		Revision as of 14:03, 13 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/core/dml/ddl}}
	{{Moodle_2.0}}In this page you'll access to the available functions under Moodle to be able to handle DB structures (tables, fields, indexes...).		{{Moodle_2.0}}In this page you'll access to the available functions under Moodle to be able to handle DB structures (tables, fields, indexes...).

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:30:39Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:30, 14 July 2021
				
Line 13:
Line 13:
* All the function calls in this page are public methods of the '''database manager''', accessible from the $DB global object. So you'll need to "import" it within your '''upgrade.php''' main function with something like: * All the function calls in this page are public methods of the '''database manager''', accessible from the $DB global object. So you'll need to "import" it within your '''upgrade.php''' main function with something like:



<code php> <syntaxhighlight lang="php">
function xmldb_xxxx_upgrade { function xmldb_xxxx_upgrade {
         
Line 33:
Line 33:



===Handling tables=== ===Handling tables===
<code php> <syntaxhighlight lang="php">
/// To detect if one table exists: /// To detect if one table exists:
     $dbman->table_exists($table)      $dbman->table_exists($table)
Line 48:
Line 48:



===Handling fields=== ===Handling fields===
<code php> <syntaxhighlight lang="php">
/// To detect if one field exists: /// To detect if one field exists:
     $dbman->field_exists($table, $field)      $dbman->field_exists($table, $field)
Line 83:
Line 83:



===Handling indexes=== ===Handling indexes===
<code php> <syntaxhighlight lang="php">
/// To detect if one index exists: /// To detect if one index exists:
     $dbman->index_exists($table, $index)      $dbman->index_exists($table, $index)

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T13:02:44Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 13:02, 14 July 2021
Line 23:		Line 23:
	}		}

	</~~code~~>		</syntaxhighlight>

	* Once more, the use of these functions is '''restricted''' to the upgrade processes and it shouldn't be used ever out from there.		* Once more, the use of these functions is '''restricted''' to the upgrade processes and it shouldn't be used ever out from there.
Line 45:		Line 45:
	/// To rename one table:		/// To rename one table:
	$dbman->rename_table($table, $newname, $continue=true, $feedback=true)		$dbman->rename_table($table, $newname, $continue=true, $feedback=true)
	</~~code~~>		</syntaxhighlight>

	===Handling fields===		===Handling fields===
Line 80:		Line 80:
	/// To rename one field:		/// To rename one field:
	$dbman->rename_field($table, $field, $newname, $continue=true, $feedback=true)		$dbman->rename_field($table, $field, $newname, $continue=true, $feedback=true)
	</~~code~~>		</syntaxhighlight>

	===Handling indexes===		===Handling indexes===
Line 95:		Line 95:
	/// To drop one index:		/// To drop one index:
	$dbman->drop_index($table, $index, $continue=true, $feedback=true)		$dbman->drop_index($table, $index, $continue=true, $feedback=true)
	</~~code~~>		</syntaxhighlight>

	==Some considerations==		==Some considerations==

Mits: ja link

2020-10-07T15:03:49Z

ja link

← Older revision		Revision as of 15:03, 7 October 2020
Line 118:		Line 118:
	[[Category:XMLDB]]		[[Category:XMLDB]]
	[[Category:API]]		[[Category:API]]

			[[ja:データ定義API]]

Dougiamas: /* See also */

2012-01-25T08:55:43Z

Deraadt: moved DDL functions to Data definition API

2012-01-13T03:30:25Z

moved DDL functions to Data definition API

← Older revision	Revision as of 03:30, 13 January 2012
(No difference)

Stronk7: /* Main info */

2009-05-25T16:23:50Z

Main info

← Older revision		Revision as of 16:23, 25 May 2009
Line 9:		Line 9:
	==Main info==		==Main info==

	'''Important note:''' All the functions showed in this page are for use in '''Moodle 2.0 upwards''', where we changed the [[DB layer 2.0\|DB layer]] to support some new features. If you need information for previous Moodle version, take a look to the [[DDL functions - pre 2.0\|DDL functions - pre 2.0]] page.		'''Important note:''' All the functions showed in this page are for use in '''Moodle 2.0 upwards''', where we changed the [[DB layer 2.0\|DB layer]] to support some new features. If you need information for previous Moodle version, take a look to the [[DDL functions - pre 2.0\|DDL functions - pre 2.0]] page. For a detailed reference of changes, see the [[DB layer 2.0 migration docs\|migration docs]].

	* All the function calls in this page are public methods of the '''database manager''', accessible from the $DB global object. So you'll need to "import" it within your '''upgrade.php''' main function with something like:		* All the function calls in this page are public methods of the '''database manager''', accessible from the $DB global object. So you'll need to "import" it within your '''upgrade.php''' main function with something like:

Stronk7: /* Handling fields */

2009-05-25T14:47:34Z

Handling fields

← Older revision		Revision as of 14:47, 25 May 2009
Line 73:		Line 73:
	/// (note this function will be only available in Moodle 2.0 as it's needed		/// (note this function will be only available in Moodle 2.0 as it's needed
	/// to drop any enum existing in previous Moodle releases). Will be out in Moodle 2.1		/// to drop any enum existing in previous Moodle releases). Will be out in Moodle 2.1
	$dbman->~~change_field_enum~~($table, $field, $continue=true, $feedback=true)		$dbman->drop_enum_from_field($table, $field, $continue=true, $feedback=true)

	/// To change the default value of one field:		/// To change the default value of one field:

Stronk7: /* Handling indexes */

2009-05-05T14:17:32Z

Handling indexes

← Older revision		Revision as of 14:17, 5 May 2009
Line 86:		Line 86:
	/// To detect if one index exists:		/// To detect if one index exists:
	$dbman->index_exists($table, $index)		$dbman->index_exists($table, $index)

	/// To return the name of one index in DB:		/// To return the name of one index in DB:
	$dbman->find_index_name($table, $index)		$dbman->find_index_name($table, $index)

	/// To add one index:		/// To add one index:
	$dbman->add_index($table, $index, $continue=true, $feedback=true)		$dbman->add_index($table, $index, $continue=true, $feedback=true)

	/// To drop one index:		/// To drop one index:
	$dbman->drop_index($table, $index, $continue=true, $feedback=true)		$dbman->drop_index($table, $index, $continue=true, $feedback=true)

← Older revision		Revision as of 08:55, 25 January 2012
Line 106:		Line 106:
	==See also==		==See also==

			* [[Core APIs]]
	* [[XMLDB Documentation\|XMLDB Documentation]]: Main page of the whole XMLDB documentation, where all the process is defined and all the related information resides.		* [[XMLDB Documentation\|XMLDB Documentation]]: Main page of the whole XMLDB documentation, where all the process is defined and all the related information resides.
	* [[XMLDB Defining one XML structure]]: Where you will know a bit more about the underlying XML structure used to define the DB objects, that is used continuously by the functions described in this page.		* [[XMLDB Defining one XML structure]]: Where you will know a bit more about the underlying XML structure used to define the DB objects, that is used continuously by the functions described in this page.
Line 116:		Line 117:
	[[Category:DB]]		[[Category:DB]]
	[[Category:XMLDB]]		[[Category:XMLDB]]
			[[Category:API]]

← Older revision		Revision as of 13:30, 14 July 2021
Line 13:		Line 13:
	* All the function calls in this page are public methods of the '''database manager''', accessible from the $DB global object. So you'll need to "import" it within your '''upgrade.php''' main function with something like:		* All the function calls in this page are public methods of the '''database manager''', accessible from the $DB global object. So you'll need to "import" it within your '''upgrade.php''' main function with something like:

	<~~code~~ php>		<syntaxhighlight lang="php">
	function xmldb_xxxx_upgrade {		function xmldb_xxxx_upgrade {

Line 33:		Line 33:

	===Handling tables===		===Handling tables===
	<~~code~~ php>		<syntaxhighlight lang="php">
	/// To detect if one table exists:		/// To detect if one table exists:
	$dbman->table_exists($table)		$dbman->table_exists($table)
Line 48:		Line 48:

	===Handling fields===		===Handling fields===
	<~~code~~ php>		<syntaxhighlight lang="php">
	/// To detect if one field exists:		/// To detect if one field exists:
	$dbman->field_exists($table, $field)		$dbman->field_exists($table, $field)
Line 83:		Line 83:

	===Handling indexes===		===Handling indexes===
	<~~code~~ php>		<syntaxhighlight lang="php">
	/// To detect if one index exists:		/// To detect if one index exists:
	$dbman->index_exists($table, $index)		$dbman->index_exists($table, $index)