Compartir a través de


sp_help (Transact-SQL)

Presenta información acerca de un objeto de base de datos (cualquier objeto de la vista de compatibilidad sys.sysobjects), un tipo de datos definido por el usuario o un tipo de datos.

Icono de vínculo a temasConvenciones de sintaxis de Transact-SQL

Sintaxis

sp_help [ [ @objname = ] 'name' ]

Argumentos

  • [ @objname=] 'name'
    Es el nombre de cualquier objeto, en sysobjects, o cualquier tipo de datos definido por el usuario en la tabla systypes. name es de tipo nvarchar(776) y su valor predeterminado es NULL. No se aceptan nombres de bases de datos.

Valores de código de retorno

0 (correcto) o 1 (error)

Conjuntos de resultados

Los conjuntos de resultados que se devuelven dependen de si se ha especificado name, de cuándo se ha especificado y del objeto de base de datos de que se trate.

  1. Si sp_help se ejecuta sin argumentos, se devuelve información de resumen de los objetos de todo tipo que existen en la base de datos actual.

    Nombre de columna

    Tipo de datos

    Descripción

    Name

    nvarchar(128)

    Nombre del objeto.

    Owner

    nvarchar(128)

    Propietario del objeto.

    Object_type

    nvarchar(31)

    Tipo de objeto.

  2. Si name es un tipo de datos de SQL Server o un tipo de datos definido por el usuario, sp_help devuelve el siguiente conjunto de resultados.

    Nombre de columna

    Tipo de datos

    Descripción

    Type_name

    nvarchar(128)

    Nombre del tipo de datos.

    Storage_type

    nvarchar(128)

    Nombre del tipo de SQL Server.

    Length

    smallint

    Longitud física del tipo de datos (en bytes).

    Prec

    int

    Precisión (número total de dígitos).

    Scale

    int

    Número de dígitos a la derecha del separador decimal.

    Nullable

    varchar(35)

    Indica si se permiten valores NULL: Yes o No.

    Default_name

    nvarchar(128)

    Nombre de un valor predeterminado enlazado a este tipo.

    NULL = No hay un valor predeterminado enlazado.

    Rule_name

    nvarchar(128)

    Nombre de una regla enlazada a este tipo.

    NULL = No hay un valor predeterminado enlazado.

    Collation

    sysname

    Intercalación del tipo de datos. NULL para tipos de datos que no sean de caracteres.

  3. Si name es un objeto de base de datos distinto de un tipo de datos, sp_help devuelve este conjunto de resultados además de conjuntos de resultados adicionales, según el tipo de objeto especificado.

    Nombre de columna

    Tipo de datos

    Descripción

    Name

    nvarchar(128)

    Nombre de la tabla.

    Owner

    nvarchar(128)

    Propietario de la tabla.

    Type

    nvarchar(31)

    Tipo de tabla.

    Created_datetime

    datetime

    Fecha de creación de la tabla.

    Según el objeto de base de datos especificado, sp_help devuelve conjuntos de resultados adicionales.

    Si name es una tabla del sistema, una tabla de usuario o una vista, sp_help devuelve el siguiente conjunto de resultados. No obstante, el conjunto de resultados que describe la ubicación del archivo de datos en un grupo de archivos no se devuelve para una vista.

    • Conjunto de resultados adicional devuelto en los objetos de columna:

      Nombre de columna

      Tipo de datos

      Descripción

      Column_name

      nvarchar(128)

      Nombre de la columna.

      Type

      nvarchar(128)

      Tipo de datos de la columna.

      Computed

      varchar(35)

      Indica si los valores de la columna son calculados: Yes o No.

      Length

      int

      Longitud de la columna en bytes.

      NotaNota
      Si el tipo de datos de la columna es un valor grande (varchar(max), nvarchar(max), varbinary(max) o xml), el valor se mostrará como -1.

      Prec

      char(5)

      Precisión de la columna.

      Scale

      char(5)

      Escala de la columna.

      Nullable

      varchar(35)

      Indica si se permiten valores NULL en la columna: Yes o No.

      TrimTrailingBlanks

      varchar(35)

      Recorta los espacios en blanco finales. Devuelve Yes o No.

      FixedLenNullInSource

      varchar(35)

      Se conserva únicamente por compatibilidad con versiones anteriores.

      Collation

      sysname

      Intercalación de la columna. NULL para tipos de datos que no sean de caracteres.

    • Conjunto de resultados adicional devuelto en las columnas de identidad:

      Nombre de columna

      Tipo de datos

      Descripción

      Identity

      nvarchar(128)

      Nombre de la columna cuyo tipo de datos se declara como identidad.

      Seed

      numeric

      Valor inicial de la columna de identidad.

      Increment

      numeric

      Incremento que se va a utilizar en los valores de esta columna.

      Not For Replication

      int

      No se aplica la propiedad IDENTITY cuando un inicio de sesión de replicación, como sqlrepl, inserta datos en la tabla:

      1 = Verdadero

      0 = Falso

    • Conjunto de resultados adicional devuelto en las columnas:

      Nombre de columna

      Tipo de datos

      Descripción

      RowGuidCol

      sysname

      Nombre de la columna de identificador único global.

    • Conjunto de resultados adicional devuelto en los grupos de archivos:

      Nombre de columna

      Tipo de datos

      Descripción

      Data_located_on_filegroup

      nvarchar(128)

      Grupo de archivos en el que se encuentran los datos: Principal, Secundario o Registro de transacciones.

    • Conjunto de resultados adicional devuelto en los índices:

      Nombre de columna

      Tipo de datos

      Descripción

      index_name

      sysname

      Nombre del índice.

      Index_description

      varchar(210)

      Descripción del índice.

      index_keys

      nvarchar(2078)

      Nombres de las columnas en las que se ha generado el índice.

    • Conjunto de resultados adicional devuelto en las restricciones:

      Nombre de columna

      Tipo de datos

      Descripción

      constraint_type

      nvarchar(146)

      Tipo de restricción.

      constraint_name

      nvarchar(128)

      Nombre de la restricción.

      delete_action

      nvarchar(9)

      Indica si la acción DELETE es: NO ACTION, CASCADE o N/A.

      Sólo se aplica a las restricciones FOREIGN KEY.

      update_action

      nvarchar(9)

      Indica si la acción UPDATE es: NO ACTION, CASCADE o N/A.

      Sólo se aplica a las restricciones FOREIGN KEY.

      status_enabled

      varchar(8)

      Indica si la restricción está habilitada: Habilitada, Deshabilitada o N/A.

      Sólo se aplica a las restricciones CHECK y FOREIGN KEY.

      status_for_replication

      varchar(19)

      Indica si la restricción es para replicación.

      Sólo se aplica a las restricciones CHECK y FOREIGN KEY.

      constraint_keys

      nvarchar(2078)

      Nombres de las columnas que componen la restricción o, en el caso de valores predeterminados y reglas, el texto que define el valor predeterminado o la regla.

    • Conjunto de resultados adicional devuelto en los objetos de referencia:

      Nombre de columna

      Tipo de datos

      Descripción

      Table is referenced by

      nvarchar(516)

      Identifica otros objetos de base de datos que hacen referencia a la tabla.

    • Conjunto de resultados adicional devuelto en los procedimientos almacenados, las funciones o los procedimientos almacenados extendidos.

      Nombre de columna

      Tipo de datos

      Descripción

      Parameter_name

      nvarchar(128)

      Nombre del parámetro del procedimiento almacenado.

      Type

      nvarchar(128)

      Tipo de datos del parámetro del procedimiento almacenado.

      Length

      smallint

      Longitud máxima de almacenamiento físico en bytes.

      Prec

      int

      Precisión o número total de dígitos.

      Scale

      int

      Número de dígitos a la derecha del separador decimal.

      Param_order

      smallint

      Orden del parámetro.

Notas

El procedimiento sp_help sólo busca un objeto en la base de datos actual.

Cuando no se especifica name, sp_help presenta los nombres, los propietarios y los tipos de objeto de todos los objetos de la base de datos actual. sp_helptrigger proporciona información acerca de los desencadenadores.

sp_help solo expone columnas de índice ordenable; por consiguiente, no expone información acerca de los índices XML o de los índices espaciales.

Permisos

Debe pertenecer a la función public. El usuario debe tener por lo menos un permiso en objname. Para ver claves de restricción de columna, valores predeterminados o reglas, debe tener el permiso VIEW DEFINITION en la tabla.

Ejemplos

A. Devolver información acerca de todos los objetos

En el siguiente ejemplo se presenta información acerca de cada objeto de la base de datos master.

USE master;
GO
EXEC sp_help;
GO

B. Devolver información acerca de un solo objeto

En el siguiente ejemplo se presenta información acerca de la tabla Contact.

USE AdventureWorks;
GO
EXEC sp_help 'Person.Contact';
GO