MaxCompute Studio is a big data integrated development environment (IDE) plug-in for IntelliJ IDEA, provided by Alibaba Cloud MaxCompute. With MaxCompute Studio, you can:
-
Write and validate SQL scripts with syntax highlighting, real-time error detection, and intelligent code completion
-
Browse and manage tables, views, user-defined functions (UDFs), and resource files in your MaxCompute projects
-
Compile, submit, and monitor SQL jobs without leaving your IDE
-
Develop MapReduce programs, Java UDFs, and Python UDFs
-
Upload and download local data through MaxCompute Tunnel
-
Run MaxCompute client commands directly in the integrated console
User interface
MaxCompute Studio extends the standard IntelliJ IDEA interface with four panels. For a general overview of the IntelliJ IDEA interface, see Guided Tour around the User Interface.
| Panel | Description |
|---|---|
| SQL Editor | Write and run SQL scripts. Provides syntax highlighting, real-time error reporting, code completion, local compilation, and job submission. |
| Project Explorer | Connect to a MaxCompute project and browse its tables, views, UDFs, and resource files in a tree view. |
| Job Explorer | Browse and search active and historical jobs across your connected MaxCompute projects. |
| MaxCompute console | Enter and run MaxCompute client commands directly within the IDE. |
Connect to a MaxCompute project
Most MaxCompute Studio features require an active project connection. After connecting, you can edit SQL scripts, submit jobs, view job details, and open the MaxCompute console.
MaxCompute Studio caches a local copy of each project's metadata to reduce access latency.
For setup instructions, see Manage project connections.
Manage data
In Project Explorer, expand a project to browse its tables, columns, partition key columns, virtual views, UDFs, function signatures, resource files, and types of resource files. Double-click any table to open Table Details View, which shows the table's metadata, schema, and sample data.
If you lack the required permissions on the connected project, MaxCompute Studio displays an error message.
To upload or download local data, use the integrated MaxCompute Tunnel. See Tunnel commands and Import and export data by using Tunnel in MaxCompute Studio.
Write SQL scripts
Create a project or module:
-
In the IntelliJ IDEA menu bar, choose File > New.
-
Select Project... or Module....
-
In the dialog, select MaxCompute Studio and click Next.
-
Enter a project name or module name, then click Finish.
Create a SQL script file:
-
Choose File > New, or right-click an existing project or module.
-
Select MaxCompute SQL Script.
-
Enter a script name in the Script Name field and click OK.
When you create a script, MaxCompute Studio prompts you to associate it with a MaxCompute project. SQL Editor checks table schemas and other metadata against the associated project and reports errors accordingly. To change the associated project later, use Project Selector on the right side of the SQL Editor toolbar.
For more details, see Write SQL scripts.
Check and complete code
Syntax verification
SQL Editor checks your code in real time and marks syntax errors, type mismatches, and other alerts inline.
Code completion
As you type, SQL Editor suggests project names, tables, fields, functions, types, and keywords based on context.
Manage jobs
Compile a job
Click the 
icon in the SQL Editor toolbar to compile the SQL script on your local machine. SQL Editor reports any syntax or semantic errors.
Submit a job
Click the 
icon to submit the compiled SQL script to the associated MaxCompute project for execution.
View jobs and job details
Open Job Explorer to see recent jobs for a specific MaxCompute project. Jobs are grouped by status:
| Category | Status | Description |
|---|---|---|
| Active jobs | waiting | Submitted but not yet in the queue |
| Active jobs | pending | In the queue, waiting for resource allocation |
| Active jobs | running | Currently executing |
| Historical jobs | success | Completed successfully |
| Historical jobs | failed | Failed to run |
| Historical jobs | cancelled | Cancelled |
Double-click any job in the list to view its details. Click the 
icon to open the job in Logview. See Use Logview to view job information.
Develop MapReduce programs and UDFs
MaxCompute Studio supports developing MapReduce programs, Java UDFs, and Python UDFs directly in IntelliJ IDEA. See Develop a MapReduce program, Develop a UDF, and Develop a Python UDF.
Connect to the MaxCompute client
MaxCompute Studio is integrated with the latest version of the MaxCompute client. To use a client already installed on your machine, specify its path in the MaxCompute Studio configuration page. See Configure MaxCompute Studio.
To open the console, right-click a project in Project Explorer and select Open in Console. The MaxCompute Console window appears.
What's next
To start using MaxCompute Studio, complete the following steps in order:
-
Install IntelliJ IDEA — MaxCompute Studio requires IntelliJ IDEA as its base platform.
-
Install MaxCompute Studio — Install the MaxCompute Studio plug-in on IntelliJ IDEA.
-
Configure MaxCompute Studio — Set configuration options such as the MaxCompute client path.
-
Connect to a MaxCompute project — Connect to a project to start editing scripts and submitting jobs.