Skip to content

Latest commit

 

History

History
49 lines (43 loc) · 2.81 KB

sys-plan-guides-transact-sql.md

File metadata and controls

49 lines (43 loc) · 2.81 KB
title description author ms.author ms.date ms.service ms.subservice ms.topic f1_keywords helpviewer_keywords dev_langs monikerRange
sys.plan_guides (Transact-SQL)
sys.plan_guides (Transact-SQL)
rwestMSFT
randolphwest
06/10/2016
sql
system-objects
reference
sys.planguides_TSQL
plan_guides
sys.planguides
plan_guides_TSQL
sys.plan_guides catalog view
TSQL
=azuresqldb-current||>=sql-server-2016||>=sql-server-linux-2017||=azuresqldb-mi-current

sys.plan_guides (Transact-SQL)

[!INCLUDE SQL Server Azure SQL Database Azure SQL Managed Instance]

Contains a row for each plan guide in the database.

Column name Data type Description
plan_guide_id int Unique identifier of the plan guide in the database.
name sysname Name of the plan guide.
create_date datetime Date and time the plan guide was created.
modify_date Datetime Date the plan guide was last modified.
is_disabled bit 1 = Plan guide is disabled.

0 = Plan guide is enabled.
query_text nvarchar(max) Text of the query on which the plan guide is created.
scope_type tinyint Identifies the scope of the plan guide.

1 = OBJECT

2 = SQL

3 = TEMPLATE
scope_type_desc nvarchar(60) Description of scope of the plan guide.

OBJECT

SQL

TEMPLATE
scope_object_id Int object_id of the object defining the scope of the plan guide, if the scope is OBJECT.

NULL if the plan guide is not scoped to OBJECT.
scope_batch nvarchar(max) Batch text, if scope_type is SQL.

NULL if batch type is not SQL.

If NULL and scope_type is SQL, the value of query_text applies.
parameters nvarchar(max) The string defining the list of parameters associated with the plan guide.

NULL = No parameter list is associated with the plan guide.
hints nvarchar(max) The OPTION clause hints associated with the plan guide.

Permissions

[!INCLUDEssCatViewPerm] For more information, see Metadata Visibility Configuration.

See Also

Catalog Views (Transact-SQL)
sp_create_plan_guide (Transact-SQL)
sp_create_plan_guide_from_handle (Transact-SQL)