Skip to content

Commit 4ccc1e7

Browse files
authored
Fix CONFIG (#408)
Fix readme
1 parent 3dae3d0 commit 4ccc1e7

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

CONFIG.md

+33
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,39 @@ Current options:
256256
`pg_bigint_hash`: PARTITION BY HASH (Postgres hashing function)
257257
`sha1`: A hashing function based on SHA1
258258

259+
### auth_query
260+
```
261+
path: pools.<pool_name>.auth_query
262+
default: <UNSET>
263+
example: "SELECT $1"
264+
```
265+
266+
Query to be sent to servers to obtain the hash used for md5 authentication. The connection will be
267+
established using the database configured in the pool. This parameter is inherited by every pool
268+
and can be redefined in pool configuration.
269+
270+
### auth_query_user
271+
```
272+
path: pools.<pool_name>.auth_query_user
273+
default: <UNSET>
274+
example: "sharding_user"
275+
```
276+
277+
User to be used for connecting to servers to obtain the hash used for md5 authentication by sending the query
278+
specified in `auth_query_user`. The connection will be established using the database configured in the pool.
279+
This parameter is inherited by every pool and can be redefined in pool configuration.
280+
281+
### auth_query_password
282+
```
283+
path: pools.<pool_name>.auth_query_password
284+
default: <UNSET>
285+
example: "sharding_user"
286+
```
287+
288+
Password to be used for connecting to servers to obtain the hash used for md5 authentication by sending the query
289+
specified in `auth_query_user`. The connection will be established using the database configured in the pool.
290+
This parameter is inherited by every pool and can be redefined in pool configuration.
291+
259292
### automatic_sharding_key
260293
```
261294
path: pools.<pool_name>.automatic_sharding_key

pgcat.toml

+15
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,21 @@ primary_reads_enabled = true
113113
# `sha1`: A hashing function based on SHA1
114114
sharding_function = "pg_bigint_hash"
115115

116+
# Query to be sent to servers to obtain the hash used for md5 authentication. The connection will be
117+
# established using the database configured in the pool. This parameter is inherited by every pool
118+
# and can be redefined in pool configuration.
119+
# auth_query = "SELECT $1"
120+
121+
# User to be used for connecting to servers to obtain the hash used for md5 authentication by sending the query
122+
# specified in `auth_query_user`. The connection will be established using the database configured in the pool.
123+
# This parameter is inherited by every pool and can be redefined in pool configuration.
124+
# auth_query_user = "sharding_user"
125+
126+
# Password to be used for connecting to servers to obtain the hash used for md5 authentication by sending the query
127+
# specified in `auth_query_user`. The connection will be established using the database configured in the pool.
128+
# This parameter is inherited by every pool and can be redefined in pool configuration.
129+
# auth_query_password = "sharding_user"
130+
116131
# Automatically parse this from queries and route queries to the right shard!
117132
# automatic_sharding_key = "data.id"
118133

0 commit comments

Comments
 (0)