Updated on 2022-09-20 GMT+08:00

RawFormDataResponse

Table 1 RawFormDataResponse

Parameter

Mandatory

Type

Description

project_id

No

String

Project ID.

task_name

No

String

Task name.

task_type

No

String

Task type.

- realtime: real-time

- timing: scheduled

description

No

String

Task description.

source_datasource_type

No

String

Data source type at the source.

source_datasource

No

String

Data source name at the source.

source_ds_id

No

String

Data source ID at the source.

target_datasource_type

No

String

Data source type at the destination.

target_datasource

No

String

Data source name at the destination.

target_ds_id

No

String

Data source ID at the destination.

need_mqs

No

Boolean

Whether the offline version uses MQS as the internal channel.

- true: The offline version uses MQS as the internal channel.

- false: The offline version does not use MQS as the internal channel.

need_api

No

Boolean

Whether the offline version uses API as the internal channel.

- true: The offline version uses API as the internal channel.

- false: The offline version does not use API as the internal channel.

need_email_new

No

Boolean

Whether the offline version uses Email as the internal channel.

- true: The offline version uses Email as the internal channel.

- false: The offline version does not use Email as the internal channel.

source_selected_datasource

No

SourceSelectedDatasource

Data source at the source.

target_selected_datasource

No

TargetSelectedDatasource

Data source at the destination.

mapping_table

No

List<MappingTable>

Mapping between the source and destination.

mapping_table_properties

No

List<MappTableProperties>

Property in the mapping between the source and destination. This property is used for relational data sources. For other types of data sources, leave this parameter blank.

mapping_source_textornot

No

List<Flag>

Whether the text mode is used for the mapping between the source and destination. The default value is false.

mapping_input

No

String

Mapping relationship. This parameter can be left blank.

mapping_required

No

Boolean

Whether a mapping is required. The default value is true.

- true: A mapping is required.

- false: A mapping is not required.

task_tag

No

String

Task tag.

Table 2 MappingTable

Name

Mandatory

Type

Description

source_column

No

String

Name of a field in the source table.

source_column_type

No

String

Type of a field in the source table.

source_column_length

No

String

Length of a field in the source table.

target_column

No

String

Name of the destination field.

target_column_type

No

String

Type of a field in the destination table.

target_column_length

No

String

Length of a field in the destination table.

is_add_mapping

No

String

Whether a mapping is added. The default value is false.

Table 3 TargetSelectedDatasource

Parameter

Mandatory

Type

Description

instance_id

No

String

Instance ID.

target_need_create_table

No

Boolean

Whether a table is created at the destination. This parameter is fixed to false.

is_support_clear_tab

No

Boolean

Whether the table can be cleared. This parameter is fixed to false.

target_table

No

String

Name of the destination table.

target_schema

No

String

Mode of the destination database. This parameter is used for the GaussDB 100 database.

batch_number

No

String

Batch data.

target_selected_column_list

No

List<Column>

List of column names selected at the destination.

support_part_update

No

Boolean

Whether to update changed fields only.

If this option is enabled, only the table fields whose values change are updated. If this option is disabled, all table fields are updated.

meta_data

No

List<MetaData>

Metadata of the data source type at the destination.

path

No

String

File path. Set this parameter to the path of the folder to be accessed on the FTP server.

write_mode

No

String

Write mode. This parameter is mandatory for file data sources.

file_name_charset

No

String

Character encoding format of the file name. This parameter is mandatory for file data sources.

file_content_type

No

String

File content type.

If file_content_type is textFile, set this parameter to csv or txt.

If file_content_type is binaryFile, set this parameter to xls or xlsx.

- binaryFile: binary file

- textFile: text file

file_type

No

String

File type. This parameter is mandatory for file data sources.

If file_content_type is textFile, set this parameter to csv or txt.

If file_content_type is binaryFile, set this parameter to xls or xlsx.

file_name_prefix

No

String

File name prefix.

null_format

No

String

Space format character, which defines the format of spaces in a file.

remark_date_format

No

String

File name suffix.

add_header

No

Boolean

Whether to add a file header.

file_content_charset

No

String

File content encoding.

field_delimiter

No

String

File separator. By default, files are separated by commas (,).

Table 4 MappTableProperties

Parameter

Mandatory

Type

Description

source_nullable

No

String

Whether the source table field can be left blank.

- 0: The source table field cannot be left blank.

- 1: The source table field can be left blank.

source_unique

No

String

Whether the source table field is unique.

- 0: The source table field is unique.

- 1: The source table field is not unique.

target_nullable

No

String

Whether the destination table field can be left blank.

- 0: The destination table field cannot be left blank.

- 1: The destination table field can be left blank.

target_unique

No

String

Whether the destination table field is unique.

- 0: The destination table field is unique.

- 1: The destination table field is not unique.

Table 5 Flag

Parameter

Mandatory

Type

Description

flag

No

Boolean

Whether the text mode is used. The default value is false.

- true: The text mode is used.

