MaxCompute:MaxCompute Studio

Basic user interface

As an IntelliJ IDEA plug-in, MaxCompute Studio shares the standard IDEA interface. For more information, see the IntelliJ IDEA user interface.

Connect to a MaxCompute project

To use most features in MaxCompute Studio, connect to a MaxCompute project. Once connected, you can edit SQL scripts, submit jobs, view job information, and open the MaxCompute console. MaxCompute Studio automatically caches a local copy of each project's metadata to improve access speed and reduce latency. For more information, see Manage project connections.

Data management

The Project Explorer lets you browse tables, views, user-defined functions, and resource files in your project. The tree view lists data tables, columns, partition columns, virtual views, UDF names, function signatures, and resource files with their types for all connected projects, and supports quick navigation.

Double-click a data table in a project to open the Table Details, where you can view the table's metadata, schema, and sample data. If you do not have the necessary permissions for the project, MaxCompute Studio displays an error message.

MaxCompute Studio integrates MaxCompute Tunnel to support uploading and downloading local data. For more information, see MaxCompute Tunnel commands and Import and export data using MaxCompute Tunnel in MaxCompute Studio.

Write SQL scripts

The SQL Editor in MaxCompute Studio supports writing MaxCompute SQL scripts with the following workflow:

• Create a project or module.

  1. In the IntelliJ IDEA interface, click File > New.

  2. On the New menu, select Project... or Module....

  3. In the New Project or New Module dialog box, select MaxCompute Studio and click Next.

  4. Enter a Project Name or Module Name and click Finish.

• Create a MaxCompute SQL script file.

  1. In the IntelliJ IDEA interface, click File > New.

     Note

     You can also right-click an existing project or module to create a new MaxCompute SQL script.

  2. On the New menu, select MaxCompute SQL Script.

  3. In the New MaxCompute SQL Script dialog box, enter a Script Name and click OK.

  Note

  When you create a MaxCompute SQL script, MaxCompute Studio prompts you to associate it with a MaxCompute project. You can also change this association using the Project Selector on the far right of the SQL Editor toolbar. The editor validates your SQL statements against the associated project's metadata (such as the schema) and reports any errors. When you run the script, the job is submitted to the associated project for execution. For more information, see Write SQL scripts.

Intelligent SQL code hints

• Code syntax validation

  The SQL Editor detects SQL syntax errors, type mismatches, or warnings as you type and marks them inline.

  select a.key, b.value + c.value value
  from src a join srcp b, src c
  where a.key = b.key and b.key = c.key;

• Intelligent code completion

  The code completion feature provides context-aware suggestions for project names, tables, fields, functions, types, and keywords, and automatically completes the code based on your selection. When you enter the following statement in the SQL Editor, the editor automatically displays a completion list of table names that start with the text you typed (for example, table name suggestions that start with meta):

  select * from meta

Job management

• Job status

  • Active jobs

    • Pending: The job is submitted and is waiting to enter the queue.

    • pending: The job is in the queue and waiting for resource allocation.

    • running: The job is running.

  • Historical jobs

    • success: The job completed successfully.

    • failed: The job failed.

    • cancelled: The job was manually cancelled.

• Compile a job

  Click the icon on the SQL Editor toolbar to compile the SQL script locally. If the script contains syntax or semantic errors, the compiler window reports the errors.

  -- select clause in the front
      select * from table_test;
      -- from clause in the front
      from table_test table_alias select *;
      -- table name with project prefix
  MaxCompute Compiler
  Information: Parsing ...
  Information: Type checking ...
  Information: Latency.compiler_parse_error : 44170
  Information: Build failed(2)
  /Users/xueming.xm/IdeaProjects/MyUDF/Script/scripts/...
    Error:(9, 15)  table meta.table_test cannot be resolved
    Error:(12, 6)  table meta.table_test cannot be resolved

• Submit a job

  Click the icon on the SQL Editor toolbar to compile locally and then submit the SQL script to the specified MaxCompute project for queued execution.

• View jobs

  Open the Job Explorer to view recent jobs in the specified project.

• View job details

  Double-click a job in the list to view its details. You can also click the icon to open Logview in a browser and view job details. For more information about Logview, see Logview tool.

Develop MapReduce and UDFs

MaxCompute Studio supports developing MapReduce programs, Java UDFs, and Python UDFs. For more information, see Develop MapReduce, Develop a Java UDF, and Develop a Python UDF.

Connect to the MaxCompute client

MaxCompute Studio integrates the latest version of the MaxCompute client. You can also specify the path to a locally installed MaxCompute client on the MaxCompute Studio configuration page. For more information, see Configure MaxCompute Studio.

Aliyun ODPS Command Line Tool
Version 0.24.1
@Copyright 2015 Alibaba Cloud Computing Co., Ltd. All rights reserved.
odps@ sql_optimizer>

Next steps: Install and configure

To get started with MaxCompute Studio, complete the following installation and configuration steps:

1. Install IntelliJ IDEA

   MaxCompute Studio is a plug-in that runs on IntelliJ IDEA, so you must install IntelliJ IDEA first.

2. Install MaxCompute Studio

   Install the MaxCompute Studio plug-in in IntelliJ IDEA.

3. Configure MaxCompute Studio

   Configure MaxCompute Studio.

4. Connect to a MaxCompute project.

   Connect to a MaxCompute project to view its information in the IDE.