Updated on 2024-06-03 GMT+08:00

DBE_ILM_ADMIN

Interface Description

Implements ILM policies, and controls ADO background scheduling and concurrency control parameters.

Table 1 DBE_ILM_ADMIN

Interface

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 (
       parameter            IN       int8,
       value                IN       int8);
    
    Table 2 DBE_ILM_ADMIN.CUSTOMIZE_ILM parameters

    Parameter

    Description

    parameter

    Sequence number of a parameter.

    value

    Parameter value.

    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

    Specifies the background scheduling status which cannot be modified in this interface. Otherwise, the message "Invalid argument value, ENABLED should be change by calling DBE_ILM_ADMIN.ENABLE_ILM and DBE_ILM_ADMIN.DISABLE_ILM" is displayed. Instead, use disable_ilm() and enable() 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.

  • 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 management and control plane.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
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
(8 rows)