DBE_ILM_ADMIN
API Description
Implements ILM policies, and controls ADO background scheduling and concurrency control parameters.
API |
Description |
---|---|
CUSTOMIZE_ILM |
Customizes ILM policy attributes based on input parameters. |
DISABLE_ILM |
Disables background scheduling. |
ENABLE_ILM |
Enables background scheduling. |

When there are a large number of concurrent requests and you run DBE_ILM_ADMIN.DISABLE_ILM or DBE_ILM_ADMIN.ENABLE_ILM, the system may display the message "Resources are busy, please try again later." In this case, try again later.
- DBE_ILM_ADMIN.CUSTOMIZE_ILM
Customizes ILM policy attributes based on input parameters. The prototype is as follows:
1 2 3
DBE_ILM_ADMIN.CUSTOMIZE_ILM( PARAM IN NUMBER, VAL IN NUMBER);
Table 2 DBE_ILM_ADMIN.CUSTOMIZE_ILM parameters Parameter
Description
PARAM
Sequence number of a parameter.
VAL
Parameter value.
In B- or M-compatible mode, if the input VAL is a non-numeric character when DBE_ILM_ADMIN.CUSTOMIZE_ILM() is called, for example, DBE_ILM_ADMIN.CUSTOMIZE_ILM(13, '*'), the input VAL is set to 0 by default.
Table 3 DBE_ILM_ADMIN.CUSTOMIZE_ILM parameters Parameter ID
Parameter Value
Description
1
EXECUTION_INTERVAL
Specifies the frequency of executing an ADO task, in minutes. The default value is 15. The value is an integer or floating-point number greater than or equal to 1 and less than or equal to 2147483647. The value is rounded down.
2
RETENTION_TIME
Specifies the retention period of ADO-related history records, in days. The default value is 30. The value is an integer or floating-point number greater than or equal to 1 and less than or equal to 2147483647. The value is rounded down.
7
ENABLE
Status of background scheduling. This parameter cannot be modified using DBE_ILM_ADMIN.CUSTOMIZE_ILM. Use DBE_ILM_ADMIN.DISABLE_ILM or DBE_ILM_ADMIN.ENABLE_ILM to modify it.
11
POLICY_TIME
Specifies whether the time unit of ADO is day or second. The time unit second is used only for testing. Possible values are:
- 0: ILM_POLICY_IN_DAYS (default value)
- 1: ILM_POLICY_IN_SECONDS
12
ABS_JOBLIMIT
Specifies the maximum number of ADO jobs generated by an ADO task. The value is an integer or floating-point number greater than or equal to 0 and less than or equal to 2147483647. The value is rounded down.
13
JOB_SIZELIMIT
Specifies the maximum number of bytes that can be processed by a single ADO job. The unit is MB. The value is an integer or floating-point number greater than or equal to 1 and less than or equal to 2147483647. The value is rounded down.
14
WIND_DURATION
Specifies the maintenance window duration, in minutes. The default value is 240 minutes (4 hours). The value is an integer greater than or equal to 0 and less than 1440 (24 hours).
15
BLOCK_LIMITS
Specifies the upper limit of the instance-level row-store compression rate. The default value is 40. The value ranges from 0 to 10000, in block/ms, indicating the maximum number of blocks that can be compressed per millisecond. 0 indicates that the rate is not limited.
16
ENABLE_META_COMPRESSION
Specifies whether to enable header compression. The default value is 0. The value can be 0 (disabled) or 1 (enabled).
NOTE:If this parameter is set to 1, the compression ratio is improved for tables with short rows (less data in a single row), but the performance of accessing compressed rows greatly deteriorates. If most tables in the database have long rows, you are advised not to enable this parameter.
17
SAMPLE_MIN
Minimum sampling step for constant encoding and equivalent encoding. The default value is 10. The value range is [1,100]. Decimals can be entered and will be automatically rounded down.
18
SAMPLE_MAX
Maximum sampling step for constant encoding and equivalent encoding. The default value is 10. The value range is [1,100]. Decimals can be entered and will be automatically rounded down.
19
CONST_PRIO
Constant encoding priority. The default value is 40. The value range is [0,100]. The value 100 indicates that constant encoding is disabled. Decimals can be entered and will be automatically rounded down.
20
CONST_THRESHOLD
Constant encoding threshold. The default value is 90. The value range is [1,100], indicating that constant encoding is performed when the proportion of constant values in a column exceeds the threshold. Decimals can be entered and will be automatically rounded down.
21
EQVALUE_PRIO
Equivalent encoding priority. The default value is 60. The value range is [0,100]. The value 100 indicates that equivalent encoding is disabled. Decimals can be entered and will be automatically rounded down.
22
EQVALUE_THRESHOLD
Equivalent encoding threshold. The default value is 80. The value range is [1,100], indicating that equivalent encoding is performed when the ratio of equal values in two columns exceeds the threshold. Decimals can be entered and will be automatically rounded down.
23
ENABLE_DELTA_ENCODE_SWITCH
Specifies whether to enable difference encoding. The default value is 1. The value 0 indicates that difference encoding is disabled, and the value 1 indicates that difference encoding is enabled. Decimals can be entered and will be automatically rounded down.
24
LZ4_COMPRESSION_LEVEL
LZ4 compression level. The default value is 0. The value range is [0,16]. Decimals can be entered and will be automatically rounded down.
25
ENABLE_LZ4_PARTIAL_DECOMPRESSION
Specifies whether to enable partial decompression. The default value is 1. The value 0 indicates that partial decompression is disabled, and the value 1 indicates that partial decompression is enabled. Decimals can be entered and will be automatically rounded down.
- DBE_ILM_ADMIN.DISABLE_ILM
Disables background scheduling. The prototype is as follows:
1
gaussdb=# DBE_ILM_ADMIN.DISABLE_ILM();
- DBE_ILM_ADMIN.ENABLE_ILM
Enables background scheduling. The prototype is as follows:
1
gaussdb=# DBE_ILM_ADMIN.ENABLE_ILM();
Note: To make background scheduling take effect, you need to enable the GUC parameter enable_ilm on the database O&M platform.
Examples
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
gaussdb=# CALL DBE_ILM_ADMIN.CUSTOMIZE_ILM(1, 15); customize_ilm --------------- (1 row) gaussdb=# select * from gs_adm_ilmparameters; name | value ----------------------------------+------- EXECUTION_INTERVAL | 15 RETENTION_TIME | 30 ENABLED | 1 POLICY_TIME | 0 ABS_JOBLIMIT | 10 JOB_SIZELIMIT | 1024 WIND_DURATION | 240 BLOCK_LIMITS | 40 ENABLE_META_COMPRESSION | 0 SAMPLE_MIN | 10 SAMPLE_MAX | 10 CONST_PRIO | 40 CONST_THRESHOLD | 90 EQVALUE_PRIO | 60 EQVALUE_THRESHOLD | 80 ENABLE_DELTA_ENCODE_SWITCH | 1 LZ4_COMPRESSION_LEVEL | 0 ENABLE_LZ4_PARTIAL_DECOMPRESSION | 1 (18 rows) |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot