sp_help (Transact-SQL)
Relata informações sobre um objeto de banco de dados (qualquer objeto listado na exibição de compatibilidade sys.sysobjects), um tipo de dados definido pelo usuário ou um tipo de dados.
.gif "Ícone de vínculo de tópico")
Convenções de sintaxe Transact-SQL
Sintaxe
sp_help [ [ @objname = ] 'name' ]
Argumentos
- [ @objname=] 'name'
É o nome de qualquer objeto, em sysobjects ou qualquer outro tipo de dados definido pelo usuário na tabela systypes. name é nvarchar(776), com um padrão de NULL. Nomes de banco de dados não são aceitáveis.
Valores de código de retorno
0 (êxito) ou 1 (falha)
Conjuntos de resultados
Os conjuntos de resultados retornados dependem do fato de name ser especificado, de quando ele é especificado e de qual objeto de banco de dados ele se refere.
Se sp_help for executado sem nenhum argumento, serão retornadas as informações de resumo de objetos de todos os tipos que existem no banco de dados atual.
Nome da coluna
Tipo de dados
Descrição
Name
nvarchar(128)
Nome do objeto
Proprietário
nvarchar(128)
Proprietário do objeto (esta é a entidade de segurança do banco de dados que é a proprietária deste objeto. Assume o proprietário do esquema que contém o objeto.)
Object_type
nvarchar(31)
Tipo de objeto
Se name for um tipo de dados do SQL Server ou tipo de dados definido pelo usuário, sp_help retornará este conjunto de resultados.
Nome da coluna
Tipo de dados
Descrição
Type_name
nvarchar(128)
Nome do tipo de dados.
Storage_type
nvarchar(128)
Nome do tipo do SQL Server.
Length
smallint
O comprimento físico do tipo de dados (em bytes).
Prec
int
Precisão (número total de dígitos).
Escala
int
Número de dígitos à direita da casa decimal.
Anulável
varchar(35)
Indica se valores NULL são permitidos: Sim ou Não.
Default_name
nvarchar(128)
Nome de uma associação padrão para esse tipo.
NULL = Nenhum padrão é associado.
Rule_name
nvarchar(128)
Nome de uma associação de regra para esse tipo.
NULL = Nenhum padrão é associado.
Agrupamento
sysname
Agrupamento do tipo de dados. NULL para tipos de dados de não caracteres.
Se name for qualquer objeto de banco de dados diferente de um tipo de dados, sp_help retornará esse conjunto de resultado e também conjuntos de resultados adicionais, com base no tipo de objeto especificado.
Nome da coluna
Tipo de dados
Descrição
Nome
nvarchar(128)
Nome da tabela
Owner
nvarchar(128)
Proprietário da tabela
Tipo
nvarchar(31)
Tipo de tabela
Created_datetime
datetime
Tabela de data criada
Dependendo do objeto de banco de dados especificado, sp_help retorna conjuntos de resultados adicionais.
Se name for uma tabela do sistema, tabela de usuário ou exibição, sp_help retornará os conjuntos de resultados a seguir. Entretanto, o conjunto de resultados que descreve onde o arquivo de dados está localizado em um grupo de arquivos não é retornado para uma exibição.
Conjunto de resultados adicionais retornado em objetos de coluna:
Nome da coluna
Tipo de dados
Descrição
Column_name
nvarchar(128)
Nome da coluna.
Tipo
nvarchar(128)
Tipo de dados da coluna.
Computed
varchar(35)
Indica se os valores na coluna são computados: Sim ou Não.
Length
int
Comprimento da coluna em bytes.
.gif "Observação")
ObservaçãoSe o tipo de dados da coluna for um tipo de valor grande (varchar(max), nvarchar(max), varbinary(max) ou xml), o valor será exibido como -1.
Prec
char(5)
Precisão da coluna.
Scale
char(5)
Escala da coluna.
Nullable
varchar(35)
Indica se valores NULL são permitidos na coluna: Sim ou Não.
TrimTrailingBlanks
varchar(35)
Exclui os espaços em branco à direita. Retorna Sim ou Não.
FixedLenNullInSource
varchar(35)
Somente para compatibilidade com versões anteriores.
Collation
sysname
Agrupamento da coluna. NULL para tipos de dados de não caracteres.
Conjunto de resultados adicionais retornado em colunas de identidade:
Nome da coluna
Tipo de dados
Descrição
Identity
nvarchar(128)
Nome da coluna cujo tipo de dados é declarado como identidade.
Seed
numeric
O valor inicial para a coluna de identidade.
Increment
numeric
Incremento a ser usado para obter valores nesta coluna.
Not For Replication
int
A propriedade IDENTITY não é imposta quando um logon de replicação, como sqlrepl, insere dados na tabela:
1 = Verdadeiro
0 = Falso
Conjunto de resultados adicionais retornado em colunas:
Nome da coluna
Tipo de dados
Descrição
RowGuidCol
sysname
Nome da coluna de identificador exclusivo global.
Conjunto de resultados adicionais retornado em grupos de arquivos:
Nome da coluna
Tipo de dados
Descrição
Data_located_on_filegroup
nvarchar(128)
Grupo de arquivos no qual os dados estão localizados: Primário, Secundário ou Log de Transações.
Conjunto de resultados adicionais retornado em índices:
Nome da coluna
Tipo de dados
Descrição
index_name
sysname
Nome do índice.
Index_description
varchar(210)
Descrição do índice.
index_keys
nvarchar(2078)
Nomes de coluna para os quais o índice é criado. Retorna NULL para índices columnstore xVelocity de memória otimizada.
Conjunto de resultados adicionais retornado em restrições:
Nome da coluna
Tipo de dados
Descrição
constraint_type
nvarchar(146)
Tipo de restrição.
constraint_name
nvarchar(128)
Nome da restrição.
delete_action
nvarchar(9)
Indica se a ação DELETE é: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT ou N/A.
Aplicável somente para restrições FOREIGN KEY.
update_action
nvarchar(9)
Indica se a ação UPDATE é: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT ou N/A.
Aplicável somente para restrições FOREIGN KEY.
status_enabled
varchar(8)
Indica se a restrição está habilitada: Habilitado, Desabilitado ou N/A.
Aplicável somente para restrições CHECK e FOREIGN KEY.
status_for_replication
varchar(19)
Indica se a restrição é para replicação.
Aplicável somente para restrições CHECK e FOREIGN KEY.
constraint_keys
nvarchar(2078)
Os nomes das colunas que compõem a restrição ou, no caso de padrões e regras, do texto que define o padrão ou a regra.
Conjunto de resultados adicionais retornado em objetos de referência:
Nome da coluna
Tipo de dados
Descrição
A tabela é referenciada por
nvarchar(516)
Identifica outros objetos de banco de dados que referenciam a tabela.
Conjunto de resultados adicionais retornado em procedimentos armazenados, funções ou procedimentos armazenados estendidos.
Nome da coluna
Tipo de dados
Descrição
Parameter_name
nvarchar(128)
Nome de parâmetro de procedimento armazenado.
Tipo
nvarchar(128)
Tipo de dados do parâmetro de procedimento armazenado.
Comprimento
smallint
Comprimento máximo de armazenamento físico, em bytes.
Prec
int
Precisão ou número total de dígitos.
Escala
int
Número de dígitos à direita da vírgula decimal.
Param_order
smallint
Ordem do parâmetro.
Comentários
O procedimento sp_help procura um objeto apenas no banco de dados atual.
Quando name não é especificado, sp_help lista nomes de objetos, proprietários e tipos de objeto de todos os objetos do banco de dados atual. sp_helptrigger fornece informações sobre gatilhos.
sp_help expõe apenas as colunas de índices que podem ser solicitadas; por isso, não expõe informações sobre índices XML ou índices espaciais.
Permissões
Requer associação na função pública. O usuário deve ter pelo menos uma permissão no objname. Para exibir as chaves de restrição de coluna, padrões ou regras, você deve ter a permissão VIEW DEFINITION na tabela.
Exemplos
A.Retornando informações sobre todos os objetos
O exemplo a seguir lista informações sobre cada objeto no banco de dados master.
USE master;
GO
EXEC sp_help;
GO
B.Retornando informações sobre um único objeto
O exemplo a seguir exibe informações sobre a tabela Person.
USE AdventureWorks2012;
GO
EXEC sp_help 'Person.Person';
GO
Consulte também
Referência
Procedimentos armazenados do Mecanismo de Banco de Dados (Transact-SQL)