sp_help (Transact-SQL)sp_help (Transact-SQL)

APLICA-SE A: simSQL Server simBanco de Dados SQL do Azure nãoAzure Synapse Analytics (SQL DW) nãoParallel Data Warehouse APPLIES TO: yesSQL Server yesAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse

Relata informações sobre um objeto Database (qualquer objeto listado na exibição de compatibilidade Sys. sysobjects ), um tipo de dados definido pelo usuário ou um tipo de dados.Reports information about a database object (any object listed in the sys.sysobjects compatibility view), a user-defined data type, or a data type.

Ícone de link do tópico convenções de sintaxe Transact-SQLTopic link icon Transact-SQL Syntax Conventions

SintaxeSyntax

  
sp_help [ [ @objname = ] 'name' ]  

ArgumentosArguments

[ @objname = ] 'name' é o nome de qualquer objeto, em sysobjects ou qualquer tipo de dados definido pelo usuário na tabela systypes .[ @objname = ] 'name' Is the name of any object, in sysobjects or any user-defined data type in the systypes table. Name é nvarchar ( 776 ) , com um padrão de NULL.name is nvarchar( 776 ), with a default of NULL. Nomes de banco de dados não são aceitáveis.Database names are not acceptable. Dois ou três nomes de parte devem ser delimitados, como 'Person.AddressType' ou [Person.AddressType].Two or three part names must be delimited, such as 'Person.AddressType' or [Person.AddressType].

Valores do código de retornoReturn Code Values

0 (êxito) ou 1 (falha)0 (success) or 1 (failure)

Conjuntos de resultadosResult Sets

