Compose Toolbars

Alation Cloud Service Applies to Alation Cloud Service instances of Alation

Customer Managed Applies to customer-managed instances of Alation

Compose has several toolbars to help you navigate the program. The top and middle toolbars assist you with opening and viewing queries, the bottom toolbar assists with writing and editing, and the Results toolbar shows you the Results, Preview, History, and Description of your query.

These toolbars have changed over time. References to earlier and later versions are mentioned throughout. View annotations at the bottom for 2021.4 and earlier versions.

Top-Level Toolbars

There are three toolbars at the top of the screen. The annotations in this section refer to versions 2022.1 and later.

• Top toolbar

• Middle toolbar

• Bottom toolbar

Top Toolbar

1. Alation logo. Click to return to your Alation Catalog.

2. Compose menu. Here you can start a new query, open an existing query, open a new Compose window, or close all tabs.

3. Tab navigation. Click the left and right carets to activate the next tab in the respective direction. Click the three dots to select from a list of all open tabs.

4. Query tabs. Click a tab to activate it. Double click to rename the query. Hover over a tab and click the X to close the tab.

5. New tab button. Click the plus button to start a query in a new tab.

6. Settings. Click to open the Compose Settings page.

7. Help. Click the Help button to:

   1. Open the Alation documentation site

   2. Learn about keyboard shortcuts

   3. View release notes

   4. Start the Alation quick tour

Middle Toolbar

1. Hamburger menu. Click here to show or hide the data browser sidebar.

2. Query name. Click the text to rename it. (To add a description, click Description in the Results Toolbar.)

3. Data source. The name of the data source you are querying.

4. Schema. The name of the schema in the database you are querying. If there’s more than one schema in the database, click the schema name to choose another schema.

5. Connection Settings. Click to add, edit, or remove connection URIs and user credentials. For more details, click the following links:

   • 2022.1 and later: Working with Data Source Connections

   • 2021.4 and earlier: Switch and Remove Data Source Accounts

6. Active connection info. Hover over the information icon to see the current connection setting for the query.

7. Save status. Queries are saved automatically anytime you stop typing for five seconds. During this five second window, you’ll see a Save Now link you can click. Once the query is saved, it changes to read All Edits Saved. You can click All Edits Saved to see the query’s version history.

Bottom Toolbar

When the screen gets narrow enough, most of the button names become icons.

1. Edit button. Click the dropdown for the Find, Replace, Go to line, Undo, and Redo options.

2. Format button. Format your query in one click, apply indentation, change case, or toggle comments.

3. Embed button. Find and embed previously saved SQL code.

4. Insert Date button. Select a date from the calendar and insert it into your code.

5. Explain button. Explain runs the explain function of the connected database for information about how it will execute the SQL. Highlight a part of your code and click Explain to learn about that section. If you click without highlighting, Explain will run on the statement where your cursor is.

6. Run button. Click to execute your query. Learn more about run options.

7. Export button. Run and export your query results. Learn more about export options.

8. Cancel button. Stop your query from running after it is already in progress.

9. Schedule button. Click to schedule a query. Learn more about scheduling.

10. Publish button. Publish your query in the Catalog. Learn more about publishing your query.

11. Share button (versions 2022.4 and earlier)

    Sharing & Access button (versions 2023.1 and later)

    In versions 2023.1 and later, the button is only visible if you have edit or owner access to the query. You can perform the following with the Sharing & Access button:

    1. Share your query

    2. Turn it into a form

    3. Jump directly from Compose to the query’s corresponding catalog page with View Query Page in versions 2023.1.6 and later.

    4. Create an Excel Live Report

12. More button. Click to access the query’s version history, configure access, clone the query, or delete the query.

Much of the above functionality also has keyboard shortcuts.

Results Toolbar

The Results Toolbar is located below the Code Pane.

1. Results tab. Click the Results tab to view your query results. Select subtabs to view all previous runs. Click a row number in the Results pane to highlight and view the entire row.

   1. If a row number is already highlighted, any other row number you click will also be highlighted.

   2. If you click anywhere inside the Results pane, the row highlight disappears.

   3. Click any cell inside the Results pane and only that individual cell is highlighted.

2. Preview tab. Preview your columns and tables as you code. Learn more about previews.

3. History tab. Click to view your query revision history. Learn more about code revision history.

4. Description tab. Add insights and information about your query in the Description tab.

5. Manual resize. Drag up or down to change the size of your results toolbar.

6. Resize tabs. Click Minimize, Split, or Maximize to navigate between your query and results.

Note

Tabs one through four can also be enabled using shortcut keys. The combination keys for your operating system will appear to the right of the tabs in yellow by either hovering over each individual tab or pressing command for Mac, Ctrl for Windows. Learn more about keyboard shortcuts.

2021.4 and Earlier

(*) Alation logo. Click to return to your Alation Catalog.

1. Query tabs. Query tabs. Drag to reorder them or double click a tab to view it.

2. Settings. Click to toggle SmartSuggest on and off or navigate to the Compose Settings page.

3. Help. If you made it here, you have likely found this one already! Click the Help button to visit this knowledge base.

4. Edit button. Traditional selection of word processing edit tools with keyboard shortcuts.

5. Format button. Format your query in one click or highlight sections to apply formatting options.

6. Embed button. Embed previously saved SQL code. Use the search bar to find any user’s saved query. Click Return to insert the code in your workspace.

7. Insert Date button. Select a date from the calendar and insert it into your code.

8. Explain button. Explain runs the explain function of the connected database for information about how it will execute the SQL. Highlight a part of your code and click Explain to learn about that section. If you click without highlighting, Explain will run on the statement where your cursor is.

9. Run button. Click to run the entirety of your code. Learn more about run options.

10. Export button. Run and export your query results. Learn more about export options.

11. Cancel button. Stop your query from running After it is already in progress.

12. Query name. The name of your query. Double-click the text to rename it.

13. Data source. The name of the data source you are querying.

14. Schema. The name of the schema in the database you are querying.

15. Connection button. The URI you will use to execute your query.

16. New database button. Click to add an alternative database URI. Learn more about adding DB connections here.

17. Schedule button. Click to schedule a query. Learn more about scheduling here.

18. Save button. Click to save a query. You can Save or Save as which will duplicate the query. When you save your query the first time, you can provide a Title and Description for your query. If you choose to write a description for your query at a later date, you need click Description in the Results Toolbar.

19. Publish button. Publish your query in Catalog. Learn more about publishing your query here.

20. Share button. Click to share your query.

21. Delete button. Delete your query.

When you are not full-screen, you will see the following. Functionality remains the same; however, most buttons will display only their corresponding icons instead of words.

Additionally, keyboard shortcuts exist for much of the above functionality.

The Results Toolbar functions the same in both earlier and later versions. Review the Results Toolbar section for reference.