xp_trace_setreadfilter (T-SQL)

Specifies the read filter, or the minimum and maximum number of logical read operations to capture for the events specified. Microsoft® SQL Server™ captures the required information, configured by executing xp_trace_seteventclassrequired, for all events with a read value greater than the minimum read value, if any, and less than the maximum read value, if any.

Syntax

xp_trace_setreadfilter {queue_handle, minimum_read, maximum_read}

Arguments

queue_handle

Is an integer representing the handle for the trace queue. queue_handle is used to reference the trace queue event placed in an output parameter by xp_trace_addnewqueue.

minimum_read

Is an integer specifying the minimum cumulative process reads for which to trace. There is no default value. If 0, there are no minimum restrictions. The maximum value is 4294967295.

maximum_read

Is an integer specifying the maximum cumulative process reads for which to trace. There is no default value. If 0, there are no maximum restrictions. The maximum value is 4294967295.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_setreadfilter returns this message:

The command(s) completed successfully.

Permissions

Execute permissions for xp_trace_setreadfilter default to members of the sysadmin fixed server role but can be granted to other users.

Examples

This example configures the read filter value information for the trace queue. A minimum read operation value of 250 is specified, and the maximum number of read operations is 5000.

USE master

DECLARE @queue_handle int, @column_value int

SET @column_value = 16|32|8192|128|512

EXEC xp_trace_addnewqueue 1000,

    5,

    95,

    90,

    @column_value,

    @queue_handle OUTPUT

EXEC xp_trace_setreadfilter @queue_handle,

    250,

    5000

See Also