postgresql_instances

Creates, updates, deletes, gets or lists a postgresql_instances resource.

Overview

Name	`postgresql_instances`
Type	Resource
Id	`linode.databases.postgresql_instances`

Fields

The following fields are returned by SELECT queries:

get
list

Returns information for a single PostgreSQL Managed Database.

Name	Datatype	Description
`id`	`integer`	Read-only A unique ID that can be used to identify and reference the Managed Database.
`allow_list`	`array`	Controls access to the Managed Database. - Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked. - A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database. - An empty array (`[]`) blocks all public and private connections to the Managed Database.
`cluster_size`	`integer`	The number of Linode instance nodes deployed to the Managed Database. - Choose `3` nodes to create a high availability cluster that consists of one primary node and two replica nodes. - A `2` node cluster is only available with a dedicated plan. It consists of one primary node and one replica node. (1, 2, 3)
`created`	`string (date-time)`	Read-only When this Managed Database was created. (example: 2022-01-01T00:01:01)
`encrypted`	`boolean`	Read-only Whether the Managed Databases is encrypted. Currently required to be `true`.
`engine`	`string`	Filterable, Read-only The Managed Database engine type. (example: postgresql)
`engine_config`	`object`	Advanced parameters you can apply to a PostgreSQL Managed Database, via our partner Aiven's specification. Only include the objects for parameters you want to set in your database. Omit objects for parameters you don't want to define or change. > 📘 > > Aiven may offer additional parameters in their specification. Currently, only those listed here are supported for use in a PostgreSQL Managed Database. You can also run the List PostgreSQL Managed Database advanced parameters operation to see an up-to-date list.
`fork`	`object`	Details on the database that was the target of the fork. This only exists if the database was restored by creating a fork from another MySQL or PostgreSQL database.
`hosts`	`object`	Read-only The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.
`label`	`string`	Filterable A unique, user-defined string referring to the Managed Database. This string needs to be unique per Managed Database engine type. (example: example-db)
`members`	`string`	Read-only A mapping between IP addresses and strings designating them as `primary` or `failover`. (opaque JSON object)
`oldest_restore_time`	`string (date-time)`	Read-only The oldest time to which a database can be restored. (example: 2024-10-03 20:48:05)
`platform`	`string`	Filterable, Read-only The back-end platform for relational databases used by the service. (rdbms-legacy, rdbms-default) (example: rdbms-default)
`port`	`integer`	Read-only The access port for this Managed Database.
`private_network`	`object`	Beta Restricts access to a PostgreSQL Managed Database using a Virtual Private Cloud (VPC). Displayed as `null` if no VPC is configured.
`region`	`string`	Filterable The unique identifier for the region where the Managed Database lives. (example: us-east)
`ssl_connection`	`boolean`	Currently required to be `true`. Whether to require SSL credentials to establish a connection to the Managed Database. Run the Get managed PostgreSQL database credentials operation for access information.
`status`	`string`	Filterable, Read-only The operating status of the Managed Database. (provisioning, active, suspending, suspended, resuming, failed, degraded, updating, resizing) (example: active)
`total_disk_size_gb`	`integer`	Read-only The total disk size of the database, in GB.
`type`	`string`	Filterable The Linode Instance type used by the Managed Database for its nodes. (example: g6-dedicated-2)
`updated`	`string (date-time)`	Read-only When this Managed Database was last updated. (example: 2022-01-01T00:01:01)
`updates`	`object`	Configuration settings for automated patch update maintenance for the Managed Database.
`used_disk_size_gb`	`integer`	Read-only The amount of space currently in use in the database, in GB.
`version`	`string`	Filterable The Managed Database engine version. (example: 13.2)

Returns a paginated list of all accessible PostgreSQL Managed Databases on your account.

Name	Datatype	Description
`id`	`integer`	Read-only A unique ID that can be used to identify and reference the Managed Database.
`allow_list`	`array`	Controls access to the Managed Database. - Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked. - A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database. - An empty array (`[]`) blocks all public and private connections to the Managed Database.
`cluster_size`	`integer`	The number of Linode instance nodes deployed to the Managed Database. - Choose `3` nodes to create a high availability cluster that consists of one primary node and two replica nodes. - A `2` node cluster is only available with a dedicated plan. It consists of one primary node and one replica node. (1, 2, 3)
`created`	`string (date-time)`	Read-only When this Managed Database was created. (example: 2022-01-01T00:01:01)
`encrypted`	`boolean`	Read-only Whether the Managed Databases is encrypted. Currently required to be `true`.
`engine`	`string`	Filterable, Read-only The Managed Database engine type. (example: postgresql)
`engine_config`	`object`	Advanced parameters you can apply to a PostgreSQL Managed Database, via our partner Aiven's specification. Only include the objects for parameters you want to set in your database. Omit objects for parameters you don't want to define or change. > 📘 > > Aiven may offer additional parameters in their specification. Currently, only those listed here are supported for use in a PostgreSQL Managed Database. You can also run the List PostgreSQL Managed Database advanced parameters operation to see an up-to-date list.
`fork`	`object`	Details on the database that was the target of the fork. This only exists if the database was restored by creating a fork from another MySQL or PostgreSQL database.
`hosts`	`object`	Read-only The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.
`label`	`string`	Filterable A unique, user-defined string referring to the Managed Database. This string needs to be unique per Managed Database engine type. (example: example-db)
`members`	`string`	Read-only A mapping between IP addresses and strings designating them as `primary` or `failover`. (opaque JSON object)
`oldest_restore_time`	`string (date-time)`	Read-only The oldest time to which a database can be restored. (example: 2024-10-03 20:48:05)
`platform`	`string`	Filterable, Read-only The back-end platform for relational databases used by the service. (rdbms-legacy, rdbms-default) (example: rdbms-default)
`port`	`integer`	Read-only The access port for this Managed Database.
`private_network`	`object`	Beta Restricts access to a PostgreSQL Managed Database using a Virtual Private Cloud (VPC). Displayed as `null` if no VPC is configured.
`region`	`string`	Filterable The unique identifier for the region where the Managed Database lives. (example: us-east)
`ssl_connection`	`boolean`	Currently required to be `true`. Whether to require SSL credentials to establish a connection to the Managed Database. Run the Get managed PostgreSQL database credentials operation for access information.
`status`	`string`	Filterable, Read-only The operating status of the Managed Database. (provisioning, active, suspending, suspended, resuming, failed, degraded, updating, resizing) (example: active)
`total_disk_size_gb`	`integer`	Read-only The total disk size of the database, in GB.
`type`	`string`	Filterable The Linode Instance type used by the Managed Database for its nodes. (example: g6-dedicated-2)
`updated`	`string (date-time)`	Read-only When this Managed Database was last updated. (example: 2022-01-01T00:01:01)
`updates`	`object`	Configuration settings for automated patch update maintenance for the Managed Database.
`used_disk_size_gb`	`integer`	Read-only The amount of space currently in use in the database, in GB.
`version`	`string`	Filterable The Managed Database engine version. (example: 13.2)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`instanceId`		Display information for a single, accessible PostgreSQL Managed Database. Learn more... Learn more...
`list`	`select`		`page`, `page_size`	Display all accessible PostgreSQL Managed Databases. Learn more... Learn more...
`create`	`insert`	`label`, `type`, `engine`, `region`		Provision a PostgreSQL Managed Database Use this operation to create a new PostgreSQL Managed Database. - Restricted users need the `add_databases` user grant. - New instances can take 10 to 15 minutes to deploy. - When you create a new PostgreSQL Managed Database, our partner Aiven automatically enables disk encryption on each cluster. - All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week. - All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the PostgreSQL Managed Database. Configure the maintenance window for these updates with the Update a managed PostgreSQL database operation. - If your database cluster is configured with a single node, downtime occurs during maintenance updates. Adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a high availability plan to avoid any maintenance downtime. - Major upgrades are optional until the service reaches end of service, and can be done in place. - A successful request triggers a `database_create` event. Beta Virtual Private Cloud (VPC) support You can create a PostgreSQL Managed Database in a VPC using the `private_network` object in the request. Talk to your Akamai account team for more details. > 📘 > > Currently, VPC subnets associated with Managed Database instances don't automatically block outbound connections outside the subnet. To limit network exposure, you should configure Cloud Firewall rules to explicitly deny outbound connections beyond the intended subnet. For more details on configuring rules, see the Cloud Firewall documentation. Restore a PostgreSQL Managed Database Include the `fork` object in the request to target a backed-up database. Your user needs `read_write` access to the target database and its status can be `active`, `degraded`, or `failed`. > 📘 > > Restoring from a backup creates a second running cluster, which incurs billing. Delete the first cluster after the restore is complete, to avoid this billing. Learn more... Learn more...
`patch`	`update`	`instanceId`		Apply security patches and updates to the underlying operating system of the PostgreSQL Managed Database. This function runs during regular maintenance windows, which you can configure with the Update a managed PostgreSQL database operation. - The user needs `read_write` user grant access to the database. - The database's status needs to be `active`. - If your database cluster is configured with a single node, downtime occurs during maintenance updates. Consider upgrading to a high availability plan to avoid any maintenance downtime. - Major upgrades are optional until the service reaches end of service, and can be done in place. - A successful request triggers a `database_upgrade` event. Learn more... Learn more...
`update`	`replace`	`instanceId`		Make changes to an existing PostgreSQL Managed Database. - The user needs `read_write` user grant access to the database. - The database's status needs to be `active`. - New values set in the `allow_list` overwrite existing values. To keep existing values, run the List PostgreSQL Managed Databases operation, store the `allow_list` addresses from the response, and include them with any new addresses in this operation. - Updates to your `allow_list` may take a short period of time to complete, making this operation inappropriate for rapid successive updates. - Also allows resizing the database cluster to a larger one. Clusters can't be resized to smaller plans. - All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the Managed PostgreSQL Database. Use the `updates` object in this operation to modify the maintenance window for these updates. - If your database cluster is configured with a single node, downtime occurs during maintenance updates. Use the `updates` object to adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a high availability plan to avoid any maintenance downtime. - Major upgrades are optional until the service reaches end of service, and can be done in place. - You can't update `engine_config` advanced parameter settings for a suspended database. You'll need to resume it first. - A successful request triggers a `database_update` event. - Beta. You can update an existing PostgreSQL Managed Database to move it to a Virtual Private Cloud (VPC) using the `private_network` object in the request. This support is in beta. Talk to your Akamai account team for more details. > 📘 > > Currently, VPC subnets associated with Managed Database instances don't automatically block outbound connections outside the subnet. To limit network exposure, you should configure Cloud Firewall rules to explicitly deny outbound connections beyond the intended subnet. For more details on configuring rules, see the Cloud Firewall documentation. Learn more... Learn more...
`delete`	`delete`	`instanceId`		Remove a PostgreSQL Managed Database from your account. - The user needs `read_write` user grant access to the database. - The database's status can be `active`, `failed`, or `degraded`. - Only unrestricted users can access this operation. They have access regardless of the acting token's OAuth scopes. Learn more... Learn more...
`resume`	`exec`	`instanceId`		Resume a suspended PostgreSQL Managed Database from your account. This resumes billing for the cluster. - The user needs `read_write` user grant access to the database. - The database's status needs to be `suspended`. - A successful request triggers a `database_resume` event. OAuth scopes. `<br /> databases:read_write<br />` Learn more...
`suspend`	`exec`	`instanceId`		Suspend a PostgreSQL Managed Database from your account, releasing idle resources and keeping only necessary data. All service data is lost if there are no backups available. This halts billing for the cluster. - The user needs `read_write` user grant access to the database. - The database's status needs to be `active`. - Akamai deletes suspended clusters after 180 days. - A successful request triggers a `database_suspend` event. OAuth scopes. `<br /> databases:read_write<br />` Learn more...

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`instanceId`	`string`	The ID of the Managed PostgreSQL Database.
`page`	`integer`	The page of a collection to return.
`page_size`	`integer`	The number of items to return per page.

