product_analytics_mapping_connections
Creates, updates, deletes, gets or lists a product_analytics_mapping_connections resource.
Overview
| Name | product_analytics_mapping_connections |
| Type | Resource |
| Id | datadog.digital_experience.product_analytics_mapping_connections |
Fields
The following fields are returned by SELECT queries:
- list_connections
Successful response with list of connections
| Name | Datatype | Description |
|---|---|---|
id | string | Unique identifier for the list connections response resource. |
attributes | object | Attributes of the list connections response, containing the collection of data source connections. |
type | string | List connections response resource type. (list_connections_response) (default: list_connections_response, example: list_connections_response) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_connections | select | entity | List all data connections for an entity | |
create_connection | insert | entity | Create a new data connection and its fields for an entity | |
update_connection | replace | entity | Update an existing data connection by adding, updating, or deleting fields | |
delete_connection | delete | id, entity | Delete an existing data connection for an entity |
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 | string | The entity for which to delete the connection |
id | string | The connection ID to delete |
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. |
SELECT examples
- list_connections
List all data connections for an entity
SELECT
id,
attributes,
type
FROM datadog.digital_experience.product_analytics_mapping_connections
WHERE entity = '{{ entity }}' -- required
;
INSERT examples
- create_connection
- Manifest
Create a new data connection and its fields for an entity
INSERT INTO datadog.digital_experience.product_analytics_mapping_connections (
data,
entity
)
SELECT
'{{ data }}',
'{{ entity }}'
;
# Description fields are for documentation purposes
- name: product_analytics_mapping_connections
props:
- name: entity
value: "{{ entity }}"
description: Required parameter for the product_analytics_mapping_connections resource.
- name: data
description: |
The data object containing the resource type and attributes for creating a new connection.
value:
attributes:
fields:
- description: "{{ description }}"
display_name: "{{ display_name }}"
groups: "{{ groups }}"
id: "{{ id }}"
source_name: "{{ source_name }}"
type: "{{ type }}"
join_attribute: "{{ join_attribute }}"
join_type: "{{ join_type }}"
metadata: "{{ metadata }}"
type: "{{ type }}"
id: "{{ id }}"
type: "{{ type }}"
REPLACE examples
- update_connection
Update an existing data connection by adding, updating, or deleting fields
REPLACE datadog.digital_experience.product_analytics_mapping_connections
SET
data = '{{ data }}'
WHERE
entity = '{{ entity }}' --required;
DELETE examples
- delete_connection
Delete an existing data connection for an entity
DELETE FROM datadog.digital_experience.product_analytics_mapping_connections
WHERE id = '{{ id }}' --required
AND entity = '{{ entity }}' --required
;