Warning: array_merge(): Expected parameter 1 to be an array, null given in D:\Wordpress\blogs\kimberly\wp-includes\blocks\shortcode.php on line 31 Warning: array_merge(): Expected parameter 1 to be an array, null given in D:\Wordpress\blogs\kimberly\wp-includes\blocks\social-link.php on line 45 Setting CE Trace Flags query-by-query - by Kimberly L. Tripp

Setting CE TraceFlags on a query-by-query (or session) basis

IMPORTANT NOTE: Be sure to read the ENTIRE post as there’s a workaround that QUERYTRACEON is ALLOWED inside of stored procedures… just NOT in an adHoc statement. Not documented but I think this is excellent! There are still some uses of what I’ve written but this specific use is much easier because of this undoc’ed “feature.” :-)

While the new cardinality estimator can offer benefits for some queries, it might not be perfect for ALL queries. Having said that, there is an OPTION clause that allows you to set the CE for that query. The setting to use depends on the CE that you’re running under currently. And, as of SQL Server 2016, even determining this can be difficult. At any given time, there are multiple settings that might affect your CE.

In SQL Server 2014, your CE was set by the database compatibility model. If you’re running with compatibility mode 120 or higher, then you’re using the new CE. If you’re running with compatibility mode 110 or lower, then you’re using the Legacy CE. In SQL Server 2016, the database compatibility mode is not the only setting that can affect the CE that you’re using. In SQL Server 2016, they added ‘database scoped configuations’ and introduced:

ALTER DATABASE SCOPED CONFIGURATION LEGACY_CARDINALITY_ESTIMATION = { ON | OFF | PRIMARY}

Having said that, an administrator can always override this setting by setting one of the CE trace flags globally [using DBCC TRACEON (TF, -1) – but I don’t recommend this!].

To use the LegacyCE when the database is set to the new CE, use Trace Flag 9481.
To use the New CE when the database is set to the LegacyCE, use Trace Flag 2312.

Generally, I recommend that most people STAY with the LegacyCE until they’ve thoroughly tested the new CE. Then, and only then, change the compatibility mode. But, even with extensive testing, you might still want some queries to run with the LegacyCE while most run with the new CE (or, potentially the opposite). What I like most about the addition of the new CE is that we have the ability to set EITHER!

But, before setting this (or, overriding how the database is set), let’s make sure we know how it’s set currently… If you’re wondering which CE you’re running under, you can see it within the graphical showplan (in the Properties [F4] window, use: CardinalityEstimationModelVersion OR search for that within the showplan XML).

CardinalityEstimationModelVersion

Above all, what I like most is – CHOICE. I can even set this for a specific query:

SELECT m.*
FROM [dbo].[Member] AS [m]
WHERE [m].[firstname] LIKE ‘Kim%’
OPTION (QUERYTRACEON 9481);

However, the bad news is the QUERYTRACEON is limited to SysAdmin only (be sure to read the UPDATEs at the end of this post). Jack Li (Microsoft CSS) wrote a great article about a problem they solved by using a logon trigger to change the CE for an entire session: Wanting your non-sysadmin users to enable certain trace flags without changing your app? Now, I do want to caution you that setting master to trustworthy is not something you should take lightly. But, you should NOT let anyone other than SysAdmin have any other rights in master (other than the occasional EXEC on an added user-defined SP). Here are a couple of posts to help warn you of the danger:

A warning about the TRUSTWORTHY database option
Guidelines for using the TRUSTWORTHY database setting in SQL Server

Having said that, what I really want is to set this on a query by query basis AND I don’t want to elevate the rights of an entire stored procedure (in order to execute DBCC TRACEON). So, I decided that I could create a procedure in master, set master to trustworthy (with the caution and understanding of the above references/articles), and then I can reference it within my stored procedures NOT having to use use 3-part naming (for the sp_ version of the procedure):

ALTER DATABASE master
SET TRUSTWORTHY ON;
GO

USE master;
GO

