Skip to content

Commit e275970

Browse files
authored
Improve formatting of connection options (#8284)
Right now the names of the options aren't easy to scan. Having a list with code formatting on the option names improves readability.
1 parent 5e4e8ea commit e275970

1 file changed

Lines changed: 24 additions & 46 deletions

File tree

docs/en/orm/database-basics.md

Lines changed: 24 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -188,99 +188,77 @@ use a non-default connection, see [Configuring Table Connections](../orm/table-o
188188
There are a number of keys supported in database configuration. A full list is
189189
as follows:
190190

191-
className
192-
: The fully namespaced class name of the class that represents the connection to a database server.
191+
- `className`: The fully namespaced class name of the class that represents the connection to a database server.
193192
This class is responsible for loading the database driver, providing SQL
194193
transaction mechanisms and preparing SQL statements among other things.
195194

196-
driver
197-
: The class name of the driver used to implement all specificities for
195+
- `driver`: The class name of the driver used to implement all specificities for
198196
a database engine. This can either be a short classname using `plugin syntax`,
199197
a fully namespaced name, or a constructed driver instance.
200198
Examples of short classnames are Mysql, Sqlite, Postgres, and Sqlserver.
201199

202-
persistent
203-
: Whether or not to use a persistent connection to the database. This option
200+
- `persistent`: Whether or not to use a persistent connection to the database. This option
204201
is not supported by SqlServer. An exception is thrown if you attempt to set
205202
`persistent` to `true` with SqlServer.
206203

207-
host
208-
: The database server's hostname (or IP address).
204+
- `host`: The database server's hostname (or IP address).
209205

210-
username
211-
: The username for the account.
206+
- `username`: The username for the account.
212207

213-
password
214-
: The password for the account.
208+
- `password`: The password for the account.
215209

216-
database
217-
: The name of the database for this connection to use. Avoid using `.` in
210+
- `database`: The name of the database for this connection to use. Avoid using `.` in
218211
your database name. Because of how it complicates identifier quoting CakePHP
219212
does not support `.` in database names. The path to your SQLite database
220213
should be an absolute path (for example, `ROOT . DS . 'my_app.db'`) to avoid
221214
incorrect paths caused by relative paths.
222215

223-
port (*optional*)
224-
: The TCP port or Unix socket used to connect to the server.
216+
- `port`: The TCP port or Unix socket used to connect to the server
217+
(*optional*).
225218

226-
encoding
227-
: Indicates the character set to use when sending SQL statements to
219+
- `encoding`: Indicates the character set to use when sending SQL statements to
228220
the server. This defaults to the database's default encoding for
229221
all databases other than DB2.
230222

231-
timezone
232-
: Server timezone to set.
223+
- `timezone`: Server timezone to set.
233224

234-
schema
235-
: Used in PostgreSQL database setups to specify which schema to use.
225+
- `schema`: Used in PostgreSQL database setups to specify which schema to use.
236226

237-
unix_socket
238-
: Used by drivers that support it to connect via Unix socket files. If you are
227+
- `unix_socket`: Used by drivers that support it to connect via Unix socket files. If you are
239228
using PostgreSQL and want to use Unix sockets, leave the host key blank.
240229

241-
ssl_key
242-
: The file path to the SSL key file. (Only supported by MySQL).
230+
- `ssl_key`: The file path to the SSL key file. (Only supported by MySQL).
243231

244-
ssl_cert
245-
: The file path to the SSL certificate file. (Only supported by MySQL).
232+
- `ssl_cert`: The file path to the SSL certificate file. (Only supported by MySQL).
246233

247-
ssl_ca
248-
: The file path to the SSL certificate authority. (Only supported by MySQL).
234+
- `ssl_ca`: The file path to the SSL certificate authority. (Only supported by MySQL).
249235

250-
init
251-
: A list of queries that should be sent to the database server as
236+
- `init`: A list of queries that should be sent to the database server as
252237
when the connection is created.
253238

254-
log
255-
: Set to `true` to enable query logging. When enabled queries will be logged
239+
- `log`: Set to `true` to enable query logging. When enabled queries will be logged
256240
at a `debug` level with the `queriesLog` scope.
257241

258-
quoteIdentifiers
259-
: Set to `true` if you are using reserved words or special characters in
242+
- `quoteIdentifiers`: Set to `true` if you are using reserved words or special characters in
260243
your table or column names. Enabling this setting will result in queries
261244
built using the [Query Builder](../orm/query-builder) having identifiers quoted when
262245
creating SQL. It should be noted that this decreases performance because
263246
each query needs to be traversed and manipulated before being executed.
264247

265-
flags
266-
: An associative array of PDO constants that should be passed to the
248+
- `flags`: An associative array of PDO constants that should be passed to the
267249
underlying PDO instance. See the PDO documentation for the flags supported
268250
by the driver you are using.
269251

270-
cacheMetadata
271-
: Either boolean `true`, or a string containing the cache configuration to
252+
- `cacheMetadata`: Either boolean `true`, or a string containing the cache configuration to
272253
store meta data in. Having metadata caching disabled by setting it to `false`
273254
is not advised and can result in very poor performance. See the
274255
[Database Metadata Cache](#database-metadata-cache) section for more information.
275256

276-
mask
277-
: Set the permissions on the generated database file. (Only supported by SQLite)
257+
- `mask`: Set the permissions on the generated database file. (Only supported by SQLite)
278258

279-
cache
280-
: The `cache` flag to send to SQLite.
259+
- `cache`: The `cache` flag to send to SQLite.
281260

282-
mode
283-
: The `mode` flag value to send to SQLite.
261+
- `mode`: The `mode` flag value to send to SQLite.
284262

285263
### SqlServer Entra Authentication
286264

0 commit comments

Comments
 (0)