QuIcK ReFereNce GuIde - SYsteM Stored Procedures - SQL SerVer 2005

This is a quick reference for the usable system proc. Not all system procs are in scope, only the ones considered to be most useful. Focus is on ss2k5 system procs. Initial categories utilized are defined using http:// msdn2.microsoft.com/en-us/library/ms187961.aspx: 1. Catalog

DataBase ENgINe Stored Procedures

Create and store a user defined message inside the instance.
sp_addmessage [ @msgnum = ] msg_id , [ @severity = ] severity , [ @msgtext = ] msg [ , [ @lang = ] language ] [ , [ @with_log = ] with_log ] [ , [ @replace = ] replace ]

Return name of the DLL for the specified extended stored procedure, or all extended stored procedures.
sp_helpextendedproc [ [@funcname = ] procedure ]

Create a group (i.e., role) in the current database.

sp_addgroup [ @grpname = ] group

Remove a server login from the specified fixed server role.

sp_dropsrvrolemember [ @loginame = ] login , [ @rolename = ] role

Return information on the specified database filename, or all database files.

sp_helpfile [ [ @filename = ] name ]

Create new SQL Server login.

Return information on the specified filegroup, or all filegroups.

sp_helpfilegroup [ [ @filegroupname = ] name ]

sp_addlogin [ @loginame = ] login [ , [ @passwd = ] password ] [ , [ @defdb = ] database ] [ , [ @deflanguage = ] language ] [ , [ @sid = ] sid ] [ , [ @encryptopt= ] encryption_option ]

Remove database user from the current database.

sp_dropuser [ sp_dropuser ] user

GeNeral EXteNded Stored Procedures

Spawn a command shell and execute the command string.
xp_cmdshell { command_string } [ , no_output ]

Create specified database user for the specified server login.

sp_grantdbaccess [ @loginame = ] login [ , [ @name_in_db = ] name_in_db [ OUTPUT ] ]

[ , [ @start_run_date = ] start_run_date ] [ , [ @end_run_date = ] end_run_date ] [ , [ @start_run_time = ] start_run_time ] [ , [ @end_run_time = ] end_run_time ] [ , [ @minimum_run_duration = ] minimum_run_duration ] [ , [ @run_status = ] run_status ] [ , [ @minimum_retries = ] minimum_retries ] [ , [ @oldest_first = ] oldest_first ] [ , [ @server = ] server ] [ , [ @mode = ] mode ]

Create and map a remote login to a local login.

sp_addremotelogin [ @remoteserver = ] remoteserver [ , [ @loginame = ] login ] [ , [ @remotename = ] remote_name ]

Return list of defined groups within the specified domain.

xp_enumgroups [ domain_name ]

2. Database Engine 3. General Extended 4. Security 5. SQL Profiler 6. SQL Server Agent
All system stored procedures are located inside the master database, except for the SQL Server Agent stored procedures. Those are located in the msdb database, and as a result the user will either need to connect to the msdb database or issue an execute command as follows: EXEC msdb..[proc_name]

Create a backup device.

Return information regarding the indexes on the specified table or view.

sp_helpindex [ @objname = ] name

Create a server login for a domain user or group.

sp_grantlogin [@loginame=] login

Return information about the job schedule for the specified job.
sp_help_jobschedule [ @job_id = ] job_id | [ @job_name = ] job_name [ , [ @schedule_name = ] schedule_name ] | [ , [ @schedule_id = ] schedule_id ] [ , [ @include_description = ] include_description ]

sp_addumpdevice [ @devtype = ] device_type , [ @logicalname = ] logical_name , [ @physicalname = ] physical_name [ , { [ @cntrltype = ] controller_type | [ @devstatus = ] device_status } ]

Create a role in the current database.

sp_addrole [ @rolename = ] role [ , [ @ownername = ] owner ]

Return list of all roles for the current database.

