Skip to content
Streamkap
Esc
navigateopen⌘Jpreview
On this page

Database Upgrade Guide

Keep CDC pipelines intact through a source database version upgrade, with preparation and verification steps for PostgreSQL, MySQL, Oracle, SQL Server, and MongoDB.

Upgrading your source database version (e.g., PostgreSQL 14 to 16, MySQL 5.7 to 8.0) requires careful planning to maintain CDC pipeline continuity. This guide covers pre-upgrade preparation, upgrade procedures, and post-upgrade verification for each supported database type.

General Pre-Upgrade Checklist

Before upgrading any source database, complete the following preparation steps:

  1. Verify your pipeline is healthy – no errors, low consumer lag, and the connector shows a RUNNING status
  2. Note the current pipeline position (snapshot status, consumer lag metrics)
  3. Consider pausing the pipeline during the upgrade window to avoid partial captures
  4. Ensure a database backup is available and tested
  5. Review the database-specific CDC requirements for your target version (see tabs below)
  6. Test the upgrade in a non-production environment first, including verifying that CDC resumes correctly

Database-Specific Upgrade Guides

Minor Version Upgrades (e.g., 14.8 to 14.12)

Minor version upgrades are generally safe for CDC pipelines:

  • Replication slots are preserved across minor upgrades
  • The pipeline reconnects automatically after the database restarts
  • No snapshot is typically required

Verify that wal_level = logical remains set after the upgrade, as minor upgrades should not change this.

Major Version Upgrades (e.g., 14 to 16)

PostgreSQL removes replication slots during major upgrades and does not restore them. When the connector restarts, it requests the last known offset, but PostgreSQL cannot return it from the new slot. A new replication slot only tracks changes from its creation point, so the connector would skip older change events and resume from the latest log position.

Procedure:

Stop writes to the database

Using your database’s upgrade procedure, ensure writes to the database have stopped.

Allow the connector to drain all events

Allow the connector to capture all remaining change events before starting the upgrade. Ask Streamkap to confirm all events have been captured.

Stop the Source in Streamkap

Stop the Source in the Streamkap app. This flushes the last records and saves the last offset.

Upgrade the database

Stop the database and upgrade it using your standard upgrade procedure (e.g., pg_upgrade).

Verify wal_level

Confirm that wal_level = logical is set in the upgraded PostgreSQL configuration. Major upgrades may reset this parameter.

SHOW wal_level;

Recreate the replication slot

The replication slot must be recreated after the upgrade:

SELECT pg_create_logical_replication_slot('streamkap_pgoutput_slot', 'pgoutput');

Verify or recreate the publication

Confirm the publication for Streamkap still exists. Recreate it if necessary with the same tables:

-- Check if publication exists
SELECT * FROM pg_publication WHERE pubname = 'streamkap_pub';

-- Recreate if needed (all tables)
CREATE PUBLICATION streamkap_pub FOR ALL TABLES;

-- Or recreate with specific tables
CREATE PUBLICATION streamkap_pub FOR TABLE table1, table2, table3;

Restore write access and resume the Source

Restore write access to the database, then resume or restart the Source in the Streamkap app.

Trigger a snapshot if needed

If any events were not captured before the upgrade, trigger a snapshot for the affected tables to ensure no data was missed.

RDS / Aurora PostgreSQL Specifics

The same general procedure applies for Amazon RDS and Aurora PostgreSQL managed upgrades. Key considerations:

  • Use the RDS console or CLI to perform the version upgrade
  • After the upgrade, verify rds.logical_replication is still set to 1 in your parameter group
  • Recreate the replication slot and verify the publication as described above
  • For Aurora, ensure you are upgrading the primary instance (Aurora read replicas only support physical replication)

For full PostgreSQL source setup and troubleshooting details, see:

Minor Version Upgrades (e.g., 8.0.30 to 8.0.35)

Minor version upgrades are generally seamless for MySQL CDC pipelines:

  • If GTID is enabled, the pipeline resumes from the GTID position automatically
  • Binary log positions are typically preserved
  • No snapshot is required in most cases

