[BUGFIX] Use proper key name in db config
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Documentation / Changelog / 8.1 / Breaking-75454-LocalConfigurationDBConfigStructureHasChanged.rst
1
2 .. include:: ../../Includes.txt
3
4 =====================================================================
5 Breaking: #75454 - LocalConfiguration DB config structure has changed
6 =====================================================================
7
8 See :issue:`75454`
9
10 Description
11 ===========
12
13 To provide support for multiple database connections and remapping tables to different
14 database systems within the TYPO3 Core the configuration format for database connections
15 in `LocalConfiguration.php` / `$GLOBALS['TYPO3_CONF_VARS']['DB']` has changed.
16
17 The new configuration array structure:
18
19 .. code-block:: php
20
21         'DB' => [
22                 'Connections' => [
23                         'Default' => [
24                                 'driver' => 'mysqli',
25                                 'dbname' => 'typo3_database',
26                                 'password' => 'typo3',
27                                 'host' => '127.0.0.1',
28                                 'port' => 3306,
29                                 'user' => 'typo3',
30                                 'unix_socket' => '',
31                                 'charset' => 'utf-8',
32                         ],
33                 ],
34         ],
35
36 Be aware that besides the deeper nesting below 'Connections/Default' some of the configuration
37 keys have been renamed. It is required to provide the new configuration key `driver` with a
38 value of `mysqli` explicitly.
39
40 The following table lists the changed configuration keys and the appropriate values if these
41 have changed.
42
43 ============================   ===============================================
44 Old name                       New name
45 ============================   ===============================================
46 DB/username                    DB/Connections/Default/user
47 DB/password                    DB/Connections/Default/password
48 DB/host                        DB/Connections/Default/host
49 DB/port                        DB/Connections/Default/port
50 DB/socket                      DB/Connections/Default/unix_socket
51 DB/database                    DB/Connections/Default/dbname
52 SYS/setDBinit                  DB/Connections/Default/initCommands
53 SYS/no_pconnect                DB/Connections/Default/persistentConnection
54 SYS/dbClientCompress           DB/Connections/Default/driverOptions
55                                Valid values for MySQLi connections:
56                                0  compression disabled
57                                32 compression enabled
58 ============================   ===============================================
59
60
61 Impact
62 ======
63
64 Connections to the database will fail with an exception until the configuration has been migrated
65 to the new structure.
66
67
68 Affected Installations
69 ======================
70
71 All Installations
72
73
74 Migration
75 =========
76
77 The Install Tool will migrate the configuration information for the default connection to the new
78 format. Installations overriding the database configuration using `AdditionalConfiguration.php`
79 or other means need to ensure the new format is being used.
80
81 .. index:: Database, LocalConfiguration