tcb db pg realtime get
Query the Realtime settings of a PG mode environment: service state, channel access policy, Presence switch, rate limits, and connection pool sizes.
Version
The tcb db pg realtime commands are available since v3.9.0.
Usage
tcb db pg realtime get -e <envId>
Parameters
| Parameter | Required | Description | Default |
|---|---|---|---|
-e, --env-id <envId> | Yes | Environment ID | — |
--json | No | Output JSON | — |
Output fields
By default the command prints a two-column table of setting and current value. Field meanings:
| Field | Description |
|---|---|
Suspend | Whether the service is suspended. When true, all online connections are dropped immediately, new connections are rejected, and server-side broadcast APIs are disabled |
PrivateOnly | Whether only private channels are allowed. When true, clients cannot join channels prefixed with public: |
PresenceEnabled | Master switch for Presence. When disabled, presence join requests are rejected |
MaxConcurrentUsers | Maximum concurrent users, counted per user (multiple connections of the same user count once) |
MaxEventsPerSecond | Maximum broadcast events per second, summed across all clients |
MaxJoinsPerSecond | Maximum channel joins per second |
MaxBytesPerSecond | Maximum broadcast payload bytes per second |
MaxChannelsPerClient | Maximum channels per client |
MaxPresenceEventsPerSecond | Maximum presence events per second, summed across all track / untrack calls |
MaxPayloadSizeInKB | Maximum payload size per message, in KB |
ConnectionPool | Database connection pool size, used for RLS authorization queries |
PostgresChangesPool | Dedicated pool size for CDC (postgres_changes), isolated from the authorization pool |
CreatedTime / UpdatedTime | Creation and last update time (ISO 8601) |
AdminSuspendedTime | Platform freeze time. Returned only when the service is frozen by the platform; the row is hidden otherwise |
Examples
# Table output
tcb db pg realtime get -e <envId>
# JSON output
tcb db pg realtime get -e <envId> --json
Notes
- Run this command before changing settings.
setapplies incremental updates and leaves unspecified fields untouched - Fields that are empty or not returned by the server are shown as
-