sp_helpdbfixedrole [ [ @rolename = ] role ]

Log event in the instance error log and the server event log.
xp_logevent { error_number , message } [ , severity ]

Return information regarding the remote, linked, or replication servers for the current instance.
sp_helpserver [ [ @server = ] server ] [ , [ @optname = ] option ] [ , [ @show_topology = ] show_topology ]

Add a database user, database role, or server login to the specified role.
sp_addrolemember [ @rolename = ] role, [ @membername = ] security_account

Return information for the specified role, or all roles for the current database.
sp_helpgroup [ [ @grpname = ] role ]

Return the login security context for the current instance.

xp_loginconfig [config_name]

Return information on the job steps for the specified job.

sp_help_jobstep { [ @job_id = ] job_id | [ @job_name = ] job_name } [ , [ @step_id = ] step_id ] [ , [ @step_name = ] step_name ] [ , [ @suffix = ] suffix ]

Return information for the specified login or all logins.

xp_logininfo [[@acctname =] account_name] [,[@option =] all | members] [,[@privelege=] variable_name OUTPUT]

Alter a user defined message inside the instance.

sp_altermessage [ @message_id = ] message_number , [ @parameter = ] write_to_log , [ @parameter_value = ] value

Return the sort order and character set information for the current instance.
sp_helpsort

Create a remote server entry for the local instance.

sp_addserver [ @server = ] server [ , [ @local= ] local ] [ , [ @duplicate_ok = ] duplicate_OK ]

Return information for the specified remote or linked server, or all defined remote and linked servers.
sp_helplinkedsrvlogin [ [ @rmtsrvname = ] rmtsrvname ] [ , [ @locallogin = ] locallogin ]

Return version information for the current instance.

xp_msver [ optname ]

Attach a database file(s) to the instance.

sp_attach_db [ @dbname= ] dbname , [ @filename1= ] filename_n [ ,...16 ]

Return statistic information for the specified table.

sp_helpstats[ @objname = ] object_name [ , [ @results = ] value ]

Returns information about operators and associated alerts.

sp_help_notification [ @object_type = ] object_type , [ @name = ] name , [ @enum_type = ] enum_type , [ @notification_method = ] notification_method [ , [ @target_name = ] target_name ]

CATALOG STORED PROCEDURES

Display column level permissions for a table.
sp_column_privileges [ @table_name = ] table_name [ , [ @table_owner = ] table_owner ] [ , [ @table_qualifier = ] table_qualifier ] [ , [ @column_name = ] column ]

Attach a database file to the instance. This procedure is most useful when no associated log file is available.
sp_attach_single_file_db [ @dbname= ] dbname , [ @physname= ] physical_name

Return the definition of the specified object.

Add a server login as a member to the specified fixed server role.

sp_addsrvrolemember [ @loginame= ] login , [ @rolename = ] role

Return information for the specified server login, or for all server logins.
sp_helplogins [ [ @LoginNamePattern = ] login ]

sp_helptext [ @objname = ] name [ , [ @columnname = ] computed_ column_name ]

Display or alter the UPDATE STATISTICS setting for a table or view.

sp_autostats [ @tblname = ] table_name [ , [ @flagc = ] stats_flag ] [ , [ @indname = ] index_name ]

Return information on any DML triggers for the specified table.

sp_helptrigger [ @tabname = ] table [ , [ @triggertype = ] type ]

Add an existing server login as a user in the current database.

sp_adduser [ @loginame = ] login [ , [ @name_in_db = ] user ] [ , [ @grpname = ] role ]

Return information for the specified domain group, or all domain groups, with access to the current database.
sp_helpntgroup [ [ @ntname= ] name ]

SQL SerVer ProFIler Stored Procedures

Create a new trace definition.
sp_trace_create [ @traceid = ] trace_id OUTPUT , [ @options = ] option_value , [ @tracefile = ] trace_file [ , [ @maxfilesize = ] max_file_size ] [ , [ @stoptime = ] stop_time ] [ , [ @filecount = ] max_rollover_files ]

