Archived:Managing Component Updates (Update SQL files) - Revision history

M-b-o: M-b-o moved page J2.5:Managing Component Updates (Update SQL files) to Archived:Managing Component Updates (Update SQL files)

2022-04-26T22:21:28Z

M-b-o moved page J2.5:Managing Component Updates (Update SQL files) to Archived:Managing Component Updates (Update SQL files)

← Older revision	Revision as of 22:21, 26 April 2022
(No difference)

Vdespa: removed needs review.

2013-11-06T13:14:31Z

removed needs review.

← Older revision		Revision as of 13:14, 6 November 2013
Line 1:		Line 1:
	{{version/tutor\|2.5}}{{Chunk:Managing Component Updates - Contents~~}}{{review~~}}		{{version/tutor\|2.5}}{{Chunk:Managing Component Updates - Contents}}
	== Update SQL files ==		== Update SQL files ==
	The update SQL file(s) are ideally located in a directory under <code>/administrator/components/com_YOURCOMPONENT/sql/updates/mysql</code>. This folder needs to be listed in the manifest file:		The update SQL file(s) are ideally located in a directory under <code>/administrator/components/com_YOURCOMPONENT/sql/updates/mysql</code>. This folder needs to be listed in the manifest file:

Vdespa: Corected the XML, added more details about the sql folder.

2013-11-06T13:13:11Z

Corected the XML, added more details about the sql folder.

