This topic describes how to configure MaxCompute Studio.
After installing the MaxCompute Studio plug-in, go to File > Settings... to open the MaxCompute Studio configuration dialog.
MaxCompute Studio configuration items
In the Settings dialog box, click MaxCompute Studio in the left-side navigation pane. The following configuration options are available:
General Settings
Local meta store location: Specifies the local path to store metadata for MaxCompute projects. By default, MaxCompute Studio uses the .odps.studio\meta directory in your user home directory.
Table preview rows: The maximum number of rows to display in a table preview.
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.
NoteIf 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: When selected, MaxCompute Studio automatically checks for updates. This option is enabled by default.
Check new versions: Click to check for updates manually. If a new version is found, click Install latest version to install it. You must then restart IntelliJ IDEA for the changes to take effect.
SDK & Console configuration items
In the left-side navigation pane of the Settings dialog box, click MaxCompute Studio > SDK & Console to open the SDK & Console configuration page.
On this page, use the Installed Location option to specify the installation path of the local MaxCompute client. MaxCompute Studio automatically detects the client version in the specified path. If the detection fails, an error message is displayed.
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 left-side navigation pane of the Settings dialog box, click MaxCompute Studio > MaxCompute SQL to open the MaxCompute SQL configuration page.
The following configuration items appear on the right side of the dialog box:
Color and Annotator
Select Enable syntax coloring to apply syntax highlighting to your code.
Code Completion
Select Enable code completion to get automatic suggestions as you type.
Select this option to trigger code completion when you press the spacebar.
Code Formatting
Select Enable code formatting to allow reformatting of SQL code.
Select Enable code folding to allow collapsing and expanding of code blocks.
Script Submit
Show job detail when script submitted: When selected, automatically displays job details after a script is submitted.
Record SQL history when script submitted: When selected, saves submitted SQL scripts to your history.
Show SQL cost confirm dialog when script submitted: When selected, displays a cost confirmation dialog before a script is submitted.
Pin SQL execution result tab by default: When selected, pins the SQL execution result tab by default.
Ignore local compile error when submit script (Optional): Ignores local compilation errors when you submit a script.
Use tunnel to download query acceleration result (Optional): Uses Tunnel to download query acceleration results.
Job Name: Configures how the default job name is generated.
Use script file name as default: Uses the script filename as the default job name.
Input job name when first submit: Prompts you to enter a job name on the first submission.
Input job name for every submit: Prompts you to enter a job name for every submission.
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: Compiles and submits the entire SQL file as a single script. This mode allows the optimizer to improve the execution plan for better overall 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.
Execution mode
Default: Uses the standard execution engine provided by MaxCompute.
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 left-side navigation pane of the Settings dialog box, click MaxCompute Studio > MaxCompute Job to open the MaxCompute Job configuration page.
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 left-side navigation pane of the Settings dialog box, click MaxCompute Studio > Accounts to open the Accounts configuration page.
This page is for managing accounts that access MaxCompute. For more information about accounts, see user authentication.
MaxCompute Studio uses the specified accounts to access MaxCompute projects and run jobs.
Add an account
In the right-side navigation pane, click + and select Alibaba Cloud account by AccessKey.
In the Add MaxCompute Account dialog box, configure the following parameters:
Account Name: The display name for the account in MaxCompute Studio. For an Alibaba Cloud account such as
user_****@test.aliyun.com, set this field touser_test. For a RAM user such asuser_ram@xxxxx.onaliyun.comthat belongs to the Alibaba Cloud accountuser_****@test.aliyun.com, set this field touser_****:user_ram.Using properties file: If you have previously configured the MaxCompute client or MaxCompute Studio and have a local odps_config.ini file, you can select this option to read the AccessKey ID and AccessKey Secret from the configuration file. If you select this option, you must upload your local odps_config.ini file.
Using properties: Manually enter the AccessKey ID and AccessKey Secret. You can select either this option or Using properties file.
AccessKey ID: Enter the AccessKey ID of the Alibaba Cloud account or RAM user.
AccessKey Secret: Enter the AccessKey Secret of the Alibaba Cloud account or RAM user.
Click OK. The new account appears in the list on the Accounts page.
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.
Select the account that you want to remove from the account list.
In the right-side navigation pane, click -.
In the confirmation dialog box that appears, click OK to delete the account.
Modify the information of an account
Select the account whose information you want to modify from the account list.
In the right-side navigation pane, click the
icon. In the Edit MaxCompute Account dialog box, edit the following account details:
AccessKey ID: Enter the updated AccessKey ID of the Alibaba Cloud account or RAM user.
AccessKey Secret: Enter the updated AccessKey Secret of the Alibaba Cloud account or RAM user.
Click OK to save the changes.