Returns information about the specified operator, or all operators defined for the current instance.
sp_help_operator [ [ @operator_name = ] operator_name ] [ , [ @operator_id = ] operator_id ]

Return information for the specified remote server logins, or for all remote server logins, defined on the local server.
sp_helpremotelogin [ [ @remoteserver = ] remoteserver ] [ , [ @remotename = ] remote_name ]

Configure locking options for specified table or index.

sp_indexoption [ @IndexNamePattern = ] table_or_index_name , [ @OptionName = ] option_name , [ @OptionValue = ] value

Display column information for a table.

sp_columns [ @table_name = ] object [ , [ @table_owner = ] owner ] [ , [ @table_qualifier = ] qualifier ] [ , [ @column_name = ] column ] [ , [ @ODBCVer = ] ODBCVer ]

Display or alter instance configuration settings for the instance.

sp_configure [ [ @configname = ] option_name [ , [ @configvalue = ] value ] ]

Alter the password of the specified application role in the current database.
sp_approlepassword [ @rolename= ] role , [ @newpwd = ] password

Return information for the specified database role, or all database roles, for the current database.
sp_helprole [ [ @rolename = ] role ]

Return information for the specified schedule, or all schedules. sp_help_schedule

[ { [ @schedule_id = ] id | [ @schedule_name = ] schedule_name } ] [ , [ @attached_schedules_only = ] attached_schedules_only ] [ , [ @include_description = ] include_description ]

Return information about locks.

List all databases for the current instance, including size in KB.
sp_databases

Create statistics for columns in a table, or for columns specific to indexes in a table.
sp_createstats [ [ @indexonly = ] indexonly ] [ , [ @fullscan = ] fullscan ] [ , [ @norecompute = ] norecompute ]

sp_lock [[@spid1 = ] spid1] [,[@spid2 = ] spid2] [;]

Map an existing database user to a SQL Server login.

sp_change_users_login [ @action = ] action [ , [ @UserNamePattern = ] user ] [ , [ @LoginName = ] login ] [ , [ @password = ] password ]

Create an event.

Return statistical information about the current instance.

sp_monitor

Return information for the specified database role member, or all database role members, for the current database.
sp_helprolemember [ [ @rolename = ] role ]

sp_trace_generateevent [ @eventid = ] event_id [ , [ @userinfo = ] user_info ] [ , [ @userdata = ] user_data ]

Create or remove an event from a defined trace.

sp_trace_setevent [ @traceid = ] trace_id , [ @eventid = ] event_id , [ @columnid = ] column_id , [ @on = ] on

Send email to a defined Database Mail profile. sp_notify_operator

[ @profilename = ] profilename , [ @id = ] id , [ @name = ] name , [ @subject = ] subject , [ @body = ] message , [ @file_attachments = ] attachment [ @mail_database = ] mail_host_database

Alter the owner of the current database.

sp_changedbowner [ @loginame = ] login [ , [ @map= ] remap_alias_flag ]

Display list of all tables with a defined foreign key relationship to the given primary key table.
sp_fkeys [ @pktable_name = ] pktable_name [ , [ @pktable_owner = ] pktable_owner ] [ , [ @pktable_qualifier = ] pktable_qualifier ] { , [ @fktable_name = ] fktable_name } [ , [ @fktable_owner = ] fktable_owner ] [ , [ @fktable_qualifier = ] fktable_qualifier ]

Cycle the error log as if the server had been restarted.

sp_cycle_errorlog

Configure the specified stored procedure to be executed when the server instance is started.
sp_procoption [ @ProcName = ] procedure , [ @OptionName = ] option , [ @OptionValue = ] value

Return information on permissions in the current database.

sp_helprotect [ [ @name = ] object_statement ] [ , [ @username = ] security_account ] [ , [ @grantorname = ] grantor ] [ , [ @permissionarea = ] type ]