ALTER PROCEDURE sp_SetTraceFlag
(@TraceFlag int,
@OnOff bit = 0)
WITH EXECUTE AS OWNER
AS
DECLARE @OnOffStr char(1) = @OnOff;
— Sysadmins can add supported trace flags and then use this
— from their applications
IF @TraceFlag NOT IN (
9481 — LegacyCE if database is compat mode 120 or higher
, 2312 — NewCE if database compat mode 110 or lower
)
BEGIN
RAISERROR(‘The Trace Flag supplied is not supported. Please contact your system administrator to determine inclusion of this trace flag: %i.’, 16, 1, @TraceFlag);
RETURN
END
ELSE
BEGIN
DECLARE @ExecStr nvarchar(100);
IF @OnOff = 1
SELECT @ExecStr = N’DBCC TRACEON(‘ + CONVERT(nvarchar(4), @TraceFlag) + N’)’;
ELSE
SELECT @ExecStr = N’DBCC TRACEOFF(‘ + CONVERT(nvarchar(4), @TraceFlag) + N’)’;
— SELECT (@ExecStr)
EXEC(@ExecStr)
— RAISERROR (N’TraceFlag: %i has been set to:%s (1 = ON, 0 = OFF).’, 10, 1, @TraceFlag, @OnOffStr);
END;
GO

GRANT EXECUTE ON sp_SetTraceFlag TO PUBLIC;
GO

As for using this procedure, you have TWO options. If you can modify the stored procedure then you can wrap a single statement with the change in trace flag. But, to make it take effect, you’ll need to recompile that statement. So, if your stored procedure looks like the following:

CREATE PROCEDURE procedure
( params )
AS
statement;
statement; <<<— problematic statement
statement;
statement;
GO

Then you can change this to:

CREATE PROCEDURE procedure
( params )
AS
statement;
EXEC sp_SetTraceFlag 2312, 1
statement OPTION (RECOMPILE); <<<— MODIFIED problematic statement
EXEC sp_SetTraceFlag 2312, 0
statement;
statement;
GO

If you don’t want to set master to trustworthy then you can add a similar procedure to msdb (which is already set to TRUSTWORTHY) and then use 3-part naming to reference it.

USE msdb;
GO

CREATE PROCEDURE msdbSetTraceFlag
(@TraceFlag int,
@OnOff bit = 0)
WITH EXECUTE AS OWNER
AS
DECLARE @OnOffStr char(1) = @OnOff;
— Sysadmins can add supported trace flags and then use this
— from their applications
IF @TraceFlag NOT IN (
9481 — LegacyCE if database is compat mode 120 or higher
, 2312 — NewCE if database compat mode 110 or lower
)
BEGIN
RAISERROR(‘The Trace Flag supplied is not supported. Please contact your system administrator to determine inclusion of this trace flag: %i.’, 16, 1, @TraceFlag);
RETURN
END
ELSE
BEGIN
DECLARE @ExecStr nvarchar(100);
IF @OnOff = 1
SELECT @ExecStr = N’DBCC TRACEON(‘ + CONVERT(nvarchar(4), @TraceFlag) + N’)’;
ELSE
SELECT @ExecStr = N’DBCC TRACEOFF(‘ + CONVERT(nvarchar(4), @TraceFlag) + N’)’;
— SELECT (@ExecStr)
EXEC(@ExecStr)
— RAISERROR (N’TraceFlag: %i has been set to:%s (1 = ON, 0 = OFF).’, 10, 1, @TraceFlag, @OnOffStr);
END;
GO

GRANT EXECUTE ON msdbSetTraceFlag TO PUBLIC;
GO

To use this, you’ll need to use 3-part naming:

CREATE PROCEDURE procedure
( params )
AS
statement;
EXEC msdb.dbo.msdbSetTraceFlag 2312, 1
statement OPTION (RECOMPILE); <<<— MODIFIED problematic statement
EXEC msdb.dbo.msdbSetTraceFlag 2312, 0
statement;
statement;
GO

Finally, another option is to wrap a statement with the change in trace flag.

EXEC sp_SetTraceFlag 2312, 1;
GO
STATEMENT or PROCEDURE
GO
EXEC sp_SetTraceFlag 2312, 0; — don’t remember to turn it back off!
GO

Now, you have strategic access to EITHER CE and you don’t have to elevate anyone’s specific rights to SysAdmin. You can even let developers use the changes to the new CE or the LegacyCE in their code which is incredibly useful!

