extra_sql_persos

Creates, updates, deletes, gets or lists an extra_sql_persos resource.

Overview

Name	extra_sql_persos
Type	Resource
Id	ovh.hosting_web.extra_sql_persos

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Identifier of the (additional) SQL slot
name	string	The extraSqlPerso option name
task_id	integer	The task ID working on this extraSqlPerso (wire: taskId)
service_name	string	Billing name of the matching subscription (or internal naming otherwise) (wire: serviceName)
database	integer	Number of database allowed by this option
size	object	Quota size allowed per each database by this option
status	string	The extraSqlPerso option status
usage	array	Linked databases

list

Sqlperso service

Name	Datatype	Description
id	integer	Identifier of the (additional) SQL slot
name	string	The extraSqlPerso option name
task_id	integer	The task ID working on this extraSqlPerso (wire: taskId)
service_name	string	Billing name of the matching subscription (or internal naming otherwise) (wire: serviceName)
database	integer	Number of database allowed by this option
size	object	Quota size allowed per each database by this option
status	string	The extraSqlPerso option status
usage	array	Linked databases

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Get an extra SQL option. Returns the number of databases allowed, the quota per database, the linked databases and the status of the option.
list	select	service_name	x_pagination_mode	List extra SQL options. Returns the IDs of the additional SQL options of the hosting. Each option adds databases, each with its own quota.
service_infos_update	exec	id, serviceName, renew		Update extra SQL option renewal. Updates the renewal settings of the additional SQL option: automatic renewal, renewal period and deletion at expiration.
terminate	exec	id, serviceName		Terminate an extra SQL option. Requests the termination of the additional SQL option. A link to confirm it is sent by email to the administrator contact.

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"}})
id	integer	Identifier of the (additional) SQL slot
serviceName	string	The internal name of your hosting
service_name	string	The internal name of your hosting (wire: serviceName)
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 an extra SQL option. Returns the number of databases allowed, the quota per database, the linked databases and the status of the option.

SELECT
id,
name,
task_id,
service_name,
database,
size,
status,
usage
FROM ovh.hosting_web.extra_sql_persos
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List extra SQL options. Returns the IDs of the additional SQL options of the hosting. Each option adds databases, each with its own quota.

SELECT
id,
name,
task_id,
service_name,
database,
size,
status,
usage
FROM ovh.hosting_web.extra_sql_persos
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

service_infos_update

Update extra SQL option renewal. Updates the renewal settings of the additional SQL option: automatic renewal, renewal period and deletion at expiration.

EXEC ovh.hosting_web.extra_sql_persos.service_infos_update 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"renew": "{{ renew }}"
}'
;

terminate

Terminate an extra SQL option. Requests the termination of the additional SQL option. A link to confirm it is sent by email to the administrator contact.

EXEC ovh.hosting_web.extra_sql_persos.terminate 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required
;