Display list of supported data types for the instance.

sp_datatype_info [ [ @data_type = ] data_type ] [ , [ @ODBCVer = ] odbc_version ]

Alter the role membership of a user in the database to use only the specified role.
sp_changegroup [ @grpname= ] role , [ @username = ] user

Create and apply a filter to a defined trace.

Display primary key for given table.

sp_pkeys [ @table_name = ] name [ , [ @table_owner = ] owner ] [ , [ @table_qualifier = ] qualifier ]

Alters database behaviors to be compatible with previous versions.

sp_dbcmptlevel [ [ @dbname = ] name ] [ , [ @new_cmptlevel = ] version ]

Configure a procedure or trigger to be recompiled upon next execution.

sp_recompile [ @objname = ] object

Return list of fixed server roles.

Alter the owner of the specified object in the current database.

sp_changeobjectowner [ @objname = ] object , [ @newowner = ] owner

sp_helpsrvrole [ [ @srvrolename = ] role ]

sp_trace_setfilter [ @traceid = ] trace_id , [ @columnid = ] column_id , [ @logical_operator = ] logical_operator , [ @comparison_operator = ] comparison_operator , [ @value = ] value

Remove history for the specified job, or for all jobs.

sp_purge_jobhistory { [ @job_name = ] job_name | | [ @job_id = ] job_id } [ , [ @oldest_date = ] oldest_date ]

Refresh the metadata for the specified view.

sp_refreshview [ @viewname = ] viewname

Return member information for the specified fixed server role, or all fixed server roles.
sp_helpsrvrolemember [ [ @srvrolename = ] role ]

Start, pause, or remove a defined trace.

sp_trace_setstatus [ @traceid = ] trace_id , [ @status = ] status

Start the specified job.

Display attribute id and values for the current instance.

sp_server_info [[@attribute_id = ] attribute_id]

Display or alter configuration settings for a database.

sp_dboption [ [ @dbname = ] database ] [ , [ @optname = ] option_name ] [ , [ @optvalue = ] value ]

Alter the name of the specified object.

sp_dbfixedrolepermission [ [ @rolename = ] role ]

Return the permissions for the specified database role.

sp_rename [ @objname = ] object_name , [ @newname = ] new_name [ , [ @objtype = ] object_type ]

Return information for the specified database user or role, or all database users in the current database.
sp_helpuser [ [ @name_in_db = ] security_account ]

Display columns that uniquely identify a row in a given table.

sp_special_columns [@table_name =] table_name [,[@table_owner =] table_owner] [,[@qualifier =] qualifier] [,[@col_type =] col_type] [,[@scope =] scope] [,[@nullable =] nullable] [,[@ODBCVer =] ODBCVer]

Alter the default database for a server login.

sp_defaultdb [ @loginame= ] login, [ @defdb= ] database

Remove a database and all associated database files.

sp_dbremove [ @dbname = ] database [ , [ @dropdev = ] dropdev ]

Alter the name of the specified database.

sp_renamedb [ @dbname = ] old_name , [ @newname = ] new_name

Return name and owner on all databases for which the current user has access.
sp_MShasdbaccess

SQL SerVer AgeNt Stored Procedures

NOTE: These stored procedures are located inside the msdb database.

sp_start_job { [@job_name =] job_name | [@job_id =] job_id } [ , [@error_flag =] error_flag] [ , [@server_name =] server_name] [ , [@step_name =] step_name] [ , [@output_flag =] output_flag]

Deletes backup and restore entries in the msdb database for entries older than the specified date.
sp_delete_backuphistory [ @oldest_date = ] oldest_date

Configure the AFTER triggers to be fired either first or last.

Alter the default language for the specified server login.

sp_defaultlanguage [ @loginame= ] login [ , [ @language= ] language ] [ @loginame= ] login, [ @defdb= ] database

