postgresql_databases

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

Overview

Name	postgresql_databases
Type	Resource
Id	ovh.cloud_database.postgresql_databases

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Database ID
name	string	Database name
default	boolean	Defines if the database has been created by default

list

Defines the database object in a cluster

Name	Datatype	Description
id	string (uuid)	Database ID
name	string	Database name
default	boolean	Defines if the database has been created by default

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cluster_id, database_id, service_name		Get the database for the postgresql cluster
list	select	cluster_id, service_name	x_pagination_mode
create	insert	cluster_id, service_name, name		Create a new database on the postgresql cluster
delete	delete	cluster_id, database_id, service_name		Delete a postgresql database

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
cluster_id	string (uuid)	Cluster ID (wire: clusterId)
database_id	string (uuid)	Database ID (wire: databaseId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get the database for the postgresql cluster

SELECT
id,
name,
default
FROM ovh.cloud_database.postgresql_databases
WHERE cluster_id = '{{ cluster_id }}' -- required
AND database_id = '{{ database_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Defines the database object in a cluster

SELECT
id,
name,
default
FROM ovh.cloud_database.postgresql_databases
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a new database on the postgresql cluster

INSERT INTO ovh.cloud_database.postgresql_databases (
name,
cluster_id,
service_name
)
SELECT 
'{{ name }}' /* required */,
'{{ cluster_id }}',
'{{ service_name }}'
RETURNING
id,
name,
default
;

Manifest

# Description fields are for documentation purposes
- name: postgresql_databases
props:
  - name: cluster_id
    value: "{{ cluster_id }}"
    description: Required parameter for the postgresql_databases resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the postgresql_databases resource.
  - name: name
    value: "{{ name }}"
    description: |
      Database name

DELETE examples

delete

Delete a postgresql database

DELETE FROM ovh.cloud_database.postgresql_databases
WHERE cluster_id = '{{ cluster_id }}' --required
AND database_id = '{{ database_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;