Skip to content

Database: Use utf8mb4 collation as default for creating new schemas #12145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lscharmer wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

Database: Use utf8mb4 collation as default for creating new schemas #12145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
08c494d
Database: Use utf8mb4 collation as default for creating new schemas
lscharmer Sep 29, 2026
3761de7
Database: Update documentation for utf8mb4
lscharmer Oct 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion components/ILIAS/Database/classes/Setup/ilDatabaseCreatedObjective.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ public function achieve(Environment $environment): Environment
$db = \ilDBWrapperFactory::getWrapper($this->config->getType());
$db->initFromIniFile($c->toMockIniFile());

if (!$db->createDatabase($c->getDatabase(), "utf8", $c->getCollation())) {
$charset = ilDBConstants::isUTF8MB4Collation($c->getCollation()) ? 'utf8mb4' : 'utf8';
if (!$db->createDatabase($c->getDatabase(), $charset, $c->getCollation())) {
throw new UnachievableException(
"Database cannot be created."
);
Expand Down
2 changes: 1 addition & 1 deletion components/ILIAS/Database/classes/Setup/ilDatabaseSetupConfig.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

class ilDatabaseSetupConfig implements Config
{
public const DEFAULT_COLLATION = "utf8_general_ci";
public const DEFAULT_COLLATION = \ilDBConstants::MYSQL_COLLATION_UTF8MB4_520;
public const DEFAULT_PATH_TO_DB_DUMP = "./components/ILIAS/Database/sql/ilias3.sql";

protected string $type;
Expand Down
10 changes: 3 additions & 7 deletions docs/configuration/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,15 +254,11 @@ On Debian/Ubuntu execute:
apt install mariadb-server
```

> [!NOTE]
> Please note that installing ILIAS in utf8mb4-collations is currently not supported!
> ILIAS supports utf8-collations with 3 bytes per character, such as `utf8_general_ci`, only.

We **strongly recommend** using MariaDB with the following settings:

* InnoDB storage engine (default)
* `character-set-server` = `utf8mb3`
* `collation-server` = `utf8mb3_general_ci`
* `character-set-server` = `utf8mb4`
* `collation-server` = `utf8mb4_unicode_520_ci`
* `join_buffer_size` > `128K`
* `table_open_cache` > `400`
* `innodb_buffer_pool_size` > `2G` (depending on DB size)
Expand All @@ -279,7 +275,7 @@ systemctl restart mariadb.service
We recommend creating a dedicated database user for ILIAS:

```shell
mysql -e "CREATE DATABASE ilias CHARACTER SET utf8 COLLATE utf8_general_ci;"
mysql -e "CREATE DATABASE ilias CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_520_ci;"
mysql -e "CREATE USER 'ilias'@'localhost' IDENTIFIED BY '<db-password>';"
mysql -e "GRANT LOCK TABLES on *.* TO 'ilias'@'localhost';"
mysql -e "GRANT ALL PRIVILEGES ON ilias.* TO 'ilias'@'localhost';"
Expand Down
Loading