Batch export and import

OceanBase Developer Center (ODC) allows you to export and import the schemas and data of database objects in batches. This topic describes how to export and import tables in batches in ODC.

Limitations on files

The following table describes the requirements for the size of imported and exported data and the retention period of files in ODC.

Batch export

The following takes ODC V3.3.0 as an example to describe how to export data in batches from a database. For more information about other versions, see OceanBase Developer Center.

1. After you open a database connection, click Tools in the top navigation bar, and then select Export from the drop-down list.

2. In the Batch Export panel, you can export the structure and data of multiple database objects to files in the specified format at a time.

   Configure the parameters for batch export as follows:

   

   Parameter	Description
   Task Name	In the Batch Export panel, ODC automatically generates a default task name in the Task Name field in the format of connection name_mode name_date. You can modify the task name.
   Export Content	ODC supports three export modes: Export Data Only, Export Schema Only, and Export Schema and Data. Export Schema Only exports the definition statements of the target object. You need to select an export mode in the Export Content section.
   Data Format	ODC supports exporting data to files in the CSV format and SQL format. If you specify Export Schema Only for Export Content, you can only export data to files in the SQL format. For more information about the supported formats, see Export and import file formats.
   Encoding Standard	ODC supports the following encoding standards: ASCII, ISO-8859-1, GB2312, GBK, GB18030, Unicode (UTF-8), Unicode (UTF-16), Unicode (UTF-32), and BIG5. You need to select a character set from the Encoding Standard drop-down list.
   Export Objects	In the table below Export Objects, select the objects you want to export. The table contains the Object Name and Object Type columns. You can filter objects by Object Type or enter content in the search box to search for objects.
   Export Data Settings	You must configure the following parameters: Note If you specify Export Schema Only for Export Content, you do not need to complete the export data settings. Use Global Snapshot: If you select this option, ODC exports the data in the latest global snapshot of the specified table to ensure global data consistency. Batch Commit Quantity (SQL Format): You can click Advanced next to Export Data Settings to enable this feature. If you select SQL Format for Data Format, you can specify the number of rows to be committed during the export. When this number is reached, a COMMIT command is executed. Skipped Data Types: You can click Advanced next to Export Data Settings to enable this feature. Here, you can specify the data types that you want to skip when you export the data. The data types that can be skipped are different in MySQL and Oracle modes. You can select multiple data types. Specify information for the CSV format. If you specify the CSV format for Data Format and Export Data Only or Export Schema and Data for Export Content, you can click Advanced next to Export Data Settings to configure the following parameters: Include the Column Header: specifies whether to include column headers when data is exported in CSV format. This option is selected by default. Convert Empty Character String into Null Value: specifies whether to convert empty strings in the table to NULL values \N when data is exported in the CSV format. This option is selected by default. Field Separator: specifies the separator between fields. Commas (,), semicolons (;), and colons (:) are supported. You can also use a character as the separator. Text Identifier: specifies the identifier for the text content. Single quotation marks (') and double quotation marks (") are supported. Line Break Symbol: specifies the line break symbol. The following characters are supported: \n, \r, and \r\n.
   Export Schema Settings	Select whether to add the DROP statement. If you select this option, a DROP statement is added to the corresponding CREATE statement in the export file.
   Sys Tenant Account Settings	Specify whether to select Use sys Tenant Account to Accelerate Export Task or not. If you select this option, you need to enter the account and password of the SYS tenant in the Account and Password fields. Then, you can use the privileges of this account to import data, which significantly accelerates data import. Notice The account and password of the sys tenant are the account and password of a user in a cluster tenant. Do not enter @sys#cluster in the Account field. To export objects other than tables and views, you must specify the sys tenant account. If the account of the sys tenant is not configured, comments and indexes are not imported or exported.

3. Generate an export task.

   After you specify the preceding information, you can click Export in the lower-right corner of the panel to generate an export task.

4. View the export task.

   After the export task is generated, the Task Center panel automatically appears, where you can view the task information and download exported data files.

5. Terminate the export task.

   After the task is generated, the Task Center page automatically appears, where you can terminate a running export task.

Batch import

The following takes ODC V3.3.0 as an example to describe how to import data in batches to a database. For more information about other versions, see OceanBase Developer Center.

1. After you open a database connection, click Tools in the top navigation bar, and then select Import from the drop-down list.

2. In the Batch Import panel, you can choose to import the structure and data to multiple database objects at a time.

   

   Parameter	Description
   Task Name	In the panel, ODC automatically generates a task name in the Task Name field in the format of connection name_mode name_date. You can modify the task name.
   Import Format	ODC currently supports SQL files and ZIP files for batch import. You need to select the data format from the Import Format drop-down list. For more information about the supported formats, see Export and import file formats.
   Import File	Click the file pool to go to the file explorer and select the file to be imported. You can also directly drag the file to the file pool to upload it. The format of the uploaded file must be the same as that of the value you specified for Import Format. To upload a file in the ZIP file format, you must first package it into a .zip file. SQL files suffixed with .sql are supported.
   Encoding Standard	ODC supports the following encoding standards: ASCII, ISO-8859-1, GB2312, GBK, GB18030, Unicode (UTF-8), Unicode (UTF-16), Unicode (UTF-32), and BIG5. You need to select a character set from the Encoding Standard drop-down list.
   Import Content	You must specify this parameter when you select ZIP Files for Import Format. ODC supports Import Data Only, Import Schema Only, and Import Schema and Data**.** Import Schema Only imports the definition statements of the target object. You need to select a mode under Import Content.
   Data Format	You must specify this parameter when you select ZIP Files for Import Format. ODC only supports importing data in CSV format and SQL format. For more information about the supported formats, see Export and import file formats. If you specify Import Schema Only for Import Content or SQL Files for Import Format, you do not need to select the data format.
   Import Data Settings	If you specify ZIP Files for Import Format and Import Data Only or Import Schema and Data for Import Content, this option must be specified. You need to configure the following parameters: Clear Data Before Import: If you select this option, the original data in the destination object is cleared during data import. Batch Commit Quantity: You can click Advanced next to Import Data Settings to enable this feature. After you enable this feature, a COMMIT statement is executed when the number of exported data rows reaches the specified quantity. Skipped Data Types: You can click Advanced next to Import Data Settings to enable this feature. Here, you can specify the data types that you want to skip when you import the data. The data types that can be skipped are different in MySQL and Oracle modes. You can select multiple data types.
   Import Schema Settings	You cannot enable this feature if you select Import Data Only for Import Content. This setting involves operations on schemas that already exist. If you select Skip, the system skips the schema definition statement in the file to be imported and directly imports the data. The original data in the object is retained. If you select Replace, the system executes the schema definition statement in the file to be imported to re-create an object and replace the original one. Data in the original object is cleared.
   Task Error Handling Method	ODC supports two error handling methods: Abort Task and Ignore Error and Continue. You need to select the handling method under the Task Error Handling Method label.
   Sys Tenant Account Settings	Specify whether to select Use sys Tenant Account to Accelerate Import Task or not. If you select this option, you need to enter the account and password of the SYS tenant in the Account and Password fields. Then, you can use the privileges of this account to import data, which significantly accelerates data import. Notice The account and password of the sys tenant are the account and password of a user in a cluster tenant. Do not enter @sys#cluster in the Account field. If the account of the sys tenant is not configured, comments and indexes are not imported or exported.

3. Generate the import task.

   After you specify all preceding information, you can click Import in the lower-right corner of the panel to generate the import task.

4. View the import task.

   After the task is generated, the Task Center page automatically appears, where you can view the task information.

5. Terminate the import task.

   After the task is generated, the Task Center page automatically appears, where you can terminate a running import task.