`SELECT` examples

get
list

Display information for a single, accessible PostgreSQL Managed Database.

Learn more...

Learn more...

SELECT
id,
allow_list,
cluster_size,
created,
encrypted,
engine,
engine_config,
fork,
hosts,
label,
members,
oldest_restore_time,
platform,
port,
private_network,
region,
ssl_connection,
status,
total_disk_size_gb,
type,
updated,
updates,
used_disk_size_gb,
version
FROM linode.databases.postgresql_instances
WHERE instanceId = '{{ instanceId }}' -- required
;

Display all accessible PostgreSQL Managed Databases.

Learn more...

Learn more...

SELECT
id,
allow_list,
cluster_size,
created,
encrypted,
engine,
engine_config,
fork,
hosts,
label,
members,
oldest_restore_time,
platform,
port,
private_network,
region,
ssl_connection,
status,
total_disk_size_gb,
type,
updated,
updates,
used_disk_size_gb,
version
FROM linode.databases.postgresql_instances
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}'
;

`INSERT` examples

create
Manifest

Provision a PostgreSQL Managed Database

Use this operation to create a new PostgreSQL Managed Database.

- Restricted users need the add_databases user grant.

- New instances can take 10 to 15 minutes to deploy.

- When you create a new PostgreSQL Managed Database, our partner Aiven automatically enables disk encryption on each cluster.

