{{/* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */}} {{ $ref := ref . "maintenance/configurations.md" }}

Configuration | Description
--- | ---

##### --warehouse

The path to Paimon warehouse.

##### --database

The database name in Paimon catalog.

##### --ignore_incompatible

It is default false, in this case, if MySQL table name exists in Paimon and their schema is incompatible,an exception will be thrown. You can specify it to true explicitly to ignore the incompatible tables and exception.

##### --merge_shards

It is default true, in this case, if some tables in different databases have the same name, their schemas will be merged and their records will be synchronized into one Paimon table. Otherwise, each table's records will be synchronized to a corresponding Paimon table, and the Paimon table will be named to 'databaseName_tableName' to avoid potential name conflict.

##### --table_prefix

The prefix of all Paimon tables to be synchronized. For example, if you want all synchronized tables to have "ods_" as prefix, you can specify "--table_prefix ods_".

##### --table_suffix

The suffix of all Paimon tables to be synchronized. The usage is same as "--table_prefix".

##### --including_tables

It is used to specify which source tables are to be synchronized. You must use '|' to separate multiple tables.Because '|' is a special character, a comma is required, for example: 'a|b|c'.Regular expression is supported, for example, specifying "--including_tables test|paimon.*" means to synchronize table 'test' and all tables start with 'paimon'.

##### --excluding_tables

It is used to specify which source tables are not to be synchronized. The usage is same as "--including_tables". "--excluding_tables" has higher priority than "--including_tables" if you specified both.

##### --mode

It is used to specify synchronization mode.
Possible values:

- "divided" (the default mode if you haven't specified one): start a sink for each table, the synchronization of the new table requires restarting the job.
- "combined": start a single combined sink for all tables, the new table will be automatically synchronized.

##### --metadata_column

--metadata_column is used to specify which metadata columns to include in the output schema of the connector. Metadata columns provide additional information related to the source data, for example: --metadata_column table_name,database_name,op_ts. See its document for a complete list of available metadata.

##### --type_mapping

It is used to specify how to map MySQL data type to Paimon type.
Supported options:

- "tinyint1-not-bool": maps MySQL TINYINT(1) to TINYINT instead of BOOLEAN.
- "to-nullable": ignores all NOT NULL constraints (except for primary keys). This is used to solve the problem that Flink cannot accept the MySQL 'ALTER TABLE ADD COLUMN column type NOT NULL DEFAULT x' operation.
- "to-string": maps all MySQL types to STRING.
- "char-to-string": maps MySQL CHAR(length)/VARCHAR(length) types to STRING.
- "longtext-to-bytes": maps MySQL LONGTEXT types to BYTES.
- "bigint-unsigned-to-bigint": maps MySQL BIGINT UNSIGNED, BIGINT UNSIGNED ZEROFILL, SERIAL to BIGINT. You should ensure overflow won't occur when using this option.

##### --partition_keys

The partition keys for Paimon table. If there are multiple partition keys, connect them with comma, for example "dt,hh,mm". If the keys are not in source table, the sink table won't set partition keys.

##### --primary_keys

The primary keys for Paimon table. If there are multiple primary keys, connect them with comma, for example "buyer_id,seller_id". If the keys are not in source table, but the source table has primary keys, the sink table will use source table's primary keys. Otherwise, the sink table won't set primary keys.

##### --mysql_conf

The configuration for Flink CDC MySQL sources. Each configuration should be specified in the format "key=value". hostname, username, password, database-name and table-name are required configurations, others are optional. See its document for a complete list of configurations.

##### --catalog_conf

The configuration for Paimon catalog. Each configuration should be specified in the format "key=value". See here for a complete list of catalog configurations.

##### --table_conf

The configuration for Paimon table sink. Each configuration should be specified in the format "key=value". See here for a complete list of table configurations.