clickhouse_current_queries

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

Overview

Name	clickhouse_current_queries
Type	Resource
Id	ovh.cloud_database.clickhouse_current_queries

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
queries	array	Current queries list

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cluster_id, service_name	limit, offset	Retrieve the current queries for the cluster
cancel	exec	clusterId, service_name		Cancel the given current query of the cluster

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"}})
clusterId	string (uuid)	Cluster ID
cluster_id	string (uuid)	Cluster ID (wire: clusterId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
limit	integer	Limit size of the result set returned by the pagination
offset	integer	Offset of the result set returned by the pagination

SELECT examples

get

Retrieve the current queries for the cluster

SELECT
queries
FROM ovh.cloud_database.clickhouse_current_queries
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND limit = '{{ limit }}'
AND offset = '{{ offset }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

cancel

Cancel the given current query of the cluster

EXEC ovh.cloud_database.clickhouse_current_queries.cancel 
@clusterId='{{ clusterId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set 
@@json=
'{
"pid": {{ pid }}, 
"terminate": {{ terminate }}
}'
;