site.ini [DatabaseSettings] #

The block [DatabaseSettings] of settings/site.ini, with 23 setting(s).

Never edit settings/site.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/site.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/site.ini.append.php for one siteaccess,
• extension/<extension>/settings/site.ini.append.php in an extension (read when the extension is active).

SQLitePragmas #

SQLite (DatabaseImplementation=sqlite3) only: the connection's PRAGMAs, one
per line as name=value, over the driver's defaults:
synchronous=NORMAL with WAL still crash-safe; FULL synced every commit
cache_size=-65536 64 MB page cache (SQLite's default is 2 MB)
mmap_size=268435456 read the file through 256 MB of mapped memory
temp_store=MEMORY sorts and temporary tables in memory
busy_timeout SQLiteBusyTimeout / SQLiteCLIBusyTimeout below; a
busy_timeout=<ms> line here still wins over both
Run php bin/php/ezexec.php on an ANALYZE script (or sqlite3 <file> ANALYZE)
after an install, so the query planner has statistics.

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
# an empty "SQLitePragmas[]" first replaces the shipped list; without it the items are added
SQLitePragmas[]
*/ ?>

SQLiteTransactionWait #

SQLite only: how many seconds a transaction (a publish, a save) waits at its
start for the other writers ahead of it, queued on <database>.writer-lock
next to the database file, before it gives up. Waiting there is safe: the
transaction has written nothing yet, and once it has started it cannot fail
for a lock. Keep it below the web server's request timeout, or the request
is killed before the driver can report "database is busy": Velocity ends a
request after its engine setting Q.webserver.requestTimeout, 30 s unless
changed (the client gets a 504), hence 25 here; under PHP-FPM the limit is
the pool's request_terminate_timeout. Raise both together.

Default: 25.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
SQLiteTransactionWait=25
*/ ?>

SQLiteCLITransactionWait #

SQLite only: the same wait on the command line (cronjobs, imports, scripts),
in seconds. Nobody waits for a page there, so a cronjob waits for a long
import's writes instead of stopping with "A database transaction in
Exponential failed".

Default: 300.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
SQLiteCLITransactionWait=300
*/ ?>

SQLiteBusyTimeout #

SQLite only: how many milliseconds a single statement outside a transaction
(an INSERT of a link, an UPDATE of a cronjob) waits for another write to end
before it fails with "database is busy: the statement waited N s". It
queues on the same <database>.writer-lock as a transaction, and a lock SQLite
reports at once is tried again within this time. SQLiteBusyTimeout applies to
web requests (PHP-FPM, Velocity), SQLiteCLIBusyTimeout to the command line.

Default: 5000.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
SQLiteBusyTimeout=5000
*/ ?>

SQLiteCLIBusyTimeout #

Default: 30000.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
SQLiteCLIBusyTimeout=30000
*/ ?>

DatabaseImplementation #

Default: ezmysqli.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
DatabaseImplementation=ezmysqli
*/ ?>

Server #

Default: localhost.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
Server=localhost
*/ ?>

Port #

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
Port=
*/ ?>

User #

Default: root.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
User=root
*/ ?>

Password #

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
Password=
*/ ?>

Database #

Default: nextgen.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
Database=nextgen
*/ ?>

UseSlaveServer #

Enable slave servers
The slave servers will only be used for read queries
Useful for load balanced environments

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
UseSlaveServer=disabled
*/ ?>

ConnectRetries #

SlaveServerArray[]=localhost
SlaveServerPort[]=
SlaverServerUser[]=nextgen
SlaverServerPassword[]=nextgen
SlaverServerDatabase[]=nextgen
The number of times to reconnect if the first fails

Default: 0.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
ConnectRetries=0
*/ ?>

Charset #

The charset to use for the database connection
If left empty the charset set in i18n.ini will be used,
which is often the most reasonable setting.

Default: utf-8.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
Charset=utf-8
*/ ?>

UseBuiltinEncoding #

Use charset conversion routines in DB if possible

Default: true.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
UseBuiltinEncoding=true
*/ ?>

Socket #

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
Socket=disabled
*/ ?>

QueryAnalysisOutput #

This controls if the queries should have an analysis done
for the debug output (Requires SQLOutput=enabled)
NOTE: Currently this only works for MySQL.

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
QueryAnalysisOutput=disabled
*/ ?>

SQLOutput #

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
SQLOutput=disabled
*/ ?>

SlowQueriesOutput #

When this setting is larger than 0 the Queries would only be shown in the
SQLOutput if the execution time took more than <setting> miliseconds.

Default: 0.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
SlowQueriesOutput=0
*/ ?>

DebugTransactions #

If enabled the system will store stack traces for all begin/commits in the
system. When an unbalanced nested transactions are detected it will output
all begin/commits with information on where it occured as a deep tree.
This tree can be used to debug the code and find the missing commit.

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
DebugTransactions=disabled
*/ ?>

ImplementationAlias #

Alias for implementations

Default: a hash of 9: mysql=eZMySQLiDB, mysqli=eZMySQLiDB, postgresql=eZPostgreSQLDB, ezmysql=eZMySQLiDB, ezmysqli=eZMySQLiDB, ezpostgresql=eZPostgreSQLDB, pgsql=eZPostgreSQLDB, sqlite3=eZSQLite3DB, mongodb=expMongoDB.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
# an empty "ImplementationAlias[]" first replaces the shipped list; without it the items are added
ImplementationAlias[]
ImplementationAlias[mysql]=eZMySQLiDB
ImplementationAlias[mysqli]=eZMySQLiDB
ImplementationAlias[postgresql]=eZPostgreSQLDB
ImplementationAlias[ezmysql]=eZMySQLiDB
ImplementationAlias[ezmysqli]=eZMySQLiDB
ImplementationAlias[ezpostgresql]=eZPostgreSQLDB
ImplementationAlias[pgsql]=eZPostgreSQLDB
ImplementationAlias[sqlite3]=eZSQLite3DB
ImplementationAlias[mongodb]=expMongoDB
*/ ?>

UsePersistentConnection #

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
UsePersistentConnection=disabled
*/ ?>

Transactions #

Use transactions to ensure that integrity of a database is maintained.
MySQL needs transaction safe-tables like the InnoDB table handler.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[DatabaseSettings]
Transactions=enabled
*/ ?>

Related #

• All blocks of site.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/site.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.