{{/* 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.

##### --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.

##### --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.