|
| 1 | +# |
| 2 | +# PgCat config example. |
| 3 | +# |
| 4 | + |
| 5 | +# |
| 6 | +# General pooler settings |
| 7 | +[general] |
| 8 | +# What IP to run on, 0.0.0.0 means accessible from everywhere. |
| 9 | +host = "0.0.0.0" |
| 10 | + |
| 11 | +# Port to run on, same as PgBouncer used in this example. |
| 12 | +port = 6434 |
| 13 | + |
| 14 | +# Whether to enable prometheus exporter or not. |
| 15 | +enable_prometheus_exporter = true |
| 16 | + |
| 17 | +# Port at which prometheus exporter listens on. |
| 18 | +prometheus_exporter_port = 9930 |
| 19 | + |
| 20 | +# How long to wait before aborting a server connection (ms). |
| 21 | +connect_timeout = 5000 |
| 22 | + |
| 23 | +# How much time to give `SELECT 1` health check query to return with a result (ms). |
| 24 | +healthcheck_timeout = 1000 |
| 25 | + |
| 26 | +# How long to keep connection available for immediate re-use, without running a healthcheck query on it |
| 27 | +healthcheck_delay = 30000 |
| 28 | + |
| 29 | +# How much time to give clients during shutdown before forcibly killing client connections (ms). |
| 30 | +shutdown_timeout = 60000 |
| 31 | + |
| 32 | +# For how long to ban a server if it fails a health check (seconds). |
| 33 | +ban_time = 60 # seconds |
| 34 | + |
| 35 | +# If we should log client connections |
| 36 | +log_client_connections = false |
| 37 | + |
| 38 | +# If we should log client disconnections |
| 39 | +log_client_disconnections = false |
| 40 | + |
| 41 | +# TLS |
| 42 | +# tls_certificate = "server.cert" |
| 43 | +# tls_private_key = "server.key" |
| 44 | + |
| 45 | +# Credentials to access the virtual administrative database (pgbouncer or pgcat) |
| 46 | +# Connecting to that database allows running commands like `SHOW POOLS`, `SHOW DATABASES`, etc.. |
| 47 | +admin_username = "cipherstash" |
| 48 | +admin_password = "password" |
| 49 | + |
| 50 | +# pool |
| 51 | +# configs are structured as pool.<pool_name> |
| 52 | +# the pool_name is what clients use as database name when connecting |
| 53 | +# For the example below a client can connect using "postgres://sharding_user:sharding_user@pgcat_host:pgcat_port/sharded" |
| 54 | +[pools.cipherstash] |
| 55 | +# Pool mode (see PgBouncer docs for more). |
| 56 | +# session: one server connection per connected client |
| 57 | +# transaction: one server connection per client transaction |
| 58 | +pool_mode = "session" |
| 59 | + |
| 60 | +# If the client doesn't specify, route traffic to |
| 61 | +# this role by default. |
| 62 | +# |
| 63 | +# any: round-robin between primary and replicas, |
| 64 | +# replica: round-robin between replicas only without touching the primary, |
| 65 | +# primary: all queries go to the primary unless otherwise specified. |
| 66 | +default_role = "any" |
| 67 | + |
| 68 | +# Query parser. If enabled, we'll attempt to parse |
| 69 | +# every incoming query to determine if it's a read or a write. |
| 70 | +# If it's a read query, we'll direct it to a replica. Otherwise, if it's a write, |
| 71 | +# we'll direct it to the primary. |
| 72 | +query_parser_enabled = false |
| 73 | + |
| 74 | +# If the query parser is enabled and this setting is enabled, we'll attempt to |
| 75 | +# infer the role from the query itself. |
| 76 | +query_parser_read_write_splitting = false |
| 77 | + |
| 78 | +# If the query parser is enabled and this setting is enabled, the primary will be part of the pool of databases used for |
| 79 | +# load balancing of read queries. Otherwise, the primary will only be used for write |
| 80 | +# queries. The primary can always be explicitly selected with our custom protocol. |
| 81 | +primary_reads_enabled = true |
| 82 | + |
| 83 | +# So what if you wanted to implement a different hashing function, |
| 84 | +# or you've already built one and you want this pooler to use it? |
| 85 | +# |
| 86 | +# Current options: |
| 87 | +# |
| 88 | +# pg_bigint_hash: PARTITION BY HASH (Postgres hashing function) |
| 89 | +# sha1: A hashing function based on SHA1 |
| 90 | +# |
| 91 | +sharding_function = "pg_bigint_hash" |
| 92 | + |
| 93 | +# Credentials for users that may connect to this cluster |
| 94 | +[pools.cipherstash.users.0] |
| 95 | +username = "cipherstash" |
| 96 | +password = "password" |
| 97 | +# Maximum number of server connections that can be established for this user |
| 98 | +# The maximum number of connection from a single Pgcat process to any database in the cluster |
| 99 | +# is the sum of pool_size across all users. |
| 100 | +pool_size = 100 |
| 101 | +min_pool_size = 20 |
| 102 | + |
| 103 | +# Maximum query duration. Dangerous, but protects against DBs that died in a non-obvious way. |
| 104 | +statement_timeout = 0 |
| 105 | + |
| 106 | +# Shard 0 |
| 107 | +[pools.cipherstash.shards.0] |
| 108 | + |
| 109 | +servers = [["host.docker.internal", 5532, "primary"]] |
| 110 | + |
| 111 | +database = "cipherstash" |
0 commit comments