MODULE DATA

Purpose

The MODULE DATA statement has the following two functions:

• ALTER SYSTEM LOAD MODULE DATA ...: This statement is used to import a specified feature to a tenant.
• ALTER SYSTEM CHECK MODULE DATA ...: This statement is used to check whether a specified feature has been imported to a tenant.

Limitations and considerations

• This statement can be executed only in the sys (system) tenant.
• At present, this statement supports importing only the REDIS module feature to MySQL tenants.
• At present, this statement supports checking (CHECK MODULE DATA) the REDIS module feature.

Privilege requirements

The user who executes the statement must have the ALTER SYSTEM privilege. For more information about privileges in OceanBase Database, see Privilege types in MySQL 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 feature.
• GIS: specifies to operate on the GIS module feature.
• TIMEZONE: specifies to operate on the TIMEZONE module feature.

Examples

LOAD MODULE DATA example

1. Import the REDIS module feature to the mysql001 tenant. Currently, the REDIS module does not support the INFILE parameter, 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 feature 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 feature to the mysql001 tenant. The INFILE parameter is optional. If it is not specified, the default value etc/ is used. The corresponding file is located in the etc directory of the installation 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 feature to the mysql001 tenant. The INFILE parameter is optional. If it is not specified, the default value etc/ is used. The corresponding file is located in the etc directory of the installation 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 features are imported to a tenant, the CHECK MODULE DATA statement will fail. Check whether the REDIS module is imported to the mysql002 tenant.

  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
  

• Import the features of the REDIS module to the tenant first, and then check the import status.

  1. Import the REDIS module to the mysql002 tenant.

     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 is imported to the mysql002 tenant.

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

     The return result is as follows:

     Query OK, 0 rows affected