Partilhar via

sp_help (Transact-SQL)

Aplica-se a:SQL ServerAzure SQL DatabaseAzure SQL Managed InstanceBase de dados SQL no Microsoft Fabric

Reporta informações sobre um objeto de base de dados (qualquer objeto listado na sys.sysobjects vista de compatibilidade), um tipo de dado definido pelo utilizador ou um tipo de dado.

Transact-SQL convenções de sintaxe

Sintaxe

sp_help [ [ @objname = ] N'objname' ]
[ ; ]

Arguments

[ @objname = ] N'objname'

O nome de qualquer objeto, em sys.sysobjects ou qualquer tipo de dado definido pelo utilizador na sys.systypes tabela. @objname é nvarchar(776), com um padrão de NULL. Nomes de bases de dados não são aceitáveis. Dois ou três nomes de partes podem ser delimitados, como Person.AddressType ou [Person].[AddressType].

Valores de código de retorno

0 (sucesso) ou 1 (fracasso).

Conjunto de resultados

Os conjuntos de resultados devolvidos dependem de @name está especificado, quando é especificado e qual é o objeto da base de dados.

  1. Se sp_help for executado sem argumentos, a informação resumida de todos os tipos que existem na base de dados atual é devolvida.

    Nome da coluna Tipo de dados Description
    Name nvarchar(128) Nome do objeto
    Owner nvarchar(128) Proprietário do objeto (O principal da base de dados que detém o objeto. Por defeito, pertence ao proprietário do esquema que contém o objeto.)
    Object_type Nvarchar(31) Tipo de objeto

  2. Se @name for um tipo de dado SQL Server ou definido pelo utilizador, sp_help devolve este conjunto de resultados.

    Nome da coluna Tipo de dados Description
    Type_name nvarchar(128) Nome do tipo de dados.
    Storage_type nvarchar(128) Nome do tipo SQL Server.
    Length smallint Comprimento físico do tipo de dado (em bytes).
    Prec int Precisão (número total de dígitos).
    Scale int Número de dígitos à direita do decimal.
    Nullable Varchar (35) Indica se NULL os valores são permitidos: Yes ou No.
    Default_name nvarchar(128) Nome de um padrão associado a este tipo.

    NULL = Nenhum padrão está limitado.
    Rule_name nvarchar(128) Nome de uma regra ligada a este tipo.

    NULL = Nenhum padrão está limitado.
    Collation sysname Compilação do tipo de dados. NULL para tipos de dados que não sejam caracteres.

  3. Se @name for qualquer objeto de base de dados que não seja um tipo de dados, sp_help devolve este conjunto de resultados e também conjuntos adicionais de resultados, consoante o tipo de objeto especificado.

    Nome da coluna Tipo de dados Description
    Name nvarchar(128) Nome da tabela
    Owner nvarchar(128) Dono da mesa
    Type Nvarchar(31) Tipo de tabela
    Created_datetime datetime Tabela de datas criada

    Dependendo do objeto da base de dados especificado, sp_help devolve conjuntos de resultados adicionais.

    Se @name for uma tabela de sistema, tabela de utilizador ou vista, sp_help devolve os seguintes conjuntos de resultados. No entanto, o conjunto de resultados que descreve onde o ficheiro de dados está localizado num grupo de ficheiros não é devolvido para visualização.

    • O seguinte conjunto de resultados também é devolvido nos objetos coluna:

      Nome da coluna Tipo de dados Description
      Column_name nvarchar(128) Nome da coluna.
      Type nvarchar(128) Tipo de dados da coluna.
      Computed Varchar (35) Indica se os valores na coluna são calculados: Yes ou No.
      Length int Comprimento da coluna em bytes.

      Nota: Se o tipo de dados da coluna for de valor grande (varchar(max),nvarchar(max), varbinary(max) ou xml), o valor é apresentado como -1.
      Prec char(5) Precisão na coluna.
      Scale char(5) Escala de coluna.
      Nullable Varchar (35) Indica se NULL os valores são permitidos na coluna: Yes ou No.
      TrimTrailingBlanks Varchar (35) Apara os festims de rastro. Retornos Yes ou No.
      FixedLenNullInSource Varchar (35) Este parâmetro está obsoleto e é mantido para compatibilidade retroativa dos scripts.
      Collation sysname Colação da coluna. NULL para tipos de dados que não são caracteres.

    • O seguinte conjunto de resultados também é devolvido nas colunas de identidade:

      Nome da coluna Tipo de dados Description
      Identity nvarchar(128) Nome da coluna cujo tipo de dado é declarado como identidade.
      Seed numérico Valor inicial para a coluna de identidade.
      Increment numérico Incremente para usar os valores nesta coluna.
      Not For Replication int IDENTITY A propriedade não é aplicada quando um login de replicação, como o SQLREPL, insere dados na tabela:

      1 = Verdadeiro
      0 = Falso

    • O seguinte conjunto de resultados também é devolvido nas colunas:

      Nome da coluna Tipo de dados Description
      RowGuidCol sysname Nome da coluna global de identificador único.

    • O seguinte conjunto de resultados também é devolvido nos grupos de ficheiros:

      Nome da coluna Tipo de dados Description
      Data_located_on_filegroup nvarchar(128) Grupo de ficheiros onde os dados estão localizados: Primary, Secondary, ou Transaction Log.

    • O seguinte conjunto de resultados também é devolvido nos índices:

      Nome da coluna Tipo de dados Description
      index_name sysname Nome do índice.
      Index_description Varchar (210) Descrição do índice.
      index_keys nvarchar (2078) Nomes das colunas sobre os quais o índice é construído. Retornos NULL para índices de coluna otimizados pela memória.

    • O seguinte conjunto de resultados também é devolvido nas restrições:

      Nome da coluna Tipo de dados Description
      constraint_type Nvarchar (146) Tipo de restrição.
      constraint_name nvarchar(128) Nome da restrição.
      delete_action nvarchar(9) Indica se a DELETE ação pertence a NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT, ou N/A.

      Aplicável apenas a restrições de CHAVE ESTRANGEIRA.
      update_action nvarchar(9) Indica se a UPDATE ação pertence a NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT, ou N/A.

      Aplicável apenas a FOREIGN KEY restrições.
      status_enabled Varchar(8) Indica se a restrição está ativada: Enabled, Disabled, ou N/A.

      Aplicável apenas a CHECK e FOREIGN KEY restrições.
      status_for_replication Varchar(19) Indica se a restrição é para replicação.

      Aplicável apenas a CHECK e FOREIGN KEY restrições.
      constraint_keys nvarchar (2078) Nomes das colunas que compõem a restrição ou, no caso dos padrões e regras, o texto que define o padrão ou regra.

    • O seguinte conjunto de resultados também é devolvido nos objetos de referência:

      Nome da coluna Tipo de dados Description
      Table is referenced by Nvarchar(516) Identifica outros objetos da base de dados que fazem referência à tabela.

    • O seguinte conjunto de resultados também é devolvido em procedimentos armazenados, funções ou procedimentos armazenados estendidos.

      Nome da coluna Tipo de dados Description
      Parameter_name nvarchar(128) Nome do parâmetro do procedimento armazenado.
      Type nvarchar(128) Tipo de dados do parâmetro de procedimento armazenado.
      Length smallint Comprimento máximo de armazenamento físico, em bytes.
      Prec int Precisão ou número total de dígitos.
      Scale int Número de dígitos à direita da vírgula decimal.
      Param_order smallint Ordem do parâmetro.