- All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.

- All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the PostgreSQL Managed Database. Configure the maintenance window for these updates with the Update a managed PostgreSQL database operation.

- If your database cluster is configured with a single node, downtime occurs during maintenance updates. Adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a high availability plan to avoid any maintenance downtime.

- Major upgrades are optional until the service reaches end of service, and can be done in place.

- A successful request triggers a database_create event.

Beta Virtual Private Cloud (VPC) support

You can create a PostgreSQL Managed Database in a VPC using the private_network object in the request. Talk to your Akamai account team for more details.

> 📘
>
> Currently, VPC subnets associated with Managed Database instances don't automatically block outbound connections outside the subnet. To limit network exposure, you should configure Cloud Firewall rules to explicitly deny outbound connections beyond the intended subnet. For more details on configuring rules, see the Cloud Firewall documentation.

Restore a PostgreSQL Managed Database

Include the fork object in the request to target a backed-up database. Your user needs read_write access to the target database and its status can be active, degraded, or failed.

> 📘
>
> Restoring from a backup creates a second running cluster, which incurs billing. Delete the first cluster after the restore is complete, to avoid this billing.

Learn more...

Learn more...

INSERT INTO linode.databases.postgresql_instances (
allow_list,
cluster_size,
engine,
engine_config,
fork,
label,
private_network,
region,
ssl_connection,
type
)
SELECT 
'{{ allow_list }}',
{{ cluster_size }},
'{{ engine }}' /* required */,
'{{ engine_config }}',
'{{ fork }}',
'{{ label }}' /* required */,
'{{ private_network }}',
'{{ region }}' /* required */,
{{ ssl_connection }},
'{{ type }}' /* required */
RETURNING
id,
allow_list,
cluster_size,
created,
encrypted,
engine,
engine_config,
fork,
hosts,
label,
members,
platform,
port,
region,
ssl_connection,
status,
total_disk_size_gb,
type,
updated,
updates,
used_disk_size_gb,
version
;

