Skip to content

Commit 31bd36d

Browse files
authored
Update document to remove unused parameters.
Fixing a doc bug, as there were some options in the final documentation that are not enabled as of the time of this update. [, @query_hints_comment = 'query_hints_comment' ] [, @override_plan_guide_and_hints = 'override_plan_guide_and_hints' ] [, @fail_execution_on_error = 'fail_execution_on_error' ] ------- cc: @rwestMSFT
1 parent 58e3901 commit 31bd36d

1 file changed

Lines changed: 1 addition & 16 deletions

File tree

docs/relational-databases/system-stored-procedures/sys-sp-query-store-set-hints-transact-sql.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,6 @@ monikerRange: "=azuresqldb-current||=azuresqldb-mi-current||>=sql-server-ver16||
3535
sp_query_store_set_hints
3636
@query_id = 'query_id',
3737
@query_hints = 'query_hints'
38-
[, @query_hints_comment = 'query_hints_comment' ]
39-
[, @override_plan_guide_and_hints = 'override_plan_guide_and_hints' ]
40-
[, @fail_execution_on_error = 'fail_execution_on_error' ]
4138
[, @query_hint_scope = 'query_hint_scope' ] [;]
4239
```
4340

@@ -51,21 +48,9 @@ Bigint. Required. The Query Store `query_id` from [sys.query_store_query](../sys
5148

5249
Nvarchar(max). String of query options beginning with `'OPTION`. For more information, see [Supported query hints](#supported-query-hints) in this article.
5350

54-
#### [ @query_hints_comment ]
55-
56-
Nvarchar(max). User-editable comment on query hint. Use to provide context, application, event, or other information useful to yourself and other administrators in the future.
57-
58-
#### [ @override_plan_guide_and_hints ]
59-
60-
Bit. Defaults to `1`. Controls whether the new Query Store hint will override an existing plan guide or an in-place hint in the code.
61-
62-
#### [ @fail_execution_on_error ]
63-
64-
Bit. Default is `0`. Controls whether errors in applying a query hint will be surfaced to the client. The default for this argument is `0` which matches the existing Query Store plan forcing overall behavior where failing operations are silently logged and do not block query execution.
65-
6651
#### [ @query_hint_scope ]
6752

68-
Tinyint. By default, the scope of a new Query Store hint is the local replica only. Determines the scope at which the hint will be applied, as per the `replica_group_id` column in [sys.query_store_replicas](../system-catalog-views/sys-query-store-replicas.md).
53+
Tinyint. By default, the scope of a new Query Store hint is the local replica only. This optional parameter determines the scope at which the hint will be applied on a secondary replica when [Query Store for secondary replicas](../performance/query-store-for-secondary-replicas.md) is enabled. The argument defaults to the local replica, but you can optionally specify a `replica_group_id` column as per the [sys.query_store_replicas](../system-catalog-views/sys-query-store-replicas.md) system catalog view.
6954

7055
## Return Values
7156
0 (success) or 1 (failure)

0 commit comments

Comments
 (0)