catalog_entities

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

Overview

Name	catalog_entities
Type	Resource
Id	datadog.catalog.catalog_entities

Fields

The following fields are returned by SELECT queries:

list_catalog_entity

Name	Datatype	Description
id	string	Entity ID.
attributes	object	Entity attributes.
meta	object	Entity metadata.
relationships	object	Entity relationships.
type	string	Entity.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_catalog_entity	select	region	page[offset], page[limit], filter[id], filter[ref], filter[name], filter[kind], filter[owner], filter[relation][type], filter[exclude_snapshot], include	Get a list of entities from Software Catalog.
upsert_catalog_entity	insert	region		Create or update entities in Software Catalog.
delete_catalog_entity	delete	entity_id, region		Delete a single entity in 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
entity_id	string	UUID or Entity Ref.
region	string	(default: datadoghq.com)
filter[exclude_snapshot]	string	Filter entities by excluding snapshotted entities.
filter[id]	string	Filter entities by UUID.
filter[kind]	string	Filter entities by kind.
filter[name]	string	Filter entities by name.
filter[owner]	string	Filter entities by owner.
filter[ref]	string	Filter entities by reference (example: service:shopping-cart)
filter[relation][type]	string	Filter entities by relation type.
include	string	Include relationship data.
page[limit]	integer (int64)	Maximum number of entities in the response. (example: 100)
page[offset]	integer (int64)	Specific offset to use as the beginning of the returned page.

SELECT examples

list_catalog_entity

Get a list of entities from Software Catalog.

SELECT
id,
attributes,
meta,
relationships,
type
FROM datadog.catalog.catalog_entities
WHERE region = '{{ region }}' -- required
AND page[offset] = '{{ page[offset] }}'
AND page[limit] = '{{ page[limit] }}'
AND filter[id] = '{{ filter[id] }}'
AND filter[ref] = '{{ filter[ref] }}'
AND filter[name] = '{{ filter[name] }}'
AND filter[kind] = '{{ filter[kind] }}'
AND filter[owner] = '{{ filter[owner] }}'
AND filter[relation][type] = '{{ filter[relation][type] }}'
AND filter[exclude_snapshot] = '{{ filter[exclude_snapshot] }}'
AND include = '{{ include }}'
;

INSERT examples

upsert_catalog_entity

Create or update entities in Software Catalog.

INSERT INTO datadog.catalog.catalog_entities (
region
)
SELECT 
'{{ region }}'
RETURNING
data,
included,
meta
;

Manifest

# Description fields are for documentation purposes
- name: catalog_entities
  props:
    - name: region
      value: string
      description: Required parameter for the catalog_entities resource.

DELETE examples

delete_catalog_entity

Delete a single entity in Software Catalog.

DELETE FROM datadog.catalog.catalog_entities
WHERE entity_id = '{{ entity_id }}' --required
AND region = '{{ region }}' --required
;