Merge pull request #552 from craftcms/feature/externalize-artifacts

External Artifacts

docs/.artifacts/cms/3.x/config-db.md

@@ -0,0 +1,379 @@
+<!-- This file is generated in an automated workflow based on Craft source files. Changes to it will be overwritten the next time the docs are built. -->
+
+<!-- BEGIN SETTINGS -->
+
+### `attributes`
+
+<div class="compact">
+
+Allowed types
+:  [array](https://php.net/language.types.array)
+
+Default value
+:  `[]`
+
+Defined by
+:  [DbConfig::$attributes](craft3:craft\config\DbConfig::$attributes)
+
+</div>
+
+An array of key => value pairs of PDO attributes to pass into the PDO constructor.
+
+For example, when using the [MySQL PDO driver](https://php.net/manual/en/ref.pdo-mysql.php), if you wanted to enable a SSL database connection
+(assuming [SSL is enabled in MySQL](https://dev.mysql.com/doc/mysql-secure-deployment-guide/5.7/en/secure-deployment-secure-connections.html) and `'user'` can connect via SSL,
+you’d set these:
+
+```php
+[
+    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',
+],
+```
+
+
+
+### `charset`
+
+<div class="compact">
+
+Allowed types
+:  [string](https://php.net/language.types.string)
+
+Default value
+:  `'utf8'`
+
+Defined by
+:  [DbConfig::$charset](craft3:craft\config\DbConfig::$charset)
+
+</div>
+
+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:
+
+```bash
+> php craft db/convert-charset
+```
+:::
+
+
+
+### `collation`
+
+<div class="compact">
+
+Allowed types
+:  [string](https://php.net/language.types.string), [null](https://php.net/language.types.null)
+
+Default value
+:  `null`
+
+Defined by
+:  [DbConfig::$collation](craft3:craft\config\DbConfig::$collation)
+
+Since
+:  3.6.4
+
+</div>
+
+The collation to use when creating tables.
+
+This is only used by MySQL. If null, the [charset’s](https://docs.craftcms.com/api/v3/craft-config-dbconfig.html#charset) 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:
+
+```bash
+> php craft db/convert-charset
+```
+:::
+
+
+
+### `database`
+
+<div class="compact">
+
+Allowed types
+:  [string](https://php.net/language.types.string), [null](https://php.net/language.types.null)
+
+Default value
+:  `null`
+
+Defined by
+:  [DbConfig::$database](craft3:craft\config\DbConfig::$database)
+
+</div>
+
+The name of the database to select.
+
+
+
+### `driver`
+
+<div class="compact">
+
+Allowed types
+:  [string](https://php.net/language.types.string), [null](https://php.net/language.types.null)
+
+Default value
+:  `null`
+
+Defined by
+:  [DbConfig::$driver](craft3:craft\config\DbConfig::$driver)
+
+</div>
+
+The database driver to use. Either `mysql` for MySQL or `pgsql` for PostgreSQL.
+
+
+
+### `dsn`
+
+<div class="compact">
+
+Allowed types
+:  [string](https://php.net/language.types.string), [null](https://php.net/language.types.null)
+
+Default value
+:  `null`
+
+Defined by
+:  [DbConfig::$dsn](craft3:craft\config\DbConfig::$dsn)
+
+</div>
+
+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>
+
+
+
+### `password`
+
+<div class="compact">
+
+Allowed types
+:  [string](https://php.net/language.types.string)
+
+Default value
+:  `''`
+
+Defined by
+:  [DbConfig::$password](craft3:craft\config\DbConfig::$password)
+
+</div>
+
+The database password to connect with.
+
+
+
+### `port`
+
+<div class="compact">
+
+Allowed types
+:  [integer](https://php.net/language.types.integer), [null](https://php.net/language.types.null)
+
+Default value
+:  `null`
+
+Defined by
+:  [DbConfig::$port](craft3:craft\config\DbConfig::$port)
+
+</div>
+
+The database server port. Defaults to 3306 for MySQL and 5432 for PostgreSQL.
+
+
+
+### `schema`
+
+<div class="compact">
+
+Allowed types
+:  [string](https://php.net/language.types.string)
+
+Default value
+:  `'public'`
+
+Defined by
+:  [DbConfig::$schema](craft3:craft\config\DbConfig::$schema)
+
+</div>
+
+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](https://docs.craftcms.com/api/v3/craft-config-dbconfig.html#setschemaonconnect) setting.
+:::
+
+
+
+### `server`
+
+<div class="compact">
+
+Allowed types
+:  [string](https://php.net/language.types.string), [null](https://php.net/language.types.null)
+
+Default value
+:  `null`
+
+Defined by
+:  [DbConfig::$server](craft3:craft\config\DbConfig::$server)
+
+</div>
+
+The database server name or IP address. Usually `localhost` or `127.0.0.1`.
+
+
+
+### `setSchemaOnConnect`
+
+<div class="compact">
+
+Allowed types
+:  [boolean](https://php.net/language.types.boolean)
+
+Default value
+:  `false`
+
+Defined by
+:  [DbConfig::$setSchemaOnConnect](craft3:craft\config\DbConfig::$setSchemaOnConnect)
+
+Since
+:  3.7.27
+
+</div>
+
+Whether the [schema](https://docs.craftcms.com/api/v3/craft-config-dbconfig.html#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.
+:::
+
+
+
+### `tablePrefix`
+
+<div class="compact">
+
+Allowed types
+:  [string](https://php.net/language.types.string)
+
+Default value
+:  `''`
+
+Defined by
+:  [DbConfig::$tablePrefix](craft3:craft\config\DbConfig::$tablePrefix)
+
+</div>
+
+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.
+
+
+
+### `unixSocket`
+
+<div class="compact">
+
+Allowed types
+:  [string](https://php.net/language.types.string), [null](https://php.net/language.types.null)
+
+Default value
+:  `null`
+
+Defined by
+:  [DbConfig::$unixSocket](craft3:craft\config\DbConfig::$unixSocket)
+
+</div>
+
+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.
+
+
+
+### `url`
+
+<div class="compact">
+
+Allowed types
+:  [string](https://php.net/language.types.string), [null](https://php.net/language.types.null)
+
+Default value
+:  `null`
+
+Defined by
+:  [DbConfig::$url](craft3:craft\config\DbConfig::$url)
+
+</div>
+
+The database connection URL, if one was provided by your hosting environment.
+
+If this is set, the values for [driver](https://docs.craftcms.com/api/v3/craft-config-dbconfig.html#driver), [user](https://docs.craftcms.com/api/v3/craft-config-dbconfig.html#user), [database](https://docs.craftcms.com/api/v3/craft-config-dbconfig.html#database), [server](https://docs.craftcms.com/api/v3/craft-config-dbconfig.html#server), [port](https://docs.craftcms.com/api/v3/craft-config-dbconfig.html#port), and [database](https://docs.craftcms.com/api/v3/craft-config-dbconfig.html#database) will be extracted from it.
+
+
+
+### `useUnbufferedConnections`
+
+<div class="compact">
+
+Allowed types
+:  [boolean](https://php.net/language.types.boolean)
+
+Default value
+:  `false`
+
+Defined by
+:  [DbConfig::$useUnbufferedConnections](craft3:craft\config\DbConfig::$useUnbufferedConnections)
+
+Since
+:  3.7.0
+
+</div>
+
+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.)
+
+
+
+### `user`
+
+<div class="compact">
+
+Allowed types
+:  [string](https://php.net/language.types.string)
+
+Default value
+:  `'root'`
+
+Defined by
+:  [DbConfig::$user](craft3:craft\config\DbConfig::$user)
+
+</div>
+
+The database username to connect with.
+
+
+
+
+<!-- END SETTINGS -->