Help Center/ GaussDB(DWS)/ Tool Guide/ DSC: SQL Syntax Migration Tool/ Configuring DSC/ DSC Configuration
Updated on 2023-04-03 GMT+08:00
View PDF

DSC Configuration

Configure the following items:

  • Setting application.properties: Configure the migration behavior of DSC, for example, whether to overwrite the files in the target folder and whether to format the SQL files.
  • Setting Java Memory Allocation: Configure the memory that can be used by DSC. If the memory usage exceeds the threshold, DSC displays an error and exits.

Setting application.properties

The application.properties file contains the application parameters that are used to configure the behavior of DSC. They are general parameters and are applicable to Teradata, Oracle.

Perform the following steps to configure the parameters:

  1. Open the application.properties file in the config folder.
  2. Set parameters in the application.properties file as needed.

    Table 1 describes the parameters in the application.properties file.
    • Parameter values are case-insensitive.
    • Do not modify any other parameter except the listed ones.

  3. Save the configuration and exit.
Table 1 Parameters in the application.properties file

Parameter

Description

Value Range

Default Value

Example
  • formatterrequired

If there are any changes in this configuration item, then the tool will not function as expected.
  • true
  • false

true

formatterrequired=true
  • prevalidationFlag

If there are any changes in this configuration item, then the tool will not function as expected.
  • true
  • false

true

prevalidationFlag=true
  • commentSeparatorFlag

If there are any changes in this configuration item, then the tool will not function as expected.
  • true
  • false

true

commentSeparatorFlag=true
  • queryDelimiter

If there are any changes in this configuration item, then the tool will not function as expected.

NA

NA

queryDelimiter=;
  • blogicDelimiter

If there are any changes in this configuration item, then the tool will not function as expected.

NA

NA

blogicDelimiter=/
  • Timeout

Tool migration timeout duration.

If any changes in this configuration item, then the tool will not function as expected.

-

4 hours

Timeout=4
  • fileExtension

Valid file extension separated by comma.

If there are any modifications in this configuration item, then the tool will not function as expected.

NOTE:

The exported scripts must be with the following postfix such as:

  • .sql
  • .txt
  • .fnc
  • .proc
  • .tbl
  • .tbs
  • .pl

and so on.
  • csv
  • txt
  • SQL

SQL

fileExtension=SQL
  • formattedSourceRequired

Whether to use SQL Formatter to format the source SQL files.

If this parameter is set to true, the copies of the input files are formatted and saved to the Output path/formattedSource directory.
  • true
  • false

true

formattedSourceRequired=true
  • target_files

Specifies the operations to be performed on the output folder.

Overwrite:

overwrites the output folder.

This option specifies whether the files in the output folder must be overwritten.

Delete: deletes all files in the output folder.

Cancel: cancels an operation on the output folder that contains files.
  • overwrite
  • delete
  • cancel

overwrite

target_files=overwrite
  • encodingFormat

Encoding format of input files.

If this parameter is not set (or is commented out), DSC uses the default encoding format based on locale settings.

NOTE:
  • The auto detection of file encoding is inaccurate. To ensure that the correct encoding format is used, specify the format using this parameter.
  • UTF8
  • UTF16
  • UTF32
  • GB2312
  • ASCII, etc.

Default based on locale.

encodingFormat=UTF8
  • NoOfThreads

Number of threads used for migration.

Depending on available system resources

3

NoOfThreads=3
  • MaxFileSizeWarning

Warning threshold for the input file size (unit: KB, MB, or GB).

If an invalid value is specified, the default value is used.

The following warning will be displayed if the specified source file size exceeds the threshold:

*****************
[WARNING] : Migration of the following files(>100KB) will take more time:
bigfile001.SQL
bigfile008.SQL
*****************

10 KB 1 GB

10MB

MaxFileSizeWarning=10MB
  • MaxFileSize

Maximum size of the input file allowed. If crossing this limit, the file migration will be skipped.

-

20MB

MaxFileSize=20MB
  • MaxSqlLen

Maximum size of a query to be migrated.

If an invalid value is specified, DSC resets it to the default value and displays the following warning:

The query length parameter (MaxSqlLen) value is out of range. Resetting to default value.

If an input query exceeds the specified maximum length, the pre-validation of the query migration will fail. DSC skips this query and logs the following error:

2018-07-06 12:05:57,598 ERROR TeradataBulkHandler:195 Error occurred during processing of input in Bulk Migration. PreQueryValidation failed due to: Invalid termination; OR exclude keyword found in query; OR query exceeds maximum length (MaxSqlLen config parameter). filename.SQL for Query in position : xx

1 to 52,428,800 bytes

(1 byte to 50 MB)

1048576

(1 MB)

MaxSqlLen=1048576
  • initialJVMMemory

Initial memory

N/A

256 MB

initialJVMMemory=256MB

This indicates, process will startup with 256 MB of memory
  • maxJVMMemory

Maximum memory

N/A

1024 MB

maxJVMMemory=2048m

This indicates, the process will use up to 2048 MB of memory.
  • If a parameter is set to an incorrect or invalid value, DSC uses the default value of the parameter.
  • If the extensions (for example, .doc) are not supported, then it is recommended you add extension in fileExtension configuration parameter in application.properties file.

Setting Java Memory Allocation

DSC has preset settings for the memory allocation of the Java Virtual Machine (JVM).

If the memory usage exceeds the limit during migration, DSC displays the "java.lang.OutOfMemoryError: GC overhead limit exceeded" error and exit. In this case, you can increase the values of initialJVMMemory and maxJVMMemory in the application.properties file to allocate more memory.

The available system resources also determine the memory allocation.

Table 2 Parameters for JVM Memory Allocation

Parameter

Description

Recommended Value

Xms

Initial memory allocation (unit: MB)

The minimum value is 256 MB. The maximum value depends on the available system resources.

Default value: 256

Xmx

Upper limit for memory allocation (unit: MB)

The minimum value is 1024 MB. The maximum value depends on the available system resources.

Default value: 1024
Parent topic: Configuring DSC