Observações

O sp_help procedimento procura apenas um objeto na base de dados atual.

Quando @name não está especificado, sp_help lista nomes de objetos, proprietários e tipos de objetos para todos os objetos na base de dados atual. sp_helptrigger fornece informações sobre os gatilhos.

sp_help expõe apenas colunas de índice ordenáveis; por isso, não expõe informação sobre índices XML ou espaciais.

Permissions

Requer adesão à função pública de . O utilizador deve ter pelo menos uma permissão sobre @objname. Para visualizar chaves de restrição de colunas, padrões ou regras, deve ter VIEW DEFINITION permissão na tabela.

Examples

Os exemplos de código neste artigo usam o banco de dados de exemplo AdventureWorks2025 ou AdventureWorksDW2025, que pode ser descarregado da página inicial de Exemplos e Projetos da Comunidade do Microsoft SQL Server.

A. Devolver informação sobre todos os objetos

O exemplo seguinte lista informações sobre cada objeto na master base de dados.

USE master;
GO

EXECUTE sp_help;
GO

B. Devolver informação sobre um único objeto

O exemplo seguinte apresenta informações sobre a Person.Person tabela.

USE AdventureWorks2022;
GO

EXECUTE sp_help 'Person.Person';
GO

Conteúdo relacionado

  • Last updated on