Changes for page MySQL Installation

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -6,12 +6,15 @@
6	6
7	7	== MyISAM storage engine ==
8	8
9		-MyISAM (the default storage engine for MySQL) does not support transactions. If there is an error while data is being saved to the database, XWiki will attempt to rollback the transaction to it's previous known good state. If you use MyISAM it will do nothing, leaving the database in whatever state it was in when the error occurred.
10		-**If you use MySQL with default engine MyISAM, you will most likely corrupt your database.** We highly recommend using a storage engine such as InnoDB which supports transactions.
	9	+MyISAM (the default storage engine for MySQL) does not support transactions. If there is an error while data is being saved to the database, XWiki will attempt to rollback the transaction to its previous known good state. If you use MyISAM it will do nothing, leaving the database in whatever state it was in when the error occurred.
11	11
	11	+{{warning}}
	12	+If you use MySQL with default engine MyISAM, you will most likely corrupt your database.** We highly recommend using a storage engine such as InnoDB which supports transactions.
	13	+{{/warning}}
	14	+
12	12	== MySQL versions older than 5.0 ==
13	13
14		-XWiki does not fully work with MySQL versions 4.x or lower, due to several limitations of the way the SQL standards are implemented in MySQL, limited support for non-latin1 encodings, the flaky integration of Hibernate and MySQL 4, and other things. Most of the application works fine, but there are some parts that cannot easily be fixed, so if you must use MySQL 4.x, you're doing it on your own. Seriously, MySQL 4 is pretty old and buggy, you should consider upgrading.
	17	+XWiki does not fully work with MySQL versions 4.x or lower, due to several limitations of the way the SQL standards are implemented in MySQL, limited support for non-latin1 encodings, the flaky integration of Hibernate and MySQL 4, and other things. Most of the application works fine, but there are some parts that cannot be easily fixed, so if you must use MySQL 4.x, you're doing it on your own. Seriously, MySQL 4 is pretty old and buggy, you should consider upgrading.
