database_extensions

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

Overview

Name	database_extensions
Type	Resource
Id	ovh.hosting_private_database.database_extensions

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
extension_name	string	Extension name (wire: extensionName)
description	string	Extension details
required_extensions	array	Required extensions (wire: requiredExtensions)
status	string	Extension status (disabled, disabling, enabled, enabling)

list

Webcloud Database extension

Name	Datatype	Description
extension_name	string	Extension name (wire: extensionName)
description	string	Extension details
required_extensions	array	Required extensions (wire: requiredExtensions)
status	string	Extension status (disabled, disabling, enabled, enabling)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	database_name, extension_name, service_name		Returns the status and description of the extension, and the extensions it requires.
list	select	database_name, service_name	extension_name, status, x_pagination_mode	Returns the names of the extensions available for the database.
disable	exec	databaseName, extensionName, serviceName		Disables the extension on the database. Returns a task to follow the change.
enable	exec	databaseName, extensionName, serviceName		Enables the extension on the database. The extensions it requires are not enabled automatically: enable them first.

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"}})
databaseName	string	Database name
database_name	string	Database name (wire: databaseName)
extensionName	string	Extension name
extension_name	string	Extension name (wire: extensionName)
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)
extension_name	string	Filter results on extension name (like) (wire: extensionName)
status	string	Filter results on status (=)
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

Returns the status and description of the extension, and the extensions it requires.

SELECT
extension_name,
description,
required_extensions,
status
FROM ovh.hosting_private_database.database_extensions
WHERE database_name = '{{ database_name }}' -- required
AND extension_name = '{{ extension_name }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the names of the extensions available for the database.

SELECT
extension_name,
description,
required_extensions,
status
FROM ovh.hosting_private_database.database_extensions
WHERE database_name = '{{ database_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND extension_name = '{{ extension_name }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

disable

Disables the extension on the database. Returns a task to follow the change.

EXEC ovh.hosting_private_database.database_extensions.disable 
@databaseName='{{ databaseName }}' --required, 
@extensionName='{{ extensionName }}' --required, 
@serviceName='{{ serviceName }}' --required
;

enable

Enables the extension on the database. The extensions it requires are not enabled automatically: enable them first.

EXEC ovh.hosting_private_database.database_extensions.enable 
@databaseName='{{ databaseName }}' --required, 
@extensionName='{{ extensionName }}' --required, 
@serviceName='{{ serviceName }}' --required
;