Skip to main content

genie_message_attachments

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

Overview

Namegenie_message_attachments
TypeResource
Iddatabricks_workspace.dashboards.genie_message_attachments

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
statement_responsestring

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_query_resultselectspace_id, conversation_id, message_id, attachment_id, deployment_nameGet the result of SQL query if the message has a query attachment. This is only available if a message
execute_attachment_queryexecspace_id, conversation_id, message_id, attachment_id, deployment_nameExecute the SQL for a message query attachment. Use this API when the query attachment has expired and

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.

NameDatatypeDescription
attachment_idstringAttachment ID
conversation_idstringConversation ID
deployment_namestringThe Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
message_idstringMessage ID
space_idstringGenie space ID

SELECT examples

Get the result of SQL query if the message has a query attachment. This is only available if a message

SELECT
statement_response
FROM databricks_workspace.dashboards.genie_message_attachments
WHERE space_id = '{{ space_id }}' -- required
AND conversation_id = '{{ conversation_id }}' -- required
AND message_id = '{{ message_id }}' -- required
AND attachment_id = '{{ attachment_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

Lifecycle Methods

Execute the SQL for a message query attachment. Use this API when the query attachment has expired and

EXEC databricks_workspace.dashboards.genie_message_attachments.execute_attachment_query 
@space_id='{{ space_id }}' --required,
@conversation_id='{{ conversation_id }}' --required,
@message_id='{{ message_id }}' --required,
@attachment_id='{{ attachment_id }}' --required,
@deployment_name='{{ deployment_name }}' --required
;