15	15
16	16	= Installation Steps =
17	17
...	...	@@ -23,18 +23,30 @@
23	23	mysqld --console
24	24	{{/code}}
25	25	)))
26		-* Create the wiki database. You can do that in several ways. For example:(((
	29	+* Create the wiki database. You can use the name you want for the database, but you will have to set hibernate configuration file and xwiki.cfg file accordingly. You can create the database in several ways. For example:(((
27	27	{{code language="none"}}
28	28	mysql -u root -e "create database xwiki default character set utf8"
29	29	{{/code}}
30	30	)))
31		-* Give all privileges to the xwiki user for accessing the xwiki database. You can do that in several ways. For example (if you get connections problems try localhost instead of the IP address below):(((
	34	+* Give all privileges to the xwiki user for accessing the xwiki database. You can do that in several ways. For example (if you get connection problems try localhost instead of the IP address below):(((
32	32	{{code language="none"}}
33	33	mysql -u root -e "grant all privileges on xwiki.* to xwiki@localhost identified by 'xwiki'"
34	34	{{/code}}
35		-)))
	38	+
	39	+{{warning}}
	40	+If you're going to use Workspace Manager, you should also grant access to the database ##workspacetemplate##
	41	+{{/warning}}
	42	+
	43	+{{code language="none"}}
	44	+mysql -u root -e "grant all privileges on workspacetemplate.* to xwiki@localhost identified by 'xwiki'"
	45	+{{/code}}
	46	+
36	36	* Please make sure that the DNS-name "localhost" is defined in your hosts-file (i.e. /etc/hosts)
37		-* You need to have the MySQL JDBC Driver JAR (named ##mysql-connector-java*.jar## installed in XWiki's WAR file. If this file isn't present in XWiki's ##WEB-INF/lib## directory you'll need to download it and copy it there. You can download it from the [[MySQL Connector/J Driver page>>http://www.mysql.com/products/connector/j/]] or directly from the [[Maven Central Repository>>http://repo1.maven.org/maven2/mysql/mysql-connector-java/]].
	48	+* You need to have the MySQL JDBC Driver JAR (named ##mysql-connector-java*.jar##) installed in XWiki's WAR file. If this file isn't present in XWiki's ##WEB-INF/lib## directory you'll need to download it and copy it there. You can download it from the [[MySQL Connector/J Driver page>>http://www.mysql.com/products/connector/j/]] or directly from the [[Maven Central Repository>>http://repo1.maven.org/maven2/mysql/mysql-connector-java/]].(((
	49	+{{warning}}
	50	+You need the 5.x version or higher. The 3.x version doesn't handle Boolean data correctly and will either throw errors, or will make all documents hidden by default.
	51	+{{/warning}}
	52	+)))
38	38	* Now you need to tell XWiki to use MySQL. To do this, edit the ##WEB-INF/hibernate.cfg.xml## file where you have expanded the XWiki WAR file and replace the matching properties with the following ones:(((
39	39	{{code language="xml"}}
40	40	<property name="connection.url">jdbc:mysql://localhost/xwiki</property>
...	...	@@ -41,12 +41,12 @@
41	41	<property name="connection.username">xwiki</property>
42	42	<property name="connection.password">xwiki</property>
43	43	<property name="connection.driver_class">com.mysql.jdbc.Driver</property>
44		-<property name="dialect">org.hibernate.dialect.MySQLDialect</property>
	59	+<property name="dialect">org.hibernate.dialect.MySQL5InnoDBDialect</property>
45	45	{{/code}}
46	46	)))
47	47
48	48	{{info}}
49		-By default MySQL only accepts packets smaller than 1MB. If you get the "Packet for query is too large (max_allowed_packet)" error then see the [[Packet too large error page>>http://dev.mysql.com/doc/refman/5.0/en/packet-too-large.html]]. For example to increase the packet size to 32M you could start the MySQL server with:
	64	+By default MySQL only accepts packets that are smaller than 1MB. If you get the "Packet for query is too large (max_allowed_packet)" error then see the [[Packet too large error page>>http://dev.mysql.com/doc/refman/5.0/en/packet-too-large.html]]. For example to increase the packet size to 32M you could start the MySQL server with:
50	50
51	51	(((
52	52	{{code language="none"}}
...	...	@@ -55,11 +55,38 @@
55	55	)))
56	56	{{/info}}
57	57
	73	+(((
	74	+{{info}}
	75	+If an empty Xwiki starts with no errors, but you unable to upload the default set of pages (XAR file) also try to increase "max_allowed_packet" parameter as shown above.
	76	+{{/info}}
	77	+)))
	78	+
	79	+{{warning}}
	80	+XWiki does not create the Database Indexes automatically. You can use the [[Admin Tools Application>>extensions:Extension.AdminTools]] for that or [[create them manually>>AdminGuide.Database Administration]]
	81	+{{/warning}}
	82	+)))
	83	+
58	58	= Troubleshooting =
59	59
	86	+== Unable to login to MySQL Console ==
	87	+
	88	+When running
	89	+
	90	+{{code language="none"}}
	91	+mysql -u root -e "create database xwiki default character set utf8
	92	+{{/code}}
	93	+
	94	+you may get a
	95	+
	96	+{{code language="none"}}
	97	+ERROR 1045 (28000): Access denied for user 'xwiki'@'localhost' (using password: YES)
	98	+{{/code}}
	99	+
	100	+This means that you have a password set for the MySQL root user, but you are not specifying it in the console command. You must also use the //-p// parameter. Using this you will be prompted to enter the password and be allowed to login to the MySQL console and create the database.
	101	+
60	60	== Can't create test file ==
61	61
62		-When running ##mysqld ~-~-console## you may get the following (especially if you're on Mac):
	104	+When running ##mysqld ~-~-console## you may get the following (especially if you're on a Mac):
63	63
64	64	{{code language="none"}}
65	65	071111 17:20:53 [Warning] Can't create test file /usr/local/mysql-5.0.45-osx10.4-i686/data/Vincent.lower-test
...	...	@@ -70,13 +70,13 @@
70	70
71	71	To start MySQL run the following instead:
72	72
73		-{{code}}
	115	+{{code language="none"}}
74	74	sudo /usr/local/mysql/bin/mysqld_safe --user=mysql
75	75	{{/code}}
76	76
77	77	== Data Truncation Error ==
78	78
79		-If you receive an Exception like the following while installing/upgrading XWiki, chances are, that you are using an outdated version of MySQLConnectorJ.
	121	+If you receive an Exception like the following while installing/upgrading XWiki, chances are that you are using an outdated version of MySQLConnectorJ.
80	80
81	81	{{code language="none"}}
82	82	Caused by: java.sql.BatchUpdateException: Data truncation: Out of
...	...	@@ -88,6 +88,36 @@
88	88	at org.hibernate.jdbc.AbstractBatcher.executeBatch(AbstractBatcher.java:246)
89	89	{{/code}}
90	90
91		-On Linux, mysql-connector-java-3.x has proven **not** to work due to a bug in the handling of UTF-8, and lack of support for Boolean types.
	133	+On Linux, mysql-connector-java-3.x has proven **not** to work due to a bug in the handling of UTF-8 and lack of support for Boolean types.
92	92
93	93	Upgrading to the latest version of MySQLConnectorJ should solve such an error in most of the cases.
	136	+
	137	+== HTTP 500 Error ==
	138	+
	139	+(((
	140	+{{code language="none"}}
	141	+HTTP Status 500 -
	142	+
	143	+type Exception report
	144	+
	145	+message
	146	+
	147	+descriptionThe server encountered an internal error () that prevented it from fulfilling this request.
	148	+
	149	+exception
	150	+
	151	+javax.servlet.ServletException: com.xpn.xwiki.XWikiException: Error number 3 in 0: Could not initialize main XWiki context
	152	+Wrapped Exception: Error number 3001 in 3: Cannot load class com.xpn.xwiki.store.migration.hibernate.XWikiHibernateMigrationManager from param xwiki.store.migration.manager.class
	153	+Wrapped Exception: Error number 0 in 3: Exception while hibernate execute
	154	+Wrapped Exception: Could not create a DBCP pool. There is an error in the hibernate configuration file, please review it.
	155	+
	156	+root cause
	157	+
	158	+com.xpn.xwiki.XWikiException: Error number 3 in 0: Could not initialize main XWiki context
	159	+Wrapped Exception: Error number 3001 in 3: Cannot load class com.xpn.xwiki.store.migration.hibernate.XWikiHibernateMigrationManager from param xwiki.store.migration.manager.class
	160	+Wrapped Exception: Error number 0 in 3: Exception while hibernate execute
	161	+Wrapped Exception: Could not create a DBCP pool. There is an error in the hibernate configuration file, please review it.
	162	+{{/code}}
	163	+)))
	164	+
	165	+In this case, try to disable **skip-networking** in MySQL *.ini file. Thanks a lot M Rawash for saved time (see his comment below).