Migrate Persistent Query Settings

This documentation refers to an outdated version of mongosync. View the current documentation for up-to-date guidance on mongosync and instructions on how to upgrade to the latest version.

If your source cluster uses Persistent Query Settings (PQS), you must manually migrate those settings to your destination cluster to finalize sync.

mongosync checks for PQS during initialization and the cutover process. If mongosync finds PQS on the source cluster during cutover, Mongosync shows a warning. Use the following procedure to address the warning and migrate your PQS to your destination cluster.

Steps

Export your Persistent Query Settings.

Run the following code block to output your query settings into an array:

mongosh --eval
'console.log(db.aggregate([{$querySettings:{}}]).toArray())'

Import your PQS to the destination cluster.

For each query setting that you want to migrate, use setQuerySettings to apply that setting to your destination cluster.

If the query setting includes a representativeQuery field value, use that field value as the setQuerySettings value.

Otherwise, use the queryShapeHash field value from the querySettings array as the setQuerySettings value.

Back

Finalize Cutover Process

Reverse Sync Direction