Stop the specified job.

Alter the password for a SQL Server login.

sp_password [ [ @old = ] old_password , ] { [ @new =] new_password } [ , [ @loginame = ] login ]

Display parameter information for a given stored procedure.

sp_sproc_columns [[@procedure_name = ] name] [ , [@procedure_owner = ] owner] [ , [@procedure_qualifier = ] qualifier] [ , [@column_name = ] column_name] [ , [@ODBCVer = ] ODBCVer] [ , [@fUsePattern = ] fUsePattern]

Display dependency information about the specified object.

sp_depends [ @objname = ] object

sp_settriggerorder [ @triggername = ] [ triggerschema. ] triggername , [ @order = ] value , [ @stmttype = ] statement_type [ , [ @namespace = ] { DATABASE | SERVER | NULL } ]

Return information for specified alert, or all alerts.

sp_help_alert [ [ @alert_name = ] alert_name ] [ , [ @order_by = ] order_by ] [ , [ @alert_id = ] alert_id ] [ , [ @category_name = ] category ] [ , [ @legacy_format = ] legacy_format ]

sp_stop_job [@job_name =] job_name | [@job_id =] job_id | [@originating_server =] master_server | [@server_name =] target_server

Return space information for the specified object or current database.

sp_spaceused [[ @objname = ] objname ] [,[ @updateusage = ] updateusage ]

Deny specified domain login the ability to connect to the current instance.
sp_denylogin [ @loginame= ] login

Remove specified database user from the current database.

sp_revokedbaccess [ @name_in_db = ] name

Detach a database from the instance.

sp_detach_db [ @dbname= ] dbname [ , [ @skipchecks= ] skipchecks ] [ , [ @KeepFulltextIndexFile= ] KeepFulltextIndexFile ]

Remove defined alias for the specified login as a database user.

sp_dropalias [ @loginame = ] login

Remove domain user or group as a server login.

sp_revokelogin [ @loginame= ] login

Return information about the specified job, alert, or operator.

sp_help_category [ [ @class = ] class ] [ , [ @type = ] type ] [ , [ @name = ] name ] [ , [ @suffix = ] suffix ]

Configure options for specified table.

Display indexes and statistics for a given table.

sp_statistics [ @table_name = ] table_name [ , [ @table_owner = ] owner ] [ , [ @table_qualifier = ] qualifier ] [ , [ @index_name = ] index_name ] [ , [ @is_unique = ] is_unique ] [ , [ @accuracy = ] accuracy ]

Delete a device from the instance.

sp_dropdevice [ @logicalname = ] device [ , [ @delfile = ] delfile ]

sp_tableoption [ @TableNamePattern = ] table , [ @OptionName = ] option_name , [ @OptionValue = ] value

Remove specified application role from the current database.

sp_dropapprole [@rolename = ] role

Configure permissions for the specified application role in the current database.
sp_setapprole [ @rolename = ] role, [ @password = ] { encrypt Npassword } | password [ , [ @encrypt = ] { none | odbc } ] [ , [ @fCreateCookie = ] true | false ] [ , [ @cookie = ] @cookie OUTPUT ]

Return information about the specified job, or all jobs.

sp_help_job [ [ @job_id = ] job_id ] [ , [ @job_name = ] job_name ] [ , [ @job_aspect = ] job_aspect ] [ , [ @job_type = ] job_type ] [ , [ @owner_login_name = ] login_name ] [ , [ @subsystem = ] subsystem ] [ , [ @category_name = ] category ] [ , [ @enabled = ] enabled ] [ , [ @execution_status = ] status ] [ , [ @date_comparator = ] date_comparison ] [ , [ @date_created = ] date_created ] [ , [ @date_last_modified = ] date_modified ] [ , [ @description = ] description_pattern ]

Remove a user defined message from the instance.

sp_dropmessage [ @msgnum = ] message_number [ , [ @lang = ] language ]

