DBCC HELP (Transact-SQL)

APPLIES TO: yesSQL Server (starting with 2008) noAzure SQL Database noAzure SQL Data Warehouse noParallel Data Warehouse

Returns syntax information for the specified DBCC command.

Topic link icon Transact-SQL Syntax Conventions

Syntax

DBCC HELP ( 'dbcc_statement' | @dbcc_statement_var | '?' )  
[ WITH NO_INFOMSGS ]  

Arguments

dbcc_statement | *@dbcc_statement_var*
Is the name of the DBCC command for which to receive syntax information. Provide only the part of the DBCC command that follows DBCC, for example, CHECKDB instead of DBCC CHECKDB.

?
Returns all DBCC commands for which Help is available.

WITH NO_INFOMSGS
Suppresses all informational messages that have severity levels from 0 through 10.

Result Sets

DBCC HELP returns a result set displaying the syntax for the specified DBCC command.

Permissions

Requires membership in the sysadmin fixed server role.

Examples

A. Using DBCC HELP with a variable

The following example returns syntax information for DBCC CHECKDB.

DECLARE @dbcc_stmt sysname;  
SET @dbcc_stmt = 'CHECKDB';  
DBCC HELP (@dbcc_stmt);  
GO  

B. Using DBCC HELP with the ? option

The following example returns all DBCC statements for which Help is available.

DBCC HELP ('?');  
GO  

See Also

DBCC (Transact-SQL)