Skip to content

Commit 7808b64

Browse files
author
Kyle Farris
committed
Updated some formatting of the documentation.
1 parent f101e98 commit 7808b64

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -119,16 +119,16 @@ Standard Connection Settings
119119

120120
The options listed below are available for all database drivers. Additional properties may be passed if the driver of the database you are connecting to supports them. See the "Additional Connection Options" column above for a link to the a specific driver's connection options documentation.
121121

122-
| Option | Default | Optional | Description |
123-
| :-------- | :-------- | :-------- | :-------------------------------------------- |
124-
| host | localhost | No | The server you're connecting to |
125-
| user | NULL | No | The database user |
126-
| password | NULL | Yes | The database `user`'s password |
127-
| database | NULL | Yes | The database to connect to |
128-
| port | NULL | Yes | The database port to use when connecting |
129-
| pool_size | 10 | Yes | Max connections for `pool` connection type |
130-
| debug | false | Yes | If true, debug info will be place in app log |
131-
| version | default | Yes | Version of database driver to use |
122+
| Option | Default | Optional | Description |
123+
| :------------ | :-------- | :-------- | :-------------------------------------------- |
124+
| **host** | localhost | No | The server you're connecting to |
125+
| **user** | NULL | No | The database user |
126+
| **password** | NULL | Yes | The database `user`'s password |
127+
| **database** | NULL | Yes | The database to connect to |
128+
| **port** | NULL | Yes | The database port to use when connecting |
129+
| **pool_size** | 10 | Yes | Max connections for `pool` connection type |
130+
| **debug** | false | Yes | If true, debug info will be place in app log |
131+
| **version** | default | Yes | Version of database driver to use |
132132

133133
The best way to store these options is in a JSON file outsite of your web root where only root and the server user can access them.
134134

@@ -184,12 +184,12 @@ Choosing the Connection Type
184184

185185
This library currently supports 3 connection methods:
186186

187-
* single (default)
187+
* ***single*** (default)
188188
* This will use the driver's basic single connection capabilities. All connections to your app will use this single database connection. This is usually less than ideal for most web applications but might be quite suitable for command line scripts and the like.
189189
* **All drivers must have this connection type**.
190-
* pool
190+
* ***pool***
191191
* This will utilize the driver's connection pooling capabilities if it is offered. Connection pooling allows your application to pull from a pool of connections that were created by the driver. Typically the connections will be handed out to requesting methods in a round-robin fashion. This is ideal for a web application.
192-
* cluster
192+
* ***cluster***
193193
* When you have a cluster of servers and you want to create pools of connections to different servers to help load balance your stack, using the `cluster` connection type can come in handy. This is ideal for high-traffic web sites and applications that utilize a farm of database servers as opposed to just one.
194194

195195
**Note:**

0 commit comments

Comments
 (0)