Studio integrates a data catalog sidebar that allows you to view table metadata, copy table names, insert field names, and bookmark frequently used tables without switching pages while writing SQL / Notebook / Python code. The metadata source of the data catalog sidebar is consistent with that of Data Catalog, with only the presentation optimized for development scenarios. Overview
The Studio data catalog sidebar displays a hierarchy of Data Source → Catalog → Schema → Table → Column, and provides quick actions such as Insert into Editor, Copy, and Bookmark after table and field names. The visible database and table scope is determined by the Catalog permissions you have in the current workspace.
Scenario | Benefits |
Uncertain about table structure when writing SQL | Browse the field list directly in the sidebar and insert fields into the editor with one click. |
Finding tables developed by others during team collaboration | Globally search table names, remarks, and field names |
Frequent access to frequently used tables | After an item is favorited, it is pinned to the top, reducing search costs. |
Prerequisites
You have joined the workspace and have access to the Studio module.
One or more data sources have been bound to the workspace, and the corresponding Catalog access has been completed.
Operation Steps
Step 1: Opening the Data Catalog Sidebar
1. Switch to the Data Catalog sidebar on the left side of Studio.
2. The hierarchy below is expanded in the order of Catalog → Schema → Table → Column.
Step 2: Viewing Metadata
hover over the table name: A pop-up window displays metadata such as the table name, creator, description, table size, and last update time.
hover over the field name: A pop-up window displays the field name, field type, whether it is a partition column, and field description.
Click the table name: Expand the field list.
Click the field name: Expand the field details.
Step 3: Searching Metadata
1. Click the Search icon at the top of the sidebar, and a standalone search box appears at the top.
2. Enter a keyword to match Catalog names, Schema names, table names, and field names simultaneously.
3. Search results are displayed in a list. Click any result to locate it in the tree directory.
4. Search scope: All Catalogs under the currently selected data source.
Step 4: Inserting and Copying
4.1 Inserting Table Names and Field Names into the Editor
Click the Insert icon after a table name or field name, and the fully qualified three-part name catalog.schema.table or column_name is automatically inserted at the current cursor position.
4.2 Copying Names
hover over a table name or field name, and click Copy in the pop-up window to copy the name to the clipboard.
Use this to paste into a SQL editor or Notebook cell.
Parameter Description
Search Scope and Matching Rules
Item | Description |
Search field | Catalog name / Schema name / Table name / Column name / Table description / Field description |
Hit rule. | Contains match (case-insensitive) |
Search scope | Databases and tables that you have permission to access under the currently selected data source |
Maximum Results per Request | See the console for details. |
Use Limits
The tables visible in the data catalog are controlled by Catalog permissions. For details, see Data Security. Search returns only objects for which you have permissions. Objects without permissions do not appear in the results.
The Insert and Quick SELECT features are available only in Notebook, SQL, and Python editors.
FAQs
Q1: A table is visible in the data catalog, but a "table not found" error occurs during SQL queries.
The default Catalog / Schema may not be set, causing table name resolution to fail during queries. Use the three-part name catalog.schema.table to reference the table, or set the default Catalog in the upper-right corner of the SQL editor.
Check whether the Catalog containing the table is bound to the current workspace.
Q2: Are the search results incomplete?
Search returns only objects for which you have permissions. If you are a new member, contact the workspace administrator to grant you Catalog access permissions.
Click Refresh in the sidebar to reload the metadata index.
Q3: Why is a newly created table not visible in the data catalog?
Metadata synchronization has a short delay (usually within 1 minute). If the table remains invisible for a long time, click Refresh or reselect the data source.
References
SQL IDE Basic Operations