Generate the Pre-Migration Report
Before initiating the actual migration or replication activity, users can generate a Pre-Migration Report to assess the readiness of the source database objects selected for migration. This report provides a consolidated view of the tables that will participate in the migration process and helps users identify potential risks, configuration gaps, and capacity requirements in advance.
The Pre-Migration Report is intended to be generated before starting production migration so that database administrators, migration engineers, and project stakeholders can validate the scope of migration, estimate data volume, verify table eligibility, and confirm license validity. By reviewing this report, users can take corrective actions before the migration begins, reducing the possibility of runtime failures, incomplete replication, or unexpected delays.
Purpose of the Pre-Migration Report
The primary purpose of the report is to provide an overall assessment of the migration workload and object readiness. It helps determine how many tables are included in the migration scope, the total amount of data that needs to be transferred, whether the selected tables contain primary keys or unique identifiers, and whether the environment has a valid license for the planned migration window.
Report Coverage
Total number of tables selected for migration
Displays the complete count of source tables included in the migration or replication pipeline based on the configured table list.
Table-level data size
Shows the size of each table so users can understand the storage footprint and estimate migration duration.
Total data volume to be migrated
Provides the cumulative size of all selected tables, helping teams plan bandwidth, storage, and execution windows.
Primary key availability
Identifies which tables have a defined primary key and which tables do not.
Tables without primary keys
Highlights objects that may require remediation before migration, because primary keys are important for reliable change capture, update handling, and data consistency.
Index availability
Lists the indexes present on the selected tables so users can assess performance impact, dependency requirements, and post-migration validation needs.
License validity
Shows the remaining license validity in days or months so users can confirm that the migration activity can be completed within the active license period.
Why This Report Is Required
The Pre-Migration Report acts as a readiness checkpoint before the actual migration begins. It enables users to validate that all required tables are included, confirm whether table structures meet replication requirements, and identify high-volume tables that may need special planning. It also helps detect tables without primary keys, which can affect the reliability of data synchronization and may require either primary key creation, unique constraint validation, or an approved exception strategy.
From an operational perspective, the report helps teams estimate migration effort, allocate sufficient storage, review indexing requirements, and ensure that the active Helyx license will remain valid for the expected duration of the migration activity. This reduces execution risk and improves planning accuracy for production Cutover or replication onboarding.
Expected Outcome
The report will be generated at /var/lib/helyx/report location with html format. After generating and reviewing the Pre-Migration Report, users should have a clear understanding of the migration scope, object readiness, total data volume, table eligibility, index details, and license availability. Any identified gaps should be resolved before starting the actual migration or replication process to ensure a smooth, predictable, and reliable migration activity.
<path_to_serverconfig> -pre_migration_report -pub <path_to_publication.config> -tables <path_to_tablelist.config>