Sign In

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

PRODUCTS

OceanBase Cloud

OceanBase Database

Tools Connectors and Middleware

QUICK START

OceanBase Cloud OceanBase Database

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

OceanBase Migration Service

V4.0.0Community Edition

OMS Documentation
What's new
OMS Community Edition Introduction
- What is OMS Community Edition?
- Limits
- Architecture
  - Overview
  - Hierarchical functional system
  - Basic components
- Terms
Quick Start
- Data migration process
- Data synchronization process
Deploy OMS Community Edition
- Deployment type
- System and network requirements
- Memory and disk requirements
- Prepare the environment
- 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
- Scale-out and deployment
- Check the deployment
- Deploy a time-series database (Optional)
OMS Community Edition console
- Log on to the OMS console
- Overview
- User center
  - Configure user information
  - Change your logon password
  - Log off
Data migration
- Data migration overview
- Migrate data from a MySQL database to OceanBase Community Edition
- Migrate data from OceanBase Community Edition to a MySQL database
- Migrate data within OceanBase Community Edition
- Migrate data within OceanBase Community Edition in active-active disaster recovery scenarios
- Migrate data from a TiDB database to OceanBase Community Edition
- Migrate data from a PostgreSQL database to OceanBase Community Edition
- Manage data migration projects
  - View details of a data migration project
  - View and modify migration objects
  - Use tags to manage data migration projects
  - Download and import the settings of migration objects
  - Start, pause, and resume a data migration project
  - Release and delete a data migration project
- Schema migration mechanisms
- Supported DDL operations in incremental migration and limits
  - Supported DDL operations in incremental migration from a MySQL database to OceanBase Community Edition and limits
  - Supported DDL operations in incremental migration from OceanBase Community Edition to a MySQL database and limits
  - Supported DDL operations in incremental migration between MySQL tenants of OceanBase Database
- Configure matching rules for migration objects
Data synchronization
- Data synchronization overview
- Create a project to synchronize data from OceanBase Database Community Edition to a Kafka instance
- Create a project to synchronize data from OceanBase Database Community Edition to a RocketMQ instance
- Manage data synchronization projects
  - View details of a data synchronization project
  - View and modify synchronization objects
  - Use tags to manage data synchronization projects
  - Download and import the settings of synchronization objects
  - Start, pause, and resume a data synchronization project
  - Release and delete a data synchronization project
- Data formats
Create and manage data sources
- Create data sources
  - Create an OceanBase-CE data source
  - Create a MySQL data source
  - Create a TiDB data source
  - Create a Kafka data source
  - Create a RocketMQ data source
  - Create a PostgreSQL data source
- Manage data sources
  - View data source information
  - Copy a data source
  - Edit a data source
  - Delete a data source
- Create a database user
- User privileges
- Enable binlogs for the MySQL database
OPS & Monitoring
- O&M overview
- Go to the overview page
- Server
  - View server information
  - Update quotas
  - View server 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 of 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 the information about a checker
    - Start and pause a checker
    - Rerun and reverify a checker
    - Update the configurations of a checker
    - Delete a checker
- O&M tickets
  - View details of an O\&M ticket
  - Skip a ticket or sub-ticket
  - Retry a ticket or sub-ticket
System management
- Permission Management
  - Overview
  - Manage users
  - Manage departments
- Alert center
  - View project alerts
  - View system alerts
  - Manage alert settings
- Associate with OCP
- System parameters
  - Modify system parameters
  - Modify HA configurations
OMS Community Edition O&M
- Manage OMS services
- OMS logs
- O&M operations for the Store component
- Store parameters
  - Parameters of a MySQL store
  - Parameters of an OceanBase store
- O&M operations for the Supervisor component
- Parameters of the Supervisor component
- O&M operations for the Connector component
- Connector parameters
  - Parameters of a destination RocketMQ instance
  - Parameters of a DataflowSink instance
  - Parameters in the destination Kafka instance
  - Parameters of the source database in full migration
  - Parameters of the source database in incremental data synchronization
  - Parameters for intermediate-layer synchronization
- Checker parameters
- JDBCWriter parameters
- Parameters of the CM component
Reference Guide
- API Reference
  - Obtain the status of a migration project
  - Obtain the status of a synchronization project
