sp_query_store_clear_message_queues (Transact-SQL)

Applies to: SQL Server 2022 (16.x)

Clears all queued (non-persisted) Query Store messages pending for the replica against which the command is executed. sp_query_store_clear_message_queues is used when Query Store for secondary replicas has been enabled.

Transact-SQL syntax conventions

Syntax

sp_query_store_clear_message_queues
[ ; ]

Return code values

0 (success) or 1 (failure).

Permissions

Requires the ALTER permission on the database.

Examples

The following example clears all queued (non-persisted) Query Store messages pending. The action applies to the replica against which the command is executed.

EXEC sp_query_store_clear_message_queues;

Related content

• Monitor performance by using the Query Store
• Query Store for secondary replicas
• sys.database_query_store_internal_state (Transact-SQL)
• Query Store catalog views (Transact-SQL)
• Query Store stored procedures (Transact-SQL)