catalog_relations

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

Overview

Name	catalog_relations
Type	Resource
Id	datadog.catalog.catalog_relations

Fields

The following fields are returned by SELECT queries:

list_catalog_relation

Name	Datatype	Description
id	string	Relation ID.
attributes	object	Relation attributes.
meta	object	Relation metadata.
relationships	object	Relation relationships.
subtype	string	Relation subtype.
type	string	Relation type. (relation)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_catalog_relation	select		page[offset], page[limit], filter[type], filter[from_ref], filter[to_ref], include, include_discovered	Get a list of entity relations from Software Catalog.

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
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
filter[from_ref]	string	Filter relations by the reference of the first entity in the relation. (example: service:shopping-cart)
filter[to_ref]	string	Filter relations by the reference of the second entity in the relation. (example: service:shopping-cart)
filter[type]	string	Filter relations by type.
include	string	Include relationship data.
include_discovered	boolean	If true, includes relationships discovered by APM and USM. (wire: includeDiscovered)
page[limit]	integer (int64)	Maximum number of relations in the response. (example: 100)
page[offset]	integer (int64)	Specific offset to use as the beginning of the returned page.

SELECT examples

list_catalog_relation

Get a list of entity relations from Software Catalog.

SELECT
id,
attributes,
meta,
relationships,
subtype,
type
FROM datadog.catalog.catalog_relations
WHERE page[offset] = '{{ page[offset] }}'
AND page[limit] = '{{ page[limit] }}'
AND filter[type] = '{{ filter[type] }}'
AND filter[from_ref] = '{{ filter[from_ref] }}'
AND filter[to_ref] = '{{ filter[to_ref] }}'
AND include = '{{ include }}'
AND include_discovered = '{{ include_discovered }}'
;