DbConfig

Type

Class

Namespace

craft\config

Inherits

craft\config\DbConfig » yii\base\BaseObject

Implements

yii\base\Configurable

Since

3.0.0

DB config class

View source

Public Properties

Property	Description
attributes	array – An array of key => value pairs of PDO attributes to pass into the PDO constructor.
charset	string – The charset to use when creating tables.
collation	string, null – The collation to use when creating tables.
database	string, null – The name of the database to select.
driver	string, null – The database driver to use.
dsn	string, null – The Data Source Name (“DSN”) that tells Craft how to connect to the database.
password	string – The database password to connect with.
port	integer, null – The database server port.
schema	string – The schema that Postgres is configured to use by default (PostgreSQL only).
server	string, null – The database server name or IP address.
setSchemaOnConnect	boolean – Whether the schema should be explicitly used for database queries (PostgreSQL only).
tablePrefix	string – If you’re sharing Craft installs in a single database (MySQL) or a single database and using a shared schema (PostgreSQL), you can set a table prefix here to avoid per-install table naming conflicts.
unixSocket	string, null – MySQL only.
url	string, null – The database connection URL, if one was provided by your hosting environment.
useUnbufferedConnections	boolean – Whether batched queries should be executed on a separate, unbuffered database connection.
user	string – The database username to connect with.

attributes

Type

array

Default value

[]

An array of key => value pairs of PDO attributes to pass into the PDO constructor.

For example, when using the MySQL PDO driver, if you wanted to enable a SSL database connection (assuming SSL is enabled in MySQL and 'user' can connect via SSL, you’d set these:

[
    PDO::MYSQL_ATTR_SSL_KEY    => '/path/to/my/client-key.pem',
    PDO::MYSQL_ATTR_SSL_CERT   => '/path/to/my/client-cert.pem',
    PDO::MYSQL_ATTR_SSL_CA     => '/path/to/my/ca-cert.pem',
],

View source

charset

Type

string

Default value

'utf8'

The charset to use when creating tables.

TIP

You can change the character set and collation across all existing database tables using this terminal command:

> php craft db/convert-charset

View source

collation

Type

string, null

Default value

null

Since

3.6.4

The collation to use when creating tables.

This is only used by MySQL. If null, the charset’s default collation will be used.

Charset	Default collation
utf8	utf8_general_ci
utf8mb4	utf8mb4_0900_ai_ci

TIP

You can change the character set and collation across all existing database tables using this terminal command:

> php craft db/convert-charset

View source

database

Type

string, null

Default value

null

The name of the database to select.

View source

driver

Type

string, null

Default value

null

The database driver to use. Either mysql for MySQL or pgsql for PostgreSQL.

View source

dsn

Type

string, null

Default value

null

The Data Source Name (“DSN”) that tells Craft how to connect to the database.

DSNs should begin with a driver prefix (mysql: or pgsql:), followed by driver-specific parameters. For example, mysql:host=127.0.0.1;port=3306;dbname=acme_corp.

• MySQL parameters: https://php.net/manual/en/ref.pdo-mysql.connection.php
• PostgreSQL parameters: https://php.net/manual/en/ref.pdo-pgsql.connection.php

View source

password

Type

string

Default value

''

The database password to connect with.

View source

port

Type

integer, null

Default value

null

The database server port. Defaults to 3306 for MySQL and 5432 for PostgreSQL.

View source

schema

Type

string

Default value

'public'

The schema that Postgres is configured to use by default (PostgreSQL only).

TIP

To force Craft to use the specified schema regardless of PostgreSQL’s search_path setting, you must enable the setSchemaOnConnect setting.

See also https://www.postgresql.org/docs/8.2/static/ddl-schemas.html

View source

server

Type

string, null

Default value

null

The database server name or IP address. Usually localhost or 127.0.0.1.

View source

setSchemaOnConnect

Type

boolean

Default value

false

Since

3.7.27

Whether the schema should be explicitly used for database queries (PostgreSQL only).

WARNING

This will cause an extra SET search_path SQL query to be executed per database connection. Ideally, PostgreSQL’s search_path setting should be configured to prioritize the desired schema.

View source

tablePrefix

Type

string

Default value

''

If you’re sharing Craft installs in a single database (MySQL) or a single database and using a shared schema (PostgreSQL), you can set a table prefix here to avoid per-install table naming conflicts. This can be no more than 5 characters, and must be all lowercase.

View source

unixSocket

Type

string, null

Default value

null

MySQL only. If this is set, the CLI connection string (used for yiic) will connect to the Unix socket instead of the server and port. If this is specified, then server and port settings are ignored.

View source

url

Type

string, null

Default value

null

The database connection URL, if one was provided by your hosting environment.

If this is set, the values for driver, user, database, server, port, and database will be extracted from it.

View source

useUnbufferedConnections

Type

boolean

Default value

false

Since

3.7.0

Whether batched queries should be executed on a separate, unbuffered database connection.

This setting only applies to MySQL. It can be enabled when working with high volume content, to prevent PHP from running out of memory when querying too much data at once. (See https://www.yiiframework.com/doc/guide/2.0/en/db-query-builder#batch-query-mysql for an explanation of MySQL’s batch query limitations.)

View source

user

Type

string

Default value

'root'

The database username to connect with.

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__construct()	Constructor.
__get()	Returns the value of an object property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets value of an object property.
__unset()	Sets an object property to null.
canGetProperty()	Returns a value indicating whether a property can be read.
canSetProperty()	Returns a value indicating whether a property can be set.
className()	Returns the fully qualified name of this class.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined.
init()	Initializes the object.
updateDsn()	Updates the DSN string based on the config setting values.

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

Throws

• yii\base\InvalidConfigException

updateDsn()

DEPRECATED

Deprecated in 3.4.0.

Updates the DSN string based on the config setting values.

View source

Throws

• yii\base\InvalidConfigException
  if driver isn’t set to mysql or pgsql.

Constants

Constant	Description
DRIVER_MYSQL
DRIVER_PGSQL