Os conjuntos de resultados retornados dependem se o nome é especificado, quando é especificado, e qual é o objeto de banco de dados.The result sets that are returned depend on whether name is specified, when it is specified, and which database object it is.

  1. Se sp_help for executado sem argumentos, serão retornadas informações resumidas de objetos de todos os tipos existentes no banco de dados atual.If sp_help is executed with no arguments, summary information of objects of all types that exist in the current database is returned.

    Nome da colunaColumn name Tipo de DadosData type DescriptionDescription
    NameName nvarchar( 128 )nvarchar( 128 ) Nome do objetoObject name
    ProprietárioOwner nvarchar( 128 )nvarchar( 128 ) Proprietário do objeto (esta é a entidade de segurança do banco de dados que é a proprietária deste objeto.Object owner (This is the database principal that owns object. O padrão é o proprietário do esquema que contém o objeto.)Defaults to the owner of the schema that contains the object.)
    Object_typeObject_type nvarchar ( 31 )nvarchar( 31 ) Tipo de objetoObject type
  2. Se Name for um tipo de dados SQL ServerSQL Server ou um tipo de dados definido pelo usuário, sp_help retornará esse conjunto de resultados.If name is a SQL ServerSQL Server data type or user-defined data type, sp_help returns this result set.

    Nome da colunaColumn name Tipo de DadosData type DescriptionDescription
    Type_nameType_name nvarchar( 128 )nvarchar( 128 ) Nome do tipo de dados.Data type name.
    Storage_typeStorage_type nvarchar( 128 )nvarchar( 128 ) Nome do tipo do SQL ServerSQL Server.SQL ServerSQL Server type name.
    ComprimentoLength smallintsmallint O comprimento físico do tipo de dados (em bytes).Physical length of the data type (in bytes).
    PrecPrec Intint Precisão (número total de dígitos).Precision (total number of digits).
    EscalaScale Intint Número de dígitos à direita da casa decimal.Number of digits to the right of the decimal.
    AnulávelNullable varchar ( 35 )varchar( 35 ) Indica se valores NULL são permitidos: Sim ou Não.Indicates whether NULL values are allowed: Yes or No.
    Default_nameDefault_name nvarchar( 128 )nvarchar( 128 ) Nome de uma associação padrão para esse tipo.Name of a default bound to this type.

    NULL = Nenhum padrão é associado.NULL = No default is bound.
    Rule_nameRule_name nvarchar( 128 )nvarchar( 128 ) Nome de uma associação de regra para esse tipo.Name of a rule bound to this type.

    NULL = Nenhum padrão é associado.NULL = No default is bound.
    OrdenaçãoCollation sysnamesysname Ordenação do tipo de dados.Collation of the data type. NULL para tipos de dados de não caracteres.NULL for non-character data types.
  3. Se Name for qualquer objeto Database diferente de um tipo de dados, sp_help retornará esse conjunto de resultados e também conjuntos de resultados adicionais, com base no tipo de objeto especificado.If name is any database object other than a data type, sp_help returns this result set and also additional result sets, based on the type of object specified.

    Nome da colunaColumn name Tipo de DadosData type DescriptionDescription
    NameName nvarchar( 128 )nvarchar( 128 ) Nome da tabelaTable name
    ProprietárioOwner nvarchar( 128 )nvarchar( 128 ) Proprietário da tabelaTable owner
    TipoType nvarchar ( 31 )nvarchar( 31 ) Tipo de tabelaTable type
    Created_datetimeCreated_datetime datetimedatetime Tabela de data criadaDate table created

    Dependendo do objeto de banco de dados especificado, sp_help retorna conjuntos de resultados adicionais.Depending on the database object specified, sp_help returns additional result sets.

    Se Name for uma tabela do sistema, uma tabela de usuário ou uma exibição, sp_help retornará os seguintes conjuntos de resultados.If name is a system table, user table, or view, sp_help returns the following result sets. 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.However, the result set that describes where the data file is located on a file group is not returned for a view.

    • Conjunto de resultados adicionais retornado em objetos de coluna:Additional result set returned on column objects:

      Nome da colunaColumn name Tipo de DadosData type DescriptionDescription
      Column_nameColumn_name nvarchar( 128 )nvarchar( 128 ) Nome da coluna.Column name.
      TipoType nvarchar( 128 )nvarchar( 128 ) Tipo de dados da coluna.Column data type.
      ComputadaComputed varchar ( 35 )varchar( 35 ) Indica se os valores na coluna são computados: Sim ou Não.Indicates whether the values in the column are computed: Yes or No.
      ComprimentoLength Intint Comprimento da coluna em bytes.Column length in bytes.

      Observação: se 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.Note: If the column data type is a large value type (varchar(max), nvarchar(max), varbinary(max), or xml), the value will display as -1.
      PrecPrec Char ( 5 )char( 5 ) Precisão da coluna.Column precision.
      EscalaScale Char ( 5 )char( 5 ) Escala de coluna.Column scale.
      AnulávelNullable varchar ( 35 )varchar( 35 ) Indica se valores NULL são permitidos na coluna: Sim ou Não.Indicates whether NULL values are allowed in the column: Yes or No.
      TrimTrailingBlanksTrimTrailingBlanks varchar ( 35 )varchar( 35 ) Exclui os espaços em branco à direita.Trim the trailing blanks. Retorna Sim ou Não.Returns Yes or No.
      FixedLenNullInSourceFixedLenNullInSource varchar ( 35 )varchar( 35 ) Somente para compatibilidade com versões anteriores.For backward compatibility only.
      OrdenaçãoCollation sysnamesysname Ordenação da coluna.Collation of the column. NULO para tipos de dados não caracteres.NULL for noncharacter data types.
    • Conjunto de resultados adicionais retornado em colunas de identidade:Additional result set returned on identity columns:

      Nome da colunaColumn name Tipo de DadosData type DescriptionDescription
      IdentidadeIdentity nvarchar( 128 )nvarchar( 128 ) Nome da coluna cujo tipo de dados é declarado como identidade.Column name whose data type is declared as identity.
      SementeSeed numericnumeric O valor inicial para a coluna de identidade.Starting value for the identity column.
      IncrementoIncrement numericnumeric Incremento a ser usado para obter valores nesta coluna.Increment to use for values in this column.
      Não para replicaçãoNot For Replication Intint A propriedade IDENTITY não é imposta quando um logon de replicação, como sqlrepl, insere dados na tabela:IDENTITY property is not enforced when a replication login, such as sqlrepl, inserts data into the table:

      1 = True1 = True

      0 = False0 = False
    • Conjunto de resultados adicionais retornado em colunas:Additional result set returned on columns:

      Nome da colunaColumn name Tipo de DadosData type DescriptionDescription
      RowGuidColRowGuidCol sysnamesysname Nome da coluna de identificador exclusivo global.Name of the global unique identifier column.
    • Conjunto de resultados adicionais retornado em grupos de arquivos:Additional result set returned on filegroups:

      Nome da colunaColumn name Tipo de DadosData type DescriptionDescription
      Data_located_on_filegroupData_located_on_filegroup nvarchar( 128 )nvarchar( 128 ) Grupo de arquivos no qual os dados estão localizados: Primário, Secundário ou Log de Transações.Filegroup in which the data is located: Primary, Secondary, or Transaction Log.
    • Conjunto de resultados adicionais retornado em índices:Additional result set returned on indexes:

      Nome da colunaColumn name Tipo de DadosData type DescriptionDescription
      index_nameindex_name sysnamesysname Nome do índice.Index name.
      Index_descriptionIndex_description varchar ( 210 )varchar( 210 ) Descrição do índice.Description of the index.
      index_keysindex_keys nvarchar ( 2078 )nvarchar( 2078 ) Nomes de coluna nas quais o índice é criado.Column names on which the index is built. Retorna NULL para índices columnstore xVelocity de memória otimizada.Returns NULL for xVelocity memory optimized columnstore indexes.
    • Conjunto de resultados adicionais retornado em restrições:Additional result set returned on constraints:

      Nome da colunaColumn name Tipo de DadosData type DescriptionDescription
      constraint_typeconstraint_type nvarchar ( 146 )nvarchar( 146 ) Tipo de restrição.Type of constraint.
      constraint_nameconstraint_name nvarchar( 128 )nvarchar( 128 ) Nome da restrição.Name of the constraint.
      delete_actiondelete_action nvarchar ( 9 )nvarchar( 9 ) Indica se a ação DELETE é: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT ou N/A.Indicates whether the DELETE action is: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT, or N/A.

      Aplicável somente para restrições FOREIGN KEY.Only applicable to FOREIGN KEY constraints.
      update_actionupdate_action nvarchar ( 9 )nvarchar( 9 ) Indica se a ação UPDATE é: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT ou N/A.Indicates whether the UPDATE action is: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT, or N/A.

      Aplicável somente para restrições FOREIGN KEY.Only applicable to FOREIGN KEY constraints.
      status_enabledstatus_enabled varchar ( 8 )varchar( 8 ) Indica se a restrição está habilitada: Habilitado, Desabilitado ou N/A.Indicates whether the constraint is enabled: Enabled, Disabled, or N/A.

      Aplicável somente para restrições CHECK e FOREIGN KEY.Only applicable to CHECK and FOREIGN KEY constraints.
      status_for_replicationstatus_for_replication varchar ( 19 )varchar( 19 ) Indica se a restrição é para replicação.Indicates whether the constraint is for replication.

      Aplicável somente para restrições CHECK e FOREIGN KEY.Only applicable to CHECK and FOREIGN KEY constraints.
      constraint_keysconstraint_keys nvarchar ( 2078 )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.Names of the columns that make up the constraint or, in the case for defaults and rules, the text that defines the default or rule.
    • Conjunto de resultados adicionais retornado em objetos de referência:Additional result set returned on referencing objects:

      Nome da colunaColumn name Tipo de DadosData type DescriptionDescription
      A tabela é referenciada porTable is referenced by nvarchar ( 516 )nvarchar( 516 ) Identifica outros objetos de banco de dados que referenciam a tabela.Identifies other database objects that reference the table.
    • Conjunto de resultados adicionais retornado em procedimentos armazenados, funções ou procedimentos armazenados estendidos.Additional result set returned on stored procedures, functions, or extended stored procedures.

      Nome da colunaColumn name Tipo de DadosData type DescriptionDescription
      Parameter_nameParameter_name nvarchar( 128 )nvarchar( 128 ) Nome de parâmetro de procedimento armazenado.Stored procedure parameter name.
      TipoType nvarchar( 128 )nvarchar( 128 ) Tipo de dados do parâmetro de procedimento armazenado.Data type of the stored procedure parameter.
      ComprimentoLength smallintsmallint Comprimento máximo de armazenamento físico, em bytes.Maximum physical storage length, in bytes.
      PrecPrec Intint Precisão ou número total de dígitos.Precision or total number of digits.
      EscalaScale Intint Número de dígitos à direita da vírgula decimal.Number of digits to the right of the decimal point.
      Param_orderParam_order smallintsmallint Ordem do parâmetro.Order of the parameter.

