FE Configuration - Shared-data, Data Lake, and Others
FE parameters are classified into dynamic parameters and static parameters.
-
Dynamic parameters can be configured and adjusted by running SQL commands, which is very convenient. But the configurations become invalid if you restart your FE. Therefore, we recommend that you also modify the configuration items in the fe.conf file to prevent the loss of modifications.
-
Static parameters can only be configured and adjusted in the FE configuration file fe.conf. After you modify this file, you must restart your FE for the changes to take effect.
Whether a parameter is a dynamic parameter is indicated by the IsMutable column in the output of ADMIN SHOW CONFIG. TRUE indicates a dynamic parameter.
Note that both dynamic and static FE parameters can be configured in the fe.conf file.
View FE configuration itemsβ
After your FE is started, you can run the ADMIN SHOW FRONTEND CONFIG command on your MySQL client to check the parameter configurations. If you want to query the configuration of a specific parameter, run the following command:
ADMIN SHOW FRONTEND CONFIG [LIKE "pattern"];
For detailed description of the returned fields, see ADMIN SHOW CONFIG.
You must have administrator privileges to run cluster administration-related commands.
Configure FE parametersβ
Configure FE dynamic parametersβ
You can configure or modify the settings of FE dynamic parameters using ADMIN SET FRONTEND CONFIG.
ADMIN SET FRONTEND CONFIG ("key" = "value");
The configuration changes made with ADMIN SET FRONTEND will be restored to the default values in the fe.conf file after the FE restarts. Therefore, we recommend that you also modify the configuration items in fe.conf if you want the changes to be permanent.
Configure FE static parametersβ
Static parameters of an FE are set by changing them in the configuration file fe.conf and restarting the FE to allow the changes to take effect.
This topic introduces the following types of FE configurations:
Shared-dataβ
aws_s3_access_keyβ
- Default: Empty string
- Type: String
- Unit: -
- Is mutable: No
- Description: The Access Key ID used to access your S3 bucket.
- Introduced in: v3.0
aws_s3_endpointβ
- Default: Empty string
- Type: String
- Unit: -
- Is mutable: No
- Description: The endpoint used to access your S3 bucket, for example,
https://s3.us-west-2.amazonaws.com. - Introduced in: v3.0
aws_s3_external_idβ
- Default: Empty string
- Type: String
- Unit: -
- Is mutable: No
- Description: The external ID of the AWS account that is used for cross-account access to your S3 bucket.
- Introduced in: v3.0
aws_s3_iam_role_arnβ
- Default: Empty string
- Type: String
- Unit: -
- Is mutable: No
- Description: The ARN of the IAM role that has privileges on your S3 bucket in which your data files are stored.
- Introduced in: v3.0
aws_s3_pathβ
- Default: Empty string
- Type: String
- Unit: -
- Is mutable: No
- Description: The S3 path used to store data. It consists of the name of your S3 bucket and the sub-path (if any) under it, for example,
testbucket/subpath. - Introduced in: v3.0
aws_s3_regionβ
- Default: Empty string
- Type: String
- Unit: -
- Is mutable: No
- Description: The region in which your S3 bucket resides, for example,
us-west-2. - Introduced in: v3.0
aws_s3_secret_keyβ
- Default: Empty string
- Type: String
- Unit: -
- Is mutable: No
- Description: The Secret Access Key used to access your S3 bucket.
- Introduced in: v3.0