xp_sqlmaint
Calls the sqlmaint utility with a string containing sqlmaint switches. The sqlmaint utility performs a set of maintenance operations on one or more databases.
Syntax
xp_sqlmaint 'switch_string'
Arguments
'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.
Return Code Values
None. Returns an error if the sqlmaint utility fails.
Remarks
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.
Permissions
Execute permissions for xp_sqlmaint default to members of the db_owner fixed database role in the master database and members of the sysadmin fixed server role, but can be granted to other users.
Examples
In this example, xp_sqlmaint calls sqlmaint to perform integrity checks, create a report file, and update msdb.dbo.sysdbmaintplan_history.
EXEC xp_sqlmaint '-PlanID 02A52657-D546-11D1-9D8A-00A0C9054212
-Rpt "C:\Program Files\Microsoft SQL Server\MSSQL\LOG\DBMaintPlan2.txt" -WriteHistory -CkDB -CkAl'
Here is the result:
The command(s) executed successfully.