Skip to content

Commit 5143500

Browse files
authored
docs: complete the missing general items (#553)
docs: complete the missing general items.
1 parent 3255323 commit 5143500

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

CONFIG.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,38 @@ default: 86400000 # 24 hours
5757

5858
Max connection lifetime before it's closed, even if actively used.
5959

60+
### server_round_robin
61+
```
62+
path: general.server_round_robin
63+
default: false
64+
```
65+
66+
Whether to use round robin for server selection or not.
67+
68+
### server_tls
69+
```
70+
path: general.server_tls
71+
default: false
72+
```
73+
74+
Whether to use TLS for server connections or not.
75+
76+
### verify_server_certificate
77+
```
78+
path: general.verify_server_certificate
79+
default: false
80+
```
81+
82+
Whether to verify server certificate or not.
83+
84+
### verify_config
85+
```
86+
path: general.verify_config
87+
default: true
88+
```
89+
90+
Whether to verify config or not.
91+
6092
### idle_client_in_transaction_timeout
6193
```
6294
path: general.idle_client_in_transaction_timeout
@@ -194,6 +226,55 @@ default: "admin_pass"
194226

195227
Password to access the virtual administrative database
196228

229+
### auth_query
230+
```
231+
path: general.auth_query
232+
default: <UNSET>
233+
example: "SELECT $1"
234+
```
235+
236+
Query to be sent to servers to obtain the hash used for md5 authentication. The connection will be
237+
established using the database configured in the pool. This parameter is inherited by every pool
238+
and can be redefined in pool configuration.
239+
240+
### auth_query_user
241+
```
242+
path: general.auth_query_user
243+
default: <UNSET>
244+
example: "sharding_user"
245+
```
246+
247+
User to be used for connecting to servers to obtain the hash used for md5 authentication by sending the query
248+
specified in `auth_query_user`. The connection will be established using the database configured in the pool.
249+
This parameter is inherited by every pool and can be redefined in pool configuration.
250+
251+
### auth_query_password
252+
```
253+
path: general.auth_query_password
254+
default: <UNSET>
255+
example: "sharding_user"
256+
```
257+
258+
Password to be used for connecting to servers to obtain the hash used for md5 authentication by sending the query
259+
specified in `auth_query_user`. The connection will be established using the database configured in the pool.
260+
This parameter is inherited by every pool and can be redefined in pool configuration.
261+
262+
### prepared_statements
263+
```
264+
path: general.prepared_statements
265+
default: false
266+
```
267+
268+
Whether to use prepared statements or not.
269+
270+
### prepared_statements_cache_size
271+
```
272+
path: general.prepared_statements_cache_size
273+
default: 500
274+
```
275+
276+
Size of the prepared statements cache.
277+
197278
### dns_cache_enabled
198279
```
199280
path: general.dns_cache_enabled

0 commit comments

Comments
 (0)