Wiki source code of Database Administration

Last modified by Vincent Massol on 2024/03/28

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
5 XWiki uses by default a database to store its data. You will find on this page tips and tricks to administer and tune your database setup. For Installation please check the [[Installation guide>>Documentation.AdminGuide.InstallationWAR||anchor="HInstallandconfigureaRelationalDatabase"]] which contains information on how to setup XWiki for multiple databases.
7 = Main limitations =
9 == Short strings ==
11 All fields dedicated to page references, page title and in general short object properties strings are limlited to 768 characters
13 = Indexes =
15 Even though we've configured XWiki to let Hibernate create indexes by default, there can be some limitations on some databases. For example on MySQL, indexes cannot be created automatically for string columns longer than 768 characters ([[MySQL has a limit of 768 utf8mb4 characters>>]]).
17 Instructions depending on the database you use:
19 * [[MySQL>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationMySQL.WebHome||anchor="HIndexes"]]
20 * [[Oracle>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationOracle.WebHome||anchor="HIndexes"]]
22 = Sanity Checks =
24 To verify the consistency of your XWiki database you can run the sanity check script. The script will select rows that are inconsistent with the logics of XWiki. If no rows are selected, it means the script itself can not detect any error.
26 * If you use **MySQL** as your database:
27 ** The following [[sanity check script>>attach:sanitycheck.sql]] has been tested for **MySQL 5.0** (also been reported to work with MS-SQL)
28 ** Another [[script>>attach:sanitycheckMySQL4.sql]] is a variant of the previous script for **MySQL 4.x** replacing some syntax with more ancient one (still reports errors in one command)
29 * If you use **postgresql** as your database:
30 ** Here is a [[modified version of the sanity check script>>attach:sanitycheck_postgresql.sql]], to be run in the "query" tool of pgAdmin. It is the same as the script for MySQL, except that the syntax for SQL comments is different.
31 ** pgAdmin is the GUI tool provided with postgresql to access the database. Run pgAdmin, select the ##xwiki## database, and choose the "Query" option in the "Tools" menu. Then just open the script and click on the play icon ("Execute query").
33 = Database browsing =
35 == DbVisualizer ==
37 [[DbVisualizer>>]] natively supports these DBs:
39 * DB2 for Windows/Linux
40 * JavaDB/Derby
41 * MySQL
42 * PostgreSQL
43 * [[and more>>]]
45 Any DB using the corresponding JDBC driver:
47 * Example: HSQLDB by using the driver bundled with XWiki

Get Connected