UPDATE: If you can’t change the code then another excellent option would be use to a plan guide (permissions are only at the object/database level: To create a plan guide of type OBJECT, requires ALTER permission on the referenced object. To create a plan guide of type SQL or TEMPLATE, requires ALTER permission on the current database.). Here’s a good post on how to add QUERYTRACEON into a plan guide: Using QUERYTRACEON in plan guides by Gianluca Sartori.

UPDATE #2: Wow! A bit of digging and I stumbled on this ConnectItem: QUERYTRACEON with no additional permissions and after I up-voted it, I noticed the workaround by Dan Guzman: There is currently undocumented behavior in SQL 2014 that allows use of QUERYTRACEON in a stored procedure without sysadmin permissions regardless of module signing or EXECUTE AS. This is a workaround in situations where the query is already in a stored procedure or when a problem ad-hoc query needing the trace flag can be encapsulated in a proc. However, until it’s documented, this workaround is at-your-own-risk. I did NOT know this… So, QUERYTRACEON CAN be used in a stored procedure even without SysAdmin permissions (I actually like this!). And, I tested this in BOTH 2014 AND 2016 and it works! It’s not documented nor is it recommended but I’m happy to see that you do NOT need to do this for QUERYTRACEON. It looks like it evens works in earlier versions. Most of us ran into problems with the clause erroring on adhoc statements so we just didn’t expect it to work INSIDE of a proc. Well… better late than never!

Thanks for reading,
Kimberly

7 thoughts on “Setting CE TraceFlags on a query-by-query (or session) basis

  1. I use that method (a trustworthy DB) for a number of purposes (when I have no other choice) but my preference is to create a separate database specifically for those SPs. I can then limit permissions much more carefully. For users that need access I grant CONNECT to the DB and EXECUTE on the SP only. In fact in this case I could even grant them to PUBLIC without any major risk if I also make sure PUBLIC doesn’t have any other permissions.

    This avoids the risk that someone will gain additional permissions to master from someone who doesn’t realize the risk and reduces the number of people I have to give permissions to MSDB.

    1. That’s another option for sure. It will require 3-part naming (as does the msdb option) and you’ll need to make sure to protect this new DB but that’s absolutely another good (better, really) alternative (since it’s one that you can control more directly). So, great comment Kenneth!

      THANKS!
      Kimberly

  2. One of the problems we had with this is that while the OPTION QUERYTRACEON worked fine for stored procedure executions by non-sysadmins…we would make the recommendation to the developer when we determined such an issue existed, the developer goes to change the code in their development environment, and can’t create/alter the proc. So while the execution seems allowed, the DDL for the proc seems to still require sysadmin. Our workaround is to have them just send it to the DBAs to implement for them. Can’t quite bring ourselves to grant sysadmin role membership!

    1. I totally agree. This should ONLY ever be edited by sys-admins.

      But, given that ANY sproc can use QUERYTRACEON without any special rights, you might not have to use this method often… but, again, I agree! Definitely ONLY sys-admins to modify!

      Thanks,
      k

  3. We had a stored procedure that’s prone to parameter sniffing and we did all the tips and tricks to make it perform better like updating stats frequently with sample rate, applied filtered stats (i came to know about that from your blog) and we had CE issues (we are in SQL 2014). So i finally decided to go with Option(Recompile) for a particular problematic statement in the stored procedure and then i realized it only works for users part of SA role. Initially I lost hope, then i saw this post, implemented it and it worked perfectly.

    Thanks a lot.

    1. OPTION (RECOMPILE) isn’t limited to says admins (you worried me so I just did some tests). There must be something else wrong with that proc? But, I’m glad this trick worked!!

      Cheers,
      k

Leave a Reply

Your email address will not be published. Required fields are marked *

Other articles

SQLskills SQL101: Partitioning

Continuing on our path to understanding the basics and core concepts, there’s a big topic that’s often greatly misunderstood and that’s partitioning. I know I’m

Explore

Imagine feeling confident enough to handle whatever your database throws at you.

With training and consulting from SQLskills, you’ll be able to solve big problems, elevate your team’s capacity, and take control of your data career.