DBaaS Service PG
Properties
| Property | Type | Required | Description |
|---|---|---|---|
name | string | yes | Service name Min length: 0. Max length: 63. |
plan | string | yes | Subscription plan |
prometheus-uri | Prometheus URI | yes | Prometheus integration URI |
type | string | yes | Service type code Min length: 0. Max length: 64. |
backup-schedule | Backup Schedule | no | Backup schedule |
backups | array of List of backups for the service | no | List of backups for the service |
components | array of Components | no | Service component information objects |
connection-info | Connection Info | no | PG connection information properties |
connection-pools | array of Connection Pools | no | PostgreSQL PGBouncer connection pools |
created-at | string | no | Service creation timestamp (ISO 8601) ISO 8601 date-time. |
databases | array of DBaaS Database Name | no | List of PostgreSQL databases |
disk-size | integer | no | TODO UNIT disk space for data storage Min: 0. |
integrations | array of DBaaS Integration | no | Service integrations |
ip-filter | array[string] | no | Allowed CIDR address blocks for incoming connections |
maintenance | Automatic maintenance settings | no | Automatic maintenance settings |
max-connections | integer | no | Maximum number of connections allowed to an instance Min: 0. |
node-count | integer | no | Number of service nodes in the active plan Min: 0. |
node-cpu-count | integer | no | Number of CPUs for each node Min: 0. |
node-memory | integer | no | TODO UNIT of memory for each node Min: 0. |
node-states | array of Automatic maintenance settings | no | State of individual service nodes |
notifications | array of Service notifications | no | Service notifications |
pg-settings | postgresql.conf configuration values | no | PostgreSQL-specific settings |
pgaudit-settings | System-wide settings for the pgaudit extension. | no | PGAudit settings |
pgbouncer-settings | System-wide settings for pgbouncer. | no | PGBouncer connection pooling settings |
pglookout-settings | System-wide settings for pglookout. | no | PGLookout settings |
shared-buffers-percentage | integer | no | Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. Min: 20. Max: 60. |
state | string | no | State of the service Allowed values: running, rebuilding, rebalancing, poweroff. |
synchronous-replication | string | no | Synchronous replication type. Note that the service plan also needs to support synchronous replication. Allowed values: quorum, off. |
termination-protection | boolean | no | Service is protected against termination and powering off |
timescaledb-settings | System-wide settings for the timescaledb extension | no | TimescaleDB extension configuration values |
updated-at | string | no | Service last update timestamp (ISO 8601) ISO 8601 date-time. |
uri | string | no | URI for connecting to the service (may be absent) |
uri-params | object | no | service_uri parameterized into key-value pairs |
users | array of Users | no | List of service users |
version | string | no | PostgreSQL version |
work-mem | integer | no | Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB). Min: 1. Max: 1024. |
zone | string | no | The zone where the service is running |
Connection Info
PG connection information properties
| Property | Type | Required | Description |
|---|---|---|---|
params | array of Params | no | |
standby | array[string] | no | |
syncing | array[string] | no | |
uri | array[string] | no |
Backup Schedule
Backup schedule
| Property | Type | Required | Description |
|---|---|---|---|
backup-hour | integer | no | The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Min: 0. Max: 23. |
backup-minute | integer | no | The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Min: 0. Max: 59. |
Prometheus URI
Prometheus integration URI
| Property | Type | Required | Description |
|---|---|---|---|
host | string | no | |
port | integer | no | Min: 0. Max: 65535. |
Connection Pools
| Property | Type | Required | Description |
|---|---|---|---|
connection-uri | string | yes | Connection URI for the DB pool |
database | string | yes | Service database name Min length: 1. Max length: 40. |
mode | string | yes | PGBouncer pool mode Allowed values: transaction, statement, session. |
name | string | yes | Connection pool name Min length: 1. Max length: 63. |
size | integer | yes | Size of PGBouncer’s PostgreSQL side connection pool Min: 1. Max: 10000. |
username | string | yes | Pool username Min length: 1. Max length: 64. |
Components
| Property | Type | Required | Description |
|---|---|---|---|
component | string | yes | Service component name |
host | string | yes | DNS name for connecting to the service component |
port | integer | yes | Port number for connecting to the service component Min: 0. Max: 65535. |
route | string | yes | Network access route Allowed values: dynamic, private, public, privatelink. |
usage | string | yes | DNS usage name Allowed values: primary, replica. |
Users
List of service users
| Property | Type | Required | Description |
|---|---|---|---|
type | string | yes | Account type |
username | string | yes | Account username |
allow-replication | boolean | no | |
password | string | no | Account password. A missing field indicates a user overridden password. |
Last updated on