Major Version Upgrades (e.g., 5.7 to 8.0)

Major MySQL upgrades require verifying that all CDC-related configuration remains intact.

Pre-upgrade verification:

Confirm these settings are properly configured in your target version:

Setting Required Value Verification Query
binlog_format ROW SHOW VARIABLES LIKE 'binlog_format';
binlog_row_image FULL SHOW VARIABLES LIKE 'binlog_row_image';
log_bin ON SHOW VARIABLES LIKE 'log_bin';
gtid_mode (recommended) ON SHOW VARIABLES LIKE 'gtid_mode';

Upgrade behavior depends on GTID configuration:

GTID not enabled

Without GTID, MySQL uses binlog file and position tracking. Major upgrades can change binlog filenames and positions, which means:

  1. Stop writes to the database
  2. Allow the connector to capture all remaining events and confirm with Streamkap
  3. Stop the Source in Streamkap
  4. Perform the upgrade
  5. Verify all CDC-related settings (see table above)
  6. Resume the Source in Streamkap
  7. Trigger a snapshot for all affected tables, as the binlog position from before the upgrade may no longer be valid

MySQL 5.7 to 8.0 specific notes:

  • MySQL 8.0 changes the default authentication plugin to caching_sha2_password. If your Streamkap user was created with mysql_native_password, verify it still authenticates correctly after the upgrade
  • Review binlog retention settings after upgrade: CALL mysql.rds_show_configuration; (RDS) or SHOW VARIABLES LIKE 'binlog_expire_logs_seconds'; (self-hosted)

For full MySQL source setup details, see:

General Upgrade Considerations

Streamkap’s Oracle connector uses LogMiner to read redo and archive logs for CDC. After upgrading your Oracle database, verify the following:

