L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-86294 core: Document missing dboptions in config-dist.php

Browse Source 
For the full list of database config settings, the config-dist.php file
referred to https://docs.moodle.org/en/Database_settings, which in turn
pointed back to
https://github.com/moodle/moodle/blob/master/config-dist.php. We should
not play hide and seek with our configuration options, so let's document
them.

Signed-off-by: Daniel Ziegenberg <[email protected]>
This commit is contained in:
Daniel Ziegenberg
2025-08-17 17:04:30 +02:00
parent 2b96047622
commit 89111fffa7
1 changed files with 100 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files
config-dist.php
+100 -89
View File
@@ -38,94 +38,106 @@ $CFG = new stdClass();
// will be stored. This database must already have been created //
// and a username/password created to access it. //
$CFG->dbtype = 'pgsql'; // 'pgsql', 'mariadb', 'mysqli', 'auroramysql', or 'sqlsrv'
$CFG->dblibrary = 'native'; // 'native' only at the moment
$CFG->dbhost = 'localhost'; // eg 'localhost' or 'db.isp.com' or IP
$CFG->dbname = 'moodle'; // database name, eg moodle
$CFG->dbuser = 'username'; // your database username
$CFG->dbpass = 'password'; // your database password
$CFG->prefix = 'mdl_'; // prefix to use for all table names
$CFG->dboptions = array(
'dbpersist' => false, // should persistent database connections be
// used? set to 'false' for the most stable
// setting, 'true' can improve performance
// sometimes
'dbsocket' => false, // should connection via UNIX socket be used?
// if you set it to 'true' or custom path
// here set dbhost to 'localhost',
// (please note mysql is always using socket
// if dbhost is 'localhost' - if you need
// local port connection use '127.0.0.1')
'dbport' => '', // the TCP port number to use when connecting
// to the server. keep empty string for the
// default port
'dbhandlesoptions' => false,// On PostgreSQL poolers like pgbouncer don't
// support advanced options on connection.
// If you set those in the database then
// the advanced settings will not be sent.
'dbcollation' => 'utf8mb4_unicode_ci', // MySQL has partial and full UTF-8
// support. If you wish to use partial UTF-8
// (three bytes) then set this option to
// 'utf8_unicode_ci'. If using the recommended
// settings with full UTF-8 support this should
// be set to 'utf8mb4_unicode_ci'. This option
// should be removed for all other databases.
// 'versionfromdb' => false, // On MySQL and MariaDB, this can force
// the DB version to be evaluated using
// the VERSION function instead of the version
// provided by the PHP client which could be
// wrong based on the DB server infrastructure,
// e.g. PaaS on Azure. Default is false/unset.
// Uncomment and set to true to force MySQL and
// MariaDB to use 'SELECT VERSION();'.
// 'extrainfo' => [], // Extra information for the DB driver, e.g. SQL Server,
// has additional configuration according to its environment,
// which the administrator can specify to alter and
// override any connection options.
// 'ssl' => '', // A connection mode string from the list below.
// Not supported by all drivers.
// prefer Use SSL if available - postgres default Postgres only
// disable Force non secure connection Postgres only
// require Force SSL Postgres and MySQL
// verify-full Force SSL and verify root CA Postgres and MySQL
// All mode names are adopted from Postgres
// and other databases align where possible:
// Postgres: https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-SSLMODE
// MySql: https://www.php.net/manual/en/mysqli.real-connect.php
// It is worth noting that for MySQL require and verify-full are the same - in both cases
// verification will take place if you specify hostname as a name,
// and it will be omitted if you put an IP address.
// 'fetchbuffersize' => 100000, // On PostgreSQL, this option sets a limit
// on the number of rows that are fetched into
// memory when doing a large recordset query
// (e.g. search indexing). Default is 100000.
// Uncomment and set to a value to change it,
// or zero to turn off the limit. You need to
// set to zero if you are using pg_bouncer in
// 'transaction' mode (it is fine in 'session'
// mode).
// 'clientcompress' => true // Use compression protocol to communicate with the database server.
// Decreases traffic from the database server.
// Not needed if the databse is on the same host.
// Currently supported only with mysqli, mariadb, and aurora drivers.
$CFG->dbtype = 'pgsql'; // 'pgsql', 'mariadb', 'mysqli', 'auroramysql', or 'sqlsrv'
$CFG->dblibrary = 'native'; // 'native' only at the moment
$CFG->dbhost = 'localhost'; // eg 'localhost' or 'db.isp.com' or IP
$CFG->dbname = 'moodle'; // database name, eg moodle
$CFG->dbuser = 'username'; // your database username
$CFG->dbpass = 'password'; // your database password
$CFG->prefix = 'mdl_'; // prefix to use for all table names
$CFG->dboptions = [
'dbpersist' => false, // Should persistent database connections be
// used? Set to 'false' for the most stable
// setting, 'true' can improve performance
// sometimes
'dbsocket' => false, // Should connection via UNIX socket be used?
// if you set it to 'true' or custom path
// here set dbhost to 'localhost',
// (please note mysql is always using socket
// if dbhost is 'localhost' - if you need
// local port connection use '127.0.0.1')
'dbport' => '', // The TCP port number to use when connecting
// to the server. Keep empty string for the
// default port
'dbhandlesoptions' => false, // On PostgreSQL poolers like pgbouncer don't
// support advanced options on connection.
// If you set those in the database then
// the advanced settings will not be sent.
'dbcollation' => 'utf8mb4_unicode_ci', // MySQL has partial and full UTF-8
// support. If you wish to use partial UTF-8
// (three bytes) then set this option to
// 'utf8_unicode_ci'. If using the recommended
// settings with full UTF-8 support this should
// be set to 'utf8mb4_unicode_ci'. This option
// should be removed for all other databases.
// 'dbschema' => '', // On PostgreSQL this sets the database schema to use
// for the connection.
// 'dbtransactions' => null // Set this to true to explicitly enable database transactions
// for MySQL. By default only the following storage engines are
// configured to use transactions: InnoDB, INNOBASE, BDB, XtraDB,
// Aria, Falcon.
// 'versionfromdb' => false, // On MySQL and MariaDB, this can force
// the DB version to be evaluated using
// the VERSION function instead of the version
// provided by the PHP client which could be
// wrong based on the DB server infrastructure,
// e.g. PaaS on Azure. Default is false/unset.
// Uncomment and set to true to force MySQL and
// MariaDB to use 'SELECT VERSION();'.
// 'extrainfo' => [], // Extra information for the DB driver, e.g. SQL Server,
// has additional configuration according to its environment,
// which the administrator can specify to alter and
// override any connection options.
// 'ssl' => '', // A connection mode string from the list below.
// Not supported by all drivers.
// prefer Use SSL if available - postgres default Postgres only
// disable Force non secure connection Postgres only
// require Force SSL Postgres and MySQL
// verify-full Force SSL and verify root CA Postgres and MySQL
// All mode names are adopted from Postgres
// and other databases align where possible:
// Postgres: https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-SSLMODE
// MySQL: https://www.php.net/manual/en/mysqli.real-connect.php
// It is worth noting that for MySQL require and verify-full are the same - in both cases
// verification will take place if you specify hostname as a name,
// and it will be omitted if you put an IP address.
// 'fetchbuffersize' => 100000, // On PostgreSQL, this option sets a limit
// on the number of rows that are fetched into
// memory when doing a large recordset query
// (e.g. search indexing). Default is 100000.
// Uncomment and set to a value to change it,
// or zero to turn off the limit. You need to
// set to zero if you are using pg_bouncer in
// 'transaction' mode (it is fine in 'session'
// mode).
// 'clientcompress' => true // Use compression protocol to communicate with the database server.
// Decreases traffic from the database server.
// Not needed if the databse is on the same host.
// Currently supported only with mysqli, mariadb, and aurora drivers.
// 'connecttimeout' => null, // Set connect timeout in seconds. Not all drivers support it.
// 'logall' => false, // Log all queries to the database. They are stored in the table log_queries.
// 'logslow' => 0, // Log slow queries to the database. They are stored in the table log_queries.
// This parameter controls the threshold in milliseconds and requires an integer,
// not a string!
// 'logerror' => false, // Log erroneous queries to the database. They are stored in the table log_queries.
// 'bulkinsertsize' => null, // Set the bulk insert size for database operations. MySQL has a relatively small
// query length limit by default, make sure 'max_allowed_packet' in my.cnf is
// high enough if you set this setting.
// 'readonly' => [ // Set to read-only replica details, to get safe reads
// from there instead of the primary node. Optional.
// Currently supported by pgsql and mysqli variety classes.
// If not supported silently ignored.
// 'instance' => [ // Readonly replica connection parameters
// [
// 'dbhost' => 'replica.dbhost',
// 'dbport' => '', // Defaults to primary port
// 'dbuser' => '', // Defaults to primary user
// 'dbpass' => '', // Defaults to primary password
// ],
// [...],
// ],
/*
'connecttimeout' => null, // Set connect timeout in seconds. Not all drivers support it.
'readonly' => [ // Set to read-only replica details, to get safe reads
// from there instead of the primary node. Optional.
// Currently supported by pgsql and mysqli variety classes.
// If not supported silently ignored.
'instance' => [ // Readonly replica connection parameters
[
'dbhost' => 'replica.dbhost',
'dbport' => '', // Defaults to primary port
'dbuser' => '', // Defaults to primary user
'dbpass' => '', // Defaults to primary password
],
[...],
],
Instance(s) can alternatively be specified as:
'instance' => 'replica.dbhost',
'instance' => ['replica.dbhost1', 'replica.dbhost2'],
'instance' => ['dbhost' => 'replica.dbhost', 'dbport' => '', 'dbuser' => '', 'dbpass' => ''],
@@ -146,9 +158,8 @@ $CFG->dboptions = array(
More info available in lib/dml/moodle_read_replica_trait.php where the feature is implemented.
]
*/
// For all database config settings see https://docs.moodle.org/en/Database_settings
);
*/
];
//=========================================================================