OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Migration Service

V3.3.1Community Edition
  • Product updates
  • Product Introduction
    • What is OMS Community Edition?
    • Architecture
      • Overview
      • Hierarchical functional system
      • Basic components
    • Limits
    • Terms
  • Deployment Guide
    • Overview
    • System requirements
    • Resource configuration specifications
    • Prepare the environment
    • Deploy a time-series database (Optional)
    • Deploy OMS Community Edition on a single node
    • Deploy OMS Community Edition on multiple nodes in a single region
    • Deploy OMS Community Edition on multiple nodes in multiple regions
    • Check the deployment
    • Scale out OMS Community Edition
  • User Guide
    • OMS Community Edition console
      • Log on to the OMS Community Edition console
      • Overview
      • User center
        • Configure user information
        • Change your logon password
        • Log off
    • Users and privileges
      • Create a database user
      • User privileges
      • Enable binlogs for the MySQL database
    • Manage data sources
      • Add a data source
        • Add an OceanBase Community Edition data source
        • Add a MySQL data source
        • Add a TiDB data source
        • Add a Kafka data source
        • Add a RocketMQ data source
      • View data source information
      • Copy a data source
      • Edit a data source
      • Delete a data source
    • Data migration
      • Overview
      • Supported DDL operations for incremental migration and limits
      • Create a data migration project
        • Create a project to migrate data from a MySQL database to OceanBase database Community Edition
        • Create a project to migrate data from OceanBase database Community Edition to a MySQL database
        • Migrate data within OceanBase database Community Edition
        • Create an active-active disaster recovery project in OceanBase database Community Edition
        • Create a project to migrate data from a TiDB database to OceanBase database Community Edition
      • Manage data migration projects
        • View details of a data migration project
        • Start, pause, and resume a data migration project
        • Release a data migration project
        • Delete a data migration project
        • Use tags to manage data migration projects
        • Download and import the settings of migration objects
      • Configure matching rules for migration objects
    • Data synchronization
      • Overview
      • Data formats
      • Create a data synchronization project
        • Create a project to synchronize data from an OceanBase database Community Edition to a Kafka instance
        • Create a project to synchronize data from an OceanBase database Community Edition to a RocketMQ instance
      • Manage data synchronization projects
        • View details of a data synchronization project
        • Start, pause, and resume a data synchronization project
        • Release and delete a data synchronization project
        • Use tags to manage data synchronization projects
        • Download and import the settings of synchronization objects
    • OPS & Monitoring
      • Go to the overview page
      • Server
        • View server information
        • Update the quota
        • View server logs
        • Paths of component logs
      • Components
        • Store
          • Create a store
          • View details of a store
          • Update the configurations of a store
          • Start and pause a store
          • Destroy a store
        • Connector
          • View details about a connector
          • Start and pause a connector
          • Migrate a connector
          • Update the configurations of a connector
          • Batch O&M
          • Delete a connector
        • JDBCWriter
          • View details of a JDBCWriter
          • Start and pause a JDBCWriter
          • Migrate a JDBCWriter
          • Update the configurations of a JDBCWriter
          • Batch O&M
          • Delete a JDBCWriter
        • Checker
          • View details of a checker
          • Start and pause a checker
          • Rerun and recover a checker
          • Update the configurations of a checker
          • Delete a checker
      • O&M ticket
        • View details of an O&M ticket
        • Skip a ticket or sub-ticket
        • Retry a ticket or sub-ticket
      • Component parameters
        • Store parameters
          • Parameters of a MySQL store
          • Parameters of an OceanBase store
        • Connector parameters
          • Parameters of a destination RocketMQ instance
          • Parameters of a DataflowSink instance
          • Parameters of a destination Kafka instance
          • Parameters of a source database in full migration
          • Parameters for intermediate-layer synchronization
        • JDBCWriter parameters
        • Checker parameters
    • System management
      • User management
      • Alert center
        • View project alerts
        • View system alerts
        • Manage alert settings
      • Associate with OCP
      • System Parameters
        • Modify system parameters
        • Modify HA configurations
  • Alert Reference
    • oms_host_down
    • oms_host_down_migrate_resource
    • oms_host_threshold
    • oms_migration_failed
    • oms_migration_delay
    • oms_sync_failed
    • oms_sync_status_inconsistent
    • oms_sync_delay
  • API Reference
    • Obtain the status of a migration project
    • Obtain the status of a synchronization project
  • Upgrade Guide
    • Overview
    • Upgrade OMS Community Edition in single-node deployment mode
    • Upgrade OMS Community Edition in multi-node deployment mode
    • FAQ

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Migration Service
  3. V3.3.1

Parameters of a source database in full migration

Last Updated:2026-09-04 08:14:02

Dataflow client parameters
Parameter
Type
Required
Default value
Description
checkpoint JsonNode Yes None The checkpoint. Format:
{ "ClientId": { "databaseName": "", "tableName": "", "value": { "col1": "val", "col2": "val" }, "syncedCount": the synchronized count.}, ... }
clients JsonNode Yes None The clients, in the format of a JSON list.
database_connection_timeout_sec Integer No 120 The connection timeout period for each JDBC client in the database.
database_max_connection Integer No 32 The maximum number of connections allowed for each JDBC client in the database.
database_time_zone String No +08:00 The time zone set in connections.
database_type String Yes None The type of the database.
dataflow_fetch_size Integer No 1000 The size of data pulled at a time, which may increase based on the number of source databases.
dataflow_init_table_thread_num Integer No 8 The number of worker thread pools for initializing tables. The values of the core and max parameters are the same.
dataflow_pull_worker_num Integer No 32 The number of worker thread pools for pulling data. The values of the core and max parameters are the same.
dataflow_retry_time Integer No 3 The number of retries for requesting a database operation. The default value is 3.
dataflow_retry_interval_sec Integer No 3 The retry interval. The default value is 3, indicating 3 seconds.
dataflow_slice_queue_size Integer No 128 The size of the dataflow slice queue, which increases based on the number of sources. The value of this parameter must be greater than 0.
dataflow_slice_worker_num Integer No 16 The number of worker thread pools for sharding tables. The values of the core and max parameters are the same.
source_queue_size Integer No 16384 The maximum number of messages in a queue on the source database side.

Dataflow client parameters

Parameter
Type
Required
Default value
Description
characterSet String No Subject to the value of the upper-layer parameter The character set.
clientId String Yes None The client ID.
cluster String No None The cluster, which is exclusive to OceanBase Database.
config Map No None The configuration of the data source.
connTimeout Integer No Subject to the value of the upper-layer parameter The timeout period for connecting to the database.
instance String Yes None The service address of the database, in the format of ip:port.
logicDatabase String No None The name of the logical database.
logicTable String No None The name of the logical table.
password String Yes None The password.
retryIntervalSec Integer No Subject to the value of the upper-layer parameter The retry interval for queries or writes.
retryTime Integer No Subject to the value of the upper-layer parameter The number of retries allowed for queries or writes.
tableWhiteLists Map Yes None The whitelist of tables from which data is pulled.
tenant String No None The tenant, which is exclusive to OceanBase Database.
username String Yes None The username.

Previous topic

Parameters of a destination Kafka instance
Last

Next topic

Parameters for intermediate-layer synchronization
Next
on this page
Dataflow client parameters