Post-upgrade verification checklist:

  1. Supplemental logging is enabled – Oracle upgrades may reset supplemental logging settings

    -- Verify database-level supplemental logging
    SELECT NAME, SUPPLEMENTAL_LOG_DATA_MIN FROM V$DATABASE;
    -- SUPPLEMENTAL_LOG_DATA_MIN should be YES
  2. Table-level supplemental logging is intact – Verify for each captured table

    -- Check table-level supplemental logging
    SELECT * FROM ALL_LOG_GROUPS WHERE TABLE_NAME = '{TABLE_NAME}';
  3. ARCHIVELOG mode is still enabled

    archive log list;
    -- Database log mode should be: Archive Mode
  4. Redo log configuration is unchanged – Verify redo log sizes and groups

    SELECT GROUP#, BYTES/1024/1024 SIZE_MB, STATUS FROM V$LOG ORDER BY 1;
  5. Streamkap user privileges are intact – Verify the STREAMKAP_USER (or C##STREAMKAP_USER for CDB) retains all necessary grants, including LOGMINING, FLASHBACK ANY TABLE, and access to V$ views

Upgrade procedure:

  1. Stop writes to the database
  2. Allow the connector to capture all remaining events
  3. Stop the Source in Streamkap
  4. Perform the Oracle upgrade using your standard procedure
  5. Verify all items in the checklist above
  6. Re-enable supplemental logging if needed (ALTER DATABASE ADD SUPPLEMENTAL LOG DATA;)
  7. Resume the Source in Streamkap
  8. Trigger a snapshot if you suspect any events were missed

For full Oracle source setup details, see:

General Upgrade Considerations

SQL Server CDC relies on change tracking tables and the SQL Server Agent service. Upgrades can disrupt both of these.

Post-upgrade verification checklist:

  1. CDC is still enabled on the database

    SELECT name, is_cdc_enabled FROM sys.databases WHERE name = '{database}';
    -- is_cdc_enabled should be 1
  2. CDC capture jobs are running – SQL Server CDC depends on capture and cleanup jobs

    EXEC sys.sp_cdc_help_jobs;
  3. SQL Server Agent is running – The Agent must be active for CDC capture jobs to execute. If it is not running, start it through SQL Server Management Studio or via service management

  4. CDC is enabled on all captured tables – Verify each table still has CDC tracking enabled

    EXEC sys.sp_cdc_help_change_data_capture;
  5. Streamkap user permissions are intact – Verify the streamkap_user retains SELECT privileges on the cdc schema and source tables

Upgrade procedure:

  1. Stop writes to the database
  2. Allow the connector to capture all remaining events
  3. Stop the Source in Streamkap
  4. Perform the SQL Server upgrade
  5. Verify all items in the checklist above
  6. Re-enable CDC on the database and tables if needed
  7. Ensure SQL Server Agent is running
  8. Resume the Source in Streamkap
  9. Trigger a snapshot if you suspect any events were missed

For full SQL Server source setup details, see:

General Upgrade Considerations

Streamkap’s MongoDB connector uses change streams (backed by the oplog) for CDC. MongoDB upgrade behavior depends on your deployment type and the version jump.

Replica set rolling upgrades are CDC-friendly:

  • Rolling upgrades (upgrading secondary nodes first, then stepping down the primary) allow the connector to continue reading change streams with minimal interruption
  • The connector automatically reconnects to the new primary after a stepdown

Key risks during major version upgrades:

  • Change stream resume tokens may not survive major version upgrades if the oplog format changes
  • If the resume token is invalidated, the connector cannot resume from its last position

Post-upgrade verification checklist:

  1. Oplog size is sufficient – Verify the oplog window is large enough to cover the upgrade duration plus a buffer

  2. Replica set is healthy – All members should be in a healthy state

    rs.status()
  3. Streamkap user privileges are intact – Verify the streamkap_user retains readAnyDatabase and read on the local database

  4. Change streams are functional – Verify the connector can open a change stream on the target collections

Upgrade procedure:

  1. Verify your oplog window is large enough to cover the expected upgrade duration
  2. If performing a rolling upgrade, allow the connector to continue running during secondary node upgrades
  3. Before stepping down the primary, allow the connector to capture all pending events
  4. Stop the Source in Streamkap if the resume token may be invalidated (major version upgrade)
  5. Complete the upgrade
  6. Verify all items in the checklist above
  7. Resume the Source in Streamkap
  8. Trigger a snapshot if the resume token was invalidated or you suspect data gaps

For full MongoDB source setup details, see:

Post-Upgrade Verification Checklist

After completing the upgrade for any database type, verify the following:

  1. The pipeline reconnects and shows a RUNNING status in the Streamkap app
  2. New data changes (inserts, updates, deletes) are being captured – insert a test row and verify it appears at the destination
  3. Consumer group lag is decreasing steadily
  4. Check the DLQ (Dead Letter Queue) for any error messages related to the upgrade
  5. Compare row counts between source and destination for key tables to identify any gaps
  6. Monitor the pipeline for 24-48 hours for any delayed issues

When to Snapshot

A full snapshot is required in specific situations. Trigger a snapshot if any of the following apply:

Scenario Database Reason
Replication slot was dropped PostgreSQL Major upgrades drop logical replication slots; new slots only track changes from creation
Binlog position was lost MySQL (without GTID) Binlog file names and positions can change during major upgrades
Resume token was invalidated MongoDB Major version upgrades may change oplog format, invalidating existing resume tokens
CDC was disabled during upgrade SQL Server Change events are not captured while CDC is disabled
Supplemental logging was reset Oracle Events during the period without supplemental logging are not captured
Data gaps are suspected Any If you cannot confirm all events were captured before the upgrade

Cloud-Managed Database Considerations

Key points for managed database upgrades:

  • Amazon RDS / Aurora: Managed upgrades may handle some infrastructure steps automatically, but replication slots (PostgreSQL) and CDC configuration (SQL Server) still need manual verification
  • Google Cloud SQL: Similar to RDS – verify CDC-related parameters in your database flags after the upgrade
  • Azure Database: Check that server parameters and CDC settings are preserved through the upgrade process
  • MongoDB Atlas: Atlas manages rolling upgrades automatically for replica sets, but verify your connector resumes correctly after the upgrade completes