- OMS error codes
- 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
Upgrade Guide
- Overview
- Upgrade OMS in single-node deployment mode
- Upgrade OMS in multi-node deployment mode
- FAQ
FAQ
- General O&M
  - How do I modify the resource quotas of an OMS container?
  - How do I troubleshoot the OMS server down issue?
- Project diagnostics
  - What do I do when a store does not have data of the timestamp requested by the downstream?
  - What do I do when OceanBase Store failed to access an OceanBase cluster through RPC?
- OPS & monitoring
  - What are the alert rules?
- Data synchronization
  - FAQ about synchronization to a message queue
    - What are the strategies for ensuring the message order in incremental data synchronization to Kafka
- Data migration
  - Full migration
    - FAQ about full migration
      - How do I query the ID of a checker?
      - How do I query log files of the Checker component of OMS?
      - How do I query the verification result files of the Checker component of OMS?
      - What do I do if the destination table does not exist?
  - Incremental synchronization
    - How do I skip DDL statements?
    - How do I update the configurations of a JDBCWriter?
    - How do I start or stop a JDBCWriter?
    - How do I update whitelists and blacklists?
    - What are the application scope and limits of ETL?
- Installation and deployment
  - How do I download an image?
  - How do I upgrade Store?

Download PDF

Document Feedback

Parameters of the source database in incremental data synchronization

Last Updated：2023-06-25 03:29:51 Updated

share

share

Parameter	Type	Required	Default value	Description
checkpoint	JsonNode	Yes	None	The format is {"clientId": "timestamp", "clientId2": "timestamp"}.
clients	JsonNode	Yes	None	The list of store clients.
source_receive_queue_size	Integer	No	8096	The queue size.
store_ask_self_unit	Boolean	No	false	Indicates whether to mask other data.
store_connection_timeout_sec	Integer	No	120	The store connection timeout period.
store_max_retries	Integer	No	3	The maximum number of retries to pull data from a store.
store_record_sequence_enabled	Boolean	No	true	Specifies whether to enable sequence recording.
store_socket_timeout_sec	Integer	No	120	The timeout period of store socket connections.
store_time_zone	String	No	+08:00	The time zone of the store from which data is pulled.
store_transaction_counter_ignore_exception	Boolean	No	false	Specifies whether to ignore exceptions during transaction calculation. It is a temporary parameter for new features.
store_transaction_enabled	Boolean	No	false	Specifies whether to enable sequence numbers for transactions.
store_username	String	Yes	None	The password for pulling data from a store, which is the password of the consumer account in oms_cm.

StoreClient parameters

Parameter	Type	Required	Default value	Description
askSelfUnit	Boolean	No	Subject to the value of the upper-layer parameter	Specifies whether to mask the traffic of other regions.
clientId	String	Yes	None	The unique ID of the store client.
clusterManagerUrl	String	Yes	None	The value is in the format of "address of the cluster manager.manager.host".
connectionTimeoutSec	Integer	No	Subject to the value of the upper-layer parameter	The timeout period of client connections.
filterConditions	String	Yes	No	The store whitelist.
logicDatabase	String	No	None	The name of the logical database.
logicTable	String	No	None	The name of the logical table.
maxRetries	Integer	No	Subject to the value of the upper-layer parameter	The maximum number of connection retries.
password	String	No	Subject to the value of the upper-layer parameter	The password for accessing Binlog.
socketTimeoutSec	Integer	No	Subject to the value of the upper-layer parameter	The timeout period of client responses.
subtopic	String	Yes	None	The subtopic.
transactionEnabled	Boolean	No	Subject to the value of the upper-layer parameter	Specifies whether to sort transactions by sequence number.
transactionCounterExceptionIgnore	Boolean	No	Subject to the value of the upper-layer parameter	Specifies whether to ignore transaction sorting exceptions.
timestamp	Integer	Yes	None	The timestamp.
username	String	No	Subject to the value of the upper-layer parameter	The username for accessing Binlog.

Previous topic

Parameters of the source database in full migration

Next topic

Parameters for intermediate-layer synchronization