PostgreSQL

Search…
🐘
PostgreSQL
When using the PostgreSQL app driver, first configure your PostgreSQL connection credentials using environment variables:
Name
Default
Possible values
Description
DB_POSTGRES_HOST
127.0.0.1
Any string
The PostgreSQL host.
DB_POSTGRES_PORT
3306
Any integer
The PostgreSQL port.
DB_POSTGRES_USERNAME
root
Any string
The PostgreSQL username.
DB_POSTGRES_PASSWORD
password
Any string
The PostgreSQL password.
DB_POSTGRES_DATABASE
main
Any string
The PostgreSQL database.
This database supports database connection pooling.
Once you have configured your PostgreSQL database credentials, you should create a table with the following structure:
CREATE TABLE IF NOT EXISTS apps (
 id varchar(255) PRIMARY KEY,
 "key" varchar(255) NOT NULL,
 secret varchar(255) NOT NULL,
 max_connections integer NOT NULL,
 enable_client_messages smallint NOT NULL,
 "enabled" smallint NOT NULL,
 max_backend_events_per_sec integer NOT NULL,
 max_client_events_per_sec integer NOT NULL,
 max_read_req_per_sec integer NOT NULL,
 webhooks json
);
Environment Variables
The following environment variables are used to define the behavior of the PostgreSQL app driver:
Name
Default
Possible values
Description
APP_MANAGER_POSTGRES_TABLE
apps
Any string
The table to pull the app data from.
APP_MANAGER_POSTGRES_VERSION
13.3
Any string
The PostgreSQL version (utilized by the underlying Knex database abstraction layer).
Limits on an app-by-app basis
This feature is truly optional. To enforce app-level limits in PostgreSQL, you should add the following fields to your table:
max_presence_members_per_channel integer DEFAULT NULL,
max_presence_member_size_in_kb integer DEFAULT NULL,
max_channel_name_length integer DEFAULT NULL,
max_event_channels_at_once integer DEFAULT NULL,
max_event_name_length integer DEFAULT NULL,
max_event_payload_in_kb integer DEFAULT NULL,
max_event_batch_size integer DEFAULT NULL
Setting any of them to null or '' will ignore the setting, and use the limits associated with the server-level declared defaults.
Existing apps running on <0.29.0 will still work even if you don't have these fields added after the migration to 0.29.0. You should add these fields to keep your database up-to-date or to have the choice to, later on, imply limits to your apps.
MySQL
Database Pooling
Last modified 5mo ago
Copy link
On this page
Environment Variables
Limits on an app-by-app basis