- false: The text mode is not used.

Table 6 Column

Parameter

Mandatory

Type

Description

field_name

No

String

Field name.

field_type

No

String

Field type.

field_length

No

String

Field length.

null_able

No

String

Whether the field can be left blank.

- 0: The field cannot be left blank.

- 1: The field can be left blank.

unique

No

String

Whether the field is unique.

- 0: The field is unique.

- 1: The field is not unique.

Table 7 SourceSelectedDatasource

Parameter

Mandatory

Type

Description

instance_id

No

String

Instance ID.

is_add_sql

No

Boolean

Whether to add SQL statements. This parameter is used for relational databases.

- true: SQL statements are added.

- false: SQL statements are not added.

query_sql

No

String

SQL query statement, which can be left blank. This parameter is used for relational databases.

source_table

No

String

Source table name. This parameter is used for relational databases.

source_schema

No

String

Mode of the source database. This parameter is used for the GaussDB 100 database.

source_selected_column_list

No

List<Column>

List of field names selected at the source. This parameter is used for relational databases.

order_column

No

String

List of field names used for sorting at the source. This parameter is used for relational databases.

order_type

No

String

Sorting type at the source, which can be left empty. This parameter is used for relational databases.

- ASC: ascending order

- DESC: descending order

source_date_column

No

String

Column name used for incremental migration at the source. This parameter is used for relational databases.

data_timestamp

No

Integer

Initial time of incremental migration at the source.

where

No

List<Where>

Filter criteria statement of the relational or Hive data source at the source. This parameter can be left blank.

where_options

No

List<WhereOptions>

Criteria used for filtering types. at the source. This parameter can be left blank. This parameter is used for relational databases.

- equal

- notEqual

- less

- lessEqual

- more

- moreEqual

- isNull

- notNull

- between

- notBetween

- inList

- notInList

is_text_input

No

Boolean

Whether the text mode is used.

text_input_value

No

String

Textual input value at the source, which can be left blank.

meta_data

No

List<MetaData>

Metadata of the data source type at the source.

need_inc_migration

No

Boolean

Whether to perform incremental migration for data at the source.

time_zone

No

String

Time zone used for incremental migration of source data. The default value is GMT+08:00.

reset_incr_begin_time

No

Boolean

Whether to reset the start time of incremental migration at the source.

compensation_time

No

String

Compensation time for the initial time of incremental migration at the source.

is_parse

No

Boolean

Whether parsing is required.

If this parameter is set to true, data is not transparently transmitted.

If this parameter is set to false, data is transparently transmitted.

Transparent transmission refers to pass-through, transmitting the data from the source to the destination without alteration.

The default value is true. This parameter is used with source_meta_data.

path

No

String

File path. Enter the path of the folder to be accessed on the FTP server, for example, /data/FDI.

file_name

No

String

File name. Enter the name of the file to be accessed on the FTP server.

file_name_charset

No

String

File name encoding.

max_file_size

No

Integer

Maximum file size.

file_content_charset

No

String

File content encoding.

field_delimiter

No

String

File separator.

null_format

No

String

Space format character, which defines the format of spaces in a file.

batch_num

No

Integer

Amount of data to be migrated.

If is_parse is set to true, this parameter indicates the number of data rows to be parsed. The maximum value is 1500000. If is_parse is set to false, this parameter indicates the number of files to be parsed. The maximum value is 20000.

skip_header

No

Boolean

Whether to skip the file header.

This parameter is mandatory only if is_parse is set to true.

This parameter specifies whether to skip the file header in the data file. The file header is the first line or several lines at the beginning of a file, which helps identify and distinguish the file content.

skip_header_rows

No

Integer

Number of file header lines to be skipped.

extend_meta_data

No

List<MetaData>

Extended information of the metadata configuration of the data source at the source.

source_meta_data

No

List<MetaData>

Metadata configuration of the data source at the source.

Table 8 Where

Parameter

Mandatory

Type

Description

andor

No

String

Filter. Set this parameter to and.

field_name

No

String

Field name.

field_type

No

String

Field type.

op

No

String

Filter criteria.

value

No

String

Value.

minValue

No

String

Minimum value.

maxValue

No

String

Maximum value.

Table 9 WhereOptions

Parameter

Mandatory

Type

Description

options

No

List<Options>

Criteria used for filtering types. This parameter can be left blank. This parameter is used for relational databases.

- equal

- notEqual

- less

- lessEqual

- more

- moreEqual

- isNull

- notNull

- between

- notBetween

- inList

- notInList

Table 10 MetaData

Parameter

Mandatory

Type

Description

dataSource

No

List<DataSource>

Mapping information of the data source.

Table 11 Datasource

Parameter

Mandatory

Type

Description

index

No

String

Field index.

name

No

String

Field name.

type

No

String

Field type.

format

No

String

Field format.

path

No

String

Parsing path.

Table 12 Options

Parameter

Mandatory

Type

Description

id

No

String

Filter type ID.

lable

No

String

Filter type.