All Products
Search
Document Center

MaxCompute:Configure MaxCompute Studio

Last Updated:Jul 07, 2023

This topic describes how to configure MaxCompute Studio.

After MaxCompute Studio is installed, choose File > Settings... in the main menu bar of IntelliJ IDEA to go to the Settings dialog box to configure MaxCompute Studio.

MaxCompute Studio configuration items

In the Settings dialog box, click MaxCompute Studio in the left-side navigation pane. The following configuration items appear on the right side of the dialog box:

  • General Settings

    • Local meta store location: the local path in which metadata is stored. This configuration item specifies the local path that is used to store the metadata of a MaxCompute project. By default, MaxCompute Studio stores the metadata in the local path .odps.studio\meta.

    • Table preview rows: the maximum number of rows that can be previewed in a table.

    • Local directory for jobs: the local path that is used to store the data of MaxCompute Studio jobs. By default, MaxCompute Studio stores the data in the local path .odps.studio\job.

      Note

      If you retain the default value, you must make sure that the path .odps.studio\job exists and MaxCompute Studio has write permissions on the path. Otherwise, an error may occur when you confirm the configurations.

    • Python path to resolve UDF: the local installation path of Python.

  • Updates Checking

    • Automatically checks for new version: specifies whether to enable MaxCompute Studio to automatically check for a new version. By default, this parameter is selected to support automatic updates.

    • Check new versions: You can click this button to manually check for a new version. After you click this button, the Install latest version button appears if a new version is available. You can click the Install latest version button to install the new version. After the new version is installed, you must restart IntelliJ IDEA.

SDK & Console configuration items

In the Settings dialog box, choose MaxCompute Studio > SDK & Console in the left-side navigation pane.

The Installed Location configuration item appears on the right side of the dialog box. This configuration item specifies the local installation path of the MaxCompute client. MaxCompute Studio automatically detects the version of the MaxCompute client that is installed in the path. If no client is found, an error message is returned.

Note

If the version of MaxCompute Studio is later than V2.6.1, you do not need to specify a path because MaxCompute Studio automatically installs the latest MaxCompute client. If you want to use the MaxCompute client of a specific version, you can specify the path.

MaxCompute SQL configuration items

In the Settings dialog box, choose MaxCompute Studio > MaxCompute SQL in the left-side navigation pane.

The following configuration items appear on the right side of the dialog box:

  • Color and Annotator

    You can select Enable syntax coloring to enable the syntax highlighting feature.

  • Code Completion

    • You can select Enable code completion to enable the automatic code completion feature.

    • If you select Invoke code completion when you enter a space, the automatic code completion feature is disabled when you enter a space.

  • Code Formatting

    • You can select Enable code formatting to enable the code formatting feature.

    • You can select Enable code folding to enable the code folding feature.

  • Script Submit

    • If you select Show job detail when script submitted, job details are displayed when you submit a script.

    • If you select Record sql history when script submitted, the execution history of SQL statements is recorded when you submit a script.

    • If you select Show sql cost confirm dialog when script submitted, a message is displayed to prompt you to confirm the execution cost of SQL statements when you submit a script.

    • If you select Pin sql execution result tab by default, the SQL Execution Result tab is locked by default.

    • If you select Ignore local compile error when submit script, a local compiling error that is returned is ignored when a script is submitted. This item is optional.

    • If you select Use tunnel to download query acceleration result, Tunnel is used to download the query acceleration result. This item is optional.

    • Job Name:

      • If you select use script file name as default, the name of the script file is used as the job name by default.

      • If you select input job name when first submit, you must enter a job name the first time you submit a job.

      • If you select input job name for every submit, you must enter a job name each time you submit a job.

  • Compile | Submit

    This section provides the default settings of global compiler configuration items. You can separately configure the configuration items for each file in the toolbar of the SQL compiler:

    • Compiler Mode

      • Statement Mode: In this mode, the compiler compiles and submits each statement of an SQL file as a unit.

      • Script Mode: In this mode, the compiler compiles and submits an entire SQL file as a unit. This mode enables the compiler and optimizer to optimize the execution plan and improve the overall execution efficiency.

    • Data type edition

      • Legacy TypeSystem: The MaxCompute V1.0 data type edition is used.

      • MaxCompute TypeSystem: The MaxCompute V2.0 data type edition is used.

      • Hive Compatible TypeSystem: The Hive-compatible data type edition that is based on the MaxCompute V2.0 data type edition is used.

    • Compiler

      • Default: The default compiler of MaxCompute Studio is used.

      • UseShortQueryAcceleration: The compiler that can accelerate queries is used.

      • FallbackWhenFailed: The compiler that reruns jobs is used if query acceleration fails.

MaxCompute Job configuration items

In the Settings dialog box, choose MaxCompute Studio > MaxCompute Job in the left-side navigation pane.

The following configuration items appear on the right side of the dialog box:

  • Maximum jobs shown in job explorer table list: the maximum number of jobs that can be displayed on the Job Explorer page. Default value: 1000.

  • Reset filter when switch MaxCompute project: If you select this configuration item, the job configurations are reset when you switch between MaxCompute projects.

  • Cache history instance in local database: If you select this configuration item, historical instance information is cached in the local data warehouse.

Accounts configuration items

In the Settings dialog box, choose MaxCompute Studio > Accounts in the left-side navigation pane.

You can perform the following operations to manage the accounts that are used to access MaxCompute. For more information about accounts, see User authentication.

Note

MaxCompute Studio uses the specified accounts to access MaxCompute projects and run jobs.

  • Add an account

    1. In the right-side navigation pane, choose + > Aliyun Account By AccessKey.

    2. In the Add MaxCompute Account dialog box, configure the following parameters:

      • Account Name: the display name of an account in MaxCompute Studio. Both Alibaba Cloud accounts and RAM users can be added. For example, if you add the Alibaba Cloud account user_****@test.aliyun.com, set this parameter to user_test. If you add the RAM user user_ram@xxxxx.onaliyun.com that belongs to the Alibaba Cloud account user_****@test.aliyun.com, set this parameter to user_****:user_ram.

      • Using properties file: specifies whether to read an AccessKey ID and an AccessKey secret from the configuration file odps_config.ini if odpscmd or MaxCompute Studio is configured. If you select this parameter, you must make sure that the odps_config.ini file is uploaded.

      • Using properties: specifies whether to manually enter an AccessKey ID and an AccessKey secret. You must select this parameter or Using properties file.

        • Access Id: Enter the AccessKey ID of the Alibaba Cloud account or RAM user that you want to add.

        • Access Key: Enter the AccessKey secret of the Alibaba Cloud account or RAM user that you want to add.

    3. Click OK. The added account is displayed in the account list in the Settings dialog box.

  • Remove an account

    You can perform the following steps to remove an account from MaxCompute Studio. This operation does not affect your Alibaba Cloud account or the RAM user that belongs to your Alibaba Cloud account.

    1. Select the account that you want to remove from the account list.

    2. In the right-side navigation pane, click -.

    3. In the message that appears, click OK.

  • Modify the information of an account

    1. Select the account whose information you want to modify from the account list.

    2. In the right-side navigation pane, click the 修改 icon.

    3. In the Edit MaxCompute Account dialog box, edit the following account information:

      • Access Id: Enter a new AccessKey ID.

      • Access Key: Enter a new AccessKey secret.

    4. Click OK.