database_capabilities
Creates, updates, deletes, gets or lists a database_capabilities resource.
Overview​
| Name | database_capabilities |
| Type | Resource |
| Id | ovh.hosting_web.database_capabilities |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
change_password | boolean | Availability of the changePassword function (wire: changePassword) |
change_right | boolean | Availability of the changeRight function (wire: changeRight) |
delete | boolean | Availability of the delete function |
dump | boolean | Availability of the dump function |
get_quota | boolean | Availability of the getQuota function (wire: getQuota) |
get_right | boolean | Availability of the getQuota function (wire: getRight) |
gui_url | string | URL of the database management tool (wire: guiURL) |
optimize | boolean | Availability of the optimize function |
restore | boolean | Availability of the restore function |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | name, service_name | Get database capabilities. Returns the functions available on the database, such as dump, restore or password change, and the URL of its management tool. |
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"}}) |
name | string | Database name (like mydb.mysql.db or mydb.postgres.db) |
service_name | string | The internal name of your hosting (wire: serviceName) |
SELECT examples​
- get
Get database capabilities. Returns the functions available on the database, such as dump, restore or password change, and the URL of its management tool.
SELECT
change_password,
change_right,
delete,
dump,
get_quota,
get_right,
gui_url,
optimize,
restore
FROM ovh.hosting_web.database_capabilities
WHERE name = '{{ name }}' -- required
AND service_name = '{{ service_name }}' -- required
;