Execute UPDATE STATISTICS against all tables in the current database.

sp_updatestats [ [ @resample = ] resample]

Remove a group (i.e., role) from the current database.

sp_dropgroup [ @rolename = ] role

Author, Thomas LaRock Thomas LaRock, a member of Quests Association for SQL Server Experts, is a seasoned IT professional with almost a decade of technical and management experience. Currently serving as a database engineering team lead with ING Investment Management, Thomas has progressed through several roles at ING, including programmer, analyst, and DBA. Prior to ING, he worked at several software and consulting companies, working at customer sites in the United States and abroad. Thomas holds a MS degree in mathematics from Washington State University and is also a member of PASS and the Usability Professionals Association.

Display list of stored procedures in current database.

sp_stored_procedures [ [ @sp_name = ] name ] [ , [ @sp_owner = ] schema] [ , [ @sp_qualifier = ] qualifier ] [ , [@fUsePattern = ] fUsePattern ]

Execute a T-SQL statement.

Display table level permissions for a table.

sp_table_privileges [ @table_name = ] table_name [ , [ @table_owner = ] table_owner ] [ , [ @table_qualifier = ] table_qualifier ] [ , [@fUsePattern =] fUsePattern]

sp_executesql [ @stmt = ] stmt [ {, [@params=] N@parameter_name data_type [ [ OUT [ PUT ][,...n] } {, [ @param1 = ] value1 [ ,...n ] } ]

Return information about the specified login or all logins currently connected to the instance.
sp_who [[@login_name =] login]

Remove a SQL Server login from the current instance.

sp_droplogin [ @loginame= ] login

Remove the specified remote login from the current instance.

sp_dropremotelogin [ @remoteserver = ] remoteserver [ , [ @loginame = ] login ] [ , [ @remotename = ] remote_name ]

Return permission information for the specified fixed server role, or all fixed server roles.
sp_srvrolepermission [ [ @srvrolename = ] role]

Removes an application role and reverts to previous security context.

sp_unsetapprole @cookie

Return information about the specified database object, or all objects.

sp_help [ [ @objname = ] name ]

Display list of all tables and views in current database.

sp_tables [ [ @table_name = ] name ] [ , [ @table_owner = ] owner ] [ , [ @table_qualifier = ] qualifier ] [ , [ @table_type = ] type ] [ , [@fUsePattern = ] fUsePattern]

Return information about the specified database, or all databases.

sp_helpdb [ [ @dbname= ] name ]

SecurItY Stored Procedures

Map a server login to a database user.
sp_addalias [ @loginame = ] login , [ @name_in_db = ] alias_user

Remove specified empty role from the current database.

sp_droprole [ @rolename= ] role

Return information on domain users or groups that exist as server logins, but no longer exist in the domain.
sp_validatelogins

Return information about the current state of the specified job, or all jobs.
sp_help_jobactivity [ [ @job_id = ] job_id ] | [ @job_name = ] job_name ] ] [ , [ @session_id = ] session_id ] ]

Remove a database user, database role, or server login from the specified role.
sp_droprolemember [ @rolename = ] role , [ @membername = ] security_account

Return information about the specified backup device, or all backup devices.
sp_helpdevice [ [ @devname = ] name ]

Create an application role in the current database.

sp_addapprole [ @rolename = ] role , [ @password = ] password

Remove defined remote or linked server from the current instance.

sp_dropserver [ @server = ] server [ , [ @droplogins = ] { droplogins | NULL} ]

Find all your SQL Servers in your environment with our free tool download from quest.com/sqldiscovery

Return information on the history of the specified job, or all jobs.

sp_help_jobhistory [ [ @job_id = ] job_id ] [ , [ @job_name = ] job_name ] [ , [ @step_id = ] step_id ] [ , [ @sql_message_id = ] sql_message_id ] [ , [ @sql_severity = ] sql_severity ]