Edit

sp_add_maintenance_plan_db (Transact-SQL)

  • Article

Applies to: SQL Server

Associates a database with a maintenance plan.

Note

This stored procedure is used with database maintenance plans. This feature has been replaced with maintenance plans which do not use this stored procedure. Use this procedure to maintain database maintenance plans on installations that were upgraded from a previous version of SQL Server.

This feature will be removed in a future version of SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

Transact-SQL syntax conventions

Syntax

sp_add_maintenance_plan_db
    [ @plan_id = ] 'plan_id'
    , [ @db_name = ] 'database_name'
[ ; ]

Arguments

[ @plan_id = ] 'plan_id'

Specifies the plan ID of the maintenance plan. @plan_id is uniqueidentifier, and must be a valid ID.

[ @db_name = ] 'database_name'

Specifies the name of the database to be added to the maintenance plan. The database must be created or exist before its addition to the plan. @database_name is sysname.

Return code values

0 (success) or 1 (failure).

Remarks

sp_add_maintenance_plan_db must be run from the msdb database.

Permissions

This stored procedure is owned by the db_owner role. You can grant EXECUTE permissions for any user, but these permissions may be overridden during a SQL Server upgrade.

Examples

This example adds the AdventureWorks2022 database to the maintenance plan created in sp_add_maintenance_plan.

EXEC sp_add_maintenance_plan_db
    N'FAD6F2AB-3571-11D3-9D4A-00C04FB925FC',
    N'AdventureWorks2022';

Related content