The data catalog codes window allows you to perform additional operations on a cataloged query. This window is accessible from the object browser's Data catalog > Codes. The queries grid displays the two types of queries – a built-in query and a manual query. Built-in-query is not editable.
Note: The minimum permission the end-user will need even to access this module is a Metadata Read and Data Read on their user role.
The Codes home page will display the following information for the crawled connection or profiles.
Columns |
Description |
---|---|
Connector Name |
Displays the name of a Connector |
Schema |
Displays the name of a Schema |
Code Name |
A Query with a hyperlink is displayed. When you click, it will navigate to the query summary page |
Title |
Displays the title of a query |
Code |
A query is displayed |
Tags |
Displays the tags associated with Query. |
Terms |
Displays the terms associated with Query. |
Business Description |
This shows the business description of the query |
Technical Description |
Shows the technical description of the query |
Job Type |
Displays the query of SQL, Procedure, or View |
SQL Type |
The query is written using SELECT |
Catalog |
It will display the queries that are cataloged (YES) and uncataloged(NO) |
Project |
Display the default project name a query is associated with. |
Created Date |
Displays the date on which query is created |
Last Run on |
Displays the date on which query is executed |
Note: To see the list of queries, you may first go to Administration > Crawler > Setting page. Select the checkbox for (1) Table, Views, and Column and (2) Procedure, Functions, Triggers, and View Source Code.
Query Interface
The query interface allows you to view, edit or add a new query. It is divided into five parts.
- Query Window Editor
- Summary
- Associates
- Visual Result
- Lineages
It will display the code of the query in view mode of the query is the built-in query. If it is a manual query, then you have the option to edit, run and delete the query.
Summary
It will display the following information for a query. A description of a data object (Business Description, Technical Description). Tags and terms associated with the query. In addition to the top users, the crawled date, type, last run date, job type, popularity, Catalog toggle button, and quality index are displayed.
Results
When the cataloged query is executed, the results of the cataloged query are displayed in this window.
Note: You can now download the results data just by clicking on the download button at the right corner bottom
Visualize Result
Once the query result is displayed in the Results tab, the query result is displayed in the pictorial representation.
Note: You can now download the results data just by clicking on the download button at the right-corner bottom
- Visualize result is in disable mode when we use the Param button as enabled.
- The pie chart in Visualize result tab is dependent on integer values only. When a pie chart is given with an integer value, it will display the result in the pie chart.
- Based on the result, other charts are displayed in the Visualize Results tab.
How to Publish the Visual
Once the Query results are viewed graphically, click publish to share and view the results in the All Reports.
Note: In order to publish a report, firstly, you need to create a report group in the Security > Report Groups module.
- Click the Publish button. A pop-up window allows the user to input the chart details.
- Enter a report name.
- Enter a report description. The report description allows users to get more detail about the chart.
- Select the Reports group from the drop-down list.
(If no report group is listed, create a report group using the Administration>Security>Report group tab or reach your administrator.) - The Reports group is a user-defined group name where the selected report must be published.
- Click Publish report and Navigate to the timeline dashboard to view the published chart.
Associate Object
The association tab lists all the data objects included in the displayed query.
To Associate Object,
- In the associate tab, click the Associate Object to associate an object (Table/Files/Reports)
- Select the type of object (Table/Table Column/File/File column/Report/Report Column)
- Select a corresponding database, schema, and table (respective type of object you initially selected)
- Click the Save button. It will display the list of data objects associated with the query.
References
References are like pointers to a data object. Query references provide a list of objects (tables/columns/files/reports/data stories or other queries) from where this query is referenced. In this section, a user can find all the referenced data objects associated with the query.
For Example: Assume a query is written on table A and table B, which includes all the columns from table A and a few columns from table B. You can add this query as a reference object in any data stories/description tabs.
Lineage
A data lineage shows where a particular piece of data originated, where it moved, and how it was transformed over time. It enables the tracking, management, viewing, and editing of data transformations from source to destination.
You can find the existing lineage of this query in this section.
Note: Users should run the Recommend Lineage and References job to calculate or recommend lineage and reference. You can access this by the Nine dots icon on this page.
Add a Code
To add a code,
- The Add New Code in Nine Dots option allows you to create a new query from this page.
- A pop-up window allows you to select a new database, schema, and query name.
- Click the Save Query button to navigate to the empty query editor.
- You can enter the query and click the Param button.
- A pop-up window opens where you can provide the exact parameter for the query. Param button is enabled with a query having criteria.
- Enter the param value as 2
- Click the Save button, and the respective Parameter value as two is displayed.
Download button: You can now download the results data just by clicking on the download button at the right-corner bottom
Version: A version history is maintained whenever a query is created or edited. You can use the version dropdown list to select the latest or previous query versions. It shows the Query version no, User name, and Update Date & Time
Reference for Query Sheet Permission
Query Type |
Data No Access/ Data Preview |
Data Read |
Data Write |
||
Query Sheet |
Query Interface |
Query Sheet |
Query Interface |
||
SELECT Query |
No access to use query |
Can execute select queries |
|
Execute select queries |
Execute the catalog queries cannot manipulate the query but make an own copy of the query and execute |
INSERT Statement(DML) |
No security rights to manipulate the data |
No security rights to manipulate this data |
Execute insert queries |
Execute the catalog queries cannot manipulate the query but make an own copy of the Query and Execute |
|
ALTER Statement (DDL) |
No security rights to manipulate the data |
Cannot run query/filter catalog queries See queries but no security rights to execute the query |
Execute ALTER queries |
Execute DDL Statements |
Copyright © 2019, OvalEdge LLC, Peachtree Corners GA USA