capabilities_engines

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

Overview

Name	capabilities_engines
Type	Resource
Id	ovh.public_cloud_database.capabilities_engines

Fields

The following fields are returned by SELECT queries:

list

Capability definition for a specific database engine

Name	Datatype	Description
name	string	Engine name
category	string	Category of the engine (database or analytics) (ANALYTICS, DATABASE)
default_version	string	Version used when no version is specified at service creation (wire: defaultVersion)
description	string	Human-readable description of the engine
lifecycle	object	Lifecycle information of the engine
order	integer	Display order
ssl_modes	array	Supported TLS modes for connections (wire: sslModes)
storage	string	Storage strategy of the engine (DISTRIBUTED, NOT_APPLICABLE, REPLICATED)
tags	array	Display tags
versions	array	Versions available for this engine

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	project_id	x_pagination_cursor, x_pagination_size	Returns the available Databases engines with their versions, default version and supported TLS modes. (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"}})
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

list

Returns the available Databases engines with their versions, default version and supported TLS modes. (Beta version)

SELECT
name,
category,
default_version,
description,
lifecycle,
order,
ssl_modes,
storage,
tags,
versions
FROM ovh.public_cloud_database.capabilities_engines
WHERE 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 }}'
;