postgresql_integrations

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

Overview

Name	postgresql_integrations
Type	Resource
Id	ovh.public_cloud_database.postgresql_integrations

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the integration
destination_service_id	string (uuid)	Identifier of the destination service. Null for external integrations. (wire: destinationServiceId)
source_service_id	string (uuid)	Identifier of the source service (wire: sourceServiceId)
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the resource was created (wire: createdAt)
parameters	object	Engine-specific configuration parameters for the integration
status	string	Current readiness status of the integration (CREATING, DELETING, ERROR, READY, UPDATING)
type	string	Type of the integration (GRAFANA_DASHBOARD, GRAFANA_DATASOURCE, KAFKA_CONNECT, KAFKA_LOGS, KAFKA_MIRROR_MAKER, OPENSEARCH_LOGS, POSTGRESQL_METRICS, PROMETHEUS, RSYSLOG)
updated_at	string (date-time)	Date of the last update to the resource (wire: updatedAt)

list

An integration linking two managed database services

Name	Datatype	Description
id	string (uuid)	Unique identifier of the integration
destination_service_id	string (uuid)	Identifier of the destination service. Null for external integrations. (wire: destinationServiceId)
source_service_id	string (uuid)	Identifier of the source service (wire: sourceServiceId)
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the resource was created (wire: createdAt)
parameters	object	Engine-specific configuration parameters for the integration
status	string	Current readiness status of the integration (CREATING, DELETING, ERROR, READY, UPDATING)
type	string	Type of the integration (GRAFANA_DASHBOARD, GRAFANA_DATASOURCE, KAFKA_CONNECT, KAFKA_LOGS, KAFKA_MIRROR_MAKER, OPENSEARCH_LOGS, POSTGRESQL_METRICS, PROMETHEUS, RSYSLOG)
updated_at	string (date-time)	Date of the last update to the resource (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	integration_id, service_id, project_id		Returns the integration type, its source and destination services and its status. (Beta version)
list	select	service_id, project_id	x_pagination_cursor, x_pagination_size	Returns the integrations of the service with other services. (Beta version)
create	insert	service_id, project_id, destination_service_id, source_service_id, type		Integrates the service with another database or analytics service. sourceServiceId must be the identifier of this service. Compatible engine pairs are listed on the capabilities endpoint. (Beta version)
delete	delete	integration_id, service_id, project_id		Deletes the integration. (Beta version)

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"}})
integration_id	string (uuid)	Integration ID (wire: integrationId)
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
service_id	string (uuid)	Service ID (wire: serviceId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the integration type, its source and destination services and its status. (Beta version)

SELECT
id,
destination_service_id,
source_service_id,
checksum,
created_at,
parameters,
status,
type,
updated_at
FROM ovh.public_cloud_database.postgresql_integrations
WHERE integration_id = '{{ integration_id }}' -- required
AND service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the integrations of the service with other services. (Beta version)

SELECT
id,
destination_service_id,
source_service_id,
checksum,
created_at,
parameters,
status,
type,
updated_at
FROM ovh.public_cloud_database.postgresql_integrations
WHERE service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;

INSERT examples

create

Integrates the service with another database or analytics service. sourceServiceId must be the identifier of this service. Compatible engine pairs are listed on the capabilities endpoint. (Beta version)

INSERT INTO ovh.public_cloud_database.postgresql_integrations (
destination_service_id,
parameters,
source_service_id,
type,
service_id,
project_id
)
SELECT 
'{{ destination_service_id }}' /* required */,
'{{ parameters }}',
'{{ source_service_id }}' /* required */,
'{{ type }}' /* required */,
'{{ service_id }}',
'{{ project_id }}'
RETURNING
id,
destination_service_id,
source_service_id,
checksum,
created_at,
parameters,
status,
type,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: postgresql_integrations
props:
  - name: service_id
    value: "{{ service_id }}"
    description: Required parameter for the postgresql_integrations resource.
  - name: project_id
    value: "{{ project_id }}"
    description: Required parameter for the postgresql_integrations resource.
  - name: destination_service_id
    value: "{{ destination_service_id }}"
    description: |
      Identifier of the destination service. Compatible source and destination engine pairs can be retrieved from the capabilities endpoint.
  - name: parameters
    value: "{{ parameters }}"
    description: |
      Engine-specific configuration parameters for the integration
  - name: source_service_id
    value: "{{ source_service_id }}"
    description: |
      Identifier of the source service
  - name: type
    value: "{{ type }}"
    description: |
      Type of the integration
    valid_values: ['GRAFANA_DASHBOARD', 'GRAFANA_DATASOURCE', 'KAFKA_CONNECT', 'KAFKA_LOGS', 'KAFKA_MIRROR_MAKER', 'OPENSEARCH_LOGS', 'POSTGRESQL_METRICS', 'PROMETHEUS', 'RSYSLOG']

DELETE examples

delete

Deletes the integration. (Beta version)

DELETE FROM ovh.public_cloud_database.postgresql_integrations
WHERE integration_id = '{{ integration_id }}' --required
AND service_id = '{{ service_id }}' --required
AND project_id = '{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;