| title | xp_sqlmaint (Transact-SQL) | Microsoft Docs | ||
|---|---|---|---|
| ms.custom | |||
| ms.date | 03/14/2017 | ||
| ms.prod | sql | ||
| ms.prod_service | database-engine | ||
| ms.reviewer | |||
| ms.technology | system-objects | ||
| ms.topic | language-reference | ||
| f1_keywords |
|
||
| dev_langs |
|
||
| helpviewer_keywords |
|
||
| ms.assetid | bda66e1b-6bbd-49be-b86e-37efc920e912 | ||
| author | MashaMSFT | ||
| ms.author | mathoma |
[!INCLUDEtsql-appliesto-ss2008-xxxx-xxxx-xxx-md]
Calls the sqlmaint utility with a string that contains sqlmaintswitches. The sqlmaint utility performs a set of maintenance operations on one or more databases.
Note
[!INCLUDEssNoteDepFutureAvoid]
Transact-SQL Syntax Conventions
xp_sqlmaint 'switch_string'
' switch_string '
Is a string containing the sqlmaint utility switches. The switches and their values must be separated by a space.
The -? switch is not valid for xp_sqlmaint.
None. Returns an error if the sqlmaint utility fails.
If this procedure is called by a user logged on with SQL Server Authentication, the -U "login_id" and -P "password" switches are prepended to switch_string before execution. If the user is logged on with Windows Authentication, switch_string is passed without change to sqlmaint.
Requires membership in the sysadmin fixed server role.
In the following example, xp_sqlmaint calls sqlmaint to perform integrity checks, create a report file, and update msdb.dbo.sysdbmaintplan_history.
EXEC xp_sqlmaint '-D AdventureWorks2012 -PlanID 02A52657-D546-11D1-9D8A-00A0C9054212
-Rpt "C:\Program Files\Microsoft SQL Server\MSSQL\LOG\DBMaintPlan2.txt" -WriteHistory -CkDB -CkAl';
[!INCLUDEssResult]
The command(s) executed successfully.