opensearch_indices

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

Overview

Name	opensearch_indices
Type	Resource
Id	ovh.cloud_database.opensearch_indices

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Index ID
name	string	Name of the index
created_at	string (date-time)	Date of the creation of the index (wire: createdAt)
documents	integer	Number of documents hold by the index
replicas_number	integer	Number of replicas of the index (wire: replicasNumber)
shards_number	integer	Number of shards of the index (wire: shardsNumber)
size	integer	Size of the index

list

Cloud database opensearch index definition

Name	Datatype	Description
id	string (uuid)	Index ID
name	string	Name of the index
created_at	string (date-time)	Date of the creation of the index (wire: createdAt)
documents	integer	Number of documents hold by the index
replicas_number	integer	Number of replicas of the index (wire: replicasNumber)
shards_number	integer	Number of shards of the index (wire: shardsNumber)
size	integer	Size of the index

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cluster_id, index_id, service_name		Get opensearch index
list	select	cluster_id, service_name	x_pagination_mode	List indexes of the opensearch
delete	delete	cluster_id, index_id, service_name		Delete an opensearch index

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"}})
cluster_id	string (uuid)	Cluster ID (wire: clusterId)
index_id	string (uuid)	Index ID (wire: indexId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
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 opensearch index

SELECT
id,
name,
created_at,
documents,
replicas_number,
shards_number,
size
FROM ovh.cloud_database.opensearch_indices
WHERE cluster_id = '{{ cluster_id }}' -- required
AND index_id = '{{ index_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List indexes of the opensearch

SELECT
id,
name,
created_at,
documents,
replicas_number,
shards_number,
size
FROM ovh.cloud_database.opensearch_indices
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

DELETE examples

delete

Delete an opensearch index

DELETE FROM ovh.cloud_database.opensearch_indices
WHERE cluster_id = '{{ cluster_id }}' --required
AND index_id = '{{ index_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;