MODULE DATA

Purpose

The MODULE DATA statement has the following two purposes:

• ALTER SYSTEM LOAD MODULE DATA ...: this statement is used to import a specified feature for a specific tenant.
• ALTER SYSTEM CHECK MODULE DATA ...: this statement is used to check whether a specified feature is imported for a specific tenant.

Limitations and considerations

• This statement can only be executed in the sys (system) tenant.
• The current version only supports importing the REDIS module feature to MySQL-compatible tenants.
• The current version only supports checking (using the CHECK MODULE DATA statement) the imported REDIS module feature.

Privilege requirements

The user executing this statement must have the ALTER SYSTEM privilege. For more information about OceanBase Database privileges, see Privilege types in MySQL-compatible mode.

Syntax

ALTER SYSTEM {LOAD | CHECK} MODULE DATA
    MODULE = module_value
    TENANT = tenant_name
    [INFILE = file_path];

module_value:
    REDIS
    | GIS
    | TIMEZONE

Parameters

module_value

• REDIS: specifies to operate on the REDIS module.
• GIS: specifies to operate on the GIS module.
• TIMEZONE: specifies to operate on the TIMEZONE module.

Example

LOAD MODULE DATA example

1. Import the REDIS module to the mysql001 tenant. Currently, the REDIS module does not support specifying an INFILE path, so an error is returned.

   ALTER SYSTEM LOAD MODULE DATA
       MODULE = REDIS
       TENANT = mysql001 
       INFILE = '/home/admin/test.sql';
   

   The return result is as follows:

   ERROR 4025 (HY000): loading redis module does not need to specify infile
   

2. Import the REDIS module to the mysql001 tenant.

   ALTER SYSTEM LOAD MODULE DATA
       MODULE = REDIS
       TENANT = mysql001;
   

   The return result is as follows:

   Query OK, 0 rows affected
   

3. Import the GIS module to the mysql001 tenant. The INFILE parameter is optional. The default value is etc/, and the corresponding file is located in the etc directory under the deployment directory.

   ALTER SYSTEM LOAD MODULE DATA
       MODULE = GIS
       TENANT = mysql001
       INFILE = 'etc/';
   

   The return result is as follows:

   Query OK, 0 rows affected
   

4. Import the TIMEZONE module to the mysql001 tenant. The INFILE parameter is optional. The default value is etc/, and the corresponding file is located in the etc directory under the deployment directory.

   ALTER SYSTEM LOAD MODULE DATA
       MODULE = TIMEZONE
       TENANT = mysql001
       INFILE = 'etc/';
   

   The return result is as follows:

   Query OK, 0 rows affected
   

CHECK MODULE DATA example

• If no functionality is imported to the tenant, an error is returned when the CHECK MODULE DATA statement is executed. Check whether the REDIS module functionality is imported to the tenant mysql002.

  ALTER SYSTEM CHECK MODULE DATA
      MODULE = REDIS
      TENANT = mysql002;
  

  The return result is as follows:

  ERROR 4025 (HY000): redis info is not complete, please retry loading
  

• After the functionality is imported to the tenant, check the import status.

  1. Import the REDIS module functionality to the tenant mysql002.

     ALTER SYSTEM LOAD MODULE DATA
         MODULE = REDIS
         TENANT = 'mysql002';
     

     The return result is as follows:

     Query OK, 0 rows affected
     

  2. Check whether the REDIS module functionality is imported to the tenant mysql002.

     ALTER SYSTEM CHECK MODULE DATA
         MODULE = REDIS
         TENANT = mysql002;
     

     The return result is as follows:

     Query OK, 0 rows affected