Studio is the unified development workspace of DataBuddy. This section describes the overall interface layout of the Studio overview page, as well as basic operations such as file organization, search, favorites, and recycle bin.
Overview
Studio supports the development of multiple file types, including Notebook, SQL, Python, Markdown, and CSV, in a single interface, covering all development scenarios such as Notebook, SQL, and Python, and provides unified interactions including directory, creation, search, favorites, and recycle bin. The Studio directory is organized from the user's perspective, and access scopes between files are controlled through ACL permissions.
Prerequisites
You have joined the target workspace and have access to the Studio module.
The workspace is bound to compute resources, which are used when Notebook / Python / SQL files are run.
To use Git folders, the workspace must have a Git connection configured, and the current user must have completed personal Git configuration.
Studio Directory Structure
The Studio directory is organized into the following four areas:
|
Workspace | Displayed by default. Stores development files created by all members in the workspace. | By default, only the creator and workspace administrators can access it. Access can be granted to other users through ACLs. |
GitFolder | Displayed after Git connection is configured for the workspace. Directory content is synchronized with the remote Git repository. | By default, only the creator can access it. Separate authorization is not supported. |
Favorites | Folders and files favorited by the current user are displayed in an aggregated manner across regions. | The Favorites folder belongs to the current user. |
Recycle Bin | Objects deleted by the current user from other areas can be restored or permanently deleted. | The recycle bin belongs to the current user. |
Note:
Notebook, SQL, Python, and other files can all be placed in the same local folder. File types are identified by their extensions (such as .ipynb, .sql, .py, .sh, .csv, .json, .yaml, .md, and .txt).
Operation Steps
Step 1: Browsing the Studio Overview Page
1. Click the Studio feature module to open the Workspace directory by default.
2. Users can switch between Workspace, GitFolder, Favorites, and Recycle Bin in the left directory, and drill down by hierarchy to view subfolders.
3. Click a folder name to view its subfolders and files on the right.
Step 2: Creating Folders and Files
1. Click + Create in the upper-right corner of the page.
2. Select Create Object from the pop-up menu:
Folder: Used to organize files.
Notebook: A development file ending with .ipynb.
SQL: A script file ending with .sql.
Python: Select a file with the extension ending in .py.
File: Manually enter an extension. Supported extensions include .sh, .csv, .json, .yaml, .md, and .txt.
Dashboard: Navigate to the Dashboard module and automatically create a new dashboard.
Model Experiments: Navigate to the Model Experiments module and open the page for creating a machine learning experiment.
1. Enter a name, select a parent folder, and then click OK.
Step 3: Uploading Files
1. In the target folder - More Actions, select Upload File.
2. Select a local file and click Open.
3. Uploaded files appear in the target folder. For file types that cannot be opened online, such as .zip and .pdf, a "Preview unavailable" message is displayed when you click them.
Step 4: Searching for Files
1. Click Search in the upper-right corner of the page.
2. Enter a file name keyword in the search box at the top. By default, the search scope is the current directory.
3. Search results are displayed below the search box, and you can make further selections.
Step 5: File Operations
Object | Supported Operations |
Folder | Create Folder / Notebook / SQL / File, Copy Path, Rename, Move, Upload, Configure Permissions, Delete, Favorite / Unfavorite |
File | Copy Path, Rename, Move, Copy, Download, Configure Permissions, Favorite / Unfavorite, Delete |
Copy Path: Returns the full path, such as /workspace_1/your_username/folder_1/file_1.ipynb, which can be pasted into a Notebook and referenced using %run or import.
Delete: Moves the item to the recycle bin, where you can restore it or permanently delete it.
Step 6: Managing Favorites and Recycle Bin
Favorites: Displays the object name, type, time added to favorites, and original path in a list. You can filter by type and remove favorites individually or in batches.
Recycle Bin: Displays the object name, type, deletion time, and original path in a list. You can filter by type, sort by deletion time, and restore or permanently delete items individually or in batches.
Note: During restoration, if the source path does not exist, you need to select a parent folder again. If a file with the same name already exists in the target path, you need to rename the file.
Step 7: Entering the Studio IDE
After you enter the Studio IDE, the interface is divided into three columns:
Far left: The feature sidebar contains Studio Directory, Data Directory, and Git Source Control in order.
Middle: The directory or search results corresponding to the current sidebar.
Right: The main editor area, where multiple files are opened as tabs.
Note:
The Studio directory supports only creating folders, Notebooks, SQL files, Python files, and other file types. It does not support creating dashboards or model experiments. Other operations are basically the same as those on the Overview page.
Parameter Description
Naming Rules for New Objects
|
Name | Folder or file name, supporting Chinese, English, digits, underscores, hyphens, dots, spaces, and colons. | Yes | None |
Extension name. | Required only when New File is selected. Determines the file type. | Yes | None |
Parent folder | Path where the file is located. The Git folder is selectable only after a Git connection is configured for the workspace. | Yes | Current directory |
Resource Quotas
|
Single file size (page creation/upload) | 500 MB |
Single file size (OpenAPI creation/upload) | 10 MB |
Development directory depth | No more than 10 levels |
File name length | No more than 255 characters |
Number of files in a single directory level | No more than 2,000 |
Use Limits
Directories of different modules (Studio and Workflow) are isolated from each other. Notebook files in Studio cannot be directly run as scheduled tasks. You need to create a task in Workflow and reference the Notebook file.
Files in a Git folder do not support individual authorization. For fine-grained control, place the files in a local folder.
Binary files such as .zip and .pdf can be uploaded and downloaded, but they cannot be opened online.
FAQs
Q1: Can deleted files be recovered?
Yes. Deleted folders and files are moved to the personal recycle bin, where you can select Restore. Once permanently deleted, they cannot be recovered. Proceed with caution.
Q2: Can I see files created by others?
In Workspace, if you are a Workspace Admin, you can see files created by others. If you are not a Workspace Admin, you can also see the corresponding files in your directory if the owner has granted you the View, Run, Edit, and Manage permissions through ACL.
By default, you cannot see files created by others in GitFolder. If you log in to the remote Git repository, all workspace members can see all files.
Q3: What should I do if the number of files in a single-level directory exceeds 2,000?
Split the files into subfolders based on your business logic. We recommend that you organize them into three levels: scenario, topic, and date. Avoid placing too many files in one directory.
References