# Description fields are for documentation purposes
- name: postgresql_instances
props:
  - name: allow_list
    value:
      - "{{ allow_list }}"
    description: |
      Controls access to the Managed Database.
      - Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.
      - A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.
      - An empty array (`[]`) blocks all public and private connections to the Managed Database.
  - name: cluster_size
    value: {{ cluster_size }}
    description: |
      The number of Linode instance nodes deployed to the Managed Database.
      - Choose `3` nodes to create a high availability cluster that consists of one primary node and two replica nodes.
      - A `2` node cluster is only available with a dedicated plan. It consists of one primary node and one replica node.
    valid_values: ['1', '2', '3']
    default: 1
  - name: engine
    value: "{{ engine }}"
    description: |
      The Managed Database engine in engine/version format.
  - name: engine_config
    description: |
      Advanced parameters you can apply to a PostgreSQL Managed Database, via our partner [Aiven's specification](https://aiven.io/docs/products/postgresql/reference/advanced-params). Only include the objects for parameters you want to set in your database. Omit objects for parameters you don't want to define or change.
      > 📘
      >
      > Aiven may offer additional parameters in their specification. Currently, only those listed here are supported for use in a PostgreSQL Managed Database. You can also run the [List PostgreSQL Managed Database advanced parameters](https://techdocs.akamai.com/linode-api/reference/get-databases-postgresql-config) operation to see an up-to-date list.
    value:
      pg:
        autovacuum_analyze_scale_factor: {{ autovacuum_analyze_scale_factor }}
        autovacuum_analyze_threshold: {{ autovacuum_analyze_threshold }}
        autovacuum_max_workers: {{ autovacuum_max_workers }}
        autovacuum_naptime: {{ autovacuum_naptime }}
        autovacuum_vacuum_cost_delay: {{ autovacuum_vacuum_cost_delay }}
        autovacuum_vacuum_cost_limit: {{ autovacuum_vacuum_cost_limit }}
        autovacuum_vacuum_scale_factor: {{ autovacuum_vacuum_scale_factor }}
        autovacuum_vacuum_threshold: {{ autovacuum_vacuum_threshold }}
        bgwriter_delay: {{ bgwriter_delay }}
        bgwriter_flush_after: {{ bgwriter_flush_after }}
        bgwriter_lru_maxpages: {{ bgwriter_lru_maxpages }}
        bgwriter_lru_multiplier: {{ bgwriter_lru_multiplier }}
        deadlock_timeout: {{ deadlock_timeout }}
        default_toast_compression: "{{ default_toast_compression }}"
        idle_in_transaction_session_timeout: {{ idle_in_transaction_session_timeout }}
        jit: {{ jit }}
        max_files_per_process: {{ max_files_per_process }}
        max_locks_per_transaction: {{ max_locks_per_transaction }}
        max_logical_replication_workers: {{ max_logical_replication_workers }}
        max_parallel_workers: {{ max_parallel_workers }}
        max_parallel_workers_per_gather: {{ max_parallel_workers_per_gather }}
        max_pred_locks_per_transaction: {{ max_pred_locks_per_transaction }}
        max_replication_slots: {{ max_replication_slots }}
        max_slot_wal_keep_size: {{ max_slot_wal_keep_size }}
        max_stack_depth: {{ max_stack_depth }}
        max_standby_archive_delay: {{ max_standby_archive_delay }}
        max_standby_streaming_delay: {{ max_standby_streaming_delay }}
        max_wal_senders: {{ max_wal_senders }}
        max_worker_processes: {{ max_worker_processes }}
        password_encryption: "{{ password_encryption }}"
        pg_partman_bgw.interval: {{ pg_partman_bgw.interval }}
        pg_partman_bgw.role: "{{ pg_partman_bgw.role }}"
        pg_stat_monitor.pgsm_enable_query_plan: {{ pg_stat_monitor.pgsm_enable_query_plan }}
        pg_stat_monitor.pgsm_max_buckets: {{ pg_stat_monitor.pgsm_max_buckets }}
        pg_stat_statements.track: "{{ pg_stat_statements.track }}"
        temp_file_limit: {{ temp_file_limit }}
        timezone: "{{ timezone }}"
        track_activity_query_size: {{ track_activity_query_size }}
        track_commit_timestamp: "{{ track_commit_timestamp }}"
        track_functions: "{{ track_functions }}"
        track_io_timing: "{{ track_io_timing }}"
        wal_sender_timeout: {{ wal_sender_timeout }}
        wal_writer_delay: {{ wal_writer_delay }}
      pg_stat_monitor_enable: {{ pg_stat_monitor_enable }}
      pglookout:
        max_failover_replication_time_lag: {{ max_failover_replication_time_lag }}
      shared_buffers_percentage: {{ shared_buffers_percentage }}
      work_mem: {{ work_mem }}
  - name: fork
    description: |
      Include this object to restore a Managed Database by forking from a backup.
      - If you include this object, all other fields are optional.
      - Don't include this object if you're creating a new Managed Database.
    value:
      restore_time: "{{ restore_time }}"
      source: {{ source }}
  - name: label
    value: "{{ label }}"
    description: |
      __Filterable__ A unique, user-defined string referring to the Managed Database. This string needs to be unique per Managed Database engine type.
  - name: private_network
    description: |
      __Beta__ Restricts access on a PostgreSQL Managed Database to a specific Virtual Private Cloud (VPC) configured for the cluster.
    value:
      public_access: {{ public_access }}
      subnet_id: {{ subnet_id }}
      vpc_id: {{ vpc_id }}
  - name: region
    value: "{{ region }}"
    description: |
      __Filterable__ The unique identifier for the [region](https://techdocs.akamai.com/linode-api/reference/get-regions) where the Managed Database lives.
  - name: ssl_connection
    value: {{ ssl_connection }}
    description: |
      Currently required to be `true`. Whether to require SSL credentials to establish a connection to the Managed Database. Run the [Get managed PostgreSQL database credentials](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance-credentials) operation for access information.
    default: true
  - name: type
    value: "{{ type }}"
    description: |
      __Filterable__ The Linode Instance type used by the Managed Database for its nodes.

`UPDATE` examples

patch

Apply security patches and updates to the underlying operating system of the PostgreSQL Managed Database. This function runs during regular maintenance windows, which you can configure with the Update a managed PostgreSQL database operation.

- The user needs read_write user grant access to the database.

- The database's status needs to be active.

- If your database cluster is configured with a single node, downtime occurs during maintenance updates. Consider upgrading to a high availability plan to avoid any maintenance downtime.

- Major upgrades are optional until the service reaches end of service, and can be done in place.

- A successful request triggers a database_upgrade event.

Learn more...

Learn more...

UPDATE linode.databases.postgresql_instances
SET 
-- No updatable properties
WHERE 
instanceId = '{{ instanceId }}' --required
RETURNING
instanceId,
message;

`REPLACE` examples

update

Make changes to an existing PostgreSQL Managed Database.

- The user needs read_write user grant access to the database.

- The database's status needs to be active.

- New values set in the allow_list overwrite existing values. To keep existing values, run the List PostgreSQL Managed Databases operation, store the allow_list addresses from the response, and include them with any new addresses in this operation.

- Updates to your allow_list may take a short period of time to complete, making this operation inappropriate for rapid successive updates.

- Also allows resizing the database cluster to a larger one. Clusters can't be resized to smaller plans.

- All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the Managed PostgreSQL Database. Use the updates object in this operation to modify the maintenance window for these updates.

- If your database cluster is configured with a single node, downtime occurs during maintenance updates. Use the updates object to adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a high availability plan to avoid any maintenance downtime.

- Major upgrades are optional until the service reaches end of service, and can be done in place.

- You can't update engine_config advanced parameter settings for a suspended database. You'll need to resume it first.

- A successful request triggers a database_update event.

- Beta. You can update an existing PostgreSQL Managed Database to move it to a Virtual Private Cloud (VPC) using the private_network object in the request. This support is in beta. Talk to your Akamai account team for more details.

> 📘
>
> Currently, VPC subnets associated with Managed Database instances don't automatically block outbound connections outside the subnet. To limit network exposure, you should configure Cloud Firewall rules to explicitly deny outbound connections beyond the intended subnet. For more details on configuring rules, see the Cloud Firewall documentation.

Learn more...

Learn more...

REPLACE linode.databases.postgresql_instances
SET 
allow_list = '{{ allow_list }}',
engine_config = '{{ engine_config }}',
label = '{{ label }}',
private_network = '{{ private_network }}',
type = '{{ type }}',
updates = '{{ updates }}',
version = '{{ version }}'
WHERE 
instanceId = '{{ instanceId }}' --required
RETURNING
id,
allow_list,
cluster_size,
created,
encrypted,
engine,
engine_config,
fork,
hosts,
label,
members,
oldest_restore_time,
platform,
port,
private_network,
region,
ssl_connection,
status,
total_disk_size_gb,
type,
updated,
updates,
used_disk_size_gb,
version;

`DELETE` examples

delete

Remove a PostgreSQL Managed Database from your account.

- The user needs read_write user grant access to the database.

- The database's status can be active, failed, or degraded.

- Only unrestricted users can access this operation. They have access regardless of the acting token's OAuth scopes.

Learn more...

Learn more...

DELETE FROM linode.databases.postgresql_instances
WHERE instanceId = '{{ instanceId }}' --required
;

Lifecycle Methods

resume
suspend

Resume a suspended PostgreSQL Managed Database from your account. This resumes billing for the cluster.

- The user needs read_write user grant access to the database.

- The database's status needs to be suspended.

- A successful request triggers a database_resume event. OAuth scopes.

<br /> databases:read_write<br />

Learn more...

EXEC linode.databases.postgresql_instances.resume 
@instanceId='{{ instanceId }}' --required
;

Suspend a PostgreSQL Managed Database from your account, releasing idle resources and keeping only necessary data. All service data is lost if there are no backups available. This halts billing for the cluster.

- The user needs read_write user grant access to the database.

- The database's status needs to be active.

- Akamai deletes suspended clusters after 180 days.

- A successful request triggers a database_suspend event. OAuth scopes.

<br /> databases:read_write<br />

Learn more...

EXEC linode.databases.postgresql_instances.suspend 
@instanceId='{{ instanceId }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

REPLACE examples​

DELETE examples​

Lifecycle Methods​