← Older revision		Revision as of 13:13, 6 November 2013
Line 1:		Line 1:
	{{version/tutor\|2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}		{{version/tutor\|2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}
	== Update SQL files ==		== Update SQL files ==
	The update SQL file(s) are located in a directory ~~that is~~ listed in the manifest file:		The update SQL file(s) are ideally located in a directory under <code>/administrator/components/com_YOURCOMPONENT/sql/updates/mysql</code>. This folder needs to be listed in the manifest file:

	<source lang="xml">		<source lang="xml">
	<update>		<update>
	<schemas>		<schemas>
	<schemapath type="mysql">sql/updates</schemapath>		<schemapath type="mysql">sql/updates/mysql</schemapath>
	</schemas>		</schemas>
	</update>		</update>
	</source>		</source>

	There is an SQL file for each component version. Each file name must match the version string in the manifest file for that version. Joomla uses this string to determine which SQL files(s) to execute, and in what order they will be executed.		Observe that we create a folder for each database engine that the component supports. This example will only show how it's done for MySQL. For other engiens, the procedure is similar.

			There is an SQL file for each component version. Each file name must match the version string in the manifest file for that version. Joomla uses this string to determine which SQL files(s) to execute, and in what order they will be executed.

			Don't forget to update your component manifest file, by adding the <code>sql</code> folder under the admin folders.

			<blockquote>
			<folder>sql</folder>
			</blockquote>

	''Important Note:'' These files are also used to set the version number in the <code>#__schemas</code> table. This version number must be present in the current version of the component in order for the new SQL files to be run during the update. For example, if you have version 1.0 and are updating to version 1.1, the <code>1.1.sql</code> file will not be executed if there was no <code>1.0.sql</code> file in the 1.0 release. For this reason, it is good practice to have a SQL update file for each version, even if there is no SQL change in that version. You can just use an empty file or a file with a comment line.		''Important Note:'' These files are also used to set the version number in the <code>#__schemas</code> table. This version number must be present in the current version of the component in order for the new SQL files to be run during the update. For example, if you have version 1.0 and are updating to version 1.1, the <code>1.1.sql</code> file will not be executed if there was no <code>1.0.sql</code> file in the 1.0 release. For this reason, it is good practice to have a SQL update file for each version, even if there is no SQL change in that version. You can just use an empty file or a file with a comment line.

	Joomla uses the PHP ''version_compare'' function to execute the correct SQL files.. Familiarize yourself with this function. Your version strings need to adhere to the conventions of this function.		Joomla uses the PHP ''version_compare'' function to execute the correct SQL files.. Familiarize yourself with this function. Your version strings need to adhere to the conventions of this function.

	For example, the SQL files for version 1.3 of this example include:		For example, the SQL files for version 1.3 of this example include:
	<blockquote>		<blockquote>
Line 52:		Line 61:
	== Contributors ==		== Contributors ==
	*[[User:sm990\|Kim Eckert]]		*[[User:sm990\|Kim Eckert]]
			*[[User:vdespa\|Valentin Despa]]

	[[Category:Joomla! 2.5]]		[[Category:Joomla! 2.5]]
	[[Category:Component Development]]		[[Category:Component Development]]

Tom Hutchison: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 4 to J2.5:Managing Component Updates (Update SQL files)

2013-05-24T12:05:36Z

Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 4 to J2.5:Managing Component Updates (Update SQL files)

← Older revision	Revision as of 12:05, 24 May 2013
(No difference)

Wilsonge: Remove 1.6 and 1.7 categories

2013-04-29T23:01:47Z

Remove 1.6 and 1.7 categories

← Older revision		Revision as of 23:01, 29 April 2013
Line 53:		Line 53:
	*[[User:sm990\|Kim Eckert]]		*[[User:sm990\|Kim Eckert]]

	~~[[Category:Joomla! 1.6]]~~
	~~[[Category:Joomla! 1.7]]~~
	[[Category:Joomla! 2.5]]		[[Category:Joomla! 2.5]]
	[[Category:Component Development]]		[[Category:Component Development]]

Wilsonge: Remove 1.6 and 1.7 tags

2013-04-29T13:03:33Z

Remove 1.6 and 1.7 tags

← Older revision		Revision as of 13:03, 29 April 2013
Line 1:		Line 1:
	{{version/tutor\|~~1.6,1.7,~~2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}		{{version/tutor\|2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}
	== Update SQL files ==		== Update SQL files ==
	The update SQL file(s) are located in a directory that is listed in the manifest file:		The update SQL file(s) are located in a directory that is listed in the manifest file:

Wilsonge: Wilsonge moved page Managing Component Updates with Joomla!1.6 - Part 4 to Managing Component Updates with Joomla!2.5 - Part 4: Joomla 2.5 is the LTS release

2013-02-01T00:59:43Z

Wilsonge moved page Managing Component Updates with Joomla!1.6 - Part 4 to Managing Component Updates with Joomla!2.5 - Part 4: Joomla 2.5 is the LTS release

← Older revision	Revision as of 00:59, 1 February 2013
(No difference)

Tom Hutchison: page update for series

2012-09-18T14:07:06Z

page update for series

← Older revision		Revision as of 14:07, 18 September 2012
Line 1:		Line 1:
	{{~~review}}~~		{{version/tutor\|1.6,1.7,2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}
	~~{{RightTOC}}~~
	~~This tutorial is for Joomla {{JVer~~\|1.6}} {{~~JVer\|1.7~~}} {{~~JVer\|2.5~~}}

	~~== Articles in this series ==~~
	* [[Managing_Component_Updates_with_Joomla!1.6_-_Part_1\|Overview]]
	* [[Managing_Component_Updates_with_Joomla!1.6_-_Part_2\|Manifest file]]
	* [[Managing_Component_Updates_with_Joomla!1.6_-_Part_3\|Script.php]]
	* [[Managing_Component_Updates_with_Joomla!1.6_-_Part_4\|Update SQL files]]
	* [[Managing_Component_Updates_with_Joomla!1.6_-_Part_5\|Component release files]]
	* [[Managing_Component_Updates_with_Joomla!1.6_-_Part_6\|How to use this example]]

	== Update SQL files ==		== Update SQL files ==
	The update SQL file(s) are located in a directory that is listed in the manifest file:		The update SQL file(s) are located in a directory that is listed in the manifest file:
Line 64:		Line 53:
	*[[User:sm990\|Kim Eckert]]		*[[User:sm990\|Kim Eckert]]

	[[~~category~~:Joomla! 1.6]]		[[Category:Joomla! 1.6]]
	[[~~category~~:Joomla! 1.7]]		[[Category:Joomla! 1.7]]
	[[Category:~~Tutorials~~]]		[[Category:Joomla! 2.5]]
	[[Category:Component Development]]		[[Category:Component Development]]

Sm990: /* Update SQL files */

2012-09-09T21:27:56Z

Update SQL files

← Older revision		Revision as of 21:27, 9 September 2012
Line 22:		Line 22:
	</source>		</source>

	There is a file for each component version. Each file name must match the version string in the manifest file for that version. Joomla uses this string to determine which SQL files(s) to execute, and in what order they will be executed.		There is an SQL file for each component version. Each file name must match the version string in the manifest file for that version. Joomla uses this string to determine which SQL files(s) to execute, and in what order they will be executed.

	''Important Note:'' These files are also used to set the version number in the <code>#__schemas</code> table. This version number must be present in the current version of the component in order for the new SQL files to be run during the update. For example, if you have version 1.0 and are updating to version 1.1, the <code>1.1.sql</code> file will not be executed if there was no <code>1.0.sql</code> file in the 1.0 release. For this reason, it is good practice to have a SQL update file for each version, even if there is no SQL change in that version. You can just use an empty file or a file with a comment line.		''Important Note:'' These files are also used to set the version number in the <code>#__schemas</code> table. This version number must be present in the current version of the component in order for the new SQL files to be run during the update. For example, if you have version 1.0 and are updating to version 1.1, the <code>1.1.sql</code> file will not be executed if there was no <code>1.0.sql</code> file in the 1.0 release. For this reason, it is good practice to have a SQL update file for each version, even if there is no SQL change in that version. You can just use an empty file or a file with a comment line.

Sm990: /* Update SQL files */

2012-06-10T17:16:53Z

Update SQL files

← Older revision		Revision as of 17:16, 10 June 2012
Line 26:		Line 26:
	''Important Note:'' These files are also used to set the version number in the <code>#__schemas</code> table. This version number must be present in the current version of the component in order for the new SQL files to be run during the update. For example, if you have version 1.0 and are updating to version 1.1, the <code>1.1.sql</code> file will not be executed if there was no <code>1.0.sql</code> file in the 1.0 release. For this reason, it is good practice to have a SQL update file for each version, even if there is no SQL change in that version. You can just use an empty file or a file with a comment line.		''Important Note:'' These files are also used to set the version number in the <code>#__schemas</code> table. This version number must be present in the current version of the component in order for the new SQL files to be run during the update. For example, if you have version 1.0 and are updating to version 1.1, the <code>1.1.sql</code> file will not be executed if there was no <code>1.0.sql</code> file in the 1.0 release. For this reason, it is good practice to have a SQL update file for each version, even if there is no SQL change in that version. You can just use an empty file or a file with a comment line.

	Joomla uses the PHP ''version_compare'' function ~~for this~~. Familiarize yourself with this function. Your version strings need to adhere to the conventions of this function.		Joomla uses the PHP ''version_compare'' function to execute the correct SQL files.. Familiarize yourself with this function. Your version strings need to adhere to the conventions of this function.
	For example, the SQL files for version 1.3 of this example include:		For example, the SQL files for version 1.3 of this example include:
	<blockquote>		<blockquote>