Skip to main content

capabilities_engines

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

Overview​

Namecapabilities_engines
TypeResource
Idovh.public_cloud_analytics.capabilities_engines

Fields​

The following fields are returned by SELECT queries:

Capability definition for a specific database engine

NameDatatypeDescription
namestringEngine name
categorystringCategory of the engine (database or analytics) (ANALYTICS, DATABASE)
default_versionstringVersion used when no version is specified at service creation (wire: defaultVersion)
descriptionstringHuman-readable description of the engine
lifecycleobjectLifecycle information of the engine
orderintegerDisplay order
ssl_modesarraySupported TLS modes for connections (wire: sslModes)
storagestringStorage strategy of the engine (DISTRIBUTED, NOT_APPLICABLE, REPLICATED)
tagsarrayDisplay tags
versionsarrayVersions available for this engine

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectproject_idx_pagination_cursor, x_pagination_sizeReturns the available Analytics 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.

NameDatatypeDescription
api_hoststringThe 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_idstringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
x_pagination_cursorstringPagination cursor (wire: X-Pagination-Cursor)
x_pagination_sizeintegerPagination size (wire: X-Pagination-Size)

SELECT examples​

Returns the available Analytics 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_analytics.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 }}'
;