RemarksRemarks

O procedimento sp_help procura um objeto somente no banco de dados atual.The sp_help procedure looks for an object in the current database only.

Quando Name não for especificado, sp_help listará os nomes de objeto, proprietários e tipos de objeto para todos os objetos no banco de dados atual.When name is not specified, sp_help lists object names, owners, and object types for all objects in the current database. sp_helptrigger fornece informações sobre gatilhos.sp_helptrigger provides information about triggers.

sp_help expõe apenas colunas de índice ordenáveis; Portanto, ele não expõe informações sobre índices XML ou índices espaciais.sp_help exposes only orderable index columns; therefore, it does not expose information about XML indexes or spatial indexes.

PermissõesPermissions

Requer associação à função pública .Requires membership in the public role. O usuário deve ter pelo menos uma permissão em objname.The user must have at least one permission on objname. Para exibir as chaves de restrição de coluna, padrões ou regras, você deve ter a permissão VIEW DEFINITION na tabela.To view column constraint keys, defaults, or rules, you must have VIEW DEFINITION permission on the table.

ExemplosExamples

A.A. Retornando informações sobre todos os objetosReturning information about all objects

O exemplo a seguir lista informações sobre cada objeto no banco de dados master.The following example lists information about each object in the master database.

USE master;  
GO  
EXEC sp_help;  
GO  

b.B. Retornando informações sobre um único objetoReturning information about a single object

O exemplo a seguir exibe informações sobre a tabela Person.The following example displays information about the Person table.

USE AdventureWorks2012;  
GO  
EXEC sp_help 'Person.Person';  
GO  

Consulte TambémSee Also

Mecanismo de banco de dados procedimentos (armazenados Transact-) SQLDatabase Engine Stored Procedures (Transact-SQL)
(Transact-SQL) sp_helpindexsp_helpindex (Transact-SQL)
sp_helprotect (Transact-SQL) sp_helprotect (Transact-SQL)
sp_helpserver (Transact-SQL) sp_helpserver (Transact-SQL)
sp_helptrigger (Transact-SQL) sp_helptrigger (Transact-SQL)
(Transact-SQL) sp_helpusersp_helpuser (Transact-SQL)
Procedimentos armazenados do sistema (Transact-SQL) System Stored Procedures (Transact-SQL)
Transact-SQL (sys. sysobjects)sys.sysobjects (Transact-SQL)