opensearch_patterns

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

Overview

Name	opensearch_patterns
Type	Resource
Id	ovh.cloud_database.opensearch_patterns

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Pattern ID
max_index_count	integer	Maximum number of index for this pattern (wire: maxIndexCount)
pattern	string	Pattern format

list

Cloud database opensearch pattern definition

Name	Datatype	Description
id	string (uuid)	Pattern ID
max_index_count	integer	Maximum number of index for this pattern (wire: maxIndexCount)
pattern	string	Pattern format

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cluster_id, pattern_id, service_name		Get opensearch patterns
list	select	cluster_id, service_name	x_pagination_mode	List patterns of the opensearch
create	insert	cluster_id, service_name, pattern		Create a new pattern on the opensearch cluster
delete	delete	cluster_id, pattern_id, service_name		Delete an opensearch pattern

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)
pattern_id	string (uuid)	Pattern ID (wire: patternId)
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 patterns

SELECT
id,
max_index_count,
pattern
FROM ovh.cloud_database.opensearch_patterns
WHERE cluster_id = '{{ cluster_id }}' -- required
AND pattern_id = '{{ pattern_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List patterns of the opensearch

SELECT
id,
max_index_count,
pattern
FROM ovh.cloud_database.opensearch_patterns
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 }}'
;

INSERT examples

create

Create a new pattern on the opensearch cluster

INSERT INTO ovh.cloud_database.opensearch_patterns (
max_index_count,
pattern,
cluster_id,
service_name
)
SELECT 
{{ max_index_count }},
'{{ pattern }}' /* required */,
'{{ cluster_id }}',
'{{ service_name }}'
RETURNING
id,
max_index_count,
pattern
;

Manifest

# Description fields are for documentation purposes
- name: opensearch_patterns
props:
  - name: cluster_id
    value: "{{ cluster_id }}"
    description: Required parameter for the opensearch_patterns resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the opensearch_patterns resource.
  - name: max_index_count
    value: {{ max_index_count }}
    description: |
      Maximum number of index for this pattern
  - name: pattern
    value: "{{ pattern }}"
    description: |
      Pattern format

DELETE examples

delete

Delete an opensearch pattern

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