mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-25 18:30:00 +00:00
44 lines
2.9 KiB
Markdown
44 lines
2.9 KiB
Markdown
|
---
|
||
|
|
title: query
|
||
|
|
slug: /main-concepts/metadata-standard/schemas/entity/data/query
|
||
|
|
---
|
||
|
|
|
||
|
|
# Query
|
||
|
|
|
||
|
|
*This schema defines the type to capture any data asset's queries.*
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
- **`id`**: Unique identifier of the query. Refer to *../../type/basic.json#/definitions/uuid*.
|
||
|
|
- **`name`**: Name of an entity to which the query belongs to. Refer to *../../type/basic.json#/definitions/entityName*.
|
||
|
|
- **`fullyQualifiedName`**: Fully qualified name of a query. Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
|
||
|
|
- **`displayName`** *(string)*: Display Name that identifies this Query. It could be title or label.
|
||
|
|
- **`description`**: Description of a query. Refer to *../../type/basic.json#/definitions/markdown*.
|
||
|
|
- **`version`**: Metadata version of the entity. Refer to *../../type/entityHistory.json#/definitions/entityVersion*.
|
||
|
|
- **`updatedAt`**: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to *../../type/basic.json#/definitions/timestamp*.
|
||
|
|
- **`updatedBy`** *(string)*: User who made the query.
|
||
|
|
- **`href`**: Link to this Query resource. Refer to *../../type/basic.json#/definitions/href*.
|
||
|
|
- **`changeDescription`**: Change that lead to this version of the entity. Refer to *../../type/entityHistory.json#/definitions/changeDescription*.
|
||
|
|
- **`owner`**: Owner of this Query. Refer to *../../type/entityReference.json*. Default: `None`.
|
||
|
|
- **`duration`** *(number)*: How long did the query took to run in seconds.
|
||
|
|
- **`users`** *(array)*: List of users who ran this query. Default: `None`.
|
||
|
|
- **Items**: Refer to *../../type/entityReference.json*.
|
||
|
|
- **`followers`**: Followers of this Query. Refer to *../../type/entityReferenceList.json*.
|
||
|
|
- **`votes`**: Refer to *../../type/votes.json*.
|
||
|
|
- **`query`**: SQL Query definition. Refer to *../../type/basic.json#/definitions/sqlQuery*.
|
||
|
|
- **`query_type`** *(string)*: SQL query type.
|
||
|
|
- **`exclude_usage`** *(boolean)*: Flag to check if query is to be excluded while processing usage.
|
||
|
|
- **`checksum`** *(string)*: Checksum to avoid registering duplicate queries.
|
||
|
|
- **`queryDate`**: Date on which the query ran. Refer to *../../type/basic.json#/definitions/timestamp*.
|
||
|
|
- **`usedBy`** *(array)*: List of users who ran the query but does not exist in OpenMetadata.
|
||
|
|
- **Items** *(string)*
|
||
|
|
- **`tags`** *(array)*: Tags for this SQL query. Default: `None`.
|
||
|
|
- **Items**: Refer to *../../type/tagLabel.json*.
|
||
|
|
- **`queryUsedIn`**: Entities that are using this query. Refer to *../../type/entityReferenceList.json*.
|
||
|
|
- **`triggeredBy`**: Entity that triggered the query. E.g., a Stored Procedure or a Pipeline Task. Refer to *../../type/entityReference.json*.
|
||
|
|
- **`processedLineage`** *(boolean)*: Flag if this query has already been successfully processed for lineage. Default: `False`.
|
||
|
|
- **`service`**: Link to the service this query belongs to. Refer to *../../type/entityReference.json*.
|
||
|
|
|
